SpanningPipeProfileLabelCreate(ObjectIdCollection, ObjectId, ObjectId, Double, ObjectId) Method

Creates a new instance of a SpanningPipeProfileLabel that spans a collection of ProfileViewParts using the specified label style.

Namespace: Autodesk.Civil.DatabaseServices
Assembly: AeccDbMgd (in AeccDbMgd.dll) Version: 13.8.0.292
Syntax
Copy
public static ObjectId Create(
	ObjectIdCollection profileViewPartIds,
	ObjectId anchorProfileViewPartId,
	ObjectId profileViewId,
	double ratio,
	ObjectId labelStyleId
)

Parameters

profileViewPartIds  ObjectIdCollection
An ObjectIdCollection of ProfileViewParts that need spanning.
anchorProfileViewPartId  ObjectId
The ObjectId of a ProfileViewPart on which the label is located.
profileViewId  ObjectId
The ObjectId of the ProfileView in which the label is located.
ratio  Double
A ratio that determines the relative position of the label to the ProfileViewPart.
labelStyleId  ObjectId
The ObjectId of SpanningPipeLabel style.

Return Value

ObjectId
Exceptions
ExceptionCondition
ArgumentException Thrown when:
  • The anchorProfileViewPartId, profileViewId or labelStyleId is invalid.
  • The items in profileViewPartIds are not in the same PipeNetwork.
  • The items in profileViewPartIds are not in the ProfileView.
  • A path crossing two adjacent items in the profileViewPartIds can not be found.
  • The ratio is out of range.
Remarks
  • The ratio should be in the range [0, 1].
  • The source of anchorProfileViewPartId should be a pipe.
  • A path crossing each item in profileViewPartIds is calculated, and each profileViewPart on the path is spanned.
  • If the path crossing two adjacent items in partIds crosses back to the start part to form a loop, the spanned part in the loop is abandoned.
See Also