AlignmentStationLabel
Description:
Represents an object which provides access to a specialized Revit annotation element used for labeling stations.
Represents an object which provides access to a specialized Revit annotation element used for labeling stations.
Remarks:
The element is a SpotDimension. The element's category is OST_AlignmentStationLabels or, if in a set of labels, OST_AlignmentStationLabelSets. The element's type is a SpotDimensionType with DimensionStyleType equal to AlignmentStationLabel. The element's Origin is a point on the tessellated representation of an alignment. To get the precise point on the alignment's curve, use GetPointAtStation(Double) with input obtained from Station.
The element is a SpotDimension. The element's category is OST_AlignmentStationLabels or, if in a set of labels, OST_AlignmentStationLabelSets. The element's type is a SpotDimensionType with DimensionStyleType equal to AlignmentStationLabel. The element's Origin is a point on the tessellated representation of an alignment. To get the precise point on the alignment's curve, use GetPointAtStation(Double) with input obtained from Station.
public class AlignmentStationLabel
| Name | Return Type | Description | Inherited From |
|---|---|---|---|
| Create(Alignment, View, AlignmentStationLabelOptions) | AlignmentStationLabel | Creates an AlignmentStationLabel object along with its underlying SpotDimension element. Returns null if element creation fails. | |
| CreateRecommendedTypeForSet(Document) | ElementId | Creates an element type recommended for alignment label sets and returns its ElementId. | |
| CreateSet(Alignment, View, AlignmentStationLabelSetOptions) | ICollection<AlignmentStationLabel> | Creates a collection of AlignmentStationLabel objects along with their underlying SpotDimension elements. | |
| Equals | None | Determines whether the specified object is equal to the current object. (Inherited from Object ) | Object |
| Get(Element) | AlignmentStationLabel | Returns an AlignmentStationLabel object for the given element. | |
| GetAlignmentStationLabels(Alignment) | ICollection<AlignmentStationLabel> | Returns all alignment station labels placed on the given alignment. | |
| GetAlignmentStationLabels(Alignment, ElementId) | ICollection<AlignmentStationLabel> | Returns all alignment station labels placed on the given alignment in the given view. | |
| GetHashCode | None | Serves as the default hash function. (Inherited from Object ) | Object |
| GetType | None | Gets the Type of the current instance. (Inherited from Object ) | Object |
| IsRecommendedTypeForSet(Element) | Boolean | Checks if the element type is recommended for alignment labels in sets. | |
| IsValid() | Boolean | Checks if this object is a valid alignment station label. | |
| IsValid(Element) | Boolean | Checks if the element is a valid alignment station label. | |
| IsValidType(Element) | Boolean | Checks if the type is a valid alignment station label type. | |
| ToString | None | Returns a string that represents the current object. (Inherited from Object ) | Object |
| Name | Return Type | Description | Inherited From |
|---|---|---|---|
| AlignmentId | ElementId | The ElementId of the Alignment on which the SpotDimension is placed. | |
| Element | Element | The underlying SpotDimension element. | |
| Station | double | The alignment station at which the SpotDimension is placed. |