A Sandcastle Documented Class Library

# ComponentSetting Class

Represents the base class for any component settings. Component settings alter the process functionality for data retrieval.
Inheritance Hierarchy
System
Object
Dundas.BI.Data.Metadata
DescriptorBase
Dundas.BI.Data.Parameters
Setting
Dundas.BI.Data.Parameters
ComponentSetting
More...

Namespace: Dundas.BI.Data.Parameters
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 abstract class ComponentSetting : Setting

    Public MustInherit Class ComponentSetting
    	Inherits Setting

    public ref class ComponentSetting abstract : public Setting

    [<AbstractClassAttribute>]
    type ComponentSetting =
        class
            inherit Setting
        end

The ComponentSetting type exposes the following members.

Constructors

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

Top
Properties

| Name | Description
--- | --- | ---
| AvailableValueTypes | Gets the available parameter value types for the current instance. (Inherited from Setting.)
| ChangesOutputMetadata | Gets a value indicating whether the value changes the output metadata.
| DataType | Gets the component setting type. (Inherited from Setting.)
| DefaultValue | Gets the default value. (Inherited from Setting.)
| Description | Gets or sets the object description. (Inherited from DescriptorBase.)
| HasValidValues | Gets a value indicating whether this instance has valid values. (Inherited from Setting.)
| Id | Gets the object ID. (Inherited from DescriptorBase.)
| IsDependencySetting | Gets a value indicating whether the current instance is a dependency setting.
| IsElementSpecific | Gets a value indicating whether the setting is applied to a data element. (Inherited from Setting.)
| IsInvertedSelectionSupported | Gets or sets a value indicating whether this instance supports inverted selection.
| Name | Gets or sets the object name. (Inherited from DescriptorBase.)
| PrimarySettingValue | Gets the primary setting value when the current instance becomes active, if the current instance is a dependency setting.
| ValidValues | Gets the valid values for the current instance. (Inherited from Setting.)

Top
Methods

| Name | Description
--- | --- | ---
| AddValidValue(Boolean, String, String) | Adds a new value to the supported list of valid values. (Inherited from Setting.)
| AddValidValue(DateTime, String, String) | Adds a new value to the supported list of valid values. (Inherited from Setting.)
| AddValidValue(String, String, String) | Adds a new value to the supported list of valid values. (Inherited from Setting.)
| AddValidValue(Number, String, String) | Adds a new value to the supported list of valid values. (Inherited from Setting.)
| AddValidValue(ParameterToken, String, String) | Adds a new value to the supported list of valid values. (Inherited from Setting.)
| AddValidValue(Boolean, CompatibleDataTypes, String, String) | Adds a new value to the supported list of valid values. (Inherited from Setting.)
| AddValidValue(DateTime, CompatibleDataTypes, String, String) | Adds a new value to the supported list of valid values. (Inherited from Setting.)
| AddValidValue(String, CompatibleDataTypes, String, String) | Adds a new value to the supported list of valid values. (Inherited from Setting.)
| AddValidValue(Number, CompatibleDataTypes, String, String) | Adds a new value to the supported list of valid values. (Inherited from Setting.)
| AddValidValue(ParameterToken, CompatibleDataTypes, String, String) | Adds a new value to the supported list of valid values. (Inherited from Setting.)
| CheckValue | Checks the value for validity against any boundaries or existing valid values. (Inherited from Setting.)
| CheckValueAgainstBoundaries | Checks the value for validity only against existing boundaries. (Inherited from Setting.)
| RemoveDependency | Removes the current instance dependency to a primary setting.
| SetPrimaryDependencyValue | Sets the current instance as a dependency settings, and assigns the primary setting value when the current instance becomes active.
| ToString | Returns a string that represents the current object. (Inherited from DescriptorBase.)

Top
See Also

#### Reference

Dundas.BI.Data.Parameters Namespace
Inheritance Hierarchy
System
Object
Dundas.BI.Data.Metadata
DescriptorBase
Dundas.BI.Data.Parameters
Setting
Dundas.BI.Data.Parameters
ComponentSetting
Dundas.BI.Data.Parameters
BooleanSetting
Dundas.BI.Data.Parameters
DateTimeSetting
Dundas.BI.Data.Parameters
HierarchySetting
Dundas.BI.Data.Parameters
MeasureSetSetting
Dundas.BI.Data.Parameters
NumericSetting
Dundas.BI.Data.Parameters
StringSetting