Area |
An object that represents a force applied across an area.
Inheritance Hierarchy System Object
Autodesk.Revit.DB Element
Autodesk.Revit.DB.Structure LoadBase
Autodesk.Revit.DB.Structure AreaLoad
Autodesk.Revit.DB Element
Autodesk.Revit.DB.Structure LoadBase
Autodesk.Revit.DB.Structure AreaLoad
Namespace: Autodesk.Revit.DB.Structure
Assembly: RevitAPI (in RevitAPI.dll) Version: 25.0.0.0 (25.0.0.0)
Syntax The AreaLoad type exposes the following members.
Properties | Name | Description | |
|---|---|---|
 | Area | Returns area of the area load. |
| | AssemblyInstanceId | The id of the assembly instance to which the element belongs. (Inherited from Element ) |
 | BoundingBox | Retrieves a box that circumscribes all geometry of the element. (Inherited from Element ) |
| | Category | Retrieves a Category object that represents the category or sub category in which the element resides. (Inherited from Element ) |
| | CreatedPhaseId | Id of a Phase at which the Element was created. (Inherited from Element ) |
| | DemolishedPhaseId | Id of a Phase at which the Element was demolished. (Inherited from Element ) |
| | DesignOption | Returns the design option to which the element belongs. (Inherited from Element ) |
| | Document | Returns the Document in which the Element resides. (Inherited from Element ) |
| | ForceVector1 | The force vector applied to the 1st reference point of the area load, oriented according to OrientTo setting. |
| | ForceVector2 | The force vector applied to the 2nd reference point of the area load, oriented according to OrientTo setting. |
| | ForceVector3 | The force vector applied to the 3rd reference point of the area load, oriented according to OrientTo setting. |
| | Geometry | Retrieves the geometric representation of the element. (Inherited from Element ) |
| | GroupId | The id of the group to which an element belongs. (Inherited from Element ) |
| | HostElementId | The host element ID for the load. (Inherited from LoadBase ) |
| | Id | A unique identifier for an Element in an Autodesk Revit project. (Inherited from Element ) |
| | IsConstrainedOnHost | The load is constrained to host or not. (Inherited from LoadBase ) |
| | IsHosted | Indicates if the Load is hosted or non-hosted. (Inherited from LoadBase ) |
| | IsModifiable | Identifies if the element is modifiable. (Inherited from Element ) |
| | IsProjected | Indicates if the load is projected. |
| | IsReaction | The load is reaction option. (Inherited from LoadBase ) |
| | IsTransient | Indicates whether an element is transient or permanent. (Inherited from Element ) |
| | IsValidObject | Specifies whether the .NET object represents a valid Revit entity. (Inherited from Element ) |
| | LevelId | The id of the level associated with the element. (Inherited from Element ) |
| | LoadCase | The load case for the load. (Inherited from LoadBase ) |
| | LoadCaseId | The load case ID for the load. (Inherited from LoadBase ) |
| | LoadCaseName | The name of the load case to which this load belongs. (Inherited from LoadBase ) |
| | LoadCategoryName | The name of the category to which this load belongs. (Inherited from LoadBase ) |
| | LoadNatureName | A string representing the nature of the load. (Inherited from LoadBase ) |
| | Location | This property is used to find the physical location of an element within a project. (Inherited from Element ) |
| | Name | A human readable name for the Element. (Inherited from Element ) |
| | NumRefPoints | Returns the total number of reference points for the area load. |
| | OrientTo | The load orientation option. (Inherited from LoadBase ) |
| | OwnerViewId | The id of the view that owns the element. (Inherited from Element ) |
| | Parameter BuiltInParameter | Retrieves a parameter from the element given a parameter id. (Inherited from Element ) |
| | Parameter Definition | Retrieves a parameter from the element based on its definition. (Inherited from Element ) |
| | Parameter Guid | Retrieves a parameter from the element given a GUID for a shared parameter. (Inherited from Element ) |
| | Parameters | Retrieves a set containing all of the parameters that are contained within the element. (Inherited from Element ) |
| | ParametersMap | Retrieves a map containing all of the parameters that are contained within the element. (Inherited from Element ) |
| | Pinned | Identifies if the element has been pinned to prevent changes. (Inherited from Element ) |
| | UniqueId | A stable unique identifier for an element within the document. (Inherited from Element ) |
| | VersionGuid | Get the element version Guid. (Inherited from Element ) |
| | ViewSpecific | Identifies if the element is owned by a view. (Inherited from Element ) |
| | WorkPlaneId | Id of the work plane which may determine the orientation of the load. (Inherited from LoadBase ) |
| | WorksetId | Get Id of the Workset which owns the element. (Inherited from Element ) |
Methods | Name | Description | |
|---|---|---|
  | AreCurveLoopsValid | Checks if curve loops are valid for creating an area load. |
