1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259
|
//------------------------------------------------------------------------------
// <copyright file="SettingsAttributes.cs" company="Microsoft">
// Copyright (c) Microsoft Corporation. All rights reserved.
// </copyright>
//------------------------------------------------------------------------------
namespace System.Configuration
{
using System;
/// <devdoc>
/// Indicates that a setting is to be stored on a per-application basis.
/// </devdoc>
[AttributeUsage(AttributeTargets.Property)]
public sealed class ApplicationScopedSettingAttribute : SettingAttribute {
}
/// <devdoc>
/// Indicates to the provider what default value to use for this setting when no stored value
/// is found. The value should be encoded into a string and is interpreted based on the SerializeAs
/// value for this setting. For example, if SerializeAs is Xml, the default value will be
/// "stringified" Xml.
/// </devdoc>
[AttributeUsage(AttributeTargets.Property)]
public sealed class DefaultSettingValueAttribute : Attribute {
private readonly string _value;
/// <devdoc>
/// Constructor takes the default value as string.
/// </devdoc>
public DefaultSettingValueAttribute(string value) {
_value = value;
}
/// <devdoc>
/// Default value.
/// </devdoc>
public string Value {
get {
return _value;
}
}
}
/// <devdoc>
/// Indicates that the provider should disable any logic that gets invoked when an application
/// upgrade is detected.
/// </devdoc>
[AttributeUsage(AttributeTargets.Property)]
public sealed class NoSettingsVersionUpgradeAttribute : Attribute {
}
/// <devdoc>
/// Use this attribute to mark properties on a settings class that are to be treated
/// as settings. ApplicationSettingsBase will ignore all properties not marked with
/// this or a derived attribute.
/// </devdoc>
[System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Performance", "CA1813:AvoidUnsealedAttributes")]
[AttributeUsage(AttributeTargets.Property)]
public class SettingAttribute : Attribute {
}
/// <devdoc>
/// Description for a particular setting.
/// </devdoc>
[AttributeUsage(AttributeTargets.Property)]
public sealed class SettingsDescriptionAttribute : Attribute {
private readonly string _desc;
/// <devdoc>
/// Constructor takes the description string.
/// </devdoc>
public SettingsDescriptionAttribute(string description) {
_desc = description;
}
/// <devdoc>
/// Description string.
/// </devdoc>
public string Description {
get {
return _desc;
}
}
}
/// <devdoc>
/// Description for a particular settings group.
/// </devdoc>
[AttributeUsage(AttributeTargets.Class)]
public sealed class SettingsGroupDescriptionAttribute : Attribute {
private readonly string _desc;
/// <devdoc>
/// Constructor takes the description string.
/// </devdoc>
public SettingsGroupDescriptionAttribute(string description) {
_desc = description;
}
/// <devdoc>
/// Description string.
/// </devdoc>
public string Description {
get {
return _desc;
}
}
}
/// <devdoc>
/// Name of a particular settings group.
/// </devdoc>
[AttributeUsage(AttributeTargets.Class)]
public sealed class SettingsGroupNameAttribute : Attribute {
private readonly string _groupName;
/// <devdoc>
/// Constructor takes the group name.
/// </devdoc>
public SettingsGroupNameAttribute(string groupName) {
_groupName = groupName;
}
/// <devdoc>
/// Name of the settings group.
/// </devdoc>
public string GroupName {
get {
return _groupName;
}
}
}
/// <devdoc>
/// Indicates the SettingsManageability for a group of/individual setting.
/// </devdoc>
[AttributeUsage(AttributeTargets.Class | AttributeTargets.Property)]
public sealed class SettingsManageabilityAttribute : Attribute {
private readonly SettingsManageability _manageability;
/// <devdoc>
/// Constructor takes a SettingsManageability enum value.
/// </devdoc>
public SettingsManageabilityAttribute(SettingsManageability manageability) {
_manageability = manageability;
}
/// <devdoc>
/// SettingsManageability value to use
/// </devdoc>
public SettingsManageability Manageability {
get {
return _manageability;
}
}
}
/// <devdoc>
/// Indicates the provider associated with a group of/individual setting.
/// </devdoc>
[AttributeUsage(AttributeTargets.Class | AttributeTargets.Property)]
public sealed class SettingsProviderAttribute : Attribute {
private readonly string _providerTypeName;
/// <devdoc>
/// Constructor takes the provider's assembly qualified type name.
/// </devdoc>
public SettingsProviderAttribute(string providerTypeName) {
_providerTypeName = providerTypeName;
}
/// <devdoc>
/// Constructor takes the provider's type.
/// </devdoc>
public SettingsProviderAttribute(Type providerType) {
if (providerType != null) {
_providerTypeName = providerType.AssemblyQualifiedName;
}
}
/// <devdoc>
/// Type name of the provider
/// </devdoc>
public string ProviderTypeName {
get {
return _providerTypeName;
}
}
}
/// <devdoc>
/// Indicates the SettingsSerializeAs for a group of/individual setting.
/// </devdoc>
[AttributeUsage(AttributeTargets.Class | AttributeTargets.Property)]
public sealed class SettingsSerializeAsAttribute : Attribute {
private readonly SettingsSerializeAs _serializeAs;
/// <devdoc>
/// Constructor takes a SettingsSerializeAs enum value.
/// </devdoc>
public SettingsSerializeAsAttribute(SettingsSerializeAs serializeAs) {
_serializeAs = serializeAs;
}
/// <devdoc>
/// SettingsSerializeAs value to use
/// </devdoc>
public SettingsSerializeAs SerializeAs {
get {
return _serializeAs;
}
}
}
/// <devdoc>
/// Indicates the SpecialSetting for a group of/individual setting.
/// </devdoc>
[AttributeUsage(AttributeTargets.Class | AttributeTargets.Property)]
public sealed class SpecialSettingAttribute : Attribute {
private readonly SpecialSetting _specialSetting;
/// <devdoc>
/// Constructor takes a SpecialSetting enum value.
/// </devdoc>
public SpecialSettingAttribute(SpecialSetting specialSetting) {
_specialSetting = specialSetting;
}
/// <devdoc>
/// SpecialSetting value to use
/// </devdoc>
public SpecialSetting SpecialSetting {
get {
return _specialSetting;
}
}
}
/// <devdoc>
/// Indicates that a setting is to be stored on a per-user basis.
/// </devdoc>
[AttributeUsage(AttributeTargets.Property)]
public sealed class UserScopedSettingAttribute : SettingAttribute {
}
public enum SettingsManageability {
Roaming = 0
}
/// <devdoc>
/// Indicates settings that are to be treated "specially".
/// </devdoc>
public enum SpecialSetting {
ConnectionString = 0,
WebServiceUrl = 1
}
}
|