GeneralSegmentLabelCreate(ObjectId, Double, ObjectId, ObjectId) Method

Creates a new instance of a GeneralSegmentLabel on a feature object with the specified line label and curve label styles.

Namespace: Autodesk.Civil.DatabaseServices
Assembly: AeccDbMgd (in AeccDbMgd.dll) Version: 13.8.0.292
Syntax
Copy
public static ObjectId Create(
	ObjectId featureId,
	double ratio,
	ObjectId lineLabelStyleId,
	ObjectId curveLabelStyleId
)

Parameters

featureId  ObjectId
The ObjectId of the feature object to label (object type Line, Arc, Polyline or Featureline).
ratio  Double
The ratio that sets the relative position of the label to the feature.
lineLabelStyleId  ObjectId
The ObjectId of the line Label style (object type LabelStyle) to use.
curveLabelStyleId  ObjectId
The ObjectId of the curve Label style (object type LabelStyle) to use.

Return Value

ObjectId
Exceptions
ExceptionCondition
ArgumentException Thrown when:
  • The featureId, lineLabelStyleId or curveLabelStyleId parameter is invalid.
  • The ratio is out of range.
Remarks
  • featureId should be the ObjectId of a Line, Arc, Polyline or Featureline.
  • For Line and Arc objects, the ratio should be in the range of [0, 1].
  • For Polyline and FeatureLine objects, the ratio should be in the range [0, n], where n is the number of segments in the object.
See Also