flexiciousNmsp.UserSettingsOptions Class
Class responsible for storing information about the user preference persistence settings
Constructor
flexiciousNmsp.UserSettingsOptions
()
Item Index
Properties
- allowClearOnCorruption
- multiPrefDelimiter
- multiPrefGridPrefPropDelimiter
- multiPrefPrefPropDelimiter
- openSettingsPopupRenderer
- persistable
- prefColDelimiter
- prefColPrefDelimiter
- prefCustomDataDelimiter
- prefDelimiter
- saveSettingsPopupRenderer
- settingsPopupRenderer
- showErrorMessageWhenCorrupt
- silentFailure
- useCompactPreferences
- userWidthsOverrideFitToContent
Properties
allowClearOnCorruption
Boolean
If for any reason, the preferences become corrupt, prompt the user to clear them as opposed to throwing an error?
Default: true
multiPrefDelimiter
String
The delimiter that separates two preferences from each other
Default: $|
multiPrefGridPrefPropDelimiter
String
The delimiter that separates the properties of the GridPreferencesInfo object
Default: *|
multiPrefPrefPropDelimiter
String
The delimiter that separates the properties of the PreferenceInfo object
Default: %|
openSettingsPopupRenderer
flexiciousNmsp.ClassFactory
Class responsible for showing the UI that prompts the user to save or clear preferences
persistable
Null
The IPersistable being persisted
Default: null
prefColDelimiter
String
The delimiter that separates the string for two columns within a single preference
Default: @|
prefColPrefDelimiter
String
The delimiter that separates the string for two preferences within columns within a single preference
Default: &|
prefCustomDataDelimiter
String
The delimiter that separates the IPersistables data from custom data
Default: #|
prefDelimiter
String
The delimiter that separates the string for two preferences, defaults to ~|
Default: ~|
saveSettingsPopupRenderer
flexiciousNmsp.ClassFactory
Class responsible for showing the UI that prompts the user to save or clear preferences
settingsPopupRenderer
flexiciousNmsp.ClassFactory
Class responsible for showing the UI that prompts the user to display the preferences
showErrorMessageWhenCorrupt
String
If for any reason, the preferences become corrupt, prompt the user to clear them as opposed to throwing an error, and in the prompt, the error message to show?
Default: Error occurred while applying preferences: __ERRORMESSAGE__. Do you wish to clear preferences?
silentFailure
Boolean
If there is an error during parse preferences, dont apply preferences, and fail silently.
Default: false
useCompactPreferences
Boolean
- If set to true, uses the newer preference persistence scheme introduced in Flexicious 2.0, which stores the preferences as custom string as opposed to XML, making it a lot less verbose. For Ultimate, this is always true
Default: true
userWidthsOverrideFitToContent
Boolean
If set to true, will mark the columns that have column width mode = fitToContent as fixed when preferences are applied. This will cause them to no longer size according to their contents, but respect the width that the user set.
Default: false