Represents a Dialog More...

Inheritance diagram for NXOpen.BlockStyler.BlockDialog:

Classes
class	_BlockDialogApplyAdapter

class	_BlockDialogCancelAdapter

class	_BlockDialogCloseAdapter

class	_BlockDialogDialogShownAdapter

class	_BlockDialogEnableOKButtonAdapter

class	_BlockDialogFilterAdapter

class	_BlockDialogFocusNotifyAdapter

class	_BlockDialogInitializeAdapter

class	_BlockDialogKeyboardFocusNotifyAdapter

class	_BlockDialogOkAdapter

class	_BlockDialogUpdateAdapter

class	PerformCancel_Runnable

class	PerformOK_Runnable

Public Types
enum	DialogMode { Create, Edit }
	Datatype containing options for showing the dialog More...

Public Member Functions
unsafe void	AddApplyHandler (NXOpen.BlockStyler.BlockDialog.Apply applyCb)
	Adds Apply callback handler to the dialog. More...

unsafe void	AddCancelHandler (NXOpen.BlockStyler.BlockDialog.Cancel cancelCb)
	Adds Cancel callback handler to the dialog. More...

unsafe void	AddCloseHandler (NXOpen.BlockStyler.BlockDialog.Close closeCb)
	Adds Close callback handler to the dialog. More...

unsafe void	AddDialogShownHandler (NXOpen.BlockStyler.BlockDialog.DialogShown cb)
	Adds Dialog Shown callback handler to the dialog. More...

unsafe void	AddEnableOKButtonHandler (NXOpen.BlockStyler.BlockDialog.EnableOKButton cb)
	Adds enable-ok-button callback handler to the dialog. More...

unsafe void	AddFilterHandler (NXOpen.BlockStyler.BlockDialog.Filter cb)
	Adds Filter callback handler to the dialog. More...

unsafe void	AddFocusNotifyHandler (NXOpen.BlockStyler.BlockDialog.FocusNotify cb)
	Adds focus notify callback handler to the dialog. More...

unsafe void	AddInitializeHandler (NXOpen.BlockStyler.BlockDialog.Initialize cb)
	Adds Initialize callback handler to the dialog. More...

unsafe void	AddKeyboardFocusNotifyHandler (NXOpen.BlockStyler.BlockDialog.KeyboardFocusNotify cb)
	Adds keyboard focus notify callback handler to the dialog. More...

unsafe void	AddOkHandler (NXOpen.BlockStyler.BlockDialog.Ok okCb)
	Adds Ok callback handler to the dialog. More...

unsafe void	AddUpdateHandler (NXOpen.BlockStyler.BlockDialog.Update cb)
	Adds Update callback handler to the dialog. More...

delegate int	Apply ()
	Apply callback More...

delegate int	Cancel ()
	Cancel callback More...

delegate int	Close ()
	Close callback More...

delegate void	DialogShown ()
	Dialog Shown callback More...

delegate bool	EnableOKButton ()
	Callback to enable OK and Apply buttons of the dialog. More...

delegate int	Filter (NXOpen.BlockStyler.UIBlock selectionBlock, NXOpen.TaggedObject selectedObject)
	Filter callback More...

delegate void	FocusNotify (NXOpen.BlockStyler.UIBlock focusBlock, bool isFocus)
	Focus notify callback. More...

unsafe NXOpen.BlockStyler.PropertyList	GetBlockProperties (string blockName)
	Gets the properties of a block More...

delegate void	Initialize ()
	Initialize callback More...

delegate void	KeyboardFocusNotify (NXOpen.BlockStyler.UIBlock block, bool isFocus)
	Keyboard focus notify callback. More...

delegate int	Ok ()
	Ok callback More...

unsafe void	PerformApply ()
	Performs an Apply and restarts the dialog. More...

unsafe void	PerformCancel ()
	Performs a Cancel and closes the dialog. More...

unsafe void	PerformOK ()
	Performs an OK and closes the dialog. More...

