NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::Preferences::SessionUserInterfaceUI Class Reference

Represents all UI based session user interface preferneces. More...

List of all members.

Public Types

enum  DisplayResourceBar { DisplayResourceBarLeft, DisplayResourceBarRight }
 Describes whether the resource bar is displayed on left or right of window. More...

Public Member Functions

bool ConfirmUndo ()
 Returns the confirm undo flag
Created in NX3.0.0.
int DialogBarDecimalPlaces ()
 Returns the dialog box decimal places
Created in NX3.0.0.
bool DialogBarTracking ()
 Returns the dialog bar tracking flag
Created in NX3.0.0.
bool DisplayAlertsOnInformation ()
 Returns the option "Display Alerts on Information" gives choice, whether the user wants the Diagnostic alerts appear when features contain information messages during feature creation, edit, and update.
bool DisplayAlertsOnWarnings ()
 Returns the option "Display Alerts on Warnings" gives choice, whether the user wants the Diagnostic alerts appear when features contain warnings during feature creation, edit, and update.
bool DisplayDialogsInPlayback ()
 Returns the display dialogs in playback flag
Created in NX3.0.0.
NXOpen::Preferences::SessionUserInterfaceUI::DisplayResourceBar DisplayResourceBarOption ()
 Returns the display resource bar option
Created in NX3.0.0.
NXString HomePageURL ()
 Returns the home page URL
Created in NX3.0.0.
bool InitialDialogDisplay ()
 Returns the initial dialog display flag
Created in NX4.0.0.
int ListingDecimalPlaces ()
 Returns the listing decimal places
Created in NX3.0.0.
bool PagesAutomaticallyFlyOut ()
 Returns the pages automatically fly outflag
Created in NX3.0.0.
int PauseDuration ()
 Returns the pause duration
Created in NX3.0.0.
bool RecordAllTransform ()
 Returns the record all transform flag
Created in NX3.0.0.
void ResetDialogBoxSettings ()
 Resets all dialog box settings
Created in NX6.0.0.
bool SaveLayoutAtExit ()
 Returns the save layout at exit flag.
void SetConfirmUndo (bool confirmUndo)
 Sets the confirm undo flag
Created in NX3.0.0.
void SetDialogBarDecimalPlaces (int dialogBarDecimalPlaces)
 Sets the dialog box decimal places
Created in NX3.0.0.
void SetDialogBarTracking (bool dialogBarTrackingFlag)
 Sets the dialog bar tracking flag
Created in NX3.0.0.
void SetDisplayAlertsOnInformation (bool displayAlertsOnInformation)
 Sets the option "Display Alerts on Information" gives choice, whether the user wants the Diagnostic alerts appear when features contain information messages during feature creation, edit, and update.
void SetDisplayAlertsOnWarnings (bool displayAlertsOnWarnings)
 Sets the option "Display Alerts on Warnings" gives choice, whether the user wants the Diagnostic alerts appear when features contain warnings during feature creation, edit, and update.
void SetDisplayDialogsInPlayback (bool displayDialogInPlaybackFlag)
 Sets the display dialogs in playback flag
Created in NX3.0.0.
void SetDisplayResourceBarOption (NXOpen::Preferences::SessionUserInterfaceUI::DisplayResourceBar displayResourceBar)
 Sets the display resource bar option
Created in NX3.0.0.
void SetHomePageURL (const NXString &homePageUrl)
 Sets the home page URL
Created in NX3.0.0.
void SetInitialDialogDisplay (bool initialDialogDisplay)
 Sets the initial dialog display flag
Created in NX4.0.0.
void SetListingDecimalPlaces (int listingDecimalPlaces)
 Sets the listing decimal places
Created in NX3.0.0.
void SetPagesAutomaticallyFlyOut (bool pagesAutomaticallyFlyOut)
 Sets the pages automatically fly outflag
Created in NX3.0.0.
void SetPauseDuration (int pauseDuration)
 Sets the pause duration
Created in NX3.0.0.
void SetRecordAllTransform (bool recordAllTransformFlag)
 Sets the record all transform flag
Created in NX3.0.0.
void SetSaveLayoutAtExit (bool saveLayoutFlag)
 Sets the save layout at exit flag.
void SetUseSystemPrecision (bool useSystemPrecision)
 Sets the use system precision flag.
tag_t Tag () const
 Returns the tag of this object.
bool UseSystemPrecision ()
 Returns the use system precision flag.

Detailed Description

Represents all UI based session user interface preferneces.

Other User Interface settings are available with SessionUserInterface for settings applicable to session and with PartUserInterface for User Interface Preferences applicable to part
To obtain an instance of this class, refer to UI

Created in NX3.0.0.


Member Enumeration Documentation

Describes whether the resource bar is displayed on left or right of window.

Enumerator:
DisplayResourceBarLeft 

left

DisplayResourceBarRight 

right


Member Function Documentation

Returns the confirm undo flag
Created in NX3.0.0.



License requirements : None

