This class contains the various elements that represent the NX User Interface. More...

Inheritance diagram for NXOpen.UI:

Classes
class	_UIUtilityFunctionVisibilityHandlerAdapter

Public Types
enum	Status { Lock, Unlock }
	Indicates the Lock, Unlock status of NX functions. More...

Public Member Functions
unsafe int	AddUtilityFunctionVisibilityHandler (NXOpen.UI.UtilityFunctionVisibilityHandler utilityFunctionVisibilityHandler)
	Registers a user defined method that is called whenever an utility function state changes. More...

unsafe NXOpen.UI.Status	AskLockStatus ()
	Query NX lock status. More...

unsafe bool	CanOpenPart ()
	Returns a flag indicating whether the NX user interface is in a state where opening a part and making it the display part is supported. More...

unsafe NXOpen.CustomPopupMenuHandler	CreateCustomPopupMenuHandler ()
	Create a custom menu. More...

unsafe NXOpen.BlockStyler.BlockDialog	CreateDialog (string dialogName)
	Creates a block dialog. More...

unsafe NXOpen.Gateway.ImageExportBuilder	CreateImageExportBuilder ()
	Creates a NXOpen.Gateway.ImageExportBuilder More...

unsafe NXOpen.BlockStyler.SnapBlockDialog	CreateSnapDialog (string dialogName)
	Creates a snap dialog. More...

unsafe void	JournalPause ()
	Pauses execution of a journal. More...

unsafe void	LockAccess ()
	Locks access to the NX User Interface. More...

unsafe void	RemoveUtilityFunctionVisibilityHandler (int id)
	Unregisters a user defined method that is called whenever an utility function state changes. More...

unsafe void	UnlockAccess ()
	Unlocks access for a UI that has been locked by a call to LockAccess . More...

delegate void	UtilityFunctionVisibilityHandler (bool visible)
	User defined method is called whenever an NX utility function state changes. 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
NXOpen.MenuBar.MenuBarManager	MenuBarManager `[get]`
	Returns the NXOpen.MenuBar.MenuBarManager belonging to the current session More...

NXOpen.MovieManager	MovieManager `[get]`
	the Movie Manager class. More...

NXOpen.NXMessageBox	NXMessageBox `[get]`
	the Uistyler for the current session. More...

NXOpen.Preferences.ObjectPreferences	ObjectPreferences `[get]`
	the UI based Object Preferences in the current session. More...

NXOpen.Selection	SelectionManager `[get]`
	the SelectionManager for the current session. More...

NXOpen.UIStyler.Styler	Styler `[get]`
	the Uistyler for the current session. More...

NXOpen.Preferences.SessionUserInterfaceUI	UserInterfacePreferences `[get]`
	the UI based User Interface Preferences in the current session More...

NXOpen.ViewUIManager	ViewUIManager `[get]`
	Returns the ViewUIManager More...

NXOpen.Preferences.VisualizationLine	VisualizationLinePreferences `[get]`
	the UI based Visualization Preferences under Line Tab in the current session More...

NXOpen.Preferences.SessionVisualizationShade	VisualizationShadingPreferences `[get]`
	the UI based Visualization Preferences under Shading Tab in the current session More...

NXOpen.Preferences.SessionVisualizationVisual	VisualizationVisualPreferences `[get]`
	the UI based Visualization Preferences under Visual Tab in the current session 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...

Detailed Description

This class contains the various elements that represent the NX User Interface.

There is a single instance of this class per session. To obtain a reference to the current UI, call the static method UI.GetUI .

For Java, use

SessionFactory::get("UI")

to obtain the reference of the current UI.

For language bindings that support remoting, the server must export it for this class to be obtained by a client.

Use the static method in this class to obtain an instance.

Created in NX3.0.0

Member Enumeration Documentation

enum NXOpen.UI.Status

Indicates the Lock, Unlock status of NX functions.

Enumerator
Lock	Lock status
Unlock	Unlock status

Member Function Documentation

unsafe int NXOpen.UI.AddUtilityFunctionVisibilityHandler ( NXOpen.UI.UtilityFunctionVisibilityHandler utilityFunctionVisibilityHandler )

inline

Registers a user defined method that is called whenever an utility function state changes.

Created in NX5.0.5

License requirements: None.

Parameters

utilityFunctionVisibilityHandler

Returns: identifier of registered method (used to unregister the method)

unsafe NXOpen.UI.Status NXOpen.UI.AskLockStatus ( )

inline

Query NX lock status.

This function is useful when dismissing a custom dialog and you want to determine whether or not a lock has been set. Returns NXOpen.UI.Status.Lock , when NX is in lock status. Returns NXOpen.UI.Status.Unlock , when NX is in unlock status.

Created in NX5.0.0

License requirements: None.

Returns

unsafe bool NXOpen.UI.CanOpenPart ( )

inline

Returns a flag indicating whether the NX user interface is in a state where opening a part and making it the display part is supported.

For example if certain dialogs are displayed or the system is in a task environment it is not supported

