GeneralSegmentLabelCreate(ObjectId, Double) Method

Creates a new instance of a GeneralSegmentLabel at a specified location on a feature object with the default line label style and curve label style.

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

Syntax

public static ObjectId Create(
	ObjectId featureId,
	double ratio
)

Public Shared Function Create ( 
	featureId As ObjectId,
	ratio As Double
) As ObjectId

public:
static ObjectId Create(
	ObjectId featureId, 
	double ratio
)

featureId ObjectId: The ObjectId of the feature object to label.
ratio Double: The ratio that sets the relative position of the label to the feature.

ObjectId

Exceptions

Exception	Condition
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 with n segments, the ratio should be in the range of [0, n].