Sign in
2022 Members
Changes 5
M

PathOfTravel

Name Return Type Description Inherited From
M ArePhasesModifiable() bool Returns true if the properties CreatedPhaseId and DemolishedPhaseId can be modified for this Element. (Inherited from Element .) Element
M CanBeHidden(View) bool Indicates if the element can be hidden in the view. (Inherited from Element .) Element
M CanBeLocked() bool Identifies if the element can be locked. (Inherited from Element .) Element
M CanDeleteSubelement(Subelement) bool Checks if given subelement can be removed from the element. (Inherited from Element .) Element
M CanHaveAnalyticalModel() bool Indicates whether the Element can have an Analytical Model. (Inherited from Element .) Element
M CanHaveTypeAssigned.() bool 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(View, XYZ, XYZ) nullNothingnullptr Creates a new path of travel between two points.
M Create(View, XYZ, XYZ, PathOfTravelCalculationStatus.) nullNothingnullptr Creates a new path of travel between two points and provides creation result status.
M CreateMapped(View, IList.XYZ., IList.XYZ.) nullNothingnullptr Creates multiple new paths of travel by mapping each of a set of start points to each of a set of end points.
M CreateMapped(View, IList.XYZ., IList.XYZ., IList.PathOfTravelCalculationStatus.) nullNothingnullptr Creates multiple new paths of travel by mapping each of a set of start points to each of a set of end points and provides creation result statuses.
M CreateMultiple(View, IList.XYZ., IList.XYZ.) nullNothingnullptr Creates multiple new paths of travel between same size sets of start and end points.
M CreateMultiple(View, IList.XYZ., IList.XYZ., IList.PathOfTravelCalculationStatus.) nullNothingnullptr Creates multiple new paths of travel between same size sets of start and end points and provides creation result statuses.
M DeleteEntity(Schema) bool Deletes the existing entity created by %schema% in the element (Inherited from Element .) Element
M DeleteSubelement(Subelement) bool Removes a subelement from the element. (Inherited from Element .) Element
M DeleteSubelements(IList<Subelement>) bool 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 FindEndsOfShortestPaths(View, IList<XYZ>, IList<XYZ>) IList<XYZ> For a floor plan view, calculates the paths from each start point to its closest destination and return the path end points.
M FindShortestPaths(View, IList<XYZ>, IList<XYZ>) IList<IList<XYZ>> For a floor plan view, calculates paths from each start point to its closest destinations. Returns the path, represented by an array of XYZ points.
M FindStartsOfLongestPathsFromRooms(View, IList<XYZ>) IList<XYZ> For a floor plan view, calculates paths from points inside rooms to the closests of the destinations. Returns the start points of the longest path(s). If multiple paths have the same longest length, returns multiple start points.
M GetAnalyticalModel() Writeable Analytical Model. Retrieves writeable Analytical Model for Element. (Inherited from Element .) Element
M GetAnalyticalModelId() Element Id. Retrieves the Element Id of the Analytical Model Element for this Element. (Inherited from Element .) Element
M GetCurves() IList<Curve> Gets the array of curves representing the path of travel.
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) The returned 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 GetExternalResourceReferences() IDictionary Gets the full 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 a hash function for a particular type. (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 GetWaypoints() IList<XYZ> return the waypoints set for the Path of Travel
M HasPhases() bool Returns true if this Element has the properties CreatedPhaseId and DemolishedPhaseId. (Inherited from Element .) Element
M InsertWaypoint(XYZ, Int32) None Insert a waypoint at the specified index
M IsCreatedPhaseOrderValid(ElementId) bool Returns true if createdPhaseId and demolishedPhaseId are in order. (Inherited from Element .) Element
M IsDemolishedPhaseOrderValid(ElementId) bool Returns true if createdPhaseId and demolishedPhaseId are in order. (Inherited from Element .) Element
M IsExternalFileReference() bool Determines whether this Element represents an external file. (Inherited from Element .) Element
M IsHidden(View) bool Identifies if the element has been permanently hidden in the view. (Inherited from Element .) Element
M IsInRevealObstaclesMode(View) bool Returns current state of Reveal Obstacles mode for the given view.
M IsMonitoringLinkElement() bool Indicate whether an element is monitoring any elements in any linked models. (Inherited from Element .) Element
M IsMonitoringLocalElement() bool Indicate whether an element is monitoring other local elements. (Inherited from Element .) Element
M IsPhaseCreatedValid(ElementId) bool Returns true if createdPhaseId is an allowed value for the property CreatedPhaseId in this Element. (Inherited from Element .) Element
M IsPhaseDemolishedValid(ElementId) bool Returns true if demolishedPhaseId is an allowed value for the property DemolishedPhaseId in this Element. (Inherited from Element .) Element
M IsValidType(ElementId) bool Checks if given type is valid for this element. (Inherited from Element .) Element
M LookupParameter(String) nullNothingnullptr Attempts to find a parameter on the element which has the given name. (Inherited from Element .) Element
M RefersToExternalResourceReference(ExternalResourceType) bool Determines whether this Element uses external resources associated with a specified external resource type. (Inherited from Element .) Element
M RefersToExternalResourceReferences() bool Determines whether this Element uses external resources. (Inherited from Element .) Element
M RemoveWaypoint(Int32) None Remove a waypoint.
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 SetRevealObstaclesMode(View, Boolean) PathOfTravelCalculationStatus Sets Reveal Obstacles mode for the given view.
M SetWaypoint(XYZ, Int32) None Updates the specified waypoint.
M ToString None Returns a string that represents the current object. (Inherited from Object .) Object .
M Update() PathOfTravelCalculationStatus Updates the path of travel by recalculating the path between the original start and end points.
M UpdateMultiple(Document, IList.ElementId.) int Updates the specified paths of travel by recalculating each path using their original start and end points.
M UpdateMultiple(Document, IList.ElementId., IList.PathOfTravelCalculationStatus.) int Updates the specified paths of travel by recalculating each path using their original start and end points and provides creation result statuses.
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 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 Id ElementId A unique identifier for an Element in an Autodesk Revit project. (Inherited from Element .) Element
P IsTransient bool Indicates whether an element is transient or permanent. (Inherited from Element .) Element
P IsValidObject bool 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 LineStyle ElementId The line style of the path.
P Location Location This property is used to find the physical location of an element within a project. (Inherited from Element .) Element
P Name string A human readable name for the Element. (Inherited from Element .) Element
P OwnerViewId ElementId The id of the view that owns the element. (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 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 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 PathEnd XYZ The end point of the path. The Z coordinate will equal the view's level elevation. To update path calculations, call update.
P PathMidpoint XYZ The midpoint of the path. The Z coordinate will equal the view's level elevation.
P PathStart XYZ The start point of the path. The Z coordinate will equal the view's level elevation. To update path calculations, call update.
P Pinned bool Identifies if the element has been pinned to prevent changes. (Inherited from Element .) Element
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 WorksetId WorksetId Get Id of the Workset which owns the element. (Inherited from Element .) Element