The Alignment type exposes the following members.
Methods
Name | Description | |
---|---|---|
![]() | ComputeFingerPrint |
Compute FingerPrint of the Entity.
(Inherited from Entity.) |
![]() | CopyToSite(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.
|
![]() | CopyToSite(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.
|
![]() ![]() | Create(CivilDocument, String, ObjectId, ObjectId, ObjectId, ObjectId) |
Creates an Alignment without geometry information.
|
![]() ![]() | Create(CivilDocument, String, String, String, String, String) |
Creates an Alignment without geometry information.
|
![]() ![]() | Create(CivilDocument, PolylineOptions, String, ObjectId, ObjectId, ObjectId, ObjectId) |
Creates an Alignment from the specified Polyline, Polyline2d or Polyline3d.
|
![]() ![]() | Create(CivilDocument, PolylineOptions, String, String, String, String, String) |
Creates an Alignment from the specified Polyline, Polyline2d or Polyline3d.
|
![]() ![]() | Create(CivilDocument, String, ObjectId, ObjectId, ObjectId, ObjectId, AlignmentType) |
Creates an Alignment without geometry information, with Alignment Type.
|
![]() ![]() | Create(CorridorFeatureLine, String, ObjectId, ObjectId, ObjectId, ObjectId, AlignmentType) |
Creates an Alignment from the specified CorridorFeatureLine.
|
![]() ![]() | CreateConnectedAlignment |
Creates an connected alignment.
|
![]() | CreateOffsetAlignment(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.
|
![]() ![]() | CreateOffsetAlignment(String, ObjectId, Double, ObjectId) |
Creates an offset Alignment from the specified alignment object Id, returns the object Id of the offset alignment.
|
![]() ![]() | CreateOffsetAlignment(Database, String, String, Double, String) |
Creates an offset Alignment from the specified alignment name, returns the object Id of the offset alignment.
|
![]() ![]() | CreateOffsetAlignment(String, ObjectId, Double, ObjectId, Double, Double) |
Creates an offset Alignment from the specified alignment object Id, returns the object Id of the offset alignment.
|
![]() ![]() | CreateOffsetAlignment(Database, String, String, Double, String, Double, Double) |
Creates an offset Alignment from the specified alignment name, returns the object Id of the offset alignment.
|
![]() | DistanceToAlignment(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.
|
![]() | DistanceToAlignment(Double, Alignment, AlignmentSide, Double%, Double%) |
Computes the distance to another Alignment, specifying the side of current Alignment to look for the target Alignment.
|
![]() | GetAlignmentLabelGroupIds |
Gets the ObjectIdCollection of the Alignment's label group.
|
![]() | GetAlignmentLabelIds |
Gets the ObjectIdCollection of the Alignment's labels.
|
![]() | GetChildOffsetAlignmentIds()()()() |
Gets the objectId collection of all child offset alignments, whose parent is this alignment instance.
|
![]() | GetChildOffsetAlignmentIds(Boolean) |
Gets the objectId collection of all child offset alignments, whose parent is this alignment instance.
|
![]() | GetCrossSlopeAtStation |
Gets the cross slope value at the specified station for the indicated segment type.
|
![]() | GetInstantaneousRadius |
Returns the instantaneous radius at the specified station.
|
![]() | GetLabelGroupIds | Obsolete.
Gets the ObjectIdCollection of the Alignment's label group.
|
![]() | GetLabelIds | Obsolete.
Gets the ObjectIdCollection of the Alignment's labels.
|
![]() ![]() | GetNextUniqueName |
Gets a string indicating a unique name for the Alignment. The input string could be a name template.
|
![]() | GetPolyline |
Gets a polyline from the Alignment geometry.
|
![]() | GetProfileIds |
Gets the ObjectIdCollection of all profiles belonging to this Alignment.
|
![]() | GetProfileViewIds |
Gets the ObjectIdCollection of all profile views belonging to this Alignment.
|
![]() | GetReferenceInfo |
For Data Shortcut reference entity (IsReferenceObject == true), gets the entity's reference information.
(Inherited from Entity.) |
![]() | GetRegions | Obsolete.
Gets the regions, which are included in offset alignment or curb return.
|
![]() | GetSampleLineGroupIds |
Gets the ObjectIdCollection of all sample line groups belonging to this Alignment.
|
![]() | GetStationSet(StationTypes) |
Gets the station set according to the StationType.
|
![]() | GetStationSet(StationTypes, Double) |
Gets the station set according to the StationType and interval.
|
![]() | GetStationSet(StationTypes, Double, Double) |
Gets the station set according to the StationType and intervals.
|
![]() | GetStationStringWithEquations |
Gets a string indicating the station of an Alignment using the Station equations.
|
![]() | GetSuperelevationViewIds |
Gets the ObjectIdCollection of all Superelevation views belonging to this Alignment.
|
![]() | ImportLabelSet(ObjectId) |
Takes the contents of the AlignmentLabelSetStyle template and copies its data into the database object.
|
![]() | ImportLabelSet(String) |
Takes the contents of the AlignmentLabelSetStyle template and copies its data into the Database object.
|
![]() | PointLocation(Double, Double, Double%, Double%) |
Returns the easting and northing of a point on an Alignment given a station and an offset for the Alignment.
|
![]() | PointLocation(Double, Double, Double, Double%, Double%, Double%) |
Given station and offset values, returns the easting, northing, and bearing values at that point on the Alignment.
|
![]() | Reverse |
Reverse the Alignment direction.
|
![]() | StationOffset(Double, Double, Double%, Double%) |
Returns the station and offset on an Alignment at given easting and northing values.
|
![]() | StationOffset(Double, Double, Double, Double%, Double%) |
Returns the nearest station and offset on an Alignment at given easting, northing and tolerance values.
|
![]() | StationOffsetAcceptOutOfRange(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.
|
![]() | StationOffsetAcceptOutOfRange(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.
|
![]() | Update |
Updates the OffsetAlignmentInfo for an offset alignment object.
|
Properties
Name | Description | |
---|---|---|
![]() | AlignmentType |
Gets the alignment type.
|
![]() | Application |
Gets the Application. Not currently implemented.
(Inherited from Entity.) |
![]() | CANTCriticalStaitons |
Gets a collection of the CANTCriticalStationCollection objects in the Alignment.
|
![]() | CANTCurves |
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.
|
![]() | ConnectedAlignmentInfo |
Gets an ConnectedAlignmentInfo object containing properties specific to Connected Alignment.
|
![]() | CreationMode |
Gets the Alignment creation mode.
|
![]() | CriteriaFileName |
Gets or sets the criteria file name for the current alignment.
|
![]() | Description |
Gets or sets the Entity object's description.
(Inherited from Entity.) |
![]() | DesignCheckSetId |
Gets the object id of design check set that is used in the alignment.
|
![]() | DesignCheckSetName |
Gets the name of of design check set that is used in the alignment.
|
![]() | DesignSpeeds |
Gets the Alignment design speed collection.
|
![]() | DisplayName |
Gets the Entity object's display name.
(Inherited from Entity.) |
![]() | Document |
Gets the Document. Not currently implemented.
(Inherited from Entity.) |
![]() | EndingStation |
Gets the Alignment's end station.
|
![]() | EndingStationWithEquations |
Gets the Alignment's end station with equations.
|
![]() | Entities |
Gets the Alignment entities collection for the Alignment.
|
![]() | FingerPrint |
Gets or sets FingerPrint of the Entity.
(Inherited from Entity.) |
![]() | FolderId |
Gets the folder ObjectId of the Entity
Returns ObjectId::Null if the Entity is located in root folder
(Inherited from Entity.) |
![]() | HasRoundabout |
Gets whether this Alignment has a Roundabout.
|
![]() | IsConnectedAlignment |
Gets whether this Alignment is a connected alignment.
|
![]() | IsEditable |
Gets the value indicates whether the Feature derived entity (Alignment,Profile,etc) is editable.
(Inherited from Feature.) |
![]() | IsOffsetAlignment |
Gets whether this alignment is an offset alignment.
|
![]() | IsReferencedSourceExisting |
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.) |
![]() | IsReferenceObject |
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.) |
![]() | IsReferenceStale |
For reference objects (IsReferenceObject == true), gets whether the Entity object's reference is stale.
(Inherited from Entity.) |
![]() | IsReferenceSubObject |
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.) |
![]() | IsReferenceValid |
For reference objects (IsReferenceObject == true), gets whether the Entity object's reference is valid.
(Inherited from Entity.) |
![]() | IsSiteless |
Gets a bool value that indicates whether this Alignment is a siteless Alignment.
|
![]() | IsUsed |
Gets whether the style is used by other objects in the current drawing.
(Inherited from Entity.) |
![]() | Length |
Gets the Alignment's length.
|
![]() | Name |
Gets or sets the Entity object's name.
(Inherited from Entity.) |
![]() | OffsetAlignmentInfo |
Gets an OffsetAlignmentInfo object containing properties specific to Offset Alignments.
|
![]() | RailAlignmentInfo |
Gets a RailAlignmentInfo object containing properties specific to Rail Alignments.
|
![]() | ReferencePoint |
Gets or sets the Alignment reference point.
|
![]() | ReferencePointStation |
Gets or sets the Alignment reference point station.
|
![]() | ShowToolTip |
Gets or sets whether to show tooltips for the Entity.
(Inherited from Entity.) |
![]() | SiteId |
Gets the Id for the Site to which this Alignment belongs. ObjectId.Null for a siteless alignment.
|
![]() | SiteName |
Gets the name of the Site to which this Alignment belongs. a string of "" for a siteless alignment.
|
![]() | StartingStation |
Gets the Alignment's start station.
|
![]() | StationEquations |
Gets the Alignment's station equation collection.
|
![]() | StationIndexIncrement |
Gets or sets the Alignment station index increment.
|
![]() | StyleId |
Sets the Alignment's style Id.
(Overrides Entity..::..StyleId.) |
![]() | StyleName |
Sets the Alignment's style name.
(Overrides Entity..::..StyleName.) |
![]() | SuperelevationCriticalStations |
Gets a collection of the SuperElevationCriticalStation objects in the Alignment.
|
![]() | SuperelevationCurves |
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.
|
![]() | SuperelevationType | |
![]() | UpdateMode | Obsolete.
Gets the update mode of the alignment.
|
![]() | UseDesignCheckSet |
Gets or sets whether the Alignment uses the design check set.
|
![]() | UseDesignCriteriaFile |
Gets or sets whether the alignment uses the design criteria file.
|
![]() | UseDesignSpeed |
Gets or sets a bool value that indicates whether this Alignment uses degign speed.
|