DefaultSettingValueAttribute Класс

Определение

public ref class DefaultSettingValueAttribute sealed : Attribute

[System.AttributeUsage(System.AttributeTargets.Property)]
public sealed class DefaultSettingValueAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.Property)>]
type DefaultSettingValueAttribute = class
    inherit Attribute

Public NotInheritable Class DefaultSettingValueAttribute
Inherits Attribute

Наследование

Object

Attribute

DefaultSettingValueAttribute

Атрибуты

AttributeUsageAttribute

Примеры

В следующем примере кода демонстрируется использование примененного DefaultSettingValueAttribute к трем из четырех свойств FormSettings класса-оболочки, который является производным ApplicationSettingsBase от класса . Этот класс используется для сохранения расположения, размера, цвета фона и текста формы. С первыми тремя свойствами формы связаны значения по умолчанию.

Полный пример кода приведен в обзоре ApplicationSettingsBase класса .

//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. Например, LocalFileSettingsProvider объект не требует этого атрибута и переопределяет любое значение, предоставленное этим атрибутом, если в хранилище данных уже присутствуют какие-либо значения ( по умолчанию или измененные пользователем).

DefaultSettingValueAttribute требует, чтобы значение по умолчанию можно было представить в виде строки. В результате параметры, использующие XML-сериализацию, не могут иметь значение по умолчанию, заданное с помощью этого атрибута. Некоторые поставщики могут поддерживать несколько схем сериализации, которые можно указать во время компиляции SettingsSerializeAsAttributeс помощью .

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

Свойства

Методы

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

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

См. также раздел

• SettingsProvider
• LocalFileSettingsProvider
• SettingsSerializeAsAttribute
• Параметры приложения для Windows Forms