Namespace:
Autodesk.Revit.DB.Structure
LineLoad
Class
Description:
An object that represents a force/moment applied in a linear manner.
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.
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
System.Object
Autodesk.Revit.DB.Element
Autodesk.Revit.DB.Structure.LoadBase
Autodesk.Revit.DB.Structure.LineLoad
Examples
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 + ")";
}
LineLoad Class Members:
| Name | Description | Inherited From |
|---|---|---|
| AssemblyInstanceId | The id of the assembly instance to which the element belongs. (Inherited from Element ) | Element |
| BoundingBox | Retrieves a box that circumscribes all geometry of the element. (Inherited from Element ) | Element |
| Category | Retrieves a Category object that represents the category or sub category in which the element resides. (Inherited from Element ) | Element |
| CreatedPhaseId | Id of a Phase at which the Element was created. (Inherited from Element ) | Element |
| DemolishedPhaseId | Id of a Phase at which the Element was demolished. (Inherited from Element ) | Element |
| DesignOption | Returns the design option to which the element belongs. (Inherited from Element ) | Element |
| Document | Returns the Document in which the Element resides. (Inherited from Element ) | Element |
| EndPoint | Returns the three dimensional location of the end point for the line load. | |
| ForceVector1 | The force vector applied to the start point of the line load, oriented according to OrientTo setting. | |
| ForceVector2 | The force vector applied to the end point of the line load, oriented according to OrientTo setting. | |
| Geometry | Retrieves the geometric representation of the element. (Inherited from Element ) | Element |
| GroupId | The id of the group to which an element belongs. (Inherited from Element ) | Element |
| HostElementId | The host element ID for the load. (Inherited from LoadBase ) | LoadBase |
| Id | A unique identifier for an Element in an Autodesk Revit project. (Inherited from Element ) | Element |
| IsConstrainedOnHost | The load is constrained to host or not. (Inherited from LoadBase ) | LoadBase |
| IsHosted | Indicates if the Load is hosted or non-hosted. (Inherited from LoadBase ) | LoadBase |
| IsModifiable | Identifies if the element is modifiable. (Inherited from Element ) | Element |
| IsProjected | Indicates if the load is projected. | |
| IsReaction | The load is reaction option. (Inherited from LoadBase ) | LoadBase |
| IsTransient | Indicates whether an element is transient or permanent. (Inherited from Element ) | Element |
| IsUniform | Indicates if the load is uniform. | |
| IsValidObject | Specifies whether the .NET object represents a valid Revit entity. (Inherited from Element ) | Element |
| LevelId | The id of the level associated with the element. (Inherited from Element ) | Element |
| LoadCase | The load case for the load. (Inherited from LoadBase ) | LoadBase |
| LoadCaseId | The load case ID for the load. (Inherited from LoadBase ) | LoadBase |
| LoadCaseName | The name of the load case to which this load belongs. (Inherited from LoadBase ) | LoadBase |
| LoadCategoryName | The name of the category to which this load belongs. (Inherited from LoadBase ) | LoadBase |
| LoadNatureName | A string representing the nature of the load. (Inherited from LoadBase ) | LoadBase |
| Location | This property is used to find the physical location of an element within a project. (Inherited from Element ) | Element |
| MomentVector1 | The moment vector applied to the start point of the line load, oriented according to OrientTo setting. | |
| MomentVector2 | The moment vector applied to the end point of the line load, oriented according to OrientTo setting. | |
| Name | A human readable name for the Element. (Inherited from Element ) | Element |
| OrientTo | The load orientation option. (Inherited from LoadBase ) | LoadBase |
| OwnerViewId | The id of the view that owns the element. (Inherited from Element ) | Element |
| Parameter[BuiltInParameter] | Retrieves a parameter from the element given a parameter id. (Inherited from Element ) | Element |
| Parameter[Definition] | Retrieves a parameter from the element based on its definition. (Inherited from Element ) | Element |
| Parameter[Guid] | Retrieves a parameter from the element given a GUID for a shared parameter. (Inherited from Element ) | Element |
| Parameters | Retrieves a set containing all of the parameters that are contained within the element. (Inherited from Element ) | Element |
| ParametersMap | Retrieves a map containing all of the parameters that are contained within the element. (Inherited from Element ) | Element |
| Pinned | Identifies if the element has been pinned to prevent changes. (Inherited from Element ) | Element |
| StartPoint | Returns the three dimensional location of the start point for the line load. | |
| UniqueId | A stable unique identifier for an element within the document. (Inherited from Element ) | Element |
| VersionGuid | Get the element version Guid. (Inherited from Element ) | Element |
| ViewSpecific | Identifies if the element is owned by a view. (Inherited from Element ) | Element |
| WorkPlaneId | Id of the work plane which may determine the orientation of the load. (Inherited from LoadBase ) | LoadBase |
| WorksetId | Get Id of the Workset which owns the element. (Inherited from Element ) | Element |
| Name | Description | Inherited From |
|---|---|---|
| ArePhasesModifiable | Returns true if the properties CreatedPhaseId and DemolishedPhaseId can be modified for this Element. (Inherited from Element ) | Element |
| CanBeHidden | Indicates if the element can be hidden in the view. (Inherited from Element ) | Element |
| CanBeLocked | Identifies if the element can be locked. (Inherited from Element ) | Element |
| CanDeleteSubelement | Checks if given subelement can be removed from the element. (Inherited from Element ) | Element |
| CanHaveTypeAssigned() | Identifies if the element can have a type assigned. (Inherited from Element ) | Element |
| ChangeTypeId(ElementId) | Changes the type of the element. (Inherited from Element ) | Element |
| Create(Document, ElementId, XYZ, XYZ, LineLoadType) | Creates a new hosted line load within the project. | |
| Create(Document, ElementId, Curve, XYZ, XYZ, LineLoadType) | Creates a new custom line load within the project. | |
| Create(Document, ElementId, Int32, XYZ, XYZ, LineLoadType) | Creates a new hosted line load within the project. | |
| DeleteEntity | Deletes the existing entity created by %schema% in the element (Inherited from Element ) | Element |
| DeleteSubelement | Removes a subelement from the element. (Inherited from Element ) | Element |
| DeleteSubelements | Removes the subelements from the element. (Inherited from Element ) | Element |
| Dispose | (Inherited from Element ) | Element |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object ) | Object |
| EvaluateAllParameterValues | Evaluates all the parameters' values of the element. (Inherited from Element ) | Element |
| EvaluateParameterValues | Evaluate the parameters' values of the element on the given parameter ID set. (Inherited from Element ) | Element |
| GetCurve | Returns curve that define geometry of the line load. | |
| GetDependentElements | Get all elements that, from a logical point of view, are the children of this Element. (Inherited from Element ) | Element |
| 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 ) | Element |
| GetEntitySchemaGuids | Returns the Schema guids of any Entities stored in this element. (Inherited from Element ) | Element |
| GetExternalFileReference | Gets information pertaining to the external file referenced by the element. (Inherited from Element ) | Element |
| GetExternalResourceReference | Gets the ExternalResourceReference associated with a specified external resource type. (Inherited from Element ) | Element |
| GetExternalResourceReferenceExpanded | Gets the collection of ExternalResourceReference associated with a specified external resource type. (Inherited from Element ) | Element |
| GetExternalResourceReferences | Gets the map of the external resource references referenced by the element. (Inherited from Element ) | Element |
| GetExternalResourceReferencesExpanded | Gets the expanded map of the external resource references referenced by the element. (Inherited from Element ) | Element |
| GetGeneratingElementIds | Returns the ids of the element(s) that generated the input geometry object. (Inherited from Element ) | Element |
| GetGeometryObjectFromReference | Retrieve one geometric primitive contained in the element given a reference. (Inherited from Element ) | Element |
| GetHashCode | Serves as the default hash function. (Inherited from Object ) | Object |
| GetMaterialArea | Gets the area of the material with the given id. (Inherited from Element ) | Element |
| GetMaterialIds | Gets the element ids of all materials present in the element. (Inherited from Element ) | Element |
| GetMaterialVolume | Gets the volume of the material with the given id. (Inherited from Element ) | Element |
| GetMonitoredLinkElementIds | Provides the link instance IDs when the element is monitoring. (Inherited from Element ) | Element |
| GetMonitoredLocalElementIds | Provides the local element IDs when the element is monitoring. (Inherited from Element ) | Element |
| GetOrderedParameters | Gets the parameters associated to the element in order. (Inherited from Element ) | Element |
| GetParameter | Retrieves a parameter from the element given identifier. (Inherited from Element ) | Element |
| GetParameterFormatOptions | Returns a FormatOptions override for the element Parameter, or a default FormatOptions if no override exists. (Inherited from Element ) | Element |
| GetParameters | Retrieves the parameters from the element via the given name. (Inherited from Element ) | Element |
| GetPhaseStatus | Gets the status of a given element in the input phase (Inherited from Element ) | Element |
| GetSubelements | Returns the collection of element subelements. (Inherited from Element ) | Element |
| GetType | Gets the Type of the current instance. (Inherited from Object ) | Object |
| GetTypeId | Returns the identifier of this element's type. (Inherited from Element ) | Element |
| GetValidTypes() | Obtains a set of types that are valid for this element. (Inherited from Element ) | Element |
| HasPhases | Returns true if this Element has the properties CreatedPhaseId and DemolishedPhaseId. (Inherited from Element ) | Element |
| IsCreatedPhaseOrderValid | Returns true if createdPhaseId and demolishedPhaseId are in order. (Inherited from Element ) | Element |
| 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. | |
| IsDemolishedPhaseOrderValid | Returns true if createdPhaseId and demolishedPhaseId are in order. (Inherited from Element ) | Element |
| IsExternalFileReference | Determines whether this Element represents an external file. (Inherited from Element ) | Element |
| IsHidden | Identifies if the element has been permanently hidden in the view. (Inherited from Element ) | Element |
| IsMonitoringLinkElement | Indicate whether an element is monitoring any elements in any linked models. (Inherited from Element ) | Element |
| IsMonitoringLocalElement | Indicate whether an element is monitoring other local elements. (Inherited from Element ) | Element |
| IsOrientToPermitted | Indicates if the provided orientation is permitted for this load. (Inherited from LoadBase ) | LoadBase |
| IsPhaseCreatedValid | Returns true if createdPhaseId is an allowed value for the property CreatedPhaseId in this Element. (Inherited from Element ) | Element |
| IsPhaseDemolishedValid | Returns true if demolishedPhaseId is an allowed value for the property DemolishedPhaseId in this Element. (Inherited from Element ) | Element |
| 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 | |
| IsValidType(ElementId) | Checks if given type is valid for this element. (Inherited from Element ) | Element |
| LookupParameter | Attempts to find a parameter on the element which has the given name. (Inherited from Element ) | Element |
| RefersToExternalResourceReference | Determines whether this Element uses external resources associated with a specified external resource type. (Inherited from Element ) | Element |
| RefersToExternalResourceReferences | Determines whether this Element uses external resources. (Inherited from Element ) | Element |
| RemoveHostConstraint | Removes constraint from host for this load. (Inherited from LoadBase ) | LoadBase |
| SetCurve | Sets the curve for the line load. | |
| SetEntity | Stores the entity in the element. If an Entity described by the same Schema already exists, it is overwritten. (Inherited from Element ) | Element |
| SetPoints | Sets start and end point of the line load. | |
| ToString | Returns a string that represents the current object. (Inherited from Object ) | Object |