Setting Class
Represents a setting for an extension.
Inheritance Hierarchy
System.Object
Microsoft.ReportingServices.Interfaces.Setting
Namespace: Microsoft.ReportingServices.Interfaces
Assemblies: Microsoft.ReportingServices.Interfaces (in Microsoft.ReportingServices.Interfaces.dll)
Microsoft.ReportingServices.SharePoint.UI.WebParts (in Microsoft.ReportingServices.SharePoint.UI.WebParts.dll)
Syntax
'Declaration
Public Class Setting
'Usage
Dim instance As Setting
public class Setting
public ref class Setting
type Setting = class end
public class Setting
The Setting type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
.gif "Public method") |
Setting | Initializes a new instance of the Setting class. |
Top
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
DisplayName | The localized name of the extension setting that is displayed to the user. |
|
Encrypted | Indicates whether the extension setting value should be encrypted in the report server database. |
|
Error | An error that describes a problem with the value of the setting. |
|
Field | The name of the field used to derive the value of the setting. |
|
IsPassword | Indicates whether the setting value should be returned in calls to the SOAP API. |
|
Name | Gets the name of the setting. |
|
ReadOnly | Indicates whether a setting is read-only. |
|
Required | Indicates whether a value for the setting is required by the extension. |
|
ValidValues | A set of values that can be configured for the setting. |
|
Value | Gets or sets the value for the setting. |
Top
Methods
| Name | Description | |
|---|---|---|
|
AddValidValue(ValidValue) | Adds a valid value using the ValidValue class. |
|
AddValidValue(String, String) | Adds a valid value for a setting using a label and a value. |
|
Equals | (Inherited from Object.) |
.gif "Protected method") |
Finalize | (Inherited from Object.) |
|
GetHashCode | (Inherited from Object.) |
|
GetType | (Inherited from Object.) |
|
MemberwiseClone | (Inherited from Object.) |
|
ToString | (Inherited from Object.) |
Top
Remarks
The Setting class provides infrastructure for storing information about the settings that are required in order for a delivery extension to function properly. For more information about the Setting class, see Using the Setting Class for a Delivery Extension.
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.