Represents a DialogItem for UI Styler. More...

Inheritance diagram for NXOpen.UIStyler.DialogItem:

Classes
class	_DialogItemApplyAdapter

class	_DialogItemBackAdapter

class	_DialogItemCancelAdapter

class	_DialogItemConstructAdapter

class	_DialogItemDestructAdapter

class	_DialogItemFileOperationAdapter

class	_DialogItemOkayAdapter

class	_DialogItemPageSwitchAdapter

Public Types
enum	DialogItemIndex { Ok, Apply, Back, Cancel }
	Describes dialog item index More...

Public Types inherited from NXOpen.UIStyler.StylerItem
enum	ItemType { InvalidType = -1, ActionButton, Dialog, RadioBox, Real, ScaleReal, Bitmap, RowColumn, ButtonLayout, ScrolledWindow, ColorTool, SelectionBox, Separator, SingleSelectionList, String, BeginGroup, Integer, ScaleInteger, MultiList, Label, MultiLineText, TabControl, OptionMenu, Toggle, OptionToggle, ToolPalette, WideString, PropertyPage, CollapsibleGroup }
	Describes kind of action to be taken from callbac. More...

Public Member Functions
unsafe void	AddApplyHandler (NXOpen.UIStyler.DialogItem.Apply applyevent, bool isDialogLaunchingEvent)
	Registers apply callback. More...

unsafe void	AddBackHandler (NXOpen.UIStyler.DialogItem.Back backevent, bool isDialogLaunchingEvent)
	Registers back callback. More...

unsafe void	AddCancelHandler (NXOpen.UIStyler.DialogItem.Cancel cancelevent, bool isDialogLaunchingEvent)
	Registers cancel callback. More...

unsafe void	AddConstructHandler (NXOpen.UIStyler.DialogItem.Construct constructevent, bool isDialogLaunchingEvent)
	Registers construct callback. More...

unsafe void	AddDestructHandler (NXOpen.UIStyler.DialogItem.Destruct destructevent, bool isDialogLaunchingEvent)
	Registers destruct callback. More...

unsafe void	AddFileOperationHandler (NXOpen.UIStyler.DialogItem.FileOperation fileoperationevent, bool isDialogLaunchingEvent)
	Registers file operation callback. More...

unsafe void	AddOkayHandler (NXOpen.UIStyler.DialogItem.Okay okayevent, bool isDialogLaunchingEvent)
	Registers ok callback. More...

unsafe void	AddPageSwitchHandler (NXOpen.UIStyler.DialogItem.PageSwitch switchevent, bool isDialogLaunchingEvent)
	Registers switch callback. More...

delegate NXOpen.UIStyler.DialogState	Apply (NXOpen.UIStyler.StylerEvent eventobject)
	Called when a dialog user clicks Apply or <Ctrl>MB2 anywhere in NX or presses the Apply's keyboard accelerator as defined in the resource file. More...

delegate NXOpen.UIStyler.DialogState	Back (NXOpen.UIStyler.StylerEvent eventobject)
	Called when a dialog user clicks Back <Shift>MB2 anywhere in NX or presses Back's keyboard accelerator as defined in the resource file. More...

delegate NXOpen.UIStyler.DialogState	Cancel (NXOpen.UIStyler.StylerEvent eventobject)
	Called when a dialog user clicks Cancel or <Alt>MB2 anywhere in NX or presses Cancel's keyboard accelerator as defined in the resource file. More...

delegate NXOpen.UIStyler.DialogState	Construct (NXOpen.UIStyler.StylerEvent eventobject)
	Called when the dialog displays. More...

delegate NXOpen.UIStyler.DialogState	Destruct (NXOpen.UIStyler.StylerEvent eventobject)
	Called when the dialog closes. More...

delegate NXOpen.UIStyler.DialogState	FileOperation (NXOpen.UIStyler.StylerEvent eventobject)
	Called just before a dialog user selects a file operation, such as in File?New, and again after a file operation completes. More...

