A Sandcastle Documented Class Library

# AppSettingProperties Class

Class used to supply information when registering a new application configuration setting.
Inheritance Hierarchy
System
Object
Dundas.BI.Configuration
AppSettingProperties

Namespace: Dundas.BI.Configuration
Assembly: Dundas.BI.Core (in Dundas.BI.Core.dll) Version: 2.0.0.0 (10.0.0.1002)
Syntax
C#
VB
C++
F#
Copy

    public class AppSettingProperties

    Public Class AppSettingProperties

    public ref class AppSettingProperties

    type AppSettingProperties =  class end

The AppSettingProperties type exposes the following members.

Constructors

| Name | Description
--- | --- | ---
| AppSettingProperties | Initializes a new instance of the AppSettingProperties class.

Top
Properties

| Name | Description
--- | --- | ---
| AllowedValuesGenerator | Gets or sets a function which provides the allowed values for the setting.
| AvailableValuesGenerator | Gets or sets a function which provides the available values with corresponding user-facing display names.
| CategoryName | Gets or sets the name of the category under which the setting should be displayed.
| CategoryNameGenerator | Gets or sets the delegate used to return the setting's category name in the culture of the caller.
| ClientSettingVisibility | Gets or sets the recommended visibility level of the configuration setting to be used when rendering a client-side user interface.
| ClientValueVisibility | Gets or sets 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 or sets a value corresponding to ContentType.
| CustomDeserializer | Gets or sets the delegate used to deserialize values of the setting.
| CustomEffectiveValueDeriver | Gets or sets the custom delegate used to compute the effective value of the setting.
| CustomSerializer | Gets or sets the delegate used to serialize values of the setting.
| DefaultValue | Gets or sets default value of the setting.
| Description | Gets or sets the description of the setting.
| DescriptionGenerator | Gets or sets the delegate used to return the setting's description in the culture of the caller.
| DisplayName | Gets or sets the friendly name of the setting to display in a UI.
| DisplayNameGenerator | Gets or sets the delegate used to return the setting's display name in the culture of the caller.
| EmptyCollectionGenerator | Gets or sets a value corresponding to EmptyCollectionGenerator.
| HelpTopicReference | Gets or sets the help topic reference for the configuration setting.
| Id | Gets the unique ID of the setting.
| IsDangerousForImport | Gets or sets 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 or sets a value indicating whether the value of the setting will be encrypted when stored.
| IsMultiSelect | Gets or sets a value indicating whether the setting supports multiple-value selection.
| IsOnlyGlobal | Gets or sets a value indicating whether the setting may only be set at the global scope.
| IsPassword | Gets or sets a value corresponding to IsPassword.
| IsReadOnly | Gets or sets a value indicating whether the setting is read only.
| IsRestartRequired | Gets or sets a value indicating whether the setting requires an application restart to take effect.
| ModuleId | Gets the ID of the module this setting applies to.
| Name | Gets the name of the setting.
| Sanitizer | Gets or sets the delegate used to sanitize the value of the setting.
| SettingType | Gets the data type of the setting's value.
| SortKey | Gets or sets the key used to sort the setting within its category, when displayed.
| ValidationRule | Gets or sets the rule used to validate strings for this setting's value.
| ValueChecker | Gets or sets the function which checks if the value is valid.

Top
See Also

#### Reference

Dundas.BI.Configuration Namespace
IAppConfigService
RegisterSetting(AppSettingProperties)