LineLoad

Public Class

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

Inheritance Hierarchy

System.Object
Autodesk.Revit.DB.Element
Autodesk.Revit.DB.Structure.LoadBase
Autodesk.Revit.DB.Structure.LineLoad

Namespace: Autodesk.Revit.DB.Structure

Assembly: RevitAPI (in RevitAPI.dll) Version: 25.0.0.0 (25.0.0.0)

Syntax

public class LineLoad : LoadBase

The LineLoad type exposes the following members.

Properties

Name

Description

Public Property

AssemblyInstanceId

The id of the assembly instance to which the element belongs.
(Inherited from Element)

Public Property
Code Example
BoundingBox

Retrieves a box that circumscribes all geometry of the element.
(Inherited from Element)

Public Property
Category

Retrieves a Category object that represents the category or sub category in which the element resides.
(Inherited from Element)

Public Property
Code Example
CreatedPhaseId

Id of a Phase at which the Element was created.
(Inherited from Element)

Public Property
Code Example
DemolishedPhaseId

Id of a Phase at which the Element was demolished.
(Inherited from Element)

Public Property
Code Example
DesignOption

Returns the design option to which the element belongs.
(Inherited from Element)

Public Property
Document

Returns the Document in which the Element resides.
(Inherited from Element)

Public Property
EndPoint

Returns the three dimensional location of the end point for the line load.

Public Property
ForceVector1

The force vector applied to the start point of the line load, oriented according to OrientTo setting.

Public Property
ForceVector2

The force vector applied to the end point of the line load, oriented according to OrientTo setting.

Public Property
Code Example
Geometry

Retrieves the geometric representation of the element.
(Inherited from Element)

Public Property

GroupId

The id of the group to which an element belongs.
(Inherited from Element)

Public Property
HostElementId

The host element ID for the load.
(Inherited from LoadBase)

Public Property
Code Example
Id

A unique identifier for an Element in an Autodesk Revit project.
(Inherited from Element)

Public Property

IsConstrainedOnHost

The load is constrained to host or not.
(Inherited from LoadBase)

Public Property
IsHosted

Indicates if the Load is hosted or non-hosted.
(Inherited from LoadBase)

Public Property
IsModifiable

Identifies if the element is modifiable.
(Inherited from Element)

Public Property
IsProjected

Indicates if the load is projected.

Public Property

IsReaction

The load is reaction option.
(Inherited from LoadBase)

Public Property
IsTransient

Indicates whether an element is transient or permanent.
(Inherited from Element)

Public Property
IsUniform

Indicates if the load is uniform.

Public Property
IsValidObject

Specifies whether the .NET object represents a valid Revit entity.
(Inherited from Element)

Public Property

LevelId

The id of the level associated with the element.
(Inherited from Element)

Public Property

LoadCase

The load case for the load.
(Inherited from LoadBase)

Public Property

LoadCaseId

The load case ID for the load.
(Inherited from LoadBase)

Public Property

LoadCaseName

The name of the load case to which this load belongs.
(Inherited from LoadBase)

Public Property

LoadCategoryName

The name of the category to which this load belongs.
(Inherited from LoadBase)

Public Property

LoadNatureName

A string representing the nature of the load.
(Inherited from LoadBase)

Public Property
Code Example
Location

This property is used to find the physical location of an element within a project.
(Inherited from Element)

Public Property
MomentVector1

The moment vector applied to the start point of the line load, oriented according to OrientTo setting.

Public Property
MomentVector2

The moment vector applied to the end point of the line load, oriented according to OrientTo setting.

Public Property
Name

A human readable name for the Element.
(Inherited from Element)

Public Property
OrientTo

The load orientation option.
(Inherited from LoadBase)

Public Property

OwnerViewId

The id of the view that owns the element.
(Inherited from Element)

Public Property
Code Example
Parameter.BuiltInParameter.

Retrieves a parameter from the element given a parameter id.
(Inherited from Element)

Public Property
Parameter.Definition.

Retrieves a parameter from the element based on its definition.
(Inherited from Element)

Public Property
Parameter.Guid.