unsafe NXOpen.SelectionHandle	GetSelectionHandle ()
	Gets the selection handle for a given dialog item More...

delegate NXOpen.UIStyler.DialogState	Okay (NXOpen.UIStyler.StylerEvent eventobject)
	Called when a dialog user clicks OK or MB2 anywhere in NX or presses the OK's keyboard accelerator as defined in the resource file. More...

delegate NXOpen.UIStyler.DialogState	PageSwitch (NXOpen.UIStyler.StylerEvent eventobject)
	Called when a user switches tabs. More...

unsafe void	SetNavigationSensitivity (NXOpen.UIStyler.DialogItem.DialogItemIndex subItemIndex, bool type)
	Specifies the sensitivity of the navigation buttons at the bottom of the dialog. More...

unsafe void	SetResize (bool type)
	Specifies wether dialog is allowed to resize More...

unsafe void	SetSensitivity (bool type)
	Specifies the sensitivity of the dialog. More...

unsafe void	SetTitle (string strLabel)
	Specifies a string to display on the top border of the dialog More...

unsafe void	SetWidth (int width)
	Specifies the pixel width for the dialog. More...

Public Member Functions inherited from NXOpen.UIStyler.StylerItem
unsafe NXOpen.UIStyler.StylerItem.ItemType	GetItemType ()
	Gets the dialog item type. More...

unsafe NXOpen.UIStyler.Attachment	InitializeAttachment ()
	Returns initialized dialog item attachment information More...

unsafe bool	IsEqualTo (NXOpen.UIStyler.StylerItem itemToCompare)
	Equates two styler items More...

unsafe void	SetAttachment (NXOpen.UIStyler.Attachment attachment)
	Specifies the updated dialog item attachment information 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...

Properties
unsafe NXOpen.UIStyler.FileOperationData	FileOperationData `[get]`
	Returns the file operation data More...

Additional Inherited Members
Protected Member Functions inherited from NXOpen.UIStyler.StylerItem
override void	FreeResource ()
	Free resources associated with the instance. More...

Detailed Description

Represents a DialogItem for UI Styler.

Created in NX5.0.0

Member Enumeration Documentation

enum NXOpen.UIStyler.DialogItem.DialogItemIndex

Describes dialog item index

Enumerator
Ok	Ok index
Apply	Apply index
Back	Back index
Cancel	Cancel index

Member Function Documentation

unsafe void NXOpen.UIStyler.DialogItem.AddApplyHandler	(	NXOpen.UIStyler.DialogItem.Apply	applyevent,
		bool	isDialogLaunchingEvent
	)

inline

Registers apply callback.

This method should be called before calling UIStyler.Dialog.Show or UIStyler.Dialog.RegisterWithUiMenu

Created in NX5.0.0

License requirements: None.

Parameters

applyevent
isDialogLaunchingEvent

unsafe void NXOpen.UIStyler.DialogItem.AddBackHandler	(	NXOpen.UIStyler.DialogItem.Back	backevent,
		bool	isDialogLaunchingEvent
	)

inline

Registers back callback.

This method should be called before calling UIStyler.Dialog.Show or UIStyler.Dialog.RegisterWithUiMenu

Created in NX5.0.0

License requirements: None.

Parameters

backevent
isDialogLaunchingEvent

unsafe void NXOpen.UIStyler.DialogItem.AddCancelHandler	(	NXOpen.UIStyler.DialogItem.Cancel	cancelevent,
		bool	isDialogLaunchingEvent
	)

inline

Registers cancel callback.

This method should be called before calling UIStyler.Dialog.Show or UIStyler.Dialog.RegisterWithUiMenu

Created in NX5.0.0

License requirements: None.

Parameters

cancelevent
isDialogLaunchingEvent

unsafe void NXOpen.UIStyler.DialogItem.AddConstructHandler	(	NXOpen.UIStyler.DialogItem.Construct	constructevent,
		bool	isDialogLaunchingEvent
	)

inline

Registers construct callback.

