SurfaceContourLabelGroup Class

This class represents a surface countour label group.
Inheritance Hierarchy
SystemObject
  SystemMarshalByRefObject
    DisposableWrapper
      RXObject
        Drawable
          DBObject
            Entity
              Curve
                Entity
                  Autodesk.Civil.DatabaseServicesEntity
                    Autodesk.Civil.DatabaseServicesLabelBase
                      Autodesk.Civil.DatabaseServicesLabelGroup
                        Autodesk.Civil.DatabaseServicesAutoFeatureLabelGroup
                          Autodesk.Civil.DatabaseServicesSurfaceContourLabelGroup

Namespace: Autodesk.Civil.DatabaseServices
Assembly: AeccDbMgd (in AeccDbMgd.dll) Version: 13.8.0.292
Syntax
public class SurfaceContourLabelGroup : AutoFeatureLabelGroup

The SurfaceContourLabelGroup type exposes the following members.

Properties
 NameDescription
Public propertyAllowsAnchorMarker Gets a boolean value that specifies whether anchor markers are supported by the label object.
(Inherited from LabelBase)
Public propertyAllowsDimensionAnchors Gets a boolean value that specifies whether dimension anchors are supported by the label object.
(Inherited from LabelBase)
Public propertyAllowsDragging Gets a boolean value that specifies whether the label object can be dragged.
(Inherited from LabelBase)
Public propertyAllowsFlipping Gets a boolean value that specifies whether the label object can be flipped.
(Inherited from LabelBase)
Public propertyAllowsLeaderAttachment Gets a boolean value that specifies whether leader attachment options are supported by the label object.
(Inherited from LabelBase)
Public propertyAllowsPinning Gets a boolean value that specifies whether the label object can be pinned.
(Inherited from LabelBase)
Public propertyAllowsReversing Gets a boolean value that specifies whether the label object can be reversed.
(Inherited from LabelBase)
Public propertyApplication Gets the Application. Not currently implemented.
(Inherited from Entity)
Public propertyAutoStagger Gets or sets the auto stagger type on the label object.
(Inherited from LabelBase)
Public propertyDefaultDimensionAnchorOption Gets or sets the default dimension anchor option.
(Inherited from LabelGroup)
Public propertyDefaultDimensionAnchorValue Gets or sets the default dimension anchor value.
(Inherited from LabelGroup)
Public propertyDescription Gets or sets the Entity object's description.
(Inherited from Entity)
Public propertyDisplayName Gets the Entity object's display name.
(Inherited from Entity)
Public propertyDocument Gets the Document. Not currently implemented.
(Inherited from Entity)
Public propertyFeatureId Gets the ObjectId of the feature being labeled by the label object.
(Inherited from LabelBase)
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 propertyIsCWSReferenceObject 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)
Public propertyIsCWSSourceObject 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)
Public propertyIsLabelLineVisible Gets or sets whether the label line is visible.
Public propertyIsMajorContourLabelVisible Gets or sets whether the major contour's label is visible.
Public propertyIsMinorContourLabelVisible Gets or sets the value indicates whether the minor contour's label is visible.
Public propertyIsPartialReferenceObject Gets whether the surface is partial reference surface.
(Inherited from Entity)
Public propertyIsReadOnlyReferenceObject 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)
Public propertyCode exampleIsReferencedSourceExisting 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 propertyIsUsed Gets whether the style is used by other objects in the current drawing.
(Inherited from Entity)
Public propertyIsUserContourLabelVisible Gets or sets the value indicates whether the user contour's label is visible.
Public propertyLabelLinePoints Gets or sets the key points of label lines.
Public propertyMajorContourLabelStyleId Gets or sets the ObjectId of style for major contour's label.
Public propertyMask Gets or sets the mask type.
(Inherited from LabelBase)
Public propertyMinorContourLabelStyleId Gets or sets the ObjectId of style for minor contour's label.
Public propertyName Gets or sets the Entity object's name.
(Inherited from Entity)
Public propertyRangeEnd This property is not implemented by SurfaceContourLabelGroup and should not be used.
(Overrides AutoFeatureLabelGroupRangeEnd)
Public propertyRangeEndFromFeature This property is not implemented by SurfaceContourLabelGroup and should not be used.
(Overrides AutoFeatureLabelGroupRangeEndFromFeature)
Public propertyRangeStart This property is not implemented by SurfaceContourLabelGroup and should not be used.
(Overrides AutoFeatureLabelGroupRangeStart)
Public propertyRangeStartFromFeature This property is not implemented by SurfaceContourLabelGroup and should not be used.
(Overrides AutoFeatureLabelGroupRangeStartFromFeature)
Public propertyRotationType 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)
Public propertyShowToolTip Gets or sets whether to show tooltips for the Entity.
(Inherited from Entity)
Public propertyStyleId Gets or sets the label group's style Id.
(Inherited from LabelGroup)
Public propertyStyleName Gets or sets the label style name.
(Inherited from LabelGroup)
Public propertySubEntities Gets the number of sub-entity labels managed by this group label.
(Inherited from LabelGroup)
Public propertySubEntityCount Gets the number of sub-entity labels managed by this group label.
(Inherited from LabelGroup)
Public propertyUserContourLabelStyleId Gets or sets the ObjectId of style for user contour's label.
Public propertyViewId Gets the ObjectId of the view where the label exists.
(Inherited from LabelBase)
Top
Methods
 NameDescription
Public methodComputeFingerPrint Compute FingerPrint of the Entity.
(Inherited from Entity)
Public methodStatic memberCreate(ObjectId, Point2dCollection) Creates a new instance of an SurfaceContourLabelGroup and adds it to the specified surface.
Public methodStatic memberCreate(ObjectId, Point2dCollection, ObjectId, ObjectId, ObjectId) Creates a new instance of an SurfaceContourLabelGroup and adds it to the specified surface.
Public methodStatic memberCreateMultipleAtInterval(ObjectId, Point2d, Point2d, Double) Creates multiple SurfaceContourLabelGroup to a surface at a specified interval.
Public methodStatic memberCreateMultipleAtInterval(ObjectId, Point2d, Point2d, Double, SurfaceContourLabelGroupCreateOption) Creates multiple SurfaceContourLabelGroup to a surface at a specified interval.
Public methodGetAt Gets one LabelGroupSubEntity from label group according the index.
(Inherited from LabelGroup)
Public methodStatic memberGetAvailableLabelGroupIds Returns an ObjectIdCollection containing all the available contour label groups belonging to the specified surface.
Public methodStatic memberGetAvailableLabelGroupsObsolete.
Returns an ObjectIdCollection containing all the available contour label groups belonging to the specified surface.
Public methodGetLabelLinePoint Get one key point from label line by index
Public methodCode exampleGetReferenceInfo For Data Shortcut reference entity (IsReferenceObject == true), gets the entity's reference information.
(Inherited from Entity)
Public methodResetAllSubCommonLabelLocations Resets the location of all the sub-entity labels to their defaults.
(Inherited from LabelGroup)
Public methodResetAllSubCommonLabelProperties Resets the properties of all the sub-entity labels to their defaults.
(Inherited from LabelGroup)
Public methodResetAllSubCommonLabels Resets all the sub-entity labels (properties and location).
(Inherited from LabelGroup)
Public methodSetLabelLinePoint Set one key point from label line by index
Public methodSetRange Sets both range parameters (start and end) at once.
(Inherited from AutoFeatureLabelGroup)
Top
See Also