The Alignment type exposes the following members.

Methods

  NameDescription
Public methodComputeFingerPrint
Compute FingerPrint of the Entity.
(Inherited from Entity.)
Public methodCopyToSite(ObjectId)
Copies the Alignment to a specified Site. Specifying ObjectId.Null to copy it to siteless. Calling this method copies all children profiles, profile views and sample line group with this alignment as well.
Public methodCopyToSite(String)
Copies the Alignment to a specified Site. Specifying "" to move it to siteless. Calling this method copies all children profiles, profile views and sample line group with this alignment as well.
Public methodStatic memberCreate(CivilDocument, String, ObjectId, ObjectId, ObjectId, ObjectId)
Creates an Alignment without geometry information.
Public methodStatic memberCreate(CivilDocument, String, String, String, String, String)
Creates an Alignment without geometry information.
Public methodStatic memberCreate(CivilDocument, PolylineOptions, String, ObjectId, ObjectId, ObjectId, ObjectId)
Creates an Alignment from the specified Polyline, Polyline2d or Polyline3d.
Public methodStatic memberCreate(CivilDocument, PolylineOptions, String, String, String, String, String)
Creates an Alignment from the specified Polyline, Polyline2d or Polyline3d.
Public methodStatic memberCreate(CivilDocument, String, ObjectId, ObjectId, ObjectId, ObjectId, AlignmentType)
Creates an Alignment without geometry information, with Alignment Type.
Public methodStatic memberCreate(CorridorFeatureLine, String, ObjectId, ObjectId, ObjectId, ObjectId, AlignmentType)
Creates an Alignment from the specified CorridorFeatureLine.
Public methodStatic memberCreateConnectedAlignment
Creates an connected alignment.
Public methodCreateOffsetAlignment(Double) Obsolete.
Creates an offset Alignment from the current alignment, returns the offset Alignment ObjectId. A positive value to create an offset alignment to the right side and negative to the left side.
Public methodStatic memberCreateOffsetAlignment(String, ObjectId, Double, ObjectId)
Creates an offset Alignment from the specified alignment object Id, returns the object Id of the offset alignment.
Public methodStatic memberCreateOffsetAlignment(Database, String, String, Double, String)
Creates an offset Alignment from the specified alignment name, returns the object Id of the offset alignment.
Public methodStatic memberCreateOffsetAlignment(String, ObjectId, Double, ObjectId, Double, Double)
Creates an offset Alignment from the specified alignment object Id, returns the object Id of the offset alignment.
Public methodStatic memberCreateOffsetAlignment(Database, String, String, Double, String, Double, Double)
Creates an offset Alignment from the specified alignment name, returns the object Id of the offset alignment.
Public methodDistanceToAlignment(Double, Alignment, Double%, Double%)
Computes the distance to another Alignment. If the target Alignment crosses the current Alignment, this method checks the distance to the target Alignment on both sides, and returns the shorter distance.
Public methodDistanceToAlignment(Double, Alignment, AlignmentSide, Double%, Double%)
Computes the distance to another Alignment, specifying the side of current Alignment to look for the target Alignment.
Public methodGetAlignmentLabelGroupIds
Gets the ObjectIdCollection of the Alignment's label group.
Public methodGetAlignmentLabelIds
Gets the ObjectIdCollection of the Alignment's labels.
Public methodGetChildOffsetAlignmentIds()()()()
Gets the objectId collection of all child offset alignments, whose parent is this alignment instance.
Public methodGetChildOffsetAlignmentIds(Boolean)
Gets the objectId collection of all child offset alignments, whose parent is this alignment instance.
Public methodGetCrossSlopeAtStation
Gets the cross slope value at the specified station for the indicated segment type.
Public methodGetInstantaneousRadius
Returns the instantaneous radius at the specified station.
Public methodGetLabelGroupIds Obsolete.
Gets the ObjectIdCollection of the Alignment's label group.
Public methodGetLabelIds Obsolete.
Gets the ObjectIdCollection of the Alignment's labels.
Public methodStatic memberGetNextUniqueName
Gets a string indicating a unique name for the Alignment. The input string could be a name template.
Public methodGetPolyline
Gets a polyline from the Alignment geometry.
Public methodGetProfileIds
Gets the ObjectIdCollection of all profiles belonging to this Alignment.
Public methodGetProfileViewIds
Gets the ObjectIdCollection of all profile views belonging to this Alignment.
Public methodGetReferenceInfo
For Data Shortcut reference entity (IsReferenceObject == true), gets the entity's reference information.
(Inherited from Entity.)
Public methodGetRegions Obsolete.
Gets the regions, which are included in offset alignment or curb return.
Public methodGetSampleLineGroupIds
Gets the ObjectIdCollection of all sample line groups belonging to this Alignment.
Public methodGetStationSet(StationTypes)
Gets the station set according to the StationType.
Public methodGetStationSet(StationTypes, Double)
Gets the station set according to the StationType and interval.
Public methodGetStationSet(StationTypes, Double, Double)
Gets the station set according to the StationType and intervals.
Public methodGetStationStringWithEquations
Gets a string indicating the station of an Alignment using the Station equations.
Public methodGetSuperelevationViewIds
Gets the ObjectIdCollection of all Superelevation views belonging to this Alignment.
Public methodImportLabelSet(ObjectId)
Takes the contents of the AlignmentLabelSetStyle template and copies its data into the database object.
Public methodImportLabelSet(String)
Takes the contents of the AlignmentLabelSetStyle template and copies its data into the Database object.
Public methodPointLocation(Double, Double, Double%, Double%)
Returns the easting and northing of a point on an Alignment given a station and an offset for the Alignment.
Public methodPointLocation(Double, Double, Double, Double%, Double%, Double%)
Given station and offset values, returns the easting, northing, and bearing values at that point on the Alignment.
Public methodReverse
Reverse the Alignment direction.
Public methodStationOffset(Double, Double, Double%, Double%)
Returns the station and offset on an Alignment at given easting and northing values.
Public methodStationOffset(Double, Double, Double, Double%, Double%)
Returns the nearest station and offset on an Alignment at given easting, northing and tolerance values.
Public methodStationOffsetAcceptOutOfRange(Double, Double, Double%, Double%, Boolean%)
Returns the station and offset on an Alignment at given easting and northing values, the same as the StationOffset method. Whereas the StationOffset method throws and exception if the easting and northing are out of Alignment range, this one does not and instead returns either the starting or ending station as the station, and the offset returned is the distance between the easting and northing point and the first or last station.
Public methodStationOffsetAcceptOutOfRange(Double, Double, Double, Double%, Double%, Boolean%)
Returns the station and offset on an Alignment at given easting and northing values, the same as the StationOffset method. Whereas the StationOffset method throws and exception if the easting and northing are out of Alignment range, this one does not and instead returns either the starting or ending station as the station, and the offset returned is the distance between the easting and northing point and the first or last station.
Public methodUpdate
Updates the OffsetAlignmentInfo for an offset alignment object.