This method should be called before calling UIStyler.Dialog.Show or UIStyler.Dialog.RegisterWithUiMenu

Created in NX5.0.0

License requirements: None.

Parameters

constructevent
isDialogLaunchingEvent

unsafe void NXOpen.UIStyler.DialogItem.AddDestructHandler	(	NXOpen.UIStyler.DialogItem.Destruct	destructevent,
		bool	isDialogLaunchingEvent
	)

inline

Registers destruct callback.

This method should be called before calling UIStyler.Dialog.Show or UIStyler.Dialog.RegisterWithUiMenu

Created in NX5.0.0

License requirements: None.

Parameters

destructevent
isDialogLaunchingEvent

unsafe void NXOpen.UIStyler.DialogItem.AddFileOperationHandler	(	NXOpen.UIStyler.DialogItem.FileOperation	fileoperationevent,
		bool	isDialogLaunchingEvent
	)

inline

Registers file operation callback.

This method should be called before calling UIStyler.Dialog.Show or UIStyler.Dialog.RegisterWithUiMenu

Created in NX5.0.0

License requirements: None.

Parameters

fileoperationevent
isDialogLaunchingEvent

unsafe void NXOpen.UIStyler.DialogItem.AddOkayHandler	(	NXOpen.UIStyler.DialogItem.Okay	okayevent,
		bool	isDialogLaunchingEvent
	)

inline

Registers ok callback.

This method should be called before calling UIStyler.Dialog.Show or UIStyler.Dialog.RegisterWithUiMenu

Created in NX5.0.0

License requirements: None.

Parameters

okayevent
isDialogLaunchingEvent

unsafe void NXOpen.UIStyler.DialogItem.AddPageSwitchHandler	(	NXOpen.UIStyler.DialogItem.PageSwitch	switchevent,
		bool	isDialogLaunchingEvent
	)

inline

Registers switch callback.

This method should be called before calling UIStyler.Dialog.Show or UIStyler.Dialog.RegisterWithUiMenu

Created in NX8.5.3

License requirements: None.

Parameters

switchevent
isDialogLaunchingEvent

delegate NXOpen.UIStyler.DialogState NXOpen.UIStyler.DialogItem.Apply ( NXOpen.UIStyler.StylerEvent eventobject )

Called when a dialog user clicks Apply or <Ctrl>MB2 anywhere in NX or presses the Apply's keyboard accelerator as defined in the resource file.

Apply callbacks should not terminate the dialog and always return UF_UI_CB_CONTINUE_DIALOG.

Created in NX5.0.0

License requirements: None.

Parameters

eventobject Event object

delegate NXOpen.UIStyler.DialogState NXOpen.UIStyler.DialogItem.Back ( NXOpen.UIStyler.StylerEvent eventobject )

Called when a dialog user clicks Back <Shift>MB2 anywhere in NX or presses Back's keyboard accelerator as defined in the resource file.

Back callbacks should terminate the dialog and always return UF_UI_CB_EXIT_DIALOG.

Created in NX5.0.0

License requirements: None.

Parameters

eventobject Event object

delegate NXOpen.UIStyler.DialogState NXOpen.UIStyler.DialogItem.Cancel ( NXOpen.UIStyler.StylerEvent eventobject )

Called when a dialog user clicks Cancel or <Alt>MB2 anywhere in NX or presses Cancel's keyboard accelerator as defined in the resource file.

Cancel callbacks should terminate the dialog and always return UF_UI_CB_EXIT_DIALOG.

Created in NX5.0.0

License requirements: None.

Parameters

eventobject Event object

delegate NXOpen.UIStyler.DialogState NXOpen.UIStyler.DialogItem.Construct ( NXOpen.UIStyler.StylerEvent eventobject )

Called when the dialog displays.

You can use the Constructor callback to set up dialog item attributes such as populating a list or setting the sensitivity of a dialog item.

Created in NX5.0.0

License requirements: None.

Parameters

eventobject Event object

