StringSetting Class

Represents a string component setting.

Inheritance Hierarchy

SystemObject
  Dundas.BI.Data.MetadataDescriptorBase
    Dundas.BI.Data.ParametersSetting
      Dundas.BI.Data.ParametersComponentSetting
        Dundas.BI.Data.ParametersStringSetting

Namespace: Dundas.BI.Data.Parameters
Assembly: Dundas.BI.Core (in Dundas.BI.Core.dll) Version: 2.0.0.0 (24.4.0.1000)

Syntax

C++

Copy

public class StringSetting : ComponentSetting

Public Class StringSetting
	Inherits ComponentSetting

public ref class StringSetting : public ComponentSetting

type StringSetting =  
    class
        inherit ComponentSetting
    end

The StringSetting type exposes the following members.

Constructors

	Name	Description
	StringSetting(Guid, String, String, Boolean, ValidValuesSource, Boolean)	Initializes a new instance of the StringSetting class.
	StringSetting(Guid, String, String, Boolean, Int32, Boolean)	Initializes a new instance of the StringSetting class.
	StringSetting(Guid, String, String, Boolean, String, ValidValuesSource, Boolean)	Initializes a new instance of the StringSetting class.
	StringSetting(Guid, String, String, Boolean, String, Int32, Boolean)	Initializes a new instance of the StringSetting class.

Top

Properties

	Name	Description
	AvailableValueTypes	Gets the available parameter value types for the current instance. (Overrides SettingAvailableValueTypes.)
	ChangesOutputMetadata	Gets a value indicating whether the value changes the output metadata. (Inherited from ComponentSetting.)
	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. (Inherited from ComponentSetting.)
	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. (Inherited from ComponentSetting.)
	MaxLength	Gets the maximum numbers of characters allowed.
	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. (Inherited from ComponentSetting.)
	ValidationRule	Gets the rule used to validate the setting's value. (Inherited from ComponentSetting.)
	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. (Overrides SettingCheckValueAgainstBoundaries(ParameterValue).)
	RemoveDependency	Removes the current instance dependency to a primary setting. (Inherited from ComponentSetting.)
	SetPrimaryDependencyValue	Sets the current instance as a dependency settings, and assigns the primary setting value when the current instance becomes active. (Inherited from ComponentSetting.)
	ToString	Returns a string that represents the current object. (Inherited from DescriptorBase.)

Top

Reference

Dundas.BI.Data.Parameters Namespace