Adds or edits a balloon. The corresponding BOMView in the model is automatically enabled if not already enabled.
Namespace:
Autodesk.iLogic.Interfaces
Assembly:
Autodesk.iLogic.Interfaces (in Autodesk.iLogic.Interfaces.dll) Version: 25.0
Syntax
VB
Function Add (
name As String,
leaderPoints As IEnumerable(Of DocumentUnitsPoint2d),
intent As GeometryIntent,
Optional virtualComponent As Object = Nothing,
Optional balloonStyle As BalloonStyle = Nothing,
Optional layer As Layer = Nothing
) As IManagedBalloon
C#
IManagedBalloon Add(
string name,
IEnumerable<DocumentUnitsPoint2d> leaderPoints,
GeometryIntent intent,
Object virtualComponent = null,
BalloonStyle balloonStyle = null,
Layer layer = null
)
Parameters
- name
- Type: System.String
The name of the balloon. - leaderPoints
- Type: System.Collections.Generic.IEnumerable(DocumentUnitsPoint2d)
A list of DocumentUnitsPoint2d objects representing the leader originating at the balloon.
Provide an empty list or Nothing if you don't want a leader. - intent
- Type: GeometryIntent
A GeometryIntent that indicates a drawing curve to which the balloon should be attached.
The intent can also include a specification for the point on the curve to attach to. - virtualComponent (Optional)
- Type: System.Object
Optional input object that defines the virtual or custom component that this balloon will be attached to.
This can either be a ComponentOccurrence / ComponentOccurrenceProxy object representing a virtual component,
a BOMRow that represents a virtual component or a custom/virtual DrawingBOMRow.
Default: Nothing - balloonStyle (Optional)
- Type: BalloonStyle
Optional input BalloonStyle object that specifies the balloon style to use for the balloon. If not specified, the style defined by the active standard is used. Default: Nothing. - layer (Optional)
- Type: Layer
Optional input Layer object that specifies the layer to use for the balloon. If not specified, the layer defined by the active standard is used. Default: Nothing.
Return Value
Type:
IManagedBalloon
See Also
Reference