delegate NXOpen.UIStyler.DialogState NXOpen.UIStyler.DialogItem.Destruct ( NXOpen.UIStyler.StylerEvent eventobject )

Called when the dialog closes.

Use the Destructor callback to perform cleanup.

Created in NX5.0.0

License requirements: None.

Parameters

eventobject Event object

delegate NXOpen.UIStyler.DialogState NXOpen.UIStyler.DialogItem.FileOperation ( NXOpen.UIStyler.StylerEvent eventobject )

Called just before a dialog user selects a file operation, such as in File?New, and again after a file operation completes.

A typical use for a file operation callback would be to make sure that the system updates cached part data in a part before a dialog user executes a File?Save. The callback can determine from the callback data structure whether the file operation is about to begin or has just completed. It can also determine which operation is being executed. This callback is only used on DA1 dialogs because the DA2 dialogs are usually cancelled (automatically through the quick access menus) when a dialog user selects any of the File menu options.

Created in NX5.0.0

License requirements: None.

Parameters

eventobject Event object

unsafe NXOpen.SelectionHandle NXOpen.UIStyler.DialogItem.GetSelectionHandle ( )

inline

Gets the selection handle for a given dialog item

Created in NX5.0.0

License requirements: None.

Returns: Selection handle

delegate NXOpen.UIStyler.DialogState NXOpen.UIStyler.DialogItem.Okay ( NXOpen.UIStyler.StylerEvent eventobject )

Called when a dialog user clicks OK or MB2 anywhere in NX or presses the OK's keyboard accelerator as defined in the resource file.

OK callbacks should terminate the dialog and always return UF_UI_CB_EXIT_DIALOG.

Created in NX5.0.0

License requirements: None.

Parameters

eventobject Event object

delegate NXOpen.UIStyler.DialogState NXOpen.UIStyler.DialogItem.PageSwitch ( NXOpen.UIStyler.StylerEvent eventobject )

Called when a user switches tabs.

Created in NX8.5.3

License requirements: None.

Parameters

eventobject Event object

unsafe void NXOpen.UIStyler.DialogItem.SetNavigationSensitivity	(	NXOpen.UIStyler.DialogItem.DialogItemIndex	subItemIndex,
		bool	type
	)

inline

Specifies the sensitivity of the navigation buttons at the bottom of the dialog.

If you set the UF_STYLER_BACK_INDEX button to insensitive at creation time, the system does not show the BACK button; Changing the button's sensitivity while the dialog displays does not show the Back button.

Created in NX5.0.0

License requirements: None.

Parameters

subItemIndex	Sub item index
type	TRUE if sensitive, FALSE if insensitive

unsafe void NXOpen.UIStyler.DialogItem.SetResize ( bool type )

inline

Specifies wether dialog is allowed to resize

Created in NX5.0.0

License requirements: None.

Parameters

type	TRUE to allow dialog to resize; FALSE to freeze the dialog size

unsafe void NXOpen.UIStyler.DialogItem.SetSensitivity ( bool type )

inline

Specifies the sensitivity of the dialog.

Created in NX5.0.0

License requirements: None.

Parameters

type	TRUE if sensitive, FALSE if insensitive

unsafe void NXOpen.UIStyler.DialogItem.SetTitle ( string strLabel )

inline

Specifies a string to display on the top border of the dialog

Created in NX5.0.0

License requirements: None.

Parameters

strLabel

unsafe void NXOpen.UIStyler.DialogItem.SetWidth ( int width )

inline

Specifies the pixel width for the dialog.

You can only set this attribute when the Dialog Resize attribute is set to TRUE. You cannot enter a negative number.

Created in NX5.0.0

License requirements: None.

Parameters

width

Property Documentation

unsafe NXOpen.UIStyler.FileOperationData NXOpen.UIStyler.DialogItem.FileOperationData

get

Returns the file operation data

Created in NX5.0.0

License requirements: None.

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

UIStyler_DialogItem.cs

Classes

Public Types

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Member Function Documentation

Property Documentation