| | ArePhasesModifiable | Returns true if the properties CreatedPhaseId and DemolishedPhaseId can be modified for this Element. (Inherited from Element ) |
| | CanBeHidden | Indicates if the element can be hidden in the view. (Inherited from Element ) |
| | CanBeLocked | Identifies if the element can be locked. (Inherited from Element ) |
| | CanDeleteSubelement | Checks if given subelement can be removed from the element. (Inherited from Element ) |
| | CanHaveTypeAssigned | Identifies if the element can have a type assigned. (Inherited from Element ) |
| | ChangeTypeId(ElementId) | Changes the type of the element. (Inherited from Element ) |
| | Create(Document, ElementId, XYZ, AreaLoadType) | Creates a new hosted area load within the project. |
| | Create(Document, ElementId, IList CurveLoop , XYZ, AreaLoadType) | Creates a new custom area load within the project. |
| | Create(Document, ElementId, IList CurveLoop , IList XYZ , IList Int32 , IList Int32 , AreaLoadType) | Creates a new custom area load within the project. |
| | DeleteEntity | Deletes the existing entity created by %schema% in the element (Inherited from Element ) |
| | DeleteSubelement | Removes a subelement from the element. (Inherited from Element ) |
| | DeleteSubelements | Removes the subelements from the element. (Inherited from Element ) |
| | Dispose | (Inherited from Element ) |
| | Equals | Determines whether the specified object is equal to the current object. (Inherited from Object ) |
| | EvaluateAllParameterValues | Evaluates all the parameters' values of the element. (Inherited from Element ) |
| | EvaluateParameterValues | Evaluate the parameters' values of the element on the given parameter ID set. (Inherited from Element ) |
| | GetDependentElements | Get all elements that, from a logical point of view, are the children of this Element. (Inherited from 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 ) |
| | GetEntitySchemaGuids | Returns the Schema guids of any Entities stored in this element. (Inherited from Element ) |
| | GetExternalFileReference | Gets information pertaining to the external file referenced by the element. (Inherited from Element ) |
| | GetExternalResourceReference | Gets the ExternalResourceReference associated with a specified external resource type. (Inherited from Element ) |
| | GetExternalResourceReferenceExpanded | Gets the collection of ExternalResourceReference associated with a specified external resource type. (Inherited from Element ) |
| | GetExternalResourceReferences | Gets the map of the external resource references referenced by the element. (Inherited from Element ) |
| | GetExternalResourceReferencesExpanded | Gets the expanded map of the external resource references referenced by the element. (Inherited from Element ) |
| | GetGeneratingElementIds | Returns the ids of the element(s) that generated the input geometry object. (Inherited from Element ) |
| | GetGeometryObjectFromReference | Retrieve one geometric primitive contained in the element given a reference. (Inherited from Element ) |
| | GetHashCode | Serves as the default hash function. (Inherited from Object ) |
| | GetLoops | Returns curve loops that define geometry of the area load. |
| | GetMaterialArea | Gets the area of the material with the given id. (Inherited from Element ) |
| | GetMaterialIds | Gets the element ids of all materials present in the element. (Inherited from Element ) |
| | GetMaterialVolume | Gets the volume of the material with the given id. (Inherited from Element ) |
| | GetMonitoredLinkElementIds | Provides the link instance IDs when the element is monitoring. (Inherited from Element ) |
| | GetMonitoredLocalElementIds | Provides the local element IDs when the element is monitoring. (Inherited from Element ) |
| | GetOrderedParameters | Gets the parameters associated to the element in order. (Inherited from Element ) |
| | GetParameter | Retrieves a parameter from the element given identifier. (Inherited from Element ) |
| | GetParameterFormatOptions | Returns a FormatOptions override for the element Parameter, or a default FormatOptions if no override exists. (Inherited from Element ) |
| | GetParameters | Retrieves the parameters from the element via the given name. (Inherited from Element ) |
| | GetPhaseStatus | Gets the status of a given element in the input phase (Inherited from Element ) |
| | GetRefPoint | Returns the physical location of the reference point. |
| | GetSubelements | Returns the collection of element subelements. (Inherited from Element ) |
| | GetType | Gets the Type of the current instance. (Inherited from Object ) |
| | GetTypeId | Returns the identifier of this element's type. (Inherited from Element ) |
| | GetValidTypes | Obtains a set of types that are valid for this element. (Inherited from Element ) |
| | HasPhases | Returns true if this Element has the properties CreatedPhaseId and DemolishedPhaseId. (Inherited from Element ) |
| | IsCreatedPhaseOrderValid | Returns true if createdPhaseId and demolishedPhaseId are in order. (Inherited from Element ) |
| | IsCurveLoopsInsideHostBoundaries | Checks if contour loops is inside host boundaries. |
| | IsDemolishedPhaseOrderValid | Returns true if createdPhaseId and demolishedPhaseId are in order. (Inherited from Element ) |
| | IsExternalFileReference | Determines whether this Element represents an external file. (Inherited from Element ) |
| | IsHidden | Identifies if the element has been permanently hidden in the view. (Inherited from Element ) |
| | IsMonitoringLinkElement | Indicate whether an element is monitoring any elements in any linked models. (Inherited from Element ) |
| | IsMonitoringLocalElement | Indicate whether an element is monitoring other local elements. (Inherited from Element ) |
| | IsOrientToPermitted | Indicates if the provided orientation is permitted for this load. (Inherited from LoadBase ) |
| | IsPhaseCreatedValid | Returns true if createdPhaseId is an allowed value for the property CreatedPhaseId in this Element. (Inherited from Element ) |
| | IsPhaseDemolishedValid | Returns true if demolishedPhaseId is an allowed value for the property DemolishedPhaseId in this Element. (Inherited from Element ) |
| | IsValidHostId | Indicates if the provided host id can host area loads The document containing both the host and the load The id of the analytical element that is about to host an area load True if an area load can be placed on the input host id |
| | IsValidType(ElementId) | Checks if given type is valid for this element. (Inherited from Element ) |
| | LookupParameter | Attempts to find a parameter on the element which has the given name. (Inherited from Element ) |
| | RefersToExternalResourceReference | Determines whether this Element uses external resources associated with a specified external resource type. (Inherited from Element ) |
| | RefersToExternalResourceReferences | Determines whether this Element uses external resources. (Inherited from Element ) |
| | RemoveHostConstraint | Removes constraint from host for this load. (Inherited from LoadBase ) |
| | SetEntity | Stores the entity in the element. If an Entity described by the same Schema already exists, it is overwritten. (Inherited from Element ) |
| | SetLoops | Sets curve loops that define geometry of the area load. |
| | ToString | Returns a string that represents the current object. (Inherited from Object ) |
Example public void GetInfo_AreaLoad(AreaLoad areaLoad)
{
string message = "AreaLoad Force : ";
// Get areaload force1 position
message += "\nAreaLoad Force1 position :(" + areaLoad.ForceVector1.X + ", "
+ areaLoad.ForceVector1.Y + ", " + areaLoad.ForceVector1.Z + ")";
// Get areaload force2 position
message += "\nAreaLoad Force2 position :(" + areaLoad.ForceVector2.X + ", "
+ areaLoad.ForceVector2.Y + ", " + areaLoad.ForceVector2.Z + ")";
// Get areaload force3 position
message += "\nAreaLoad Force3 position :(" + areaLoad.ForceVector3.X + ", "
+ areaLoad.ForceVector3.Y + ", " + areaLoad.ForceVector3.Z + ")";
// Get Loops
int loopIndex = 0;
foreach (CurveLoop curveLoop in areaLoad.GetLoops())
{
message += "\nLoop " + loopIndex + " consist of following points :";
foreach (Curve curve in curveLoop)
{
message += " (" + curve.GetEndPoint(0).X + ", " + curve.GetEndPoint(0).Y + ", " + curve.GetEndPoint(0).Z + ")";
}
loopIndex++;
}
// Get ref points information
for (int k = 0; k < areaLoad.NumRefPoints; k++)
{
// Get areaload Ref point
message += "\nAreaLoad Ref point :(" + areaLoad.GetRefPoint(k).X + ", "
+ areaLoad.GetRefPoint(k).Y + ", " + areaLoad.GetRefPoint(k).Z + ")";
}
TaskDialog.Show("Revit",message);
}