Retrieves a parameter from the element given a GUID for a shared parameter.
(Inherited from Element)

Public Property
Code Example
Parameters

Retrieves a set containing all of the parameters that are contained within the element.
(Inherited from Element)

Public Property
ParametersMap

Retrieves a map containing all of the parameters that are contained within the element.
(Inherited from Element)

Public Property
Pinned

Identifies if the element has been pinned to prevent changes.
(Inherited from Element)

Public Property
StartPoint

Returns the three dimensional location of the start point for the line load.

Public Property
Code Example
UniqueId

A stable unique identifier for an element within the document.
(Inherited from Element)

Public Property
VersionGuid

Get the element version Guid.
(Inherited from Element)

Public Property

ViewSpecific

Identifies if the element is owned by a view.
(Inherited from Element)

Public Property
WorkPlaneId

Id of the work plane which may determine the orientation of the load.
(Inherited from LoadBase)

Public Property
WorksetId

Get Id of the Workset which owns the element.
(Inherited from Element)

Methods

Name

Description

Public Method
ArePhasesModifiable

Returns true if the properties CreatedPhaseId and DemolishedPhaseId can be modified for this Element.
(Inherited from Element)

Public Method
CanBeHidden

Indicates if the element can be hidden in the view.
(Inherited from Element)

Public Method

CanBeLocked

Identifies if the element can be locked.
(Inherited from Element)

Public Method

CanDeleteSubelement

Checks if given subelement can be removed from the element.
(Inherited from Element)

Public Method
CanHaveTypeAssigned.

Identifies if the element can have a type assigned.
(Inherited from Element)

Public Method
ChangeTypeId(ElementId)

Changes the type of the element.
(Inherited from Element)

Public Method
Static Member

Create(Document, ElementId, XYZ, XYZ, LineLoadType)

Creates a new hosted line load within the project.

Public Method
Static Member
Create(Document, ElementId, Curve, XYZ, XYZ, LineLoadType)

Creates a new custom line load within the project.

Public Method
Static Member

Create(Document, ElementId, Int32, XYZ, XYZ, LineLoadType)

Creates a new hosted line load within the project.

Public Method

DeleteEntity

Deletes the existing entity created by %schema% in the element
(Inherited from Element)

Public Method
DeleteSubelement

Removes a subelement from the element.
(Inherited from Element)

Public Method
DeleteSubelements

Removes the subelements from the element.
(Inherited from Element)

Public Method

Dispose

(Inherited from Element)

Public Method

Equals

Determines whether the specified object is equal to the current object.
(Inherited from Object)

Public Method

EvaluateAllParameterValues

Evaluates all the parameters’ values of the element.
(Inherited from Element)

Public Method

EvaluateParameterValues

Evaluate the parameters’ values of the element on the given parameter ID set.
(Inherited from Element)

Public Method

GetCurve

Returns curve that define geometry of the line load.

Public Method
GetDependentElements

Get all elements that, from a logical point of view, are the children of this Element.
(Inherited from Element)

Public Method
GetEntity

Returns the existing entity corresponding to the Schema if it has been saved in the Element, or an invalid entity otherwise.
(Inherited from Element)

Public Method

GetEntitySchemaGuids

Returns the Schema guids of any Entities stored in this element.
(Inherited from Element)

Public Method

GetExternalFileReference

Gets information pertaining to the external file referenced by the element.
(Inherited from Element)

Public Method
GetExternalResourceReference

Gets the ExternalResourceReference associated with a specified external resource type.
(Inherited from Element)

Public Method
GetExternalResourceReferenceExpanded

Gets the collection of ExternalResourceReference associated with a specified external resource type.
(Inherited from Element)

Public Method
GetExternalResourceReferences

Gets the map of the external resource references referenced by the element.
(Inherited from Element)

Public Method
GetExternalResourceReferencesExpanded

Gets the expanded map of the external resource references referenced by the element.
(Inherited from Element)

Public Method
Code Example
GetGeneratingElementIds

Returns the ids of the element(s) that generated the input geometry object.
(Inherited from Element)

Public Method
GetGeometryObjectFromReference

Retrieve one geometric primitive contained in the element given a reference.
(Inherited from Element)

