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.
Inheritance Hierarchy:
System.Object
Autodesk.Revit.DB.Infrastructure.AlignmentStationLabel
System.Object
Autodesk.Revit.DB.Infrastructure.AlignmentStationLabel
public class AlignmentStationLabel
| Name | Return Type | Description |
|---|---|---|
| Create(Alignment, View, AlignmentStationLabelOptions) | AlignmentStationLabel | Creates an object along with its underlying 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 objects along with their underlying elements. |
| 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. |
| Get(Element) | AlignmentStationLabel | Returns an object for the given element. |
| IsRecommendedTypeForSet(Element) | bool | Checks if the element type is recommended for alignment labels in sets. |
| IsValid() | bool | Checks if this object is a valid alignment station label. |
| IsValid(Element) | bool | Checks if the element is a valid alignment station label. |
| IsValidType(Element) | bool | Checks if the type is a valid alignment station label type. |
| Name | Return Type | Description |
|---|---|---|
| AlignmentId | ElementId | The ElementId of the on which the is placed. |
| Element | Element | The underlying element. |
| Station | double | The alignment station at which the is placed. |