Difference between revisions of "UserPreferenceHelper class"
Nguyenduyan (talk | contribs) (Created page with "{{CGscriptClass_Template |Name=UserPreferenceHelper |Description=A user preference helper |Constructors= {{CGscriptConstructors_Template|Description=Instanciate new helper}} |...") |
|||
| Line 1: | Line 1: | ||
{{CGscriptClass_Template | {{CGscriptClass_Template | ||
| − | |Name=UserPreferenceHelper | + | |Name=<nowiki>UserPreferenceHelper</nowiki> |
| − | |Description=A user preference helper | + | |Description=<nowiki>A user preference helper</nowiki> |
| − | |Constructors= | + | |InheritsFrom=object|Constructors= |
| − | {{CGscriptConstructors_Template|Description=Instanciate new helper}} | + | {{CGscriptConstructors_Template|Description=<nowiki>Instanciate new helper</nowiki>}} |
|Methods= | |Methods= | ||
| − | {{CGscriptMethods_Template|ReturnType=Dictionary|Name=GetAllSystemUserPreferencesByPrefType|Parameters= | + | {{CGscriptMethods_Template|ReturnType=Dictionary|Name=<nowiki>GetAllSystemUserPreferencesByPrefType</nowiki>|Parameters= |
| − | {{CGscriptParameters_Template|Type=int|Name=prefType|Description=Unique key for the setting}} | + | {{CGscriptParameters_Template|Type=int|Name=<nowiki>prefType</nowiki>|Description=<nowiki>Unique key for the setting</nowiki>}} |
| − | |Description=Get all existing system stored values for a given prefType.}} | + | |Description=<nowiki>Get all existing system stored values for a given prefType.</nowiki>}} |
| − | {{CGscriptMethods_Template|ReturnType=Dictionary|Name=GetAllSystemUserPreferenceValuesByPrefType|Parameters= | + | {{CGscriptMethods_Template|ReturnType=Dictionary|Name=<nowiki>GetAllSystemUserPreferenceValuesByPrefType</nowiki>|Parameters= |
| − | {{CGscriptParameters_Template|Type=int|Name=prefType|Description=Unique key for the setting}} | + | {{CGscriptParameters_Template|Type=int|Name=<nowiki>prefType</nowiki>|Description=<nowiki>Unique key for the setting</nowiki>}} |
| − | |Description=Get all existing system stored values for a given prefType.}} | + | |Description=<nowiki>Get all existing system stored values for a given prefType.</nowiki>}} |
| − | {{CGscriptMethods_Template|ReturnType=UserPreference|Name=GetSystemUserPreference|Parameters= | + | {{CGscriptMethods_Template|ReturnType=UserPreference|Name=<nowiki>GetSystemUserPreference</nowiki>|Parameters= |
| − | {{CGscriptParameters_Template|Type=string|Name=navName|Description=Navigation access value was stored with|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=prefType|Description=Unique key for the setting}} | + | {{CGscriptParameters_Template|Type=string|Name=<nowiki>navName</nowiki>|Description=<nowiki>Navigation access value was stored with</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>prefType</nowiki>|Description=<nowiki>Unique key for the setting</nowiki>}} |
| − | |Description=Get existing system stored value.}} | + | |Description=<nowiki>Get existing system stored value.</nowiki>}} |
| − | {{CGscriptMethods_Template|ReturnType=UserPreference|Name=GetSystemUserPreference|Parameters= | + | {{CGscriptMethods_Template|ReturnType=UserPreference|Name=<nowiki>GetSystemUserPreference</nowiki>|Parameters= |
| − | {{CGscriptParameters_Template|Type=string|Name=navName|Description=Navigation access to associate the value with|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=prefType|Description=Unique key for the setting|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=value|Description=Value to store}} | + | {{CGscriptParameters_Template|Type=string|Name=<nowiki>navName</nowiki>|Description=<nowiki>Navigation access to associate the value with</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>prefType</nowiki>|Description=<nowiki>Unique key for the setting</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=<nowiki>value</nowiki>|Description=<nowiki>Value to store</nowiki>}} |
| − | |Description=Create a new or update existing system stored value.}} | + | |Description=<nowiki>Create a new or update existing system stored value.</nowiki>}} |
| − | {{CGscriptMethods_Template|ReturnType=string|Name=ToString|Description=The string representation of the object.}} | + | {{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Inherited=object|Description=<nowiki>The string representation of the object.</nowiki>}} |
|Properties= | |Properties= | ||
| − | {{CGscriptProperties_Template|ReturnType=string|Name=ObjectTypeName|HasGetter=1|Description=The name of the type of object.}} | + | {{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}} |
| − | {{CGscriptProperties_Template|ReturnType=TypeInformation|Name=TypeInformation|HasGetter=1|Description=Get information about this class.}} | + | {{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Inherited=object|Description=<nowiki>Get information about this class.</nowiki>}} |
}} | }} | ||
Latest revision as of 09:27, 2 July 2020
UserPreferenceHelper
A user preference helper
Parent class
Inherits from object
Constructors
- () - Instanciate new helper
Methods
- Dictionary GetAllSystemUserPreferencesByPrefType(int prefType "Unique key for the setting") - Get all existing system stored values for a given prefType.
- Dictionary GetAllSystemUserPreferenceValuesByPrefType(int prefType "Unique key for the setting") - Get all existing system stored values for a given prefType.
- UserPreference GetSystemUserPreference(string navName "Navigation access value was stored with", int prefType "Unique key for the setting") - Get existing system stored value.
- UserPreference GetSystemUserPreference(string navName "Navigation access to associate the value with", int prefType "Unique key for the setting", string value "Value to store") - Create a new or update existing system stored value.
- (From object) string ToString() - The string representation of the object.
Properties
- string ObjectTypeName { get; } - The name of the type of object.
- (From object) TypeInformation TypeInformation { get; } - Get information about this class.