unsafe void	RegisterUserDefinedUIBlock (NXOpen.BlockStyler.BlockDialog blockDialog, string blockId)
	Registers the reusable block with the dialog More...

unsafe NXOpen.Selection.Response	Show ()
	Shows the dialog in BlockStyler.BlockDialog.DialogMode.Create mode. More...

unsafe NXOpen.Selection.Response	Show (NXOpen.BlockStyler.BlockDialog.DialogMode dialogMode)
	Shows the dialog based upon the mode specified in BlockStyler.BlockDialog.DialogMode . More...

delegate int	Update (NXOpen.BlockStyler.UIBlock stylerItem)
	Update callback More...

Public Member Functions inherited from NXOpen.TransientObject
void	Dispose ()
	Frees the object from memory. More...

void	PrintTestData (String variableName)
	<exclude> More...

void	PrintTestData (String variableName, int lineNumber)
	<exclude> More...

new 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...

Protected Member Functions
override void	FreeResource ()
	Frees the object from memory. More...

Properties
unsafe NXOpen.BlockStyler.CompositeBlock	TopBlock `[get]`
	Returns a composite block that contains all the blocks in the dialog More...

Properties inherited from NXOpen.TransientObject
IntPtr	Handle `[get]`
	Handle of the internal object represented by this object. More...

Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink	NextSink `[get]`
	Gets the next message sink in the sink chain. More...

Detailed Description

Represents a Dialog

Created in NX6.0.0

Member Enumeration Documentation

enum NXOpen.BlockStyler.BlockDialog.DialogMode

Datatype containing options for showing the dialog

Enumerator

Create

When the user presses Ok or Apply on the dialog, the user's inputs are saved in dialog memory and the next time that the dialog is shown in Create mode, the dialog is initialized using the user's previous inputs.

Edit

The Apply button is not shown.

The user's inputs are not saved in dialog memory and the dialog is not initialized with the user's previous inputs.

Member Function Documentation

unsafe void NXOpen.BlockStyler.BlockDialog.AddApplyHandler ( NXOpen.BlockStyler.BlockDialog.Apply applyCb )

inline

Adds Apply callback handler to the dialog.

Created in NX6.0.0

License requirements: None.

Parameters

applyCb

unsafe void NXOpen.BlockStyler.BlockDialog.AddCancelHandler ( NXOpen.BlockStyler.BlockDialog.Cancel cancelCb )

inline

Adds Cancel callback handler to the dialog.

Created in NX6.0.0

License requirements: None.

Parameters

cancelCb

unsafe void NXOpen.BlockStyler.BlockDialog.AddCloseHandler ( NXOpen.BlockStyler.BlockDialog.Close closeCb )

inline

Adds Close callback handler to the dialog.

Created in NX8.5.0

License requirements: None.

Parameters

closeCb

unsafe void NXOpen.BlockStyler.BlockDialog.AddDialogShownHandler ( NXOpen.BlockStyler.BlockDialog.DialogShown cb )

inline

Adds Dialog Shown callback handler to the dialog.

The callback function is called before the dialog is shown. The callback can be used to overwrite changes that are made during dialog initialization when user inputs saved in dialog memory are applied to the dialog.

Created in NX6.0.0

License requirements: None.

Parameters

cb

unsafe void NXOpen.BlockStyler.BlockDialog.AddEnableOKButtonHandler ( NXOpen.BlockStyler.BlockDialog.EnableOKButton cb )

inline

Adds enable-ok-button callback handler to the dialog.

Created in NX7.5.3

License requirements: None.

Parameters

cb

unsafe void NXOpen.BlockStyler.BlockDialog.AddFilterHandler ( NXOpen.BlockStyler.BlockDialog.Filter cb )

inline

Adds Filter callback handler to the dialog.

Created in NX6.0.0

License requirements: None.

Parameters

cb

unsafe void NXOpen.BlockStyler.BlockDialog.AddFocusNotifyHandler ( NXOpen.BlockStyler.BlockDialog.FocusNotify cb )

inline

Adds focus notify callback handler to the dialog.

Created in NX6.0.2

License requirements: None.

Parameters