Properties

  NameDescription
Public propertyAlignmentType
Gets the alignment type.
Public propertyApplication
Gets the Application. Not currently implemented.
(Inherited from Entity.)
Public propertyCANTCriticalStaitons
Gets a collection of the CANTCriticalStationCollection objects in the Alignment.
Public propertyCANTCurves
Gets a collection of the SuperElevationCurve objects in the Alignment. If the CANT data is out of sync from alignment geometry, it will try to recalculate it. In this case, the alignment will be upgraded to write mode, the document will be locked, and modified notification could be sent out.
Public propertyConnectedAlignmentInfo
Gets an ConnectedAlignmentInfo object containing properties specific to Connected Alignment.
Public propertyCreationMode
Gets the Alignment creation mode.
Public propertyCriteriaFileName
Gets or sets the criteria file name for the current alignment.
Public propertyDescription
Gets or sets the Entity object's description.
(Inherited from Entity.)
Public propertyDesignCheckSetId
Gets the object id of design check set that is used in the alignment.
Public propertyDesignCheckSetName
Gets the name of of design check set that is used in the alignment.
Public propertyDesignSpeeds
Gets the Alignment design speed collection.
Public propertyDisplayName
Gets the Entity object's display name.
(Inherited from Entity.)
Public propertyDocument
Gets the Document. Not currently implemented.
(Inherited from Entity.)
Public propertyEndingStation
Gets the Alignment's end station.
Public propertyEndingStationWithEquations
Gets the Alignment's end station with equations.
Public propertyEntities
Gets the Alignment entities collection for the Alignment.
Public propertyFingerPrint
Gets or sets FingerPrint of the Entity.
(Inherited from Entity.)
Public propertyFolderId
Gets the folder ObjectId of the Entity Returns ObjectId::Null if the Entity is located in root folder
(Inherited from Entity.)
Public propertyHasRoundabout
Gets whether this Alignment has a Roundabout.
Public propertyIsConnectedAlignment
Gets whether this Alignment is a connected alignment.
Public propertyIsEditable
Gets the value indicates whether the Feature derived entity (Alignment,Profile,etc) is editable.
(Inherited from Feature.)
Public propertyIsOffsetAlignment
Gets whether this alignment is an offset alignment.
Public propertyIsReferencedSourceExisting
For reference object (IsReferenceObject == true), it will try to get its source entity while opening a drawing. This indicates whether the reference object has source entity.
(Inherited from Entity.)
Public propertyIsReferenceObject
Gets whether the Entity is a reference object. A reference object is located in another drawing, and linked using a data shortcut or Vault. If the entity is native to the current drawing this property returns false; if it is being referenced via data shortcuts or AutoCAD Vault it returns true.
(Inherited from Entity.)
Public propertyIsReferenceStale
For reference objects (IsReferenceObject == true), gets whether the Entity object's reference is stale.
(Inherited from Entity.)
Public propertyIsReferenceSubObject
For reference objects (IsReferenceObject == true), gets whether the Entity is a reference subobject. For example, when iterating through the structure of a pipe network referenced from another drawing, this property is true for each entity.
(Inherited from Entity.)
Public propertyIsReferenceValid
For reference objects (IsReferenceObject == true), gets whether the Entity object's reference is valid.
(Inherited from Entity.)
Public propertyIsSiteless
Gets a bool value that indicates whether this Alignment is a siteless Alignment.
Public propertyIsUsed
Gets whether the style is used by other objects in the current drawing.
(Inherited from Entity.)
Public propertyLength
Gets the Alignment's length.
Public propertyName
Gets or sets the Entity object's name.
(Inherited from Entity.)
Public propertyOffsetAlignmentInfo
Gets an OffsetAlignmentInfo object containing properties specific to Offset Alignments.
Public propertyRailAlignmentInfo
Gets a RailAlignmentInfo object containing properties specific to Rail Alignments.
Public propertyReferencePoint
Gets or sets the Alignment reference point.
Public propertyReferencePointStation
Gets or sets the Alignment reference point station.
Public propertyShowToolTip
Gets or sets whether to show tooltips for the Entity.
(Inherited from Entity.)
Public propertySiteId
Gets the Id for the Site to which this Alignment belongs. ObjectId.Null for a siteless alignment.
Public propertySiteName
Gets the name of the Site to which this Alignment belongs. a string of "" for a siteless alignment.
Public propertyStartingStation
Gets the Alignment's start station.
Public propertyStationEquations
Gets the Alignment's station equation collection.
Public propertyStationIndexIncrement
Gets or sets the Alignment station index increment.
Public propertyStyleId
Sets the Alignment's style Id.
(Overrides Entity..::..StyleId.)
Public propertyStyleName
Sets the Alignment's style name.
(Overrides Entity..::..StyleName.)
Public propertySuperelevationCriticalStations
Gets a collection of the SuperElevationCriticalStation objects in the Alignment.
Public propertySuperelevationCurves
Gets a collection of the SuperElevationCurve objects in the Alignment. If the superelevation data is out of sync from alignment geometry, it will try to recalculate it. In this case, the alignment will be upgraded to write mode, the document will be locked, and modified notification could be sent out.
Public propertySuperelevationType
Public propertyUpdateMode Obsolete.
Gets the update mode of the alignment.
Public propertyUseDesignCheckSet
Gets or sets whether the Alignment uses the design check set.
Public propertyUseDesignCriteriaFile
Gets or sets whether the alignment uses the design criteria file.
Public propertyUseDesignSpeed
Gets or sets a bool value that indicates whether this Alignment uses degign speed.

See Also