Spanning |
This class represents a SpanningPipeLabel.
Inheritance HierarchySystemObject
SystemMarshalByRefObject
DisposableWrapper
RXObject
Drawable
DBObject
Entity
Curve
Entity
Autodesk.Civil.DatabaseServicesEntity
Autodesk.Civil.DatabaseServicesLabelBase
Autodesk.Civil.DatabaseServicesLabel
Autodesk.Civil.DatabaseServicesFeatureLabel
Autodesk.Civil.DatabaseServicesSpanningPipeLabel
SystemMarshalByRefObject
DisposableWrapper
RXObject
Drawable
DBObject
Entity
Curve
Entity
Autodesk.Civil.DatabaseServicesEntity
Autodesk.Civil.DatabaseServicesLabelBase
Autodesk.Civil.DatabaseServicesLabel
Autodesk.Civil.DatabaseServicesFeatureLabel
Autodesk.Civil.DatabaseServicesSpanningPipeLabel
Namespace: Autodesk.Civil.DatabaseServices
Assembly: AeccDbMgd (in AeccDbMgd.dll) Version: 13.8.0.292
SyntaxThe SpanningPipeLabel type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | AllowsAnchorMarker |
Gets a boolean value that specifies whether anchor markers are supported by the label object.
(Inherited from LabelBase) |
| AllowsDimensionAnchors |
Gets a boolean value that specifies whether dimension anchors are supported by the label object.
(Inherited from LabelBase) |
| AllowsDragging |
Gets a boolean value that specifies whether the label object can be dragged.
(Inherited from LabelBase) |
| AllowsFlipping |
Gets a boolean value that specifies whether the label object can be flipped.
(Inherited from LabelBase) |
| AllowsLeaderAttachment |
Gets a boolean value that specifies whether leader attachment options are supported by the label object.
(Inherited from LabelBase) |
| AllowsPinning |
Gets a boolean value that specifies whether the label object can be pinned.
(Inherited from LabelBase) |
| AllowsReversing |
Gets a boolean value that specifies whether the label object can be reversed.
(Inherited from LabelBase) |
| AnchorInfo |
Gets information about the label anchor.
(Inherited from Label) |
| AnchorMarkerRotationAngle |
Gets or sets the anchor marker rotation angle.
(Inherited from Label) |
| AnchorMarkerStyleId |
Gets or sets the anchor marker style.
(Inherited from Label) |
| AnchorPipeId | Get or set the ObjectId of the Pipe on which the label is located. |
| Application |
Gets the Application. Not currently implemented.
(Inherited from Entity) |
| AutoStagger |
Gets or sets the auto stagger type on the label object.
(Inherited from LabelBase) |
| CanRotate |
Gets whether the label object can be rotated.
(Inherited from Label) |
| DefaultDimensionAnchorOption | Obsolete. (Inherited from LabelBase) |
| DefaultDimensionAnchorValue | Obsolete. (Inherited from LabelBase) |
| Description |
Gets or sets the Entity object's description.
(Inherited from Entity) |
| DimensionAnchorInfo |
Gets information about the label dimension anchor.
(Inherited from Label) |
| DimensionAnchorOption |
Gets information about the label dimension anchor.
(Inherited from Label) |
| DimensionAnchorValue |
Gets or sets the dimension anchor value.
(Inherited from Label) |
| DisplayName |
Gets the Entity object's display name.
(Inherited from Entity) |
| Document |
Gets the Document. Not currently implemented.
(Inherited from Entity) |
| Dragged |
Gets a bool value that specifies whether the label has been dragged.
(Inherited from Label) |
| DraggedOffset |
Gets or sets the dragged offset on the sub-entity label.
(Inherited from Label) |
| FeatureId |
Gets the ObjectId of the feature being labeled by the label object.
(Inherited from LabelBase) |
| FingerPrint |
Gets or sets FingerPrint of the Entity.
(Inherited from Entity) |
| Flipped |
Gets or sets the flipped state of the label.
(Inherited from Label) |
| FolderId |
Gets the folder ObjectId of the Entity
Returns ObjectId::Null if the Entity is located in root folder
(Inherited from Entity) |
| IsCWSReferenceObject |
Gets whether the Entity is a Civil Worksharing reference object. A Civil Worksharing reference object is
a Civil object shared to Shared Space. It is not editable. But it can be updated to the new version in the Shared Space.
(Inherited from Entity) |
| IsCWSSourceObject |
Gets whether the Entity is a Civil Worksharing source object. A Civil Worksharing source object is
a Civil object shared to Shared Space. It is editable and can be updated to Shared Space.
(Inherited from Entity) |
| IsPartialReferenceObject |
Gets whether the surface is partial reference surface.
(Inherited from Entity) |
| IsReadOnlyReferenceObject |
Gets whether the Entity is a readonly reference object. A readonly reference object is
either a data shortcut referece object or a Civil Worksharing reference object.
(Inherited from Entity) |
 | 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) |
