The base class for all label classes, including single-feature labels (FeatureLabel derived classes) and group labels (LabelGroup derived classes). This class implements the ICommonLabelOptions interface, which defines common label behaviors.
Inheritance Hierarchy
SystemObjectSystemMarshalByRefObject
DisposableWrapper
RXObject
Drawable
DBObject
Entity
Curve
Entity
Autodesk.Civil.DatabaseServicesEntity
Autodesk.Civil.DatabaseServicesLabelBase
Autodesk.Civil.DatabaseServicesLabel
Autodesk.Civil.DatabaseServicesLabelGroup
Namespace: Autodesk.Civil.DatabaseServices
Assembly: AeccDbMgd (in AeccDbMgd.dll) Version: 13.7.0.1276
Syntax
C#
public abstract class LabelBase : Entity, ICommonLabelOptions
VB
Public MustInherit Class LabelBase Inherits Entity Implements ICommonLabelOptions
C++
public ref class LabelBase abstract : public Entity, ICommonLabelOptions
The LabelBase type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
 | AllowsAnchorMarker | Gets a boolean value that specifies whether anchor markers are supported by the label object. |
| AllowsDimensionAnchors | Gets a boolean value that specifies whether dimension anchors are supported by the label object. |
| AllowsDragging | Gets a boolean value that specifies whether the label object can be dragged. |
| AllowsFlipping | Gets a boolean value that specifies whether the label object can be flipped. |
| AllowsLeaderAttachment | Gets a boolean value that specifies whether leader attachment options are supported by the label object. |
| AllowsPinning | Gets a boolean value that specifies whether the label object can be pinned. |
| AllowsReversing | Gets a boolean value that specifies whether the label object can be reversed. |
| Application |
Gets the Application. Not currently implemented.
(Inherited from Entity) |
| AutoStagger | Gets or sets the auto stagger type on the label object. |
| DefaultDimensionAnchorOption | Obsolete. |
| DefaultDimensionAnchorValue | Obsolete. |
| Description |
Gets or sets the Entity object's description.
(Inherited from Entity) |
| DisplayName |
Gets the Entity object's display name.
(Inherited from Entity) |
| Document |
Gets the Document. Not currently implemented.
(Inherited from Entity) |
| FeatureId | Gets the ObjectId of the feature being labeled by the label object. |
| 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) |
| 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) |
| 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) |
| Mask | Gets or sets the mask type. |
| Name |
Gets or sets the Entity object's name.
(Inherited from Entity) |
| 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. |
| ShowToolTip |
Gets or sets whether to show tooltips for the Entity.
(Inherited from Entity) |
| StyleId |
Gets or sets the Entity object's style Id.
(Inherited from Entity) |
| StyleName |
Gets or sets the Entity object's style name.
(Inherited from Entity) |
| ViewId | Gets the ObjectId of the view where the label exists. |
Methods
| Name | Description | |
|---|---|---|
 | ComputeFingerPrint |
Compute FingerPrint of the Entity.
(Inherited from Entity) |
| GetReferenceInfo |
For Data Shortcut reference entity (IsReferenceObject == true), gets the entity's reference information.
(Inherited from Entity) |