AppSetting Class

A class used to hold an application setting and its outward facing information.
Inheritance Hierarchy
SystemObject
  Dundas.BI.ConfigurationAppSetting

Namespace: Dundas.BI.Configuration
Assembly: Dundas.BI.Core (in Dundas.BI.Core.dll) Version: 2.0.0.0 (26.2.0.1000)
Syntax
Copy
public class AppSetting

The AppSetting type exposes the following members.

Properties
 NameDescription
Public propertyAllowedValuesGeneratorGets the function which provides the allowed values for the setting.
Public propertyAvailableValuesGeneratorGets the function which provides the available values.
Public propertyCategoryName Gets the name of the category under which the setting should be displayed.
Public propertyCategoryNameGenerator Gets the delegate used to localize the setting's category name.
Public propertyClientSettingVisibility Gets the recommended visibility level of the configuration setting to be used when rendering a client-side user interface.
Public propertyClientSettingVisibilityGenerator Gets the delegate used to get the recommended visibility level of the configuration setting to be used when rendering a client-side user interface.
Public propertyClientValueVisibility 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).
Public propertyContentType Gets a value which specifies a special type of content, if SettingType is String.
Public propertyCustomDeserializer Gets the delegate used to deserialize values of the setting.
Public propertyCustomEffectiveValueDeriver Gets the custom delegate used to compute the effective value of the setting.
Public propertyCustomSerializer Gets the delegate used to serialize values of the setting.
Public propertyDefaultValue Gets the default value of the setting.
Public propertyDescriptionGets the description of the setting.
Public propertyDescriptionGenerator Gets the delegate used to localize the setting's description.
Public propertyDisplayNameGets the friendly name of the setting to display in a UI.
Public propertyDisplayNameGenerator Gets the delegate used to localize the setting's display name.
Public propertyEmptyCollectionGenerator Gets a delegate which returns an empty collection of the correct type, if SettingType implements ICollection<string>.
Public propertyExampleValueTextGenerator Gets a delegate which can optionally provide some text representing an example value for the setting.
Public propertyHelpTopicReferenceGets the help topic reference for the configuration setting.
Public propertyIdGets the unique ID of the setting.
Public propertyIsDangerousForImport 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.
Public propertyIsEncrypted Gets a value indicating whether the value of the setting will be encrypted when stored.
Public propertyIsMultiSelect Gets a value indicating whether the setting supports multiple-value selection.
Public propertyIsOnlyGlobal Gets a value indicating whether the setting may only be set at the global scope.
Public propertyIsPassword Gets a value indicating whether the value of the setting should receive special treatment because it is a password. See remarks.
Public propertyIsReadOnlyGets a value indicating whether the setting is read only.
Public propertyIsRestartRequired Gets a value indicating whether the setting requires an application restart to take effect.
Public propertyIsVisibleGets a value indicating whether the setting is visible.
Public propertyModuleIdGets the ID of the module to which the setting belongs.
Public propertyNameGets the name of the setting.
Public propertySanitizer Gets the delegate used to sanitize the value of the setting.
Public propertySettingType Gets the data type of the setting's value.
Public propertySortKey Gets the key used to sort the setting within its category, when displayed.
Public propertyValidationRule Gets the rule used to validate the setting's value.
Public propertyValueCheckerGets a delegate which checks if the value is valid.
Top
Methods
 NameDescription
Public methodGetAllowedValuesGets the list of allowed values for the setting.
Public methodGetAvailableValuesGets the list of available values for the setting.
Public methodSerializeSettingValueGets the string representation of a value for the setting.
Public methodTryDeserializeSettingValue Retrieves the object that was stored as a string in the Value property.
Top
See Also