LineLoad

Description:
An object that represents a force/moment applied in a linear manner.

Remarks:
The load/moment may be uniform or it may vary between the two ends of the line.

Inheritance Hierarchy:
System.Object
  Autodesk.Revit.DB.Element
    Autodesk.Revit.DB.Structure.LoadBase
      Autodesk.Revit.DB.Structure.LineLoad

public class LineLoad : LoadBase

Public Class LineLoad _
	Inherits LoadBase

public ref class LineLoad : public LoadBase

private void LineLoadInformation(LineLoad lineLoad)
{
     StringBuilder information = new StringBuilder("Line Load: ");

     // Get the load case name
     information.Append("\nLoad case for load: " + lineLoad.LoadCaseName);

     //Get the three dimensional force applied to the start point and end point of the line load.
     information.Append("\nForce at the start of this line load: " + XYZToString(lineLoad.ForceVector1));
     information.Append("\nForce at the end of this line load: " + XYZToString(lineLoad.ForceVector2));

     //Get the three dimensional location of the start point and end point for the line load.
     information.Append("\nStart point of this line load: " + XYZToString(lineLoad.StartPoint));
     information.Append("\nEnd Point of this line load: " + XYZToString(lineLoad.EndPoint));

     //Get the three dimensional moment applied to the start point and end point of the line load.
     information.Append("\nMoment at the start of this line load: " + XYZToString(lineLoad.MomentVector1));
     information.Append("\nMoment at the end of this line load: " + XYZToString(lineLoad.MomentVector2));

     //Whether the load is projected or not
     if (lineLoad.IsProjected)
     {
         information.Append("\nThis line load is projected.");
     }
     else
     {
         information.Append("\nThis line load is not projected");
     }

     //Report if the load is uniform
     if (false != lineLoad.IsUniform)
     {
         information.Append("\nThis load is uniform.");
     }
     else
     {
         information.Append("\nThis load is not uniform.");
     }

     //show information of lineload in a MessageBox.
     TaskDialog.Show("Revit",information.ToString());
 }

 // output the point's three coordinates
 string XYZToString(XYZ point)
 {
     return "(" + point.X + ", " + point.Y + ", " + point.Z + ")";
 }

Private Sub LineLoadInformation(lineLoad As LineLoad)
    Dim information As New StringBuilder("Line Load: ")

    ' Get the load case name
    information.Append(vbLf & "Load case for load: " & Convert.ToString(lineLoad.LoadCaseName))

    'Get the three dimensional force applied to the start point and end point of the line load.
 information.Append(vbLf & "Force at the start of this line load: " & XYZToString(lineLoad.ForceVector1))
 information.Append(vbLf & "Force at the end of this line load: " & XYZToString(lineLoad.ForceVector2))

    'Get the three dimensional location of the start point and end point for the line load.
    information.Append(vbLf & "Start point of this line load: " & XYZToString(lineLoad.StartPoint))
    information.Append(vbLf & "End Point of this line load: " & XYZToString(lineLoad.EndPoint))

    'Get the three dimensional moment applied to the start point and end point of the line load.
 information.Append(vbLf & "Moment at the start of this line load: " & XYZToString(lineLoad.MomentVector1))
 information.Append(vbLf & "Moment at the end of this line load: " & XYZToString(lineLoad.MomentVector2))

    'Whether the load is projected or not
 If lineLoad.IsProjected Then
    information.Append(vbLf & "This line load is projected.")
 Else
    information.Append(vbLf & "This line load is not projected")
 End If

    'Report if the load is uniform
 If False <> lineLoad.IsUniform Then
    information.Append(vbLf & "This load is uniform.")
 Else
    information.Append(vbLf & "This load is not uniform.")
 End If

    'show information of lineload in a MessageBox.
    TaskDialog.Show("Revit", information.ToString())
End Sub

' output the point's three coordinates
Private Function XYZToString(point As XYZ) As String
    Return "(" & Convert.ToString(point.X) & ", " & Convert.ToString(point.Y) & ", " & Convert.ToString(point.Z) & ")"
