CompositeBlock Class¶
-
class
NXOpen.BlockStyler.CompositeBlock¶ Bases:
NXOpen.BlockStyler.UIBlockA composite block is a block that contains other blocks
New in version NX6.0.0.
Properties¶
| Property | Description |
|---|---|
| Cue | Returns or sets the Cue |
| DialogSizing | Returns or sets the Dialog Sizing |
| DialogSizingAsString | Returns or sets the Dialog Sizing as string |
| Enable | Returns or sets the Enable. |
| Expanded | Returns or sets the Expanded |
| Group | Returns or sets the Group |
| Label | Returns or sets the Label |
| LastUpdated | Returns the block contained in the composite block that was last updated. |
| Name | Returns the name of the block or BlockID |
| NavigationStyle | Returns the Navigation Style |
| NavigationStyleAsString | Returns the Navigation Style as string |
| Show | Returns or sets the Visibility of block. |
| Tag | Returns the Tag for this object. |
| Type | Returns the type of block |
Methods¶
| Method | Description |
|---|---|
| FindBlock | Finds a block contained in the composite block. |
| Focus | Focuses on the block. |
| GetBlocks | Gets all the blocks available in the composite block @return |
| GetDialogSizingMembers | Gets the Dialog Sizing members @return Value to get from the property |
| GetNavigationStyleMembers | Gets the Navigation Style members @return Value to get from the property |
| GetProperties | Returns the properties of the block @return |
Property Detail¶
Cue¶
-
CompositeBlock.Cue¶ Returns or sets the Cue
-------------------------------------Getter Method
Signature
Cue()Returns: Return type: str New in version NX8.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
Cue(cue)Parameters: cue (str) – New in version NX8.5.0.
License requirements: None.
DialogSizing¶
-
CompositeBlock.DialogSizing¶ Returns or sets the Dialog Sizing
-------------------------------------Getter Method
Signature
DialogSizing()Returns: Return type: int New in version NX8.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
DialogSizing(enumIndex)Parameters: enumIndex (int) – New in version NX8.5.0.
License requirements: None.
DialogSizingAsString¶
-
CompositeBlock.DialogSizingAsString¶ Returns or sets the Dialog Sizing as string
-------------------------------------Getter Method
Signature
DialogSizingAsString()Returns: Return type: str New in version NX8.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
DialogSizingAsString(enumString)Parameters: enumString (str) – New in version NX8.5.0.
License requirements: None.
LastUpdated¶
-
CompositeBlock.LastUpdated¶ Returns the block contained in the composite block that was last updated.
For example, if the CompositeBlock is an item contained in a SetList and your update handler is notified that the CompositeBlock has been updated, this method returns which block inside the CompositeBlock has been updated.
-------------------------------------Getter Method
Signature
LastUpdated()Returns: Return type: NXOpen.BlockStyler.UIBlockNew in version NX6.0.0.
License requirements: None.
Method Detail¶
FindBlock¶
-
CompositeBlock.FindBlock¶ Finds a block contained in the composite block.
Throws an exception if block not present
Signature
FindBlock(blockName)Parameters: blockName (str) – Block name NOTE: The full Unicode character set is not supported for this parameter. Returns: Return type: NXOpen.BlockStyler.UIBlockNew in version NX6.0.0.
License requirements: None.
GetBlocks¶
-
CompositeBlock.GetBlocks¶ Gets all the blocks available in the composite block
Signature
GetBlocks()Returns: Return type: list of NXOpen.BlockStyler.UIBlockNew in version NX6.0.0.
License requirements: None.