DefaultSettingValueAttribute Класс

Определение

Определяет значение по умолчанию для свойства параметров приложения.Specifies the default value for an application settings property.

public ref class DefaultSettingValueAttribute sealed : Attribute
[System.AttributeUsage(System.AttributeTargets.Property)]
public sealed class DefaultSettingValueAttribute : Attribute
type DefaultSettingValueAttribute = class
    inherit Attribute
Public NotInheritable Class DefaultSettingValueAttribute
Inherits Attribute
Наследование
DefaultSettingValueAttribute
Атрибуты

Примеры

В следующем примере кода показано использование DefaultSettingValueAttribute, применяемого к трем из четырех свойств класса-оболочки FormSettings, который является производным от класса ApplicationSettingsBase.The following code example demonstrates the use of the DefaultSettingValueAttribute applied to three of the four properties of the FormSettings wrapper class, which is derived from the ApplicationSettingsBase class. Этот класс используется для сохранения расположения, размера, цвета фона и текста формы.This class is used to persist the location, size, background color, and text of form. Первые три из этих свойств формы имеют связанные с ними значения по умолчанию.The first three of these form properties have default values associated with them.

Полный пример кода приведен в разделе Общие сведения о классе ApplicationSettingsBase.The full code example is listed in the ApplicationSettingsBase class overview.

//Application settings wrapper class
ref class FormSettings sealed: public ApplicationSettingsBase
{
public:
    [UserScopedSettingAttribute()]
    property String^ FormText
    {
        String^ get()
        {
            return (String^)this["FormText"];
        }
        void set( String^ value )
        {
            this["FormText"] = value;
        }
    }

public:
    [UserScopedSettingAttribute()]
    [DefaultSettingValueAttribute("0, 0")]
    property Point FormLocation
    {
        Point get()
        {
            return (Point)(this["FormLocation"]);
        }
        void set( Point value )
        {
            this["FormLocation"] = value;
        }
    }

public:
    [UserScopedSettingAttribute()]
    [DefaultSettingValueAttribute("225, 200")]
    property Size FormSize
    {
        Size get()
        {
            return (Size)this["FormSize"];
        }
        void set( Size value )
        {
            this["FormSize"] = value;
        }
    }

public:
    [UserScopedSettingAttribute()]
    [DefaultSettingValueAttribute("LightGray")]
    property Color FormBackColor
    {
        Color get()
        {
            return (Color)this["FormBackColor"];
        }
        void set(Color value)
        {
            this["FormBackColor"] = value;
        }
    }

};
//Application settings wrapper class
sealed class FormSettings : ApplicationSettingsBase
{
    [UserScopedSettingAttribute()]
    public String FormText
    {
        get { return (String)this["FormText"]; }
        set { this["FormText"] = value; }
    }

    [UserScopedSettingAttribute()]
    [DefaultSettingValueAttribute("0, 0")]
    public Point FormLocation
    {
        get { return (Point)(this["FormLocation"]); }
        set { this["FormLocation"] = value; }
    }

    [UserScopedSettingAttribute()]
    [DefaultSettingValueAttribute("225, 200")]
    public Size FormSize
    {
        get { return (Size)this["FormSize"]; }
        set { this["FormSize"] = value; }
    }

    [UserScopedSettingAttribute()]
    [DefaultSettingValueAttribute("LightGray")]
    public Color FormBackColor
    {
        get { return (Color)this["FormBackColor"]; }
        set { this["FormBackColor"] = value; }
    }
}
'Application settings wrapper class. This class defines the settings we intend to use in our application.
NotInheritable Class FormSettings
    Inherits ApplicationSettingsBase

    <UserScopedSettingAttribute()> _
    Public Property FormText() As String
        Get
            Return CStr(Me("FormText"))
        End Get
        Set(ByVal value As String)
            Me("FormText") = value
        End Set
    End Property

    <UserScopedSettingAttribute(), DefaultSettingValueAttribute("0, 0")> _
    Public Property FormLocation() As Point
        Get
            Return CType(Me("FormLocation"), Point)
        End Get
        Set(ByVal value As Point)
            Me("FormLocation") = value
        End Set
    End Property

    <UserScopedSettingAttribute(), DefaultSettingValueAttribute("225, 200")> _
    Public Property FormSize() As Size
        Get
            Return CType(Me("FormSize"), Size)
        End Get
        Set(ByVal value As Size)
            Me("FormSize") = value
        End Set
    End Property

    <UserScopedSettingAttribute(), DefaultSettingValueAttribute("LightGray")> _
    Public Property FormBackColor() As Color
        Get
            Return CType(Me("FormBackColor"), Color)
        End Get
        Set(ByVal value As Color)
            Me("FormBackColor") = value
        End Set
    End Property
