SpanningPipeLabelCreate(ObjectIdCollection, ObjectId, Double, ObjectId) Method |
Creates a new instance of a SpanningPipeLabel that spans a specified collection of parts with the specified label style.
Namespace: Autodesk.Civil.DatabaseServicesAssembly: AeccDbMgd (in AeccDbMgd.dll) Version: 13.8.0.292
Syntaxpublic static ObjectId Create(
ObjectIdCollection partIds,
ObjectId anchorPipeId,
double ratio,
ObjectId labelStyleId
)
Public Shared Function Create (
partIds As ObjectIdCollection,
anchorPipeId As ObjectId,
ratio As Double,
labelStyleId As ObjectId
) As ObjectId
public:
static ObjectId Create(
ObjectIdCollection^ partIds,
ObjectId anchorPipeId,
double ratio,
ObjectId labelStyleId
)
Parameters
- partIds ObjectIdCollection
- An ObjectIdCollection of the Parts which need spanning.
- anchorPipeId ObjectId
- The ObjectId of the Pipe in which the label is located.
- ratio Double
- The relative position of the label to the pipe.
- labelStyleId ObjectId
- The ObjectId of a SpanningPipeLabel style to use.
Return Value
ObjectId
ExceptionsException | Condition |
---|
ArgumentException |
Thrown when:
- The anchorPipeId or labelStyleId is invalid.
- The items in partIds are not in same PipeNetwork.
- A path that crosses two adjacent items in partIds can not be found.
- The ratio is out of range.
|
Remarks- If a path that crosses each item in partIds can be calculated,
each pipe on the path will be spanned.
- If the path that crosses two adjacent items in partIds crosses back on the starting part
to form a loop, the spanned part in the loop is abandoned.
See Also