Label Class

The base class for all single-entity label objects.

Inheritance Hierarchy

SystemObject
  SystemMarshalByRefObject
    DisposableWrapper
      RXObject
        Drawable
          DBObject
            Entity
              Curve
                Entity
                  Autodesk.Civil.DatabaseServicesEntity
                    Autodesk.Civil.DatabaseServicesLabelBase
                      Autodesk.Civil.DatabaseServicesLabel
                        Autodesk.Civil.DatabaseServicesFeatureLabel
                        Autodesk.Civil.DatabaseServicesGeneralSegmentLabel
                        Autodesk.Civil.DatabaseServicesNoteLabel

Namespace: Autodesk.Civil.DatabaseServices
Assembly: AeccDbMgd (in AeccDbMgd.dll) Version: 13.7.0.1190

Syntax

C++

Copy

public class Label : LabelBase, ICommonLabel

Public Class Label
	Inherits LabelBase
	Implements ICommonLabel

public ref class Label : public LabelBase, 
	ICommonLabel

The Label 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.
	AnchorMarkerRotationAngle	Gets or sets the anchor marker rotation angle.
	AnchorMarkerStyleId	Gets or sets the anchor marker style.
	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.
	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.
	DimensionAnchorOption	Gets information about the label dimension anchor.
	DimensionAnchorValue	Gets or sets the dimension anchor value.
	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.
	DraggedOffset	Gets or sets the dragged offset on the sub-entity 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.
	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)
	LabelLocation	Gets or sets the label location.
	LeaderAttachment	Gets or sets the leader attachment option.
	LeaderTailVisibility	Gets or sets the leader tail visibility.
	LeaderVisibility	Gets or sets the leader visibility.
	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.
	Reversed	Gets or sets the reversed state of the label.
	RotationAngle	Gets or sets the rotation angle of the 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)
	ShowToolTip	Gets or sets whether to show tooltips for the Entity. (Inherited from Entity)
	StyleId	Gets or sets the Entity object's style Id. (Overrides EntityStyleId)
	StyleName	Gets or sets the Entity object's style name. (Overrides EntityStyleName)
	ViewId	Gets the ObjectId of the view where the label exists. (Inherited from LabelBase)

Top

Methods

	Name	Description
	ClearAllTextComponentOverrides	Clears all text component overrides in the label.
	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)
	GetReferenceTextTarget	Get the ObjectId of civil object which is referred by specified reference text component.
	GetTextComponentIds	Gets a collection of object ids that represent the text components in a label.
	GetTextComponentJustificationOverride	Get the overriden justification on the specified text component.
	GetTextComponentOverride	Get the overriden text on the specified text component.
	IsTextComponentOverriden	Returns whether the specified text component is overridden.
	Reset	Resets the label object to its defaults.
	ResetLocation	Resets the location of the label object to its default.
	ResetProperties	Resets the properties of the label object to its defaults.
	SetReferenceTextTarget	Makes the reference text component refer to other civil object.
	SetTextComponentJustificationOverride	Overrides the justification on the specified text component.
	SetTextComponentOverride(ObjectId, String)	Overrides the text on the specified text component.
	SetTextComponentOverride(ObjectId, String, TextJustificationType)	Overrides the text and justification on the specified text component.

Top

Remarks

For more information about Civil 3D labels, see the "Labels and Tags" section of the Autodesk Civil 3D User's Guide.

Reference

Autodesk.Civil.DatabaseServices Namespace