End Function

Name	Return Type	Description	Inherited From
M Create(Document, ElementId, Curve, XYZ, XYZ, LineLoadType)	nullNothingnullptr	Creates a new custom line load within the project.
M Create(Document, ElementId, Int32, XYZ, XYZ, LineLoadType)	nullNothingnullptr	Creates a new hosted line load within the project.
M Create(Document, ElementId, XYZ, XYZ, LineLoadType)	nullNothingnullptr	Creates a new hosted line load within the project.
M GetCurve()	Curve	Returns curve that define geometry of the line load.
M IsCurveInsideHostBoundaries(Document, ElementId, Curve)	bool	Indicates if the curve is inside panel's boundaries or on panel's edges or if the curve is on the member's curve.
M IsValidHostId(Document, ElementId)	bool	Indicates if the provided host id can host line loads The document containing both the host and the load The id of the analytical element that is about to host a line load True if a line load can be placed on the input host id
M SetCurve(Curve)	None	Sets the curve for the line load.
M SetPoints(XYZ, XYZ)	bool	Sets start and end point of the line load.
M ArePhasesModifiable()	bool	Returns true if the properties CreatedPhaseId and DemolishedPhaseId can be modified for this Element.	Element
M CanBeHidden(View)	bool	Indicates if the element can be hidden in the view.	Element
M CanBeLocked()	bool	Identifies if the element can be locked.	Element
M CanDeleteSubelement(Subelement)	bool	Checks if given subelement can be removed from the element.	Element
M CanHaveTypeAssigned()	bool	Identifies if the element can have a type assigned.	Element
M CanHaveTypeAssigned(Document, ICollection<ElementId>)	bool	Checks if all elements in the set can have a type assigned.	Element
M ChangeTypeId(Document, ICollection<ElementId>, ElementId)	IDictionary	Changes the type of all elements in the given set.	Element
M ChangeTypeId(ElementId)	ElementId	Changes the type of the element.	Element
M DeleteEntity(Schema)	bool	Deletes the existing entity created by %schema% in the element	Element
M DeleteSubelement(Subelement)	bool	Removes a subelement from the element.	Element
M DeleteSubelements(IList<Subelement>)	bool	Removes the subelements from the element.	Element
M Dispose()	None	Releases all resources used by the	Element
M EvaluateAllParameterValues()	EvaluatedParameter	Evaluates all the parameters' values of the element.	Element
M EvaluateParameterValues(ISet<ElementId>)	EvaluatedParameter	Evaluate the parameters' values of the element on the given parameter ID set.	Element
M GetChangeTypeAny()	ChangeType	Returns ChangeType associated with any change in an element.	Element
M GetChangeTypeElementAddition()	ChangeType	Returns ChangeType associated with element addition	Element
M GetChangeTypeElementDeletion()	ChangeType	Returns ChangeType associated with element deletion.	Element
M GetChangeTypeGeometry()	ChangeType	Returns ChangeType associated with a change in the geometry of an element	Element
M GetChangeTypeParameter(ElementId)	ChangeType	Returns ChangeType associated with a change in a parameter's value	Element
M GetChangeTypeParameter(Parameter)	ChangeType	Returns ChangeType associated with a change in a parameter's value	Element
M GetDependentElements(ElementFilter)	IList<ElementId>	Get all elements that, from a logical point of view, are the children of this Element.	Element
M GetEntity(Schema)	The returned Entity.	Returns the existing entity corresponding to the Schema if it has been saved in the Element, or an invalid entity otherwise.	Element
M GetEntitySchemaGuids()	IList<Guid>	Returns the Schema guids of any Entities stored in this element.	Element
M GetExternalFileReference()	ExternalFileReference	Gets information pertaining to the external file referenced by the element.	Element
M GetExternalResourceReferenceExpanded(ExternalResourceType)	IList<ExternalResourceReference>	Gets the collection of ExternalResourceReference associated with a specified external resource type.	Element
M GetExternalResourceReference(ExternalResourceType)	ExternalResourceReference	Gets the ExternalResourceReference associated with a specified external resource type.	Element
M GetExternalResourceReferencesExpanded()	IDictionary	Gets the expanded map of the external resource references referenced by the element.	Element
M GetExternalResourceReferences()	IDictionary	Gets the map of the external resource references referenced by the element.	Element
M GetGeneratingElementIds(GeometryObject)	ICollection<ElementId>	Returns the ids of the element(s) that generated the input geometry object.	Element
M GetGeometryObjectFromReference(Reference)	GeometryObject	Retrieve one geometric primitive contained in the element given a reference.	Element
M GetMaterialArea(ElementId, Boolean)	double	Gets the area of the material with the given id.	Element
M GetMaterialIds(Boolean)	ICollection<ElementId>	Gets the element ids of all materials present in the element.	Element
M GetMaterialVolume(ElementId)	double	Gets the volume of the material with the given id.	Element
M GetMonitoredLinkElementIds()	IList<ElementId>	Provides the link instance IDs when the element is monitoring.	Element
M GetMonitoredLocalElementIds()	IList<ElementId>	Provides the local element IDs when the element is monitoring.	Element
M GetOrderedParameters()	IList<Parameter>	Gets the parameters associated to the element in order.	Element
M GetParameterFormatOptions(ElementId)	FormatOptions	Returns a FormatOptions override for the element Parameter, or a default FormatOptions if no override exists.	Element
M GetParameter(ForgeTypeId)	Parameter	Retrieves a parameter from the element given identifier.	Element
M GetParameters(String)	IList<Parameter>	Retrieves the parameters from the element via the given name.	Element
M GetPhaseStatus(ElementId)	ElementOnPhaseStatus	Gets the status of a given element in the input phase	Element
M GetSubelements()	IList<Subelement>	Returns the collection of element subelements.	Element
M GetTypeId()	ElementId	Returns the identifier of this element's type.	Element
M GetValidTypes()	ICollection<ElementId>	Obtains a set of types that are valid for this element.	Element
M GetValidTypes(Document, ICollection<ElementId>)	ICollection<ElementId>	Obtains a set of types that are valid for all given elements.	Element
M HasPhases()	bool	Returns true if this Element has the properties CreatedPhaseId and DemolishedPhaseId.	Element
M IsCreatedPhaseOrderValid(ElementId)	bool	Returns true if createdPhaseId and demolishedPhaseId are in order.	Element
M IsDemolishedPhaseOrderValid(ElementId)	bool	Returns true if createdPhaseId and demolishedPhaseId are in order.	Element
M IsExternalFileReference()	bool	Determines whether this Element represents an external file.	Element
M IsHidden(View)	bool	Identifies if the element has been permanently hidden in the view.	Element
M IsMonitoringLinkElement()	bool	Indicate whether an element is monitoring any elements in any linked models.	Element
M IsMonitoringLocalElement()	bool	Indicate whether an element is monitoring other local elements.	Element
M IsPhaseCreatedValid(ElementId)	bool	Returns true if createdPhaseId is an allowed value for the property CreatedPhaseId in this Element.	Element
M IsPhaseDemolishedValid(ElementId)	bool	Returns true if demolishedPhaseId is an allowed value for the property DemolishedPhaseId in this Element.	Element
M IsValidType(Document, ICollection<ElementId>, ElementId)	bool	Checks if given type is valid for the set of elements.	Element
M IsValidType(ElementId)	bool	Checks if given type is valid for this element.	Element
M LookupParameter(String)	nullNothingnullptr	Attempts to find a parameter on the element which has the given name.	Element
M RefersToExternalResourceReference(ExternalResourceType)	bool	Determines whether this Element uses external resources associated with a specified external resource type.	Element
M RefersToExternalResourceReferences()	bool	Determines whether this Element uses external resources.	Element
M SetEntity(Entity)	None	Stores the entity in the element. If an Entity described by the same Schema already exists, it is overwritten.	Element
M IsOrientToPermitted(LoadOrientTo)	bool	Indicates if the provided orientation is permitted for this load.	LoadBase
M RemoveHostConstraint()	None	Removes constraint from host for this load.	LoadBase

