AppSettingData Class

Base data contract object for returning an AppSetting through REST API.

Inheritance Hierarchy

SystemObject
Dundas.BI.WebApi.ModelsBaseDataContract
Dundas.BI.WebApi.ModelsAppSettingData

Namespace: Dundas.BI.WebApi.Models
Assembly: Dundas.BI.WebApiCore (in Dundas.BI.WebApiCore.dll) Version: 2.0.0.0 (24.3.0.1000)

Syntax

C++

Copy

[DataContractAttribute]
public class AppSettingData : BaseDataContract

<DataContractAttribute>
Public Class AppSettingData
	Inherits BaseDataContract

[DataContractAttribute]
public ref class AppSettingData : public BaseDataContract

[<DataContractAttribute>]
type AppSettingData =  
    class
        inherit BaseDataContract
    end

The AppSettingData type exposes the following members.

Constructors

	Name	Description
	AppSettingData	Initializes a new instance of the AppSettingData class.

Top

Properties

	Name	Description
	AllowedValues	Gets the list of allowed values for the setting.
	AvailableValues	Gets the list of available values for the setting.
	CategoryName	Gets the name of the category under which the setting should be displayed.
	ClientSettingVisibility	Gets the recommended visibility level of the configuration setting to be used when rendering a client-side user interface.
	ContentType	Gets a value which specifies a special type of content, if SettingType is String.
	DefaultValue	Gets the default value of the setting.
	Description	Gets the description of the setting.
	DisplayName	Gets the friendly name of the setting to display in a UI.
	ExampleValueText	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.
	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.
	Name	Gets the name 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.
	UIClassName	Gets or sets the name of the UI class (used for auto de-serialization). (Inherited from BaseDataContract.)

Top

Methods

	Name	Description
	ToDataContractMappings	The mapping between AppSetting and AppSettingData.

Top

Reference

Dundas.BI.WebApi.Models Namespace