Returns the dialog box decimal places
Created in NX3.0.0.



License requirements : None

Returns the dialog bar tracking flag
Created in NX3.0.0.



License requirements : None

Returns the option "Display Alerts on Information" gives choice, whether the user wants the Diagnostic alerts appear when features contain information messages during feature creation, edit, and update.

if the option is true then the diagnostic alerts will appear. if the option is false then diagnostic alerts will not appear. Use DisplayAlertsOnWarnings and SetDisplayAlertsOnWarnings for display of alerts on warnings. Alerts are always displayed for errors and display of alerts on errors can not be changed.
Created in NX7.5.0.

License requirements : None

Returns the option "Display Alerts on Warnings" gives choice, whether the user wants the Diagnostic alerts appear when features contain warnings during feature creation, edit, and update.

if the option is true then the diagnostic alerts will appear. if the option is false then diagnostic alerts will not appear. Use DisplayAlertsOnInformation and SetDisplayAlertsOnInformation for display of alerts on information messages. Alerts are always displayed for errors and display of alerts on errors can not be changed.
Created in NX7.5.0.

License requirements : None

Returns the display dialogs in playback flag
Created in NX3.0.0.



License requirements : None

Returns the display resource bar option
Created in NX3.0.0.



License requirements : None

Returns the home page URL
Created in NX3.0.0.



License requirements : None

Returns the initial dialog display flag
Created in NX4.0.0.



License requirements : None

Returns the listing decimal places
Created in NX3.0.0.



License requirements : None

Returns the pages automatically fly outflag
Created in NX3.0.0.



License requirements : None

Returns the pause duration
Created in NX3.0.0.



License requirements : None

Returns the record all transform flag
Created in NX3.0.0.



License requirements : None

Resets all dialog box settings
Created in NX6.0.0.



License requirements : None

Returns the save layout at exit flag.


Created in NX3.0.0.

License requirements : None

Sets the confirm undo flag
Created in NX3.0.0.



License requirements : None

Parameters:
confirmUndoconfirm undo

Sets the dialog box decimal places
Created in NX3.0.0.



License requirements : None

Parameters:
dialogBarDecimalPlacesdialog bar decimal places

Sets the dialog bar tracking flag
Created in NX3.0.0.



License requirements : None

Parameters:
dialogBarTrackingFlagdialog bar tracking flag

Sets the option "Display Alerts on Information" gives choice, whether the user wants the Diagnostic alerts appear when features contain information messages during feature creation, edit, and update.

if the option is true then the diagnostic alerts will appear. if the option is false then diagnostic alerts will not appear. Use DisplayAlertsOnWarnings and SetDisplayAlertsOnWarnings for display of alerts on warnings. Alerts are always displayed for errors and display of alerts on errors can not be changed.
Created in NX7.5.0.

License requirements : None

Parameters:
displayAlertsOnInformationpreference to display Diagnostic Alerts on Information Messages

Sets the option "Display Alerts on Warnings" gives choice, whether the user wants the Diagnostic alerts appear when features contain warnings during feature creation, edit, and update.

if the option is true then the diagnostic alerts will appear. if the option is false then diagnostic alerts will not appear. Use DisplayAlertsOnInformation and SetDisplayAlertsOnInformation for display of alerts on information messages. Alerts are always displayed for errors and display of alerts on errors can not be changed.
Created in NX7.5.0.

License requirements : None

Parameters:
displayAlertsOnWarningspreference to display Diagnostic Alerts on Warnings

Sets the display dialogs in playback flag
Created in NX3.0.0.



License requirements : None

Parameters:
displayDialogInPlaybackFlagdisplay dialog in playback flag

Sets the display resource bar option
Created in NX3.0.0.



License requirements : None

Parameters:
displayResourceBardisplay resource bar

Sets the home page URL
Created in NX3.0.0.



License requirements : None

Parameters:
homePageUrlhome page url

Sets the initial dialog display flag
Created in NX4.0.0.



License requirements : None

Parameters:
initialDialogDisplayinitial dialog display

Sets the listing decimal places
Created in NX3.0.0.



License requirements : None

Parameters:
listingDecimalPlaceslisting decimal places

Sets the pages automatically fly outflag
Created in NX3.0.0.



License requirements : None

Parameters:
pagesAutomaticallyFlyOutpages automatically fly out

Sets the pause duration
Created in NX3.0.0.



License requirements : None

Parameters:
pauseDurationpause duration

Sets the record all transform flag
Created in NX3.0.0.



License requirements : None

Parameters:
recordAllTransformFlagrecord all transform flag

Sets the save layout at exit flag.


Created in NX3.0.0.

License requirements : None

Parameters:
saveLayoutFlagsave layout flag

Sets the use system precision flag.

True uses the system precision
Created in NX3.0.0.

License requirements : None

Parameters:
useSystemPrecisionuse system precision

Returns the tag of this object.

Returns the use system precision flag.

True uses the system precision
Created in NX3.0.0.

License requirements : None


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