Created in NX8.5.0

License requirements: None.

Returns

unsafe NXOpen.CustomPopupMenuHandler NXOpen.UI.CreateCustomPopupMenuHandler ( )

inline

Create a custom menu.

Created in NX6.0.4

License requirements: None.

Returns

unsafe NXOpen.BlockStyler.BlockDialog NXOpen.UI.CreateDialog ( string dialogName )

inline

Creates a block dialog.

Use

#undef CreateDialog

in C++ programs to avoid confusion with Windows API

Created in NX6.0.0

License requirements: None.

Parameters

dialogName Dialog name

Returns

unsafe NXOpen.Gateway.ImageExportBuilder NXOpen.UI.CreateImageExportBuilder ( )

inline

Creates a NXOpen.Gateway.ImageExportBuilder

Created in NX12.0.1

License requirements: None.

Returns

unsafe NXOpen.BlockStyler.SnapBlockDialog NXOpen.UI.CreateSnapDialog ( string dialogName )

inline

Creates a snap dialog.

Created in NX8.5.0

License requirements: None.

Parameters

dialogName Dialog name

Returns

unsafe void NXOpen.UI.JournalPause ( )

inline

Pauses execution of a journal.

Created in NX4.0.0

License requirements: None.

unsafe void NXOpen.UI.LockAccess ( )

inline

Locks access to the NX User Interface.

This method may be used for a custom dialog that requires the session to remain in a known state. When this method is called, all menu items that would allow the user to edit the model are grayed out.

Note that until UnlockAccess is called, the user will not be able to interact with the session. You must ensure that the UI is unlocked when the custom dialog terminates.

This method will throw an exception if the UI cannot be locked. Note that if the UI has already been locked, then it is safe to call this method again.

Created in NX3.0.0

License requirements: None.

unsafe void NXOpen.UI.RemoveUtilityFunctionVisibilityHandler ( int id )

inline

Unregisters a user defined method that is called whenever an utility function state changes.

Created in NX5.0.5

License requirements: None.

Parameters

id	identifier for method to unregister

unsafe void NXOpen.UI.UnlockAccess ( )

inline

Unlocks access for a UI that has been locked by a call to LockAccess .

If the UI is already unlocked, this method has no effect.

Created in NX3.0.0

License requirements: None.

delegate void NXOpen.UI.UtilityFunctionVisibilityHandler ( bool visible )

User defined method is called whenever an NX utility function state changes.

An example of a NX utility function is the Preferences - User Interface dialog.

The input parameter, visible is true when the function becomes visible and false when the function is no longer visible.

NX utility functions can be nested. The following scenario describes when this method is called for a function call in the middle of another function and then exiting both functions:

First utility function call 
UtilityFunctionVisibilityHandler - visible == true 
  Second utility function call while the first utility function is still visible 
  UtilityFunctionVisibilityHandler - visible == true 
  Second utility function exit 
  UtilityFunctionVisibilityHandler - visible == false 
First utility function exit 
UtilityFunctionVisibilityHandler - visible == false 

Created in NX5.0.5

License requirements: None.

Parameters

visible

Property Documentation

NXOpen.MenuBar.MenuBarManager NXOpen.UI.MenuBarManager

get

Returns the NXOpen.MenuBar.MenuBarManager belonging to the current session

Created in NX3.0.0

NXOpen.MovieManager NXOpen.UI.MovieManager

get

the Movie Manager class.

Created in NX3.0.0

NXOpen.NXMessageBox NXOpen.UI.NXMessageBox

get

the Uistyler for the current session.

Created in NX3.0.0

NXOpen.Preferences.ObjectPreferences NXOpen.UI.ObjectPreferences

get

the UI based Object Preferences in the current session.

Created in NX3.0.0

NXOpen.Selection NXOpen.UI.SelectionManager

get

the SelectionManager for the current session.

Created in NX3.0.0

NXOpen.UIStyler.Styler NXOpen.UI.Styler

get

the Uistyler for the current session.

Created in NX3.0.0

NXOpen.Preferences.SessionUserInterfaceUI NXOpen.UI.UserInterfacePreferences

get

the UI based User Interface Preferences in the current session

Created in NX3.0.0

NXOpen.ViewUIManager NXOpen.UI.ViewUIManager

get

Returns the ViewUIManager

Created in NX11.0.1

NXOpen.Preferences.VisualizationLine NXOpen.UI.VisualizationLinePreferences

get

the UI based Visualization Preferences under Line Tab in the current session

Created in NX3.0.0

NXOpen.Preferences.SessionVisualizationShade NXOpen.UI.VisualizationShadingPreferences

get

the UI based Visualization Preferences under Shading Tab in the current session

Created in NX3.0.0

NXOpen.Preferences.SessionVisualizationVisual NXOpen.UI.VisualizationVisualPreferences

get

the UI based Visualization Preferences under Visual Tab in the current session

Created in NX3.0.0

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

UI.cs

Classes

Public Types

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Member Function Documentation

Property Documentation