NXOpen .NET Reference  12.0.0
Classes | Public Member Functions | Properties | List of all members
NXOpen.BlockStyler.Explorer Class Reference

Represents an Explorer block. More...

Inheritance diagram for NXOpen.BlockStyler.Explorer:
NXOpen.BlockStyler.UIBlock

Classes

class  _ExplorerNotifyNodeSelectedPostCallbackAdapter
 
class  _ExplorerNotifyNodeSelectedPreCallbackAdapter
 

Public Member Functions

delegate int NotifyNodeSelectedPreCallback (NXOpen.BlockStyler.Explorer explorer, int nextNode)
 The NotifyNodeSelectedPre callback notifies a client before navigating to the next node in the Explorer. More...
 
delegate void NotifyNodeSelectedPostCallback (NXOpen.BlockStyler.Explorer explorer, int nextNode)
 The NotifyNodeSelectedPost callback notifies a client after navigating to the next node in the Explorer. More...
 
unsafe void SetChildMembers (NXOpen.BlockStyler.UIBlock parentMember, NXOpen.BlockStyler.UIBlock[] childMembers)
 Sets the parent member for the child members in the Explorer Navigation Tree. More...
 
unsafe void SetNotifyNodeSelectedPreHandler (NXOpen.BlockStyler.Explorer.NotifyNodeSelectedPreCallback cb)
 Sets the NotifyNodeSelectedPre handler. More...
 
unsafe void SetNotifyNodeSelectedPostHandler (NXOpen.BlockStyler.Explorer.NotifyNodeSelectedPostCallback cb)
 Sets the NotifyNodeSelectedPost handler. More...
 
- Public Member Functions inherited from NXOpen.BlockStyler.UIBlock
unsafe
NXOpen.BlockStyler.PropertyList 
GetProperties ()
 Returns the properties of the block More...
 
unsafe void Focus ()
 Focuses on the block. More...
 

Properties

unsafe int CurrentNode [get, set]
 Returns or sets the CurrentNode selected in the Navigation Tree. More...
 
unsafe bool Localize [get, set]
 Returns or sets the localization of the block label. More...
 
unsafe
NXOpen.BlockStyler.PropertyList 
Members [get]
 Returns the members. More...
 
unsafe int TreeWidth [get, set]
 Returns or sets the TreeWidth for the Navigation Tree. More...
 
- Properties inherited from NXOpen.BlockStyler.UIBlock
unsafe bool Enable [get, set]
 Returns or sets the Enable. More...
 
unsafe bool Expanded [get, set]
 Returns or sets the Expanded More...
 
unsafe bool Group [get, set]
 Returns or sets the Group More...
 
unsafe string Label [get, set]
 Returns or sets the Label More...
 
unsafe string Name [get]
 Returns the name of the block or BlockID More...
 
unsafe bool Show [get, set]
 Returns or sets the Visibility of block. More...
 
unsafe string Type [get]
 Returns the type of block More...
 

Detailed Description

Represents an Explorer block.

The Explorer block allows for collecting a large number of inputs into a single dialog. The inputs are organized into nodes and sub-nodes on a tree to allow for quick and easy navigation. The Explorer block provides the ability to have up to 3 levels of nodes in the Navigation Tree. Each node contains groups and individual inputs that are laid out like standard NX dialogs. When selecting level 1 and level 2 nodes that do not contain any groups and only contain sub-nodes the first sub-node containing groups is highlighted and its content shown.

Created in NX9.0.0

Member Function Documentation

delegate void NXOpen.BlockStyler.Explorer.NotifyNodeSelectedPostCallback ( NXOpen.BlockStyler.Explorer  explorer,
int  nextNode 
)

The NotifyNodeSelectedPost callback notifies a client after navigating to the next node in the Explorer.

The nextNode parameter for the callback is zero based and represents the nodes in the Explorer.

Created in NX9.0.0

License requirements: None.

Parameters
explorer
nextNode
delegate int NXOpen.BlockStyler.Explorer.NotifyNodeSelectedPreCallback ( NXOpen.BlockStyler.Explorer  explorer,
int  nextNode 
)

The NotifyNodeSelectedPre callback notifies a client before navigating to the next node in the Explorer.

The nextNode parameter for the callback is zero based and represents the nodes in the Explorer.

Created in NX9.0.0

License requirements: None.

Parameters
explorer
nextNode
unsafe void NXOpen.BlockStyler.Explorer.SetChildMembers ( NXOpen.BlockStyler.UIBlock  parentMember,
NXOpen.BlockStyler.UIBlock[]  childMembers 
)

Sets the parent member for the child members in the Explorer Navigation Tree.

The maximum Navigation Tree depth is 3 levels. An exception is thrown if the parent member depth is already at the maximum allowed depth.

Created in NX9.0.0

License requirements: None.

Parameters
parentMemberParent member for the child members.
childMembersChild members for the parent member.
unsafe void NXOpen.BlockStyler.Explorer.SetNotifyNodeSelectedPostHandler ( NXOpen.BlockStyler.Explorer.NotifyNodeSelectedPostCallback  cb)

Sets the NotifyNodeSelectedPost handler.

Created in NX9.0.0

License requirements: None.

Parameters
cb
unsafe void NXOpen.BlockStyler.Explorer.SetNotifyNodeSelectedPreHandler ( NXOpen.BlockStyler.Explorer.NotifyNodeSelectedPreCallback  cb)

Sets the NotifyNodeSelectedPre handler.

Created in NX9.0.0

License requirements: None.

Parameters
cb

Property Documentation

unsafe int NXOpen.BlockStyler.Explorer.CurrentNode
getset

Returns or sets the CurrentNode selected in the Navigation Tree.

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.BlockStyler.Explorer.Localize
getset

Returns or sets the localization of the block label.

If the label matches an English string in the NX string localization databse and the Localize property is set to true, then the Label is translated to the current locale language.

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.BlockStyler.PropertyList NXOpen.BlockStyler.Explorer.Members
get

Returns the members.

Created in NX9.0.0

License requirements: None.

unsafe int NXOpen.BlockStyler.Explorer.TreeWidth
getset

Returns or sets the TreeWidth for the Navigation Tree.

Created in NX11.0.0

License requirements to get this property: None.

License requirements to set this property: None.


The documentation for this class was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.