| IsUsed |
Gets whether the style is used by other objects in the current drawing.
(Inherited from Entity) |
| LabelLocation |
Gets or sets the label location.
(Inherited from Label) |
| LeaderAttachment |
Gets or sets the leader attachment option.
(Inherited from Label) |
| LeaderTailVisibility |
Gets or sets the leader tail visibility.
(Inherited from Label) |
| LeaderVisibility |
Gets or sets the leader visibility.
(Inherited from Label) |
| Length2DCenterToCenter | Gets the 2D length of all spanned pipes from center to center. |
| Length2DEdgeToEdge | Gets the 2D length of all spanned pipes from edge to edge. |
| Length3DCenterToCenter | Gets the 3D length of all spanned pipes from center to center. |
| Length3DEdgeToEdge | Gets the 3D length of all spanned pipes from edge to edge. |
| Mask |
Gets or sets the mask type.
(Inherited from LabelBase) |
| Name |
Gets or sets the Entity object's name.
(Inherited from Entity) |
| Pinned |
Gets or sets the pinned state of the label.
(Inherited from Label) |
| PipeIds | Gets an ObjectIdCollection of all spanned pipes. |
| Ratio | Gets or sets the ratio that determines the relative position of the SpanningPipeLabel on the pipe. |
| ReferenceAlignmentId | Gets or sets the ObjectId of the alignment that this SpanningPipeLabel references. |
| Reversed |
Gets or sets the reversed state of the label.
(Inherited from Label) |
| RotationAngle |
Gets or sets the rotation angle of the label.
(Inherited from Label) |
| RotationType |
Gets the rotation type of the label object, indicating whether the rotation is due to being dragged or settings in
the label composer, or both.
(Inherited from LabelBase) |
| ShowSpannedPipes | Gets or sets whether to show the spanned Pipes. |
| ShowToolTip |
Gets or sets whether to show tooltips for the Entity.
(Inherited from Entity) |
| StructureIds | Gets an ObjectIdCollection of all spanned structures. |
| StyleId |
Gets or sets the Entity object's style Id.
(Inherited from Label) |
| StyleName |
Gets or sets the Entity object's style name.
(Inherited from Label) |
| ViewId |
Gets the ObjectId of the view where the label exists.
(Inherited from LabelBase) |
Methods| Name | Description | |
|---|---|---|
 | ClearAllTextComponentOverrides |
Clears all text component overrides in the label.
(Inherited from Label) |
| ComputeFingerPrint |
Compute FingerPrint of the Entity.
(Inherited from Entity) |
 | Create(ObjectIdCollection, ObjectId) | Creates a new instance of a SpanningPipeLabel that spans a collection of parts using the default label style. |
| Create(ObjectIdCollection, ObjectId, Double, ObjectId) | Creates a new instance of a SpanningPipeLabel that spans a specified collection of parts with the specified label style. |
| GetAvailableLabelIds | Gets an ObjectIdCollection of the SpanningPipeLabels for the specified Pipe. |
| GetReferenceInfo |
For Data Shortcut reference entity (IsReferenceObject == true), gets the entity's reference information.
(Inherited from Entity) |
| GetReferenceTextTarget |
Get the ObjectId of civil object which is referred by specified reference text component.
(Inherited from Label) |
| GetTextComponentIds |
Gets a collection of object ids that represent the text components in a label.
(Inherited from Label) |
| GetTextComponentJustificationOverride |
Get the overriden justification on the specified text component.
(Inherited from Label) |
| GetTextComponentOverride |
Get the overriden text on the specified text component.
(Inherited from Label) |
| IsTextComponentOverriden |
Returns whether the specified text component is overridden.
(Inherited from Label) |
| Reset |
Resets the label object to its defaults.
(Inherited from Label) |
| ResetLocation |
Resets the location of the label object to its default.
(Inherited from Label) |
| ResetProperties |
Resets the properties of the label object to its defaults.
(Inherited from Label) |
| SetReferenceTextTarget |
Makes the reference text component refer to other civil object.
(Inherited from Label) |
| SetTextComponentJustificationOverride |
Overrides the justification on the specified text component.
(Inherited from Label) |
| SetTextComponentOverride(ObjectId, String) |
Overrides the text on the specified text component.
(Inherited from Label) |
| SetTextComponentOverride(ObjectId, String, TextJustificationType) |
Overrides the text and justification on the specified text component.
(Inherited from Label) |
See Also