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.280
Syntax
C#
public static ObjectId Create( ObjectIdCollection profileViewPartIds, ObjectId anchorProfileViewPartId, ObjectId profileViewId, double ratio, ObjectId labelStyleId )
VB
Public Shared Function Create ( profileViewPartIds As ObjectIdCollection, anchorProfileViewPartId As ObjectId, profileViewId As ObjectId, ratio As Double, labelStyleId As ObjectId ) As ObjectId
C++
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
ObjectIdExceptions
Exception | Condition |
---|---|
ArgumentException |
Thrown when:
|
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.