Name	Return Type	Description	Inherited From
P EndPoint	XYZ	Returns the three dimensional location of the end point for the line load.
P ForceVector1	XYZ	The force vector applied to the start point of the line load, oriented according to OrientTo setting.
P ForceVector2	XYZ	The force vector applied to the end point of the line load, oriented according to OrientTo setting.
P IsProjected	bool	Indicates if the load is projected.
P IsUniform	bool	Indicates if the load is uniform.
P MomentVector1	XYZ	The moment vector applied to the start point of the line load, oriented according to OrientTo setting.
P MomentVector2	XYZ	The moment vector applied to the end point of the line load, oriented according to OrientTo setting.
P StartPoint	XYZ	Returns the three dimensional location of the start point for the line load.
P AssemblyInstanceId	ElementId	The id of the assembly instance to which the element belongs.	Element
P BoundingBox	BoundingBoxXYZ	Retrieves a box that circumscribes all geometry of the element.	Element
P Category	Category	Retrieves a Category object that represents the category or sub category in which the element resides.	Element
P CreatedPhaseId	ElementId	Id of a Phase at which the Element was created.	Element
P DemolishedPhaseId	ElementId	Id of a Phase at which the Element was demolished.	Element
P DesignOption	DesignOption	Returns the design option to which the element belongs.	Element
P Document	Document	Returns the Document in which the Element resides.	Element
P Geometry	GeometryElement	Retrieves the geometric representation of the element.	Element
P GroupId	ElementId	The id of the group to which an element belongs.	Element
P Id	ElementId	A unique identifier for an Element in an Autodesk Revit project.	Element
P IsModifiable	bool	Identifies if the element is modifiable.	Element
P IsTransient	bool	Indicates whether an element is transient or permanent.	Element
P IsValidObject	bool	Specifies whether the .NET object represents a valid Revit entity.	Element
P LevelId	ElementId	The id of the level associated with the element.	Element
P Location	Location	This property is used to find the physical location of an element within a project.	Element
P Name	string	A human readable name for the Element.	Element
P OwnerViewId	ElementId	The id of the view that owns the element.	Element
P Parameter	Parameter	Retrieves a parameter from the element given a parameter id.	Element
P Parameter	Parameter	Retrieves a parameter from the element based on its definition.	Element
P Parameter	Parameter	Retrieves a parameter from the element given a GUID for a shared parameter.	Element
P ParametersMap	ParameterMap	Retrieves a map containing all of the parameters that are contained within the element.	Element
P Parameters	ParameterSet	Retrieves a set containing all of the parameters that are contained within the element.	Element
P Pinned	bool	Identifies if the element has been pinned to prevent changes.	Element
P UniqueId	string	A stable unique identifier for an element within the document.	Element
P VersionGuid	Guid	Get the element version Guid.	Element
P ViewSpecific	bool	Identifies if the element is owned by a view.	Element
P WorksetId	WorksetId	Get Id of the Workset which owns the element.	Element
P HostElementId	ElementId	The host element ID for the load.	LoadBase
P IsConstrainedOnHost	bool	The load is constrained to host or not.	LoadBase
P IsHosted	bool	Indicates if the Load is hosted or non-hosted.	LoadBase
P IsReaction	bool	The load is reaction option.	LoadBase
P LoadCaseId	ElementId	The load case ID for the load.	LoadBase
P LoadCaseName	string	The name of the load case to which this load belongs.	LoadBase
P LoadCase	LoadCase	The load case for the load.	LoadBase
P LoadCategoryName	string	The name of the category to which this load belongs.	LoadBase
P LoadNatureName	string	A string representing the nature of the load.	LoadBase
P OrientTo	LoadOrientTo	The load orientation option.	LoadBase
P WorkPlaneId	ElementId	Id of the work plane which may determine the orientation of the load.	LoadBase