DividedPath
Description:
An element that consists of a set of points distributed along a path which consists of a connected set of curves and edges.
An element that consists of a set of points distributed along a path which consists of a connected set of curves and edges.
Remarks:
The points can be the result of a uniform distribution along the path. The type of the distribution is determined by a selected 'layout'. The distance between the layout points depends on the path, the layout, and layout specific settings. In addition, points can also be the result of intersecting the path with other elements.
The points can be the result of a uniform distribution along the path. The type of the distribution is determined by a selected 'layout'. The distance between the layout points depends on the path, the layout, and layout specific settings. In addition, points can also be the result of intersecting the path with other elements.
public class DividedPath : Element
| Name | Return Type | Description | Inherited From |
|---|---|---|---|
| AreCurveReferencesConnected(Document, IList<Reference>) | Boolean | This checks if the references represent a connected set of curves as required by the divided path. | |
| ArePhasesModifiable() | Boolean | Returns true if the properties CreatedPhaseId and DemolishedPhaseId can be modified for this Element. (Inherited from Element ) | Element |
| CanBeHidden(View) | Boolean | Indicates if the element can be hidden in the view. (Inherited from Element ) | Element |
| CanBeLocked() | Boolean | Identifies if the element can be locked. (Inherited from Element ) | Element |
| CanDeleteSubelement(Subelement) | Boolean | Checks if given subelement can be removed from the element. (Inherited from Element ) | Element |
| CanHaveTypeAssigned() | Boolean | Identifies if the element can have a type assigned. (Inherited from Element ) | Element |
| ChangeTypeId(ElementId) | ElementId | Changes the type of the element. (Inherited from Element ) | Element |
| Create(Document, IList<Reference>) | DividedPath | Creates a new instance of a divided path with a default layout. | |
| Create(Document, IList<Reference>, ICollection<ElementId>) | DividedPath | Creates a new instance of a divided path whose points are determined by the intersecting elements. | |
| DeleteEntity(Schema) | Boolean | Deletes the existing entity created by %schema% in the element (Inherited from Element ) | Element |
| DeleteSubelement(Subelement) | Boolean | Removes a subelement from the element. (Inherited from Element ) | Element |
| DeleteSubelements(IList<Subelement>) | Boolean | Removes the subelements from the element. (Inherited from Element ) | Element |
| Dispose() | None | (Inherited from Element ) | Element |
| Equals | None | Determines whether the specified object is equal to the current object. (Inherited from Object ) | Object |
| EvaluateAllParameterValues() | IList<EvaluatedParameter> | Evaluates all the parameters' values of the element. (Inherited from Element ) | Element |
| EvaluateParameterValues(ISet<ElementId>) | IList<EvaluatedParameter> | Evaluate the parameters' values of the element on the given parameter ID set. (Inherited from Element ) | Element |
| Flip() | None | Toggle the flipped value | |
| GetDependentElements(ElementFilter) | IList<ElementId> | Get all elements that, from a logical point of view, are the children of this Element. (Inherited from Element ) | Element |
| 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 |
| GetEntitySchemaGuids() | IList<Guid> | Returns the Schema guids of any Entities stored in this element. (Inherited from Element ) | Element |
| GetExternalFileReference() | ExternalFileReference | Gets information pertaining to the external file referenced by the element. (Inherited from Element ) | Element |
| GetExternalResourceReference(ExternalResourceType) | ExternalResourceReference | Gets the ExternalResourceReference associated with a specified external resource type. (Inherited from Element ) | Element |
| GetExternalResourceReferenceExpanded(ExternalResourceType) | IList<ExternalResourceReference> | Gets the collection of ExternalResourceReference associated with a specified external resource type. (Inherited from Element ) | Element |
| GetExternalResourceReferences() | IDictionary<ExternalResourceType,ExternalResourceReference> | Gets the map of the external resource references referenced by the element. (Inherited from Element ) | Element |
| GetExternalResourceReferencesExpanded() | ExternalResourceType | Gets the expanded map of the external resource references referenced by the element. (Inherited from Element ) | Element |
| GetGeneratingElementIds(GeometryObject) | ICollection<ElementId> | Returns the ids of the element(s) that generated the input geometry object. (Inherited from Element ) | Element |
| GetGeometryObjectFromReference(Reference) | GeometryObject | Retrieve one geometric primitive contained in the element given a reference. (Inherited from Element ) | Element |
| GetHashCode | None | Serves as the default hash function. (Inherited from Object ) | Object |
| GetIntersectingElements() | ICollection<ElementId> | Get the elements whose intersection with path produces points. | |
| GetMaterialArea(ElementId, Boolean) | Double | Gets the area of the material with the given id. (Inherited from Element ) | Element |
| GetMaterialIds(Boolean) | ICollection<ElementId> | Gets the element ids of all materials present in the element. (Inherited from Element ) | Element |
| GetMaterialVolume(ElementId) | Double | Gets the volume of the material with the given id. (Inherited from Element ) | Element |
| GetMonitoredLinkElementIds() | IList<ElementId> | Provides the link instance IDs when the element is monitoring. (Inherited from Element ) | Element |
| GetMonitoredLocalElementIds() | IList<ElementId> | Provides the local element IDs when the element is monitoring. (Inherited from Element ) | Element |
| GetOrderedParameters() | IList<Parameter> | Gets the parameters associated to the element in order. (Inherited from Element ) | Element |
| GetParameter(ForgeTypeId) | Parameter | Retrieves a parameter from the element given identifier. (Inherited from Element ) | Element |
| GetParameterFormatOptions(ElementId) | FormatOptions | Returns a FormatOptions override for the element Parameter, or a default FormatOptions if no override exists. (Inherited from Element ) | Element |
| GetParameters(String) | IList<Parameter> | Retrieves the parameters from the element via the given name. (Inherited from Element ) | Element |
| GetPhaseStatus(ElementId) | ElementOnPhaseStatus | Gets the status of a given element in the input phase (Inherited from Element ) | Element |
| GetSubelements() | IList<Subelement> | Returns the collection of element subelements. (Inherited from Element ) | Element |
| GetType | None | Gets the Type of the current instance. (Inherited from Object ) | Object |
| GetTypeId() | ElementId | Returns the identifier of this element's type. (Inherited from Element ) | Element |
| GetValidTypes() | ICollection<ElementId> | Obtains a set of types that are valid for this element. (Inherited from Element ) | Element |
| HasPhases() | Boolean | Returns true if this Element has the properties CreatedPhaseId and DemolishedPhaseId. (Inherited from Element ) | Element |
| IsCreatedPhaseOrderValid(ElementId) | Boolean | Returns true if createdPhaseId and demolishedPhaseId are in order. (Inherited from Element ) | Element |
| IsCurveReferenceValid(Document, Reference) | Boolean | This returns true if the reference represents a curve or edge that can be used to create a divided path. | |
| IsDemolishedPhaseOrderValid(ElementId) | Boolean | Returns true if createdPhaseId and demolishedPhaseId are in order. (Inherited from Element ) | Element |
| IsExternalFileReference() | Boolean | Determines whether this Element represents an external file. (Inherited from Element ) | Element |
| IsHidden(View) | Boolean | Identifies if the element has been permanently hidden in the view. (Inherited from Element ) | Element |
| IsIntersectorValidForCreation(Document, ElementId) | Boolean | This returns true if the intersector is an element that can be used to intersect with a newly created divided path. | |
| IsIntersectorValidForDividedPath(ElementId) | Boolean | This returns true if the intersector is an element that can be used to intersect with the divided path. | |
| IsMonitoringLinkElement() | Boolean | Indicate whether an element is monitoring any elements in any linked models. (Inherited from Element ) | Element |
| IsMonitoringLocalElement() | Boolean | Indicate whether an element is monitoring other local elements. (Inherited from Element ) | Element |
| IsPhaseCreatedValid(ElementId) | Boolean | Returns true if createdPhaseId is an allowed value for the property CreatedPhaseId in this Element. (Inherited from Element ) | Element |
| IsPhaseDemolishedValid(ElementId) | Boolean | Returns true if demolishedPhaseId is an allowed value for the property DemolishedPhaseId in this Element. (Inherited from Element ) | Element |
| IsValidBeginningIndent(Double) | Boolean | Checks that the indent value does not cause the beginningIndent and endIndent to overlop | |
| IsValidEndIndent(Double) | Boolean | Checks that the indent value does not cause the beginningIndent and endIndent to overlop | |
| IsValidFixedNumberOfPoints(Int32) | Boolean | Identifies if the indicated number of points is valid for assignment to a DividedPath with a layout type 'FixedNumber'. | |
| IsValidMeasurementType(DividedPathMeasurementType) | Boolean | Checks that the measurement type enumeration value is valid | |
| IsValidSpacingRuleJustification(SpacingRuleJustification) | Boolean | Checks that the justification enumeration value is valid | |
| IsValidSpacingRuleLayout(SpacingRuleLayout) | Boolean | Checks that the spacing rule layout enumeration value is valid | |
| IsValidType(ElementId) | Boolean | Checks if given type is valid for this element. (Inherited from Element ) | Element |
| LookupParameter(String) | Parameter | Attempts to find a parameter on the element which has the given name. (Inherited from Element ) | Element |
| RefersToExternalResourceReference(ExternalResourceType) | Boolean | Determines whether this Element uses external resources associated with a specified external resource type. (Inherited from Element ) | Element |
| RefersToExternalResourceReferences() | Boolean | Determines whether this Element uses external resources. (Inherited from Element ) | Element |
| SeparateReferencesIntoConnectedReferences(Document, IList<Reference>) | IList<IList<Reference>> | This function separates the input curve references into groups of connected curve references. Each group of connected curve references can be used to create a divided path. | |
| 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 |
| SetIntersectingElements(ICollection<ElementId>) | None | Set the elements whose intersection with path produces points. | |
| ToString | None | Returns a string that represents the current object. (Inherited from Object ) | Object |
| Name | Return Type | Description | Inherited From |
|---|---|---|---|
| AssemblyInstanceId | ElementId | The id of the assembly instance to which the element belongs. (Inherited from Element ) | Element |
| BeginningIndent | double | The beginningIndent is an offset distance from the beginning of the first curve that determines the beginning of the range over which the layout is applied. The measurement type determines how the distance is measured. | |
| BoundingBox | BoundingBoxXYZ | Retrieves a box that circumscribes all geometry of the element. (Inherited from Element ) | Element |
| Category | Category | Retrieves a Category object that represents the category or sub category in which the element resides. (Inherited from Element ) | Element |
| CreatedPhaseId | ElementId | Id of a Phase at which the Element was created. (Inherited from Element ) | Element |
| DemolishedPhaseId | ElementId | Id of a Phase at which the Element was demolished. (Inherited from Element ) | Element |
| DesignOption | DesignOption | Returns the design option to which the element belongs. (Inherited from Element ) | Element |
| DisplayNodeNumbers | bool | Controls whether the node numbers are shown when the divided path is selected | |
| DisplayNodes | bool | Controls whether the points of the divided path are visible | |
| DisplayReferenceCurves | bool | Controls whether the curves in the path are visible | |
| Distance | double | The distance between points that are distributed along the path according to the selected layout. When the layout is set to 'FixedDistance' this value can be set to desired distance. The measurement type determines how the distance is measured. | |
| Document | Document | Returns the Document in which the Element resides. (Inherited from Element ) | Element |
| EndIndent | double | The endIndent is an offset distance from the end of the last curve that determines the end of the range over which the layout is applied. The measurement type determines how the distance is measured. | |
| FixedNumberOfPoints | int | The number of points used when the layout is set to 'FixedNumber'. | |
| Flipped | bool | If the divided path is flipped the nodes are numbered in the reverse order. It also switches the ends from which beginningIndent and endIndent are measured from. | |
| Geometry | GeometryElement | Retrieves the geometric representation of the element. (Inherited from Element ) | Element |
| GroupId | ElementId | The id of the group to which an element belongs. (Inherited from Element ) | Element |
| Id | ElementId | A unique identifier for an Element in an Autodesk Revit project. (Inherited from Element ) | Element |
| IsClosedLoop | bool | Whether or not the path forms a closed loop. | |
| IsCyclical | bool | True if the first and last point coincide False otherwise. | |
| IsModifiable | bool | Identifies if the element is modifiable. (Inherited from Element ) | Element |
| IsTransient | bool | Indicates whether an element is transient or permanent. (Inherited from Element ) | Element |
| IsValidObject | Boolean | Specifies whether the .NET object represents a valid Revit entity. (Inherited from Element ) | Element |
| LevelId | ElementId | The id of the level associated with the element. (Inherited from Element ) | Element |
| Location | Location | This property is used to find the physical location of an element within a project. (Inherited from Element ) | Element |
| MaximumDistance | double | The maximum distance is used when the layout is set to 'MaximumSpacing'. When that layout rule is used the distance between points will not exceed this value. The measurement type determines how the distance is measured. | |
| MeasurementType | DividedPathMeasurementType | The measurement type determines how distances are calculated. Either along a straight line between two points ('ChordLength') or along the segment of the path that connects them. ('SegmentLength'). | |
| MinimumDistance | double | The minimum distance is used when the layout is set to 'MinimumSpacing'. When that layout rule is used the distance between points will not fall below this value. The measurement type determines how the distance is measured. | |
| Name | string | A human readable name for the Element. (Inherited from Element ) | Element |
| NumberOfPoints | int | The total number of points of the divided surface. This combines the layout points and the intersection points. | |
| OwnerViewId | ElementId | The id of the view that owns the element. (Inherited from Element ) | Element |
| Parameter[BuiltInParameter] | Parameter | Retrieves a parameter from the element given a parameter id. (Inherited from Element ) | Element |
| Parameter[Definition] | Parameter | Retrieves a parameter from the element based on its definition. (Inherited from Element ) | Element |
| Parameter[Guid] | Parameter | Retrieves a parameter from the element given a GUID for a shared parameter. (Inherited from Element ) | Element |
| Parameters | ParameterSet | Retrieves a set containing all of the parameters that are contained within the element. (Inherited from Element ) | Element |
| ParametersMap | ParameterMap | Retrieves a map containing all of the parameters that are contained within the element. (Inherited from Element ) | Element |
| Pinned | bool | Identifies if the element has been pinned to prevent changes. (Inherited from Element ) | Element |
| SpacingRuleJustification | SpacingRuleJustification | When the layout is set to 'FixedDistance' the points may not cover the entire range of the path. The justification determines whether the points are centered on the range, or shifted towards the start or end of the range. | |
| SpacingRuleLayout | SpacingRuleLayout | The layout determines how points are distributed along the path. | |
| TotalPathLength | double | The sum of the curve lengths. | |
| UniqueId | string | A stable unique identifier for an element within the document. (Inherited from Element ) | Element |
| VersionGuid | Guid | Get the element version Guid. (Inherited from Element ) | Element |
| ViewSpecific | bool | Identifies if the element is owned by a view. (Inherited from Element ) | Element |
| WorksetId | WorksetId | Get Id of the Workset which owns the element. (Inherited from Element ) | Element |