ApplicationSettings

Inheritance

The ApplicationSettings object is derived from the Settings object.

Usage locations

The ApplicationSettings object can be accessed from the following locations:

Usage locations

The ApplicationSettings object can be accessed from the following locations:

Property List

AbsoluteFilePath
The full path of the project file (directory path and file name including the file extension). (Read only string)
AbsolutePath
The full directory path of the project file (directory path excluding the file name and extension). (Read only string)
Label
The object label. (Read/Write string)
Type
The object type string. (Read only string)

Property List (internal only)

AvailableFontFamilies
(Read only string)
BackupBeforeFirstSave
(Read/Write boolean)
CablesRibbonTabActive
(Read/Write boolean)
ComponentSettings
(Read only ComponentLaunchOptions)
DriverSettings
(Read only DriverSettings)
Encrypted
(Read only boolean)
FileName
(Read only string)
KeyboardShortcutSettings
(Read only KeyboardShortcutSettings)
LuaScriptSettings
(Read only ScriptSettings)
MainWindowSettings
(Read only MainWindowSettings)
ModelSettings
(Read only ModelSettings)
MouseBindingSettings
(Read only MouseBindingSettings)
NotesEditorSettings
(Read only NotesEditorSettings)
Path
(Read only string)
ScriptEditorSettings
(Read only ScriptEditorSettings)
ScriptRecorderSettings
(Read only ScriptRecorderSettings)
SessionSettings
(Read only AccessedFileHistory)
ToolSettings
(Read only BaseToolSettings)
UserAccessible
(Read only boolean)
WindscreenRibbonTabActive
(Read/Write boolean)

Method List

Delete ()
Deletes the entity.
Duplicate ()
Duplicates the entity. (Returns a Object object.)
GetProperties ()
Returns a table of properties representing the state of the object. The properties table can be used with the SetProperties method to change multiple properties of the object in one step. (Returns a table object.)
SetProperties (properties Object)
Modifies the state of the object using the provided table of properties. This method is used to modify multiple properties of the object in a single step.

Method List (internal only)

StreamFromFile ( string)
StreamToFile ( string)
StreamToXmlFile ( string)

Static Function List

GetDefaultProperties ()
Creates a table containing the default settings to create an object. (Returns a table object.)

Property Details

AbsoluteFilePath
The full path of the project file (directory path and file name including the file extension).
Type
string
Access
Read only
AbsolutePath
The full directory path of the project file (directory path excluding the file name and extension).
Type
string
Access
Read only
Label
The object label.
Type
string
Access
Read/Write
Type
The object type string.
Type
string
Access
Read only

Property Details (internal only)

AvailableFontFamilies
Type
string
Access
Read only
BackupBeforeFirstSave
Type
boolean
Access
Read/Write
CablesRibbonTabActive
Type
boolean
Access
Read/Write
ComponentSettings
Type
ComponentLaunchOptions
Access
Read only
DriverSettings
Type
DriverSettings
Access
Read only
Encrypted
Type
boolean
Access
Read only
FileName
Type
string
Access
Read only
KeyboardShortcutSettings
Type
KeyboardShortcutSettings
Access
Read only
LuaScriptSettings
Type
ScriptSettings
Access
Read only
MainWindowSettings
Type
MainWindowSettings
Access
Read only
ModelSettings
Type
ModelSettings
Access
Read only
MouseBindingSettings
Type
MouseBindingSettings
Access
Read only
NotesEditorSettings
Type
NotesEditorSettings
Access
Read only
Path
Type
string
Access
Read only
ScriptEditorSettings
Type
ScriptEditorSettings
Access
Read only
ScriptRecorderSettings
Type
ScriptRecorderSettings
Access
Read only
SessionSettings
Type
AccessedFileHistory
Access
Read only
ToolSettings
Type
BaseToolSettings
Access
Read only
UserAccessible
Type
boolean
Access
Read only
WindscreenRibbonTabActive
Type
boolean
Access
Read/Write

Method Details

Delete ()
Deletes the entity.
Duplicate ()
Duplicates the entity.
Return
Object
The new (duplicated) entity.
GetProperties ()
Returns a table of properties representing the state of the object. The properties table can be used with the SetProperties method to change multiple properties of the object in one step.
Return
table
A table defining the properties.
SetProperties (properties Object)
Modifies the state of the object using the provided table of properties. This method is used to modify multiple properties of the object in a single step.
Input Parameters
properties(Object)
A table of properties defining the new state of the object.

Method Details (internal only)

StreamFromFile ( string)
Input Parameters
(string)
StreamToFile ( string)
Input Parameters
(string)
StreamToXmlFile ( string)
Input Parameters
(string)

Static Function Details

GetDefaultProperties ()
Creates a table containing the default settings to create an object.
Return
table
A table containing the default properties.