SessionUserInterfaceUI Class¶
-
class
NXOpen.Preferences.
SessionUserInterfaceUI
¶ Bases:
object
Represents all UI based session user interface preferneces.
Other User Interface settings are available with
NXOpen.Preferences.SessionUserInterface
for settings applicable to session and withNXOpen.Preferences.PartUserInterface
for User Interface Preferences applicable to part To obtain an instance of this class, refer toNXOpen.UI
New in version NX3.0.0.
Properties¶
Property | Description |
---|---|
ConfirmUndo | Returns or sets the confirm undo flag |
DialogBarDecimalPlaces | Returns or sets the dialog box decimal places |
DialogBarTracking | Returns or sets the dialog bar tracking flag |
DisplayAlertsOnInformation | Returns or 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. |
DisplayAlertsOnWarnings | Returns or 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. |
DisplayDialogsInPlayback | Returns or sets the display dialogs in playback flag |
DisplayResourceBarOption | Returns or sets the display resource bar option |
HomePageURL | Returns or sets the home page URL |
InitialDialogDisplay | Returns or sets the initial dialog display flag |
ListingDecimalPlaces | Returns or sets the listing decimal places |
PagesAutomaticallyFlyOut | Returns or sets the pages automatically fly outflag |
PauseDuration | Returns or sets the pause duration |
RecordAllTransform | Returns or sets the record all transform flag |
SaveLayoutAtExit | Returns or sets the save layout at exit flag. |
UseSystemPrecision | Returns or sets the use system precision flag. |
Methods¶
Method | Description |
---|---|
ResetDialogBoxSettings | Resets all dialog box settings |
Enumerations¶
SessionUserInterfaceUIDisplayResourceBar Enumeration | Describes whether the resource bar is displayed on left or right of window |
Property Detail¶
ConfirmUndo¶
-
SessionUserInterfaceUI.
ConfirmUndo
¶ Returns or sets the confirm undo flag
-------------------------------------
Getter Method
Signature
ConfirmUndo
Returns: Return type: bool New in version NX3.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ConfirmUndo
Parameters: confirmUndo (bool) – New in version NX3.0.0.
License requirements: None.
DialogBarDecimalPlaces¶
-
SessionUserInterfaceUI.
DialogBarDecimalPlaces
¶ Returns or sets the dialog box decimal places
-------------------------------------
Getter Method
Signature
DialogBarDecimalPlaces
Returns: Return type: int New in version NX3.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DialogBarDecimalPlaces
Parameters: dialogBarDecimalPlaces (int) – New in version NX3.0.0.
License requirements: None.
DialogBarTracking¶
-
SessionUserInterfaceUI.
DialogBarTracking
¶ Returns or sets the dialog bar tracking flag
-------------------------------------
Getter Method
Signature
DialogBarTracking
Returns: Return type: bool New in version NX3.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DialogBarTracking
Parameters: dialogBarTrackingFlag (bool) – New in version NX3.0.0.
License requirements: None.
DisplayAlertsOnInformation¶
-
SessionUserInterfaceUI.
DisplayAlertsOnInformation
¶ Returns or 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`()
for display of alerts on warnings. Alerts are always displayed for errors and display of alerts on errors can not be changed.-------------------------------------
Getter Method
Signature
DisplayAlertsOnInformation
Returns: preference to display Diagnostic Alerts on Information Messages :rtype: bool
New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DisplayAlertsOnInformation
Parameters: displayAlertsOnInformation (bool) – preference to display Diagnostic Alerts on Information Messages New in version NX7.5.0.
License requirements: None.
DisplayAlertsOnWarnings¶
-
SessionUserInterfaceUI.
DisplayAlertsOnWarnings
¶ Returns or 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`()
for display of alerts on information messages. Alerts are always displayed for errors and display of alerts on errors can not be changed.-------------------------------------
Getter Method
Signature
DisplayAlertsOnWarnings
Returns: preference to display Diagnostic Alerts on Warnings :rtype: bool
New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DisplayAlertsOnWarnings
Parameters: displayAlertsOnWarnings (bool) – preference to display Diagnostic Alerts on Warnings New in version NX7.5.0.
License requirements: None.
DisplayDialogsInPlayback¶
-
SessionUserInterfaceUI.
DisplayDialogsInPlayback
¶ Returns or sets the display dialogs in playback flag
-------------------------------------
Getter Method
Signature
DisplayDialogsInPlayback
Returns: Return type: bool New in version NX3.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DisplayDialogsInPlayback
Parameters: displayDialogInPlaybackFlag (bool) – New in version NX3.0.0.
License requirements: None.
DisplayResourceBarOption¶
-
SessionUserInterfaceUI.
DisplayResourceBarOption
¶ Returns or sets the display resource bar option
-------------------------------------
Getter Method
Signature
DisplayResourceBarOption
Returns: Return type: NXOpen.Preferences.SessionUserInterfaceUIDisplayResourceBar
New in version NX3.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DisplayResourceBarOption
Parameters: displayResourceBar ( NXOpen.Preferences.SessionUserInterfaceUIDisplayResourceBar
) –New in version NX3.0.0.
License requirements: None.
HomePageURL¶
-
SessionUserInterfaceUI.
HomePageURL
¶ Returns or sets the home page URL
-------------------------------------
Getter Method
Signature
HomePageURL
Returns: Return type: str New in version NX3.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
HomePageURL
Parameters: homePageUrl (str) – New in version NX3.0.0.
License requirements: None.
InitialDialogDisplay¶
-
SessionUserInterfaceUI.
InitialDialogDisplay
¶ Returns or sets the initial dialog display flag
-------------------------------------
Getter Method
Signature
InitialDialogDisplay
Returns: Return type: bool New in version NX4.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
InitialDialogDisplay
Parameters: initialDialogDisplay (bool) – New in version NX4.0.0.
License requirements: None.
ListingDecimalPlaces¶
-
SessionUserInterfaceUI.
ListingDecimalPlaces
¶ Returns or sets the listing decimal places
-------------------------------------
Getter Method
Signature
ListingDecimalPlaces
Returns: Return type: int New in version NX3.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ListingDecimalPlaces
Parameters: listingDecimalPlaces (int) – New in version NX3.0.0.
License requirements: None.
PagesAutomaticallyFlyOut¶
-
SessionUserInterfaceUI.
PagesAutomaticallyFlyOut
¶ Returns or sets the pages automatically fly outflag
-------------------------------------
Getter Method
Signature
PagesAutomaticallyFlyOut
Returns: Return type: bool New in version NX3.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
PagesAutomaticallyFlyOut
Parameters: pagesAutomaticallyFlyOut (bool) – New in version NX3.0.0.
License requirements: None.
PauseDuration¶
-
SessionUserInterfaceUI.
PauseDuration
¶ Returns or sets the pause duration
-------------------------------------
Getter Method
Signature
PauseDuration
Returns: Return type: int New in version NX3.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
PauseDuration
Parameters: pauseDuration (int) – New in version NX3.0.0.
License requirements: None.
RecordAllTransform¶
-
SessionUserInterfaceUI.
RecordAllTransform
¶ Returns or sets the record all transform flag
-------------------------------------
Getter Method
Signature
RecordAllTransform
Returns: Return type: bool New in version NX3.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
RecordAllTransform
Parameters: recordAllTransformFlag (bool) – New in version NX3.0.0.
License requirements: None.
SaveLayoutAtExit¶
-
SessionUserInterfaceUI.
SaveLayoutAtExit
¶ Returns or sets the save layout at exit flag.
-------------------------------------
Getter Method
Signature
SaveLayoutAtExit
Returns: Return type: bool New in version NX3.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SaveLayoutAtExit
Parameters: saveLayoutFlag (bool) – New in version NX3.0.0.
License requirements: None.
UseSystemPrecision¶
-
SessionUserInterfaceUI.
UseSystemPrecision
¶ Returns or sets the use system precision flag.
True uses the system precision
-------------------------------------
Getter Method
Signature
UseSystemPrecision
Returns: Return type: bool New in version NX3.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
UseSystemPrecision
Parameters: useSystemPrecision (bool) – New in version NX3.0.0.
License requirements: None.