PipeLabel.Create(ObjectId, Double, ObjectId) Method

Creates a new instance of PipeLabel on a specified Pipe with the specified label style.



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

Syntax

C#

public static ObjectId Create(
	ObjectId pipeId,
	double ratio,
	ObjectId labelStyleId
)

VB

Public Shared Function Create ( 
	pipeId As ObjectId,
	ratio As Double,
	labelStyleId As ObjectId
) As ObjectId

C++

public:
static ObjectId Create(
	ObjectId pipeId, 
	double ratio, 
	ObjectId labelStyleId
)

Parameters

pipeId  ObjectId
The ObjectId of Pipe on which the label is located.
ratio  Double
The relative position of the label to the pipe.
labelStyleId  ObjectId
The ObjectId of a PipeLabel style to use.

Return Value

ObjectId

Exceptions

ExceptionCondition
ArgumentException Thrown when:
  • The pipeId or labelStyleId is invalid.
  • The ratio is out of the range 0-1.

Remarks

The ratio should be in the range [0, 1].

See Also

Reference

PipeLabel Class
Create Overload
Autodesk.Civil.DatabaseServices Namespace