2025.3 Class
Changes 2
C

AlignmentStationLabel

Description:
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.
Inheritance Hierarchy:
System.Object
  Autodesk.Revit.DB.Infrastructure.AlignmentStationLabel
public class AlignmentStationLabel
Name Return Type Description Inherited From
M Create(Alignment, View, AlignmentStationLabelOptions) AlignmentStationLabel Creates an AlignmentStationLabel object along with its underlying SpotDimension element. Returns null if element creation fails.
M CreateRecommendedTypeForSet(Document) ElementId Creates an element type recommended for alignment label sets and returns its ElementId.
M CreateSet(Alignment, View, AlignmentStationLabelSetOptions) ICollection<AlignmentStationLabel> Creates a collection of AlignmentStationLabel objects along with their underlying SpotDimension elements.
M Equals None Determines whether the specified object is equal to the current object. (Inherited from Object ) Object
M Get(Element) AlignmentStationLabel Returns an AlignmentStationLabel object for the given element.
M GetAlignmentStationLabels(Alignment) ICollection<AlignmentStationLabel> Returns all alignment station labels placed on the given alignment.
M GetAlignmentStationLabels(Alignment, ElementId) ICollection<AlignmentStationLabel> Returns all alignment station labels placed on the given alignment in the given view.
M GetHashCode None Serves as the default hash function. (Inherited from Object ) Object
M GetType None Gets the Type of the current instance. (Inherited from Object ) Object
M IsRecommendedTypeForSet(Element) Boolean Checks if the element type is recommended for alignment labels in sets.
M IsValid() Boolean Checks if this object is a valid alignment station label.
M IsValid(Element) Boolean Checks if the element is a valid alignment station label.
M IsValidType(Element) Boolean Checks if the type is a valid alignment station label type.
M ToString None Returns a string that represents the current object. (Inherited from Object ) Object
Name Return Type Description Inherited From
P AlignmentId ElementId The ElementId of the Alignment on which the SpotDimension is placed.
P Element Element The underlying SpotDimension element.
P Station double The alignment station at which the SpotDimension is placed.