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

type LineLoad = 
    class
        inherit LoadBase
    end

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

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