End Class

Комментарии

Важно!

DefaultSettingValueAttribute можно применять только к индивидуальным свойствам параметров; применение этого атрибута к целому классу параметров приложения недопустимо.DefaultSettingValueAttribute can only be applied to individual settings properties; it is invalid to apply this attribute to an entire application settings class.

Различные поставщики параметров могут иметь разные требования или ограничения на использование DefaultSettingValueAttribute.Different settings providers may have different requirements or limitations on the use of the DefaultSettingValueAttribute. Например, LocalFileSettingsProvider не требует этого атрибута и будет переопределять любое значение, предоставленное этим атрибутом, если в хранилище данных есть значения по умолчанию или измененные пользователем, уже присутствуют.For example, the LocalFileSettingsProvider does not require this attribute, and will override any value provided by this attribute if there are any values - default or user-modified - already present in the data store.

DefaultSettingValueAttribute требует, чтобы значение по умолчанию было представлено в виде строки.DefaultSettingValueAttribute requires that the default value can be represented as a string. В результате параметры, использующие сериализацию XML, не могут иметь значение по умолчанию, заданное с помощью этого атрибута.As a result, settings using XML serialization cannot have a default value specified by means of this attribute. Некоторые поставщики могут поддерживать несколько схем сериализации, которые можно указать во время компиляции с помощью SettingsSerializeAsAttribute.Some providers may choose to support multiple serialization schemes which can be specified at compile time using the SettingsSerializeAsAttribute.

Внимание!

Значения по умолчанию, заданные этим атрибутом, хранятся в итоговом скомпилированном exe-или DLL-файле в виде обычного текста.The default values specified by this attribute are stored as plain text in the resultant compiled .exe or .dll file. Поэтому эти значения по умолчанию по своей природе небезопасны.Therefore these default values are inherently insecure.

Конструкторы

DefaultSettingValueAttribute(String)

Инициализирует экземпляр класса DefaultSettingValueAttribute.Initializes an instance of the DefaultSettingValueAttribute class.

Свойства

TypeId

When implemented in a derived class, gets a unique identifier for this Attribute.When implemented in a derived class, gets a unique identifier for this Attribute.

(Унаследовано от Attribute)
Value

Возвращает значение по умолчанию для свойства параметров приложения.Gets the default value for the application settings property.

Методы

Equals(Object)

Returns a value that indicates whether this instance is equal to a specified object.Returns a value that indicates whether this instance is equal to a specified object.

(Унаследовано от Attribute)
GetHashCode()

Returns the hash code for this instance.Returns the hash code for this instance.

(Унаследовано от Attribute)
GetType()

Возвращает объект Type для текущего экземпляра.Gets the Type of the current instance.

(Унаследовано от Object)
IsDefaultAttribute()

When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.

(Унаследовано от Attribute)
Match(Object)

When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Унаследовано от Attribute)
MemberwiseClone()

Создает неполную копию текущего объекта Object.Creates a shallow copy of the current Object.

(Унаследовано от Object)
ToString()

Возвращает строку, представляющую текущий объект.Returns a string that represents the current object.

(Унаследовано от Object)

Явные реализации интерфейса

_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)

Maps a set of names to a corresponding set of dispatch identifiers.Maps a set of names to a corresponding set of dispatch identifiers.

(Унаследовано от Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Retrieves the type information for an object, which can be used to get the type information for an interface.Retrieves the type information for an object, which can be used to get the type information for an interface.

(Унаследовано от Attribute)
_Attribute.GetTypeInfoCount(UInt32)

Retrieves the number of type information interfaces that an object provides (either 0 or 1).Retrieves the number of type information interfaces that an object provides (either 0 or 1).

(Унаследовано от Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Provides access to properties and methods exposed by an object.Provides access to properties and methods exposed by an object.

(Унаследовано от Attribute)

Применяется к

Дополнительно