cb

unsafe void NXOpen.BlockStyler.BlockDialog.AddInitializeHandler ( NXOpen.BlockStyler.BlockDialog.Initialize cb )

inline

Adds Initialize callback handler to the dialog.

The callback function is called while the dialog is being initialized. The callback is called before applying any user inputs saved in dialog memory.

Created in NX6.0.0

License requirements: None.

Parameters

cb

unsafe void NXOpen.BlockStyler.BlockDialog.AddKeyboardFocusNotifyHandler ( NXOpen.BlockStyler.BlockDialog.KeyboardFocusNotify cb )

inline

Adds keyboard focus notify callback handler to the dialog.

Created in NX7.5.0

License requirements: None.

Parameters

cb

unsafe void NXOpen.BlockStyler.BlockDialog.AddOkHandler ( NXOpen.BlockStyler.BlockDialog.Ok okCb )

inline

Adds Ok callback handler to the dialog.

Created in NX6.0.0

License requirements: None.

Parameters

okCb

unsafe void NXOpen.BlockStyler.BlockDialog.AddUpdateHandler ( NXOpen.BlockStyler.BlockDialog.Update cb )

inline

Adds Update callback handler to the dialog.

Created in NX6.0.0

License requirements: None.

Parameters

cb

delegate int NXOpen.BlockStyler.BlockDialog.Apply ( )

Apply callback

Created in NX6.0.0

License requirements: None.

delegate int NXOpen.BlockStyler.BlockDialog.Cancel ( )

Cancel callback

Created in NX6.0.0

License requirements: None.

delegate int NXOpen.BlockStyler.BlockDialog.Close ( )

Close callback

Created in NX8.5.0

License requirements: None.

delegate void NXOpen.BlockStyler.BlockDialog.DialogShown ( )

Dialog Shown callback

Created in NX6.0.0

License requirements: None.

delegate bool NXOpen.BlockStyler.BlockDialog.EnableOKButton ( )

Callback to enable OK and Apply buttons of the dialog.

Return True or False to enable or disable the buttons respectively.

Created in NX7.5.3

License requirements: None.

delegate int NXOpen.BlockStyler.BlockDialog.Filter	(	NXOpen.BlockStyler.UIBlock	selectionBlock,
		NXOpen.TaggedObject	selectedObject
	)

Filter callback

Created in NX6.0.0

License requirements: None.

Parameters

selectionBlock	Selection Block
selectedObject	Tagged Objects

delegate void NXOpen.BlockStyler.BlockDialog.FocusNotify	(	NXOpen.BlockStyler.UIBlock	focusBlock,
		bool	isFocus
	)

Focus notify callback.

This is invoked when any selection block on the dialog receives focus.

Created in NX6.0.2

License requirements: None.

Parameters

focusBlock	Selection block receiving or going out of focus
isFocus	Flag representing the focus state of the block. True means that block has recieved the focus, and False suggests that block is going out of focus.

override void NXOpen.BlockStyler.BlockDialog.FreeResource ( )

inlineprotectedvirtual

Frees the object from memory.

After this method is called, it is illegal to use the object. In .NET, this method is automatically called when the object is deleted by the garbage collector.

Created in NX6.0.0

License requirements: None.

Implements NXOpen.TransientObject.

Reimplemented in NXOpen.BlockStyler.SnapBlockDialog.

unsafe NXOpen.BlockStyler.PropertyList NXOpen.BlockStyler.BlockDialog.GetBlockProperties ( string blockName )

inline

Gets the properties of a block

Created in NX8.5.0

License requirements: None.

Parameters

blockName BlockID of the block

Returns

delegate void NXOpen.BlockStyler.BlockDialog.Initialize ( )

Initialize callback

Created in NX6.0.0

License requirements: None.

delegate void NXOpen.BlockStyler.BlockDialog.KeyboardFocusNotify	(	NXOpen.BlockStyler.UIBlock	block,
		bool	isFocus
	)

Keyboard focus notify callback.

This is invoked when any block having keyboard input such as Integer block receives focus.