Public Method

GetHashCode

Serves as the default hash function.
(Inherited from Object)

Public Method

GetMaterialArea

Gets the area of the material with the given id.
(Inherited from Element)

Public Method
GetMaterialIds

Gets the element ids of all materials present in the element.
(Inherited from Element)

Public Method

GetMaterialVolume

Gets the volume of the material with the given id.
(Inherited from Element)

Public Method

GetMonitoredLinkElementIds

Provides the link instance IDs when the element is monitoring.
(Inherited from Element)

Public Method

GetMonitoredLocalElementIds

Provides the local element IDs when the element is monitoring.
(Inherited from Element)

Public Method
GetOrderedParameters

Gets the parameters associated to the element in order.
(Inherited from Element)

Public Method
GetParameter

Retrieves a parameter from the element given identifier.
(Inherited from Element)

Public Method

GetParameterFormatOptions

Returns a FormatOptions override for the element Parameter, or a default FormatOptions if no override exists.
(Inherited from Element)

Public Method
GetParameters

Retrieves the parameters from the element via the given name.
(Inherited from Element)

Public Method

GetPhaseStatus

Gets the status of a given element in the input phase
(Inherited from Element)

Public Method
GetSubelements

Returns the collection of element subelements.
(Inherited from Element)

Public Method

GetType

Gets the Type of the current instance.
(Inherited from Object)

Public Method
Code Example
GetTypeId

Returns the identifier of this element’s type.
(Inherited from Element)

Public Method

GetValidTypes.

Obtains a set of types that are valid for this element.
(Inherited from Element)

Public Method
HasPhases

Returns true if this Element has the properties CreatedPhaseId and DemolishedPhaseId.
(Inherited from Element)

Public Method

IsCreatedPhaseOrderValid

Returns true if createdPhaseId and demolishedPhaseId are in order.
(Inherited from Element)

Public Method
Static Member

IsCurveInsideHostBoundaries

Indicates if the curve is inside panel’s boundaries or on panel’s edges or if the curve is on the member’s curve.

Public Method

IsDemolishedPhaseOrderValid

Returns true if createdPhaseId and demolishedPhaseId are in order.
(Inherited from Element)

Public Method
IsExternalFileReference

Determines whether this Element represents an external file.
(Inherited from Element)

Public Method
IsHidden

Identifies if the element has been permanently hidden in the view.
(Inherited from Element)

Public Method

IsMonitoringLinkElement

Indicate whether an element is monitoring any elements in any linked models.
(Inherited from Element)

Public Method

IsMonitoringLocalElement

Indicate whether an element is monitoring other local elements.
(Inherited from Element)

Public Method
IsOrientToPermitted

Indicates if the provided orientation is permitted for this load.
(Inherited from LoadBase)

Public Method
IsPhaseCreatedValid

Returns true if createdPhaseId is an allowed value for the property CreatedPhaseId in this Element.
(Inherited from Element)

Public Method
IsPhaseDemolishedValid

Returns true if demolishedPhaseId is an allowed value for the property DemolishedPhaseId in this Element.
(Inherited from Element)

Public Method
Static Member

IsValidHostId

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

Public Method
IsValidType(ElementId)

Checks if given type is valid for this element.
(Inherited from Element)

Public Method
LookupParameter

Attempts to find a parameter on the element which has the given name.
(Inherited from Element)

Public Method

RefersToExternalResourceReference

Determines whether this Element uses external resources associated with a specified external resource type.
(Inherited from Element)

Public Method
RefersToExternalResourceReferences

Determines whether this Element uses external resources.
(Inherited from Element)

Public Method

RemoveHostConstraint

Removes constraint from host for this load.
(Inherited from LoadBase)

Public Method
SetCurve

Sets the curve for the line load.

Public Method

SetEntity

Stores the entity in the element. If an Entity described by the same Schema already exists, it is overwritten.
(Inherited from Element)

Public Method
SetPoints

Sets start and end point of the line load.

Public Method

ToString

Returns a string that represents the current object.
(Inherited from Object)

Remarks

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

Example

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 + ")";
}