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: 10.3.488.0

Syntax

C#
public static ObjectId Create(
	ObjectId featureId,
	double ratio,
	ObjectId lineLabelStyleId,
	ObjectId curveLabelStyleId
)
Visual Basic
Public Shared Function Create ( _
	featureId As ObjectId, _
	ratio As Double, _
	lineLabelStyleId As ObjectId, _
	curveLabelStyleId As ObjectId _
) As ObjectId
Visual C++
public:
static ObjectId Create(
	ObjectId featureId, 
	double ratio, 
	ObjectId lineLabelStyleId, 
	ObjectId curveLabelStyleId
)

Parameters

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

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.

Exceptions

ExceptionCondition
System..::..ArgumentException Thrown when:
  • The featureId, lineLabelStyleId or curveLabelStyleId parameter is invalid.
  • The ratio is out of range.

See Also