AlignmentStationLabel
Represents an object which provides access to a specialized Revit annotation element used for labeling Alignment stations.
Inheritance Hierarchy
System.Object
Autodesk.Revit.DB.Infrastructure.AlignmentStationLabel
Namespace: Autodesk.Revit.DB.Infrastructure
Assembly: Autodesk.CivilAlignments.DBApplication (in Autodesk.CivilAlignments.DBApplication.dll) Version: 25.0.0.0 (25.0.0.0)
Syntax
public class AlignmentStationLabelThe AlignmentStationLabel type exposes the following members.
Properties
Name
Description
Public Property
AlignmentId
The ElementId of the Alignment on which the SpotDimension is placed.
Public Property
Element
The underlying SpotDimension element.
Public Property
Station
The alignment station at which the SpotDimension is placed.
Methods
Name
Description
Public Method
Static Member
Create
Creates an AlignmentStationLabel object along with its underlying SpotDimension element. Returns null if element creation fails.
Public Method
Static Member
CreateRecommendedTypeForSet
Creates an element type recommended for alignment label sets and returns its ElementId.
Public Method
Static Member
CreateSet
Creates a collection of AlignmentStationLabel objects along with their underlying SpotDimension elements.
Public Method
Equals
Determines whether the specified object is equal to the current object.
(Inherited from Object)
Public Method
Static Member
Get
Returns an AlignmentStationLabel object for the given element.
Public Method
Static Member
GetAlignmentStationLabels(Alignment)
Returns all alignment station labels placed on the given alignment.
Public Method
Static Member
GetAlignmentStationLabels(Alignment, ElementId)
Returns all alignment station labels placed on the given alignment in the given view.
Public Method
GetHashCode
Serves as the default hash function.
(Inherited from Object)
Public Method
GetType
Gets the Type of the current instance.
(Inherited from Object)
Public Method
Static Member
IsRecommendedTypeForSet
Checks if the element type is recommended for alignment labels in sets.
Public Method
IsValid.
Checks if this object is a valid alignment station label.
Public Method
Static Member
IsValid(Element)
Checks if the element is a valid alignment station label.
Public Method
Static Member
IsValidType
Checks if the type is a valid alignment station label type.
Public Method
ToString
Returns a string that represents the current object.
(Inherited from Object)
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 fromStation
.