NXOpen .NET Reference Guide
|
Represents a Wizard block More...
Public Types | |
enum | SubNodeAction { Select, Deselect, Check, Uncheck } |
Specifies the type of action performed on a sub-node in the Wizard Task Navigator. More... | |
enum | TaskNavigatorItem { Step, SubNode, Background } |
Specifies an item in the Task Navigator. More... | |
Public Member Functions | |
unsafe NXOpen.BlockStyler.TreeListMenu | CreateMenu () |
Creates a popup menu. More... | |
unsafe int | CreateStepSubNode (int step, string text, string bitmap, bool showCheckBox, bool checkBoxChecked) |
Create a sub-node for a step in the Task Navigator. More... | |
unsafe string[] | GetStepBannerBitmaps () |
Gets the StepBannerBitmaps. More... | |
unsafe string[] | GetStepBitmaps () |
Gets the StepBitmaps. More... | |
unsafe string[] | GetStepCues () |
Gets the StepCues. More... | |
unsafe string[] | GetStepText () |
Gets the StepText. More... | |
delegate bool | IsStepOkayCallback (NXOpen.BlockStyler.Wizard wizard, int step) |
The IsStepOkay callback allows the client to notify the Wizard that the step is okay or not. More... | |
delegate void | OnMenuCallback (NXOpen.BlockStyler.Wizard wizard, NXOpen.BlockStyler.Wizard.TaskNavigatorItem item, int step, int subNodeId) |
The OnMenu callback notifies a client prior to creating the popup menu in the Task Navigator. More... | |
delegate void | OnMenuSelectionCallback (NXOpen.BlockStyler.Wizard wizard, NXOpen.BlockStyler.Wizard.TaskNavigatorItem item, int step, int subNodeId, int menuItemIndex) |
The OnMenuSelection callback notifies a client of the menu item selection on the popup menu in the Task Navigator. More... | |
delegate void | OnSubNodeCallback (NXOpen.BlockStyler.Wizard wizard, int step, int subNodeId, NXOpen.BlockStyler.Wizard.SubNodeAction action) |
The OnSubNode callback notifies a client of an action performed on a sub-node in the Wizard Task Navigator. More... | |
unsafe void | RemoveStepSubNode (int subNodeId) |
Remove a sub-node in the Task Navigator. More... | |
unsafe void | SetIsStepOkayHandler (NXOpen.BlockStyler.Wizard.IsStepOkayCallback cb) |
Sets the IsStepOkay handler. More... | |
unsafe void | SetMenu (NXOpen.BlockStyler.TreeListMenu menu) |
Set the menu items for the popup menu for a step, sub-node or the background in the Task Navigator. More... | |
unsafe void | SetOnMenuHandler (NXOpen.BlockStyler.Wizard.OnMenuCallback cb) |
Sets the OnMenu handler. More... | |
unsafe void | SetOnMenuSelectionHandler (NXOpen.BlockStyler.Wizard.OnMenuSelectionCallback cb) |
Sets the OnMenuSelection handler. More... | |
unsafe void | SetOnSubNodeHandler (NXOpen.BlockStyler.Wizard.OnSubNodeCallback cb) |
Sets the OnSubNode handler. More... | |
unsafe void | SetStepBannerBitmaps (string[] bitmaps) |
Sets the StepBannerBitmaps. More... | |
unsafe void | SetStepBitmaps (string[] bitmaps) |
Sets the StepBitmaps. More... | |
unsafe void | SetStepCues (string[] cues) |
Sets the StepCues. More... | |
unsafe void | SetStepNotifyPostHandler (NXOpen.BlockStyler.Wizard.StepNotifyPostCallback cb) |
Sets the StepNotifyPost handler. More... | |
unsafe void | SetStepNotifyPreHandler (NXOpen.BlockStyler.Wizard.StepNotifyPreCallback cb) |
Sets the StepNotifyPre handler. More... | |
unsafe void | SetStepText (string[] text) |
Sets the StepText. More... | |
delegate void | StepNotifyPostCallback (NXOpen.BlockStyler.Wizard wizard, int nextStep) |
The StepNotifyPost callback notifies a client after navigating to the next step in the Wizard. More... | |
delegate int | StepNotifyPreCallback (NXOpen.BlockStyler.Wizard wizard, int nextStep) |
The StepNotifyPre callback notifies a client before navigating to the next step in the Wizard. More... | |
Public Member Functions inherited from NXOpen.BlockStyler.UIBlock | |
unsafe void | Focus () |
Focuses on the block. More... | |
unsafe NXOpen.BlockStyler.PropertyList | GetProperties () |
Returns the properties of the block More... | |
Public Member Functions inherited from NXOpen.TaggedObject | |
void | PrintTestData (String variableName) |
<exclude> More... | |
void | PrintTestData (String variableName, int lineNumber) |
<exclude> More... | |
override string | ToString () |
Returns a String that represents the current Object. More... | |
Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject | |
IMessageCtrl | AsyncProcessMessage (IMessage msg, IMessageSink replySink) |
Asynchronously processes the given message. More... | |
IMessage | SyncProcessMessage (IMessage msg) |
Synchronously processes the given message. More... | |
Properties | |
unsafe int | CurrentStep [get, set] |
Returns or sets the CurrentStep. More... | |
unsafe bool | HighQualityBitmap [get, set] |
Returns or sets the HighQualityBitmap. More... | |
unsafe bool | Localize [get, set] |
Returns or sets the Localize. More... | |
unsafe NXOpen.BlockStyler.PropertyList | Members [get] |
Returns the Members More... | |
unsafe bool | ShowTaskNavigator [get, set] |
Returns or sets the ShowTaskNavigator. 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... | |
Properties inherited from NXOpen.TaggedObject | |
Tag | Tag [get] |
Returns the tag of this object. More... | |
Properties inherited from NXOpen.Utilities.NXRemotableObject | |
IMessageSink | NextSink [get] |
Gets the next message sink in the sink chain. More... | |
Additional Inherited Members | |
Protected Member Functions inherited from NXOpen.TaggedObject | |
new void | initialize () |
<exclude> More... | |
Represents a Wizard block
Created in NX7.5.0
Specifies the type of action performed on a sub-node in the Wizard Task Navigator.
The action is passed into the callback BlockStyler.Wizard.OnSubNodeCallback.
|
inline |
Creates a popup menu.
Use BlockStyler.Wizard.SetMenu to set the created menu. See the BlockStyler.TreeListMenu for information on creating a menu.
Created in NX7.5.0
License requirements: None.
|
inline |
Create a sub-node for a step in the Task Navigator.
Created in NX7.5.0
License requirements: None.
step | The step to add a sub-node. |
text | Text for the sub-node. |
bitmap | Optional bitmap for the sub-node. |
showCheckBox | Associate an optional check box with the sub-node |
checkBoxChecked | The initial state of the check box. |
|
inline |
Gets the StepBannerBitmaps.
Gets the list of bitmaps for the step bitmaps in the banner area.
Created in NX8.5.0
License requirements: None.
|
inline |
Gets the StepBitmaps.
Gets the list of bitmaps for the node bitmaps in the Task Navigator.
Created in NX8.5.0
License requirements: None.
|
inline |
Gets the StepCues.
Gets the list of cue lines for the wizard steps.
Created in NX8.5.0
License requirements: None.
|
inline |
Gets the StepText.
Gets the list of step descriptions for the banner area.
Created in NX8.5.0
License requirements: None.
delegate bool NXOpen.BlockStyler.Wizard.IsStepOkayCallback | ( | NXOpen.BlockStyler.Wizard | wizard, |
int | step | ||
) |
The IsStepOkay callback allows the client to notify the Wizard that the step is okay or not.
Returns true if the step is okay and false otherwise. The step parameter for the callback is zero based and represents the steps in the Wizard.
Created in NX7.5.0
License requirements: None.
wizard | |
step |
delegate void NXOpen.BlockStyler.Wizard.OnMenuCallback | ( | NXOpen.BlockStyler.Wizard | wizard, |
NXOpen.BlockStyler.Wizard.TaskNavigatorItem | item, | ||
int | step, | ||
int | subNodeId | ||
) |
The OnMenu callback notifies a client prior to creating the popup menu in the Task Navigator.
The item parameter specifies the popup menu was activated on a step, sub-node or the background. The step parameter for the callback is zero based and represents the steps in the Wizard. The subNodeId parameter is the unique id returned by BlockStyler.Wizard.CreateStepSubNode . If the popup menu is invoked on the background of the Task Navigator the step and subNodeId parameters will be -1.
Created in NX7.5.0
License requirements: None.
wizard | |
item | |
step | |
subNodeId |
delegate void NXOpen.BlockStyler.Wizard.OnMenuSelectionCallback | ( | NXOpen.BlockStyler.Wizard | wizard, |
NXOpen.BlockStyler.Wizard.TaskNavigatorItem | item, | ||
int | step, | ||
int | subNodeId, | ||
int | menuItemIndex | ||
) |
The OnMenuSelection callback notifies a client of the menu item selection on the popup menu in the Task Navigator.
The item parameter specifies the popup menu was activated on a step, sub-node or the background. The step parameter for the callback is zero based and represents the steps in the Wizard. The subNodeId parameter is the unique id returned by BlockStyler.Wizard.CreateStepSubNode . The menuItemIndex parameter will be the unique id specified when creating menu items for the BlockStyler.TreeListMenu. If the popup menu is invoked on the background of the Task Navigator the step and subNodeId parameters will be -1.
Created in NX7.5.0
License requirements: None.
wizard | |
item | |
step | |
subNodeId | |
menuItemIndex |
delegate void NXOpen.BlockStyler.Wizard.OnSubNodeCallback | ( | NXOpen.BlockStyler.Wizard | wizard, |
int | step, | ||
int | subNodeId, | ||
NXOpen.BlockStyler.Wizard.SubNodeAction | action | ||
) |
The OnSubNode callback notifies a client of an action performed on a sub-node in the Wizard Task Navigator.
The step parameter for the callback is zero based and represents the steps in the Wizard. The subNodeId parameter is the unique id returned by BlockStyler.Wizard.CreateStepSubNode .
Created in NX7.5.0
License requirements: None.
wizard | |
step | |
subNodeId | Unique id for the sub-node. |
action | Action being performed on the sub-node. |
|
inline |
Remove a sub-node in the Task Navigator.
Created in NX7.5.0
License requirements: None.
subNodeId | The sub-node id. |
|
inline |
Sets the IsStepOkay handler.
Created in NX7.5.0
License requirements: None.
cb |
|
inline |
Set the menu items for the popup menu for a step, sub-node or the background in the Task Navigator.
See the BlockStyler.TreeListMenu for information on creating a menu.
Created in NX7.5.0
License requirements: None.
menu |
|
inline |
Sets the OnMenu handler.
Created in NX7.5.0
License requirements: None.
cb |
|
inline |
Sets the OnMenuSelection handler.
Created in NX7.5.0
License requirements: None.
cb |
|
inline |
Sets the OnSubNode handler.
Created in NX7.5.0
License requirements: None.
cb |
|
inline |
Sets the StepBannerBitmaps.
Sets the list of bitmaps for the step bitmaps in the banner area.
Created in NX8.5.0
License requirements: None.
bitmaps |
|
inline |
Sets the StepBitmaps.
Sets the list of bitmaps for the node bitmaps in the Task Navigator.
Created in NX8.5.0
License requirements: None.
bitmaps |
|
inline |
Sets the StepCues.
Sets the list of cue lines for the wizard steps.
Created in NX8.5.0
License requirements: None.
cues |
|
inline |
Sets the StepNotifyPost handler.
Created in NX7.5.0
License requirements: None.
cb |
|
inline |
Sets the StepNotifyPre handler.
Created in NX7.5.0
License requirements: None.
cb |
|
inline |
Sets the StepText.
Sets the list of step descriptions for the banner area.
Created in NX8.5.0
License requirements: None.
text |
delegate void NXOpen.BlockStyler.Wizard.StepNotifyPostCallback | ( | NXOpen.BlockStyler.Wizard | wizard, |
int | nextStep | ||
) |
The StepNotifyPost callback notifies a client after navigating to the next step in the Wizard.
The nextStep parameter for the callback is zero based and represents the steps in the Wizard.
Created in NX7.5.0
License requirements: None.
wizard | |
nextStep |
delegate int NXOpen.BlockStyler.Wizard.StepNotifyPreCallback | ( | NXOpen.BlockStyler.Wizard | wizard, |
int | nextStep | ||
) |
The StepNotifyPre callback notifies a client before navigating to the next step in the Wizard.
The nextStep parameter for the callback is zero based and represents the steps in the Wizard.
Created in NX7.5.0
License requirements: None.
wizard | |
nextStep |
|
getset |
Returns or sets the CurrentStep.
Created in NX8.5.0
License requirements to get this property: None.
License requirements to set this property: None.
|
getset |
Returns or sets the HighQualityBitmap.
Created in NX8.5.0
License requirements to get this property: None.
License requirements to set this property: None.
|
getset |
Returns or sets the Localize.
Created in NX8.5.0
License requirements to get this property: None.
License requirements to set this property: None.
|
get |
Returns the Members
Created in NX8.5.0
License requirements: None.
|
getset |
Returns or sets the ShowTaskNavigator.
Created in NX8.5.0
License requirements to get this property: None.
License requirements to set this property: None.