AppSetting Class |
A class used to hold an application setting and its outward facing information.
Inheritance HierarchyNamespace: Dundas.BI.Configuration
Assembly: Dundas.BI.Core (in Dundas.BI.Core.dll) Version: 2.0.0.0 (24.3.0.1000)
SyntaxThe AppSetting type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | AllowedValuesGenerator | Gets the function which provides the allowed values for the setting. |
| AvailableValuesGenerator | Gets the function which provides the available values. |
| CategoryName |
Gets the name of the category under which the setting should be displayed.
|
| CategoryNameGenerator |
Gets the delegate used to localize the setting's category name.
|
| ClientSettingVisibility |
Gets the recommended visibility level of the configuration setting to be used when rendering
a client-side user interface.
|
| ClientSettingVisibilityGenerator |
Gets the delegate used to get the recommended visibility level of the configuration setting to be used when rendering
a client-side user interface.
|
| ClientValueVisibility |
Gets the recommended level of authorization required in order for the value of a configuration
setting to be accessible to clients (e.g. Web API).
|
| ContentType |
Gets a value which specifies a special type of content, if SettingType is String.
|
| CustomDeserializer |
Gets the delegate used to deserialize values of the setting.
|
| CustomEffectiveValueDeriver |
Gets the custom delegate used to compute the effective value of the setting.
|
| CustomSerializer |
Gets the delegate used to serialize values of the setting.
|
| DefaultValue |
Gets the default value of the setting.
|
| Description | Gets the description of the setting. |
| DescriptionGenerator |
Gets the delegate used to localize the setting's description.
|
| DisplayName | Gets the friendly name of the setting to display in a UI. |
| DisplayNameGenerator |
Gets the delegate used to localize the setting's display name.
|
| EmptyCollectionGenerator |
Gets a delegate which returns an empty collection of the correct type, if SettingType
implements ICollection<string>.
|
| ExampleValueTextGenerator |
Gets a delegate which can optionally provide some text representing an example value for the setting.
|
| HelpTopicReference | Gets the help topic reference for the configuration setting. |
| Id | Gets the unique ID of the setting. |
| IsDangerousForImport |
Gets a value indicating whether this setting is dangerous for import.
Serves as a hint that values for the setting should not be imported without careful thought.
|
| IsEncrypted |
Gets a value indicating whether the value of the setting will be encrypted when stored.
|
| IsMultiSelect |
Gets a value indicating whether the setting supports multiple-value selection.
|
| IsOnlyGlobal |
Gets a value indicating whether the setting may only be set at the global scope.
|
| IsPassword |
Gets a value indicating whether the value of the setting should receive special treatment because it is a password. See remarks.
|
| IsReadOnly | Gets a value indicating whether the setting is read only. |
| IsRestartRequired |
Gets a value indicating whether the setting requires an application restart to take effect.
|
| IsVisible | Gets a value indicating whether the setting is visible. |
| ModuleId | Gets the ID of the module to which the setting belongs. |
| Name | Gets the name of the setting. |
| Sanitizer |
Gets the delegate used to sanitize the value of the setting.
|
| SettingType |
Gets the data type of the setting's value.
|
| SortKey |
Gets the key used to sort the setting within its category, when displayed.
|
| ValidationRule |
Gets the rule used to validate the setting's value.
|
| ValueChecker | Gets a delegate which checks if the value is valid. |
Methods| Name | Description | |
|---|---|---|
 | GetAllowedValues | Gets the list of allowed values for the setting. |
| GetAvailableValues | Gets the list of available values for the setting. |
| SerializeSettingValue | Gets the string representation of a value for the setting. |
| TryDeserializeSettingValue |
Retrieves the object that was stored as a string in the Value property.
|
See Also