Create Method (ObjectId, Double)

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.2.3892.0

Syntax

C#

public static ObjectId Create(
	ObjectId featureId,
	double ratio
)

Visual Basic

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

Visual C++

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

Parameters

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

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].

Exceptions

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

See Also