CalloutGroupBuilder Class

class NXOpen.Annotations.CalloutGroupBuilder

Bases: NXOpen.Builder

Represents a NXOpen.Annotations.CalloutGroupBuilder

To create a new instance of this class, use NXOpen.Annotations.IdSymbolCollection.CreateCalloutGroupBuilder()

New in version NX7.5.0.

Properties

Property	Description
CalloutModeType	Returns or sets the mode
LayoutType	Returns or sets the layout type
SelectCallout	Returns the selected callout
Tag	Returns the Tag for this object.
VerticalLeaderAttachment	Returns or sets the leader attachment to vertical callout groups

Methods

Method	Description
Commit	Commits any edits that have been applied to the builder.
Destroy	Deletes the builder, and cleans up any objects created by the builder.
GetCommittedObjects	For builders that create more than one object, this method returns the objects that are created by commit.
GetGroupSymbols	Gets the symbols which are grouped
GetObject	Returns the object currently being edited by this builder.
SetGroupSymbols	Groups or UnGroups the symbols based on NXOpen.Annotations.CalloutGroupBuilderMode.
ShowResults	Updates the model to reflect the result of an edit to the model for all builders that support showing results.
Validate	Validate whether the inputs to the component are sufficient for commit to be called.

Enumerations

CalloutGroupBuilderLayout Enumeration	Represents group layout
CalloutGroupBuilderMode Enumeration	Represents Group or Ungroup mode.
CalloutGroupBuilderVerticalGroupLeaderAttachment Enumeration	Represents leader attachment for vertical callout groups.

Property Detail

CalloutModeType

CalloutGroupBuilder.CalloutModeType

Returns or sets the mode

-------------------------------------

Getter Method

Signature CalloutModeType

Returns: Return type:NXOpen.Annotations.CalloutGroupBuilderMode

New in version NX7.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature CalloutModeType

Parameters:mode (NXOpen.Annotations.CalloutGroupBuilderMode) –

New in version NX7.5.0.

License requirements: drafting (“DRAFTING”)

LayoutType

CalloutGroupBuilder.LayoutType

Returns or sets the layout type

-------------------------------------

Getter Method

Signature LayoutType

Returns: Return type:NXOpen.Annotations.CalloutGroupBuilderLayout

New in version NX7.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature LayoutType

Parameters:layout (NXOpen.Annotations.CalloutGroupBuilderLayout) –

New in version NX7.5.0.

License requirements: drafting (“DRAFTING”)

SelectCallout

CalloutGroupBuilder.SelectCallout

Returns the selected callout

-------------------------------------

Getter Method

Signature SelectCallout

Returns: Return type:NXOpen.SelectDisplayableObjectList

New in version NX7.5.0.

License requirements: None.

VerticalLeaderAttachment

CalloutGroupBuilder.VerticalLeaderAttachment

Returns or sets the leader attachment to vertical callout groups

-------------------------------------

Getter Method

Signature VerticalLeaderAttachment

Returns: Return type:NXOpen.Annotations.CalloutGroupBuilderVerticalGroupLeaderAttachment

New in version NX9.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature VerticalLeaderAttachment

Parameters:position (NXOpen.Annotations.CalloutGroupBuilderVerticalGroupLeaderAttachment) –

New in version NX9.0.0.

License requirements: drafting (“DRAFTING”)

Method Detail

GetGroupSymbols

CalloutGroupBuilder.GetGroupSymbols

Gets the symbols which are grouped

Signature GetGroupSymbols()

Returns: Return type:list of NXOpen.Annotations.IdSymbol

New in version NX7.5.0.

License requirements: None.

SetGroupSymbols

CalloutGroupBuilder.SetGroupSymbols

Groups or UnGroups the symbols based on NXOpen.Annotations.CalloutGroupBuilderMode.

Signature SetGroupSymbols(symbols)

Parameters:symbols (list of NXOpen.Annotations.IdSymbol) –

New in version NX7.5.0.

License requirements: drafting (“DRAFTING”)

Validate

CalloutGroupBuilder.Validate

Validate whether the inputs to the component are sufficient for commit to be called.

If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.

Signature Validate()

Returns:Was self validation successful Return type:bool

New in version NX3.0.1.

License requirements: None.