Created in NX7.5.0

License requirements: None.

Parameters

block	Block which recieves focus
isFocus	Flag representing the focus state of the block. True means that block has recieved the focus, and False suggests that block is going out of focus.

delegate int NXOpen.BlockStyler.BlockDialog.Ok ( )

Ok callback

Created in NX6.0.0

License requirements: None.

unsafe void NXOpen.BlockStyler.BlockDialog.PerformApply ( )

inline

Performs an Apply and restarts the dialog.

This invokes the apply callback on the dialog. This method is meant to be called when the dialog is shown and while inside the update callback.

Created in NX6.0.0

License requirements: None.

unsafe void NXOpen.BlockStyler.BlockDialog.PerformCancel ( )

inline

Performs a Cancel and closes the dialog.

This invokes the cancel callback on the dialog. This method must be called after the NXOpen.BlockStyler.BlockDialog.Show . This method will throw an exception if the dialog is not being shown.

This method is meant to be called in secondary thread from where the NXOpen.BlockStyler.BlockDialog.Show is called. The example PerformOk supplied in the ugopen kit walks through how to utilize this method.

This method cannot be called after NXOpen.BlockStyler.BlockDialog.Show returns as this may put NX in deadlocked state.

Created in NX11.0.0

License requirements: None.

unsafe void NXOpen.BlockStyler.BlockDialog.PerformOK ( )

inline

Performs an OK and closes the dialog.

This invokes the OK callback on the dialog. This method must be called after the NXOpen.BlockStyler.BlockDialog.Show . This method will throw an exception if the dialog is not being shown.

This method is meant to be called in secondary thread from where the NXOpen.BlockStyler.BlockDialog.Show is called. The example PerformOk supplied in the ugopen kit walks through how to utilize this method.

This method cannot be called after NXOpen.BlockStyler.BlockDialog.Show returns as this may put NX in deadlocked state.

Created in NX11.0.0

License requirements: None.

unsafe void NXOpen.BlockStyler.BlockDialog.RegisterUserDefinedUIBlock	(	NXOpen.BlockStyler.BlockDialog	blockDialog,
		string	blockId
	)

inline

Registers the reusable block with the dialog

Created in NX8.0.0

License requirements: None.

Parameters

blockDialog	Dialog which contains the reusable block
blockId	"Block ID" of reusable block

unsafe NXOpen.Selection.Response NXOpen.BlockStyler.BlockDialog.Show ( )

inline

Shows the dialog in BlockStyler.BlockDialog.DialogMode.Create mode.

This method will not return until the dialog is closed, which typically is when the dialog's OK or Cancel button is pressed.

Created in NX6.0.0

License requirements: None.

Returns

unsafe NXOpen.Selection.Response NXOpen.BlockStyler.BlockDialog.Show ( NXOpen.BlockStyler.BlockDialog.DialogMode dialogMode )

inline

Shows the dialog based upon the mode specified in BlockStyler.BlockDialog.DialogMode .

This method will not return until the dialog is closed, which typically is when the dialog's OK or Cancel button is pressed.

Created in NX6.0.0

License requirements: None.

Parameters

dialogMode Dialog mode as Create or Edit. BlockStyler.BlockDialog.DialogMode

Returns: Returns 1: When Back is pressed. 2: When Cancel is pressed. 3: When Ok or Apply is pressed.

delegate int NXOpen.BlockStyler.BlockDialog.Update ( NXOpen.BlockStyler.UIBlock stylerItem )

Update callback

Created in NX6.0.0

License requirements: None.

Parameters

stylerItem

Property Documentation

unsafe NXOpen.BlockStyler.CompositeBlock NXOpen.BlockStyler.BlockDialog.TopBlock

get

Returns a composite block that contains all the blocks in the dialog

Created in NX6.0.0

License requirements: None.

The documentation for this class was generated from the following file:

BlockStyler_BlockDialog.cs

Classes

Public Types

Public Member Functions

Protected Member Functions

Properties

Detailed Description

Member Enumeration Documentation

Member Function Documentation

Property Documentation