NXOpen::Preferences::SessionUserInterface Class Reference

Represents the set of User Interface preferences applicable to entire session. More...

Public Types
enum	JournalFileFormatType { JournalFileFormatTypeAscii, JournalFileFormatTypeUnicode, JournalFileFormatTypeUnicodeBigEndian, JournalFileFormatTypeUtf8 }
	Describes the available format types for a journal file. More...
enum	JournalLanguageType { JournalLanguageTypeVisualBasic, JournalLanguageTypeCPlusPlus, JournalLanguageTypeJava, JournalLanguageTypeCs }
	Describes the language used to record journals. More...

Public Member Functions
bool	InsetMenuDialogComments ()
	Returns the insert menu/dialog comments flag Created in NX3.0.0.
NXOpen::Preferences::SessionUserInterface::JournalFileFormatType	JournalFileFormat ()
	Returns the journal file format Created in NX3.0.0.
NXOpen::Preferences::SessionUserInterface::JournalLanguageType	JournalLanguage ()
	Returns the journal language.
void	SetInsetMenuDialogComments (bool insetMenuDialogComments)
	Sets the insert menu/dialog comments flag Created in NX3.0.0.
void	SetJournalFileFormat (NXOpen::Preferences::SessionUserInterface::JournalFileFormatType journalFileFormat)
	Sets the journal file format Created in NX3.0.0.
void	SetJournalLanguage (NXOpen::Preferences::SessionUserInterface::JournalLanguageType language)
	Sets the journal language.
tag_t	Tag () const
	Returns the tag of this object.

Detailed Description

Represents the set of User Interface preferences applicable to entire session.

Other User Interface settings are available with PartUserInterface for settings applicable to part and with the SessionUserInterfaceUI class for UI based User Interface Preferences
To obtain an instance of this class, refer to Preferences::SessionPreferences

Created in NX3.0.0.

Member Enumeration Documentation

enum NXOpen::Preferences::SessionUserInterface::JournalFileFormatType

Describes the available format types for a journal file.

Enumerator:

JournalFileFormatTypeAscii	Ascii.
JournalFileFormatTypeUnicode	Unicode.
JournalFileFormatTypeUnicodeBigEndian	Unicode Big Endian.
JournalFileFormatTypeUtf8	UTF 8.

enum NXOpen::Preferences::SessionUserInterface::JournalLanguageType

Describes the language used to record journals.

Enumerator:

JournalLanguageTypeVisualBasic	visual basic
JournalLanguageTypeCPlusPlus	C++ restricts the file format to Ascii.
JournalLanguageTypeJava	java
JournalLanguageTypeCs	cs

Member Function Documentation

bool NXOpen::Preferences::SessionUserInterface::InsetMenuDialogComments

(

)

Returns the insert menu/dialog comments flag
Created in NX3.0.0.

License requirements : None

NXOpen::Preferences::SessionUserInterface::JournalFileFormatType NXOpen::Preferences::SessionUserInterface::JournalFileFormat

(

)

Returns the journal file format
Created in NX3.0.0.

License requirements : None

NXOpen::Preferences::SessionUserInterface::JournalLanguageType NXOpen::Preferences::SessionUserInterface::JournalLanguage

(

)

Returns the journal language.

Setting the journal language to C++ restricts the file format to Ascii.
Created in NX3.0.0.

License requirements : None

void NXOpen::Preferences::SessionUserInterface::SetInsetMenuDialogComments

(

bool

insetMenuDialogComments

)

Sets the insert menu/dialog comments flag
Created in NX3.0.0.

License requirements : None

Parameters

insetMenuDialogComments

inset menu dialog comments

void NXOpen::Preferences::SessionUserInterface::SetJournalFileFormat

(

NXOpen::Preferences::SessionUserInterface::JournalFileFormatType

journalFileFormat

)

Sets the journal file format
Created in NX3.0.0.

License requirements : None

Parameters

journalFileFormat

journal file format

void NXOpen::Preferences::SessionUserInterface::SetJournalLanguage

(

NXOpen::Preferences::SessionUserInterface::JournalLanguageType

language

)

Sets the journal language.

Setting the journal language to C++ restricts the file format to Ascii.
Created in NX3.0.0.

License requirements : None

Parameters

language

language

tag_t NXOpen::Preferences::SessionUserInterface::Tag

(

)

const

Returns the tag of this object.

---

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

• Preferences_SessionUserInterface.hxx