DefaultSettingValueAttribute Klasa

Definicja

Przestrzeń nazw:

System.Configuration

Zestaw:

System.Configuration.ConfigurationManager.dll

Pakiet:

System.Configuration.ConfigurationManager v8.0.0

Źródło:

DefaultSettingValueAttribute.cs

Określa wartość domyślną właściwości ustawień aplikacji.

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

Dziedziczenie

Object

Attribute

DefaultSettingValueAttribute

Atrybuty

AttributeUsageAttribute

Przykłady

Poniższy przykład kodu pokazuje użycie zastosowanego DefaultSettingValueAttribute do trzech z czterech właściwości FormSettings klasy otoki, która pochodzi z ApplicationSettingsBase klasy . Ta klasa służy do utrwalania lokalizacji, rozmiaru, koloru tła i tekstu formularza. Pierwsze trzy z tych właściwości formularza mają skojarzone wartości domyślne.

Pełny przykład kodu znajduje się na liście w przeglądzie ApplicationSettingsBase klasy.

//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

Uwagi

Ważne

DefaultSettingValueAttribute można stosować tylko do poszczególnych właściwości ustawień; jest on nieprawidłowy, aby zastosować ten atrybut do całej klasy ustawień aplikacji.

Różni dostawcy ustawień mogą mieć różne wymagania lub ograniczenia dotyczące korzystania z programu DefaultSettingValueAttribute. Na przykład LocalFileSettingsProvider atrybut nie wymaga tego atrybutu i zastąpi dowolną wartość podaną przez ten atrybut, jeśli istnieją jakiekolwiek wartości — domyślne lub zmodyfikowane przez użytkownika — już obecne w magazynie danych.

DefaultSettingValueAttribute wymaga, aby wartość domyślna mogła być reprezentowana jako ciąg. W związku z tym ustawienia używające serializacji XML nie mogą mieć wartości domyślnej określonej za pomocą tego atrybutu. Niektórzy dostawcy mogą zdecydować się na obsługę wielu schematów serializacji, które można określić w czasie kompilacji przy użyciu polecenia SettingsSerializeAsAttribute.

Przestroga

Wartości domyślne określone przez ten atrybut są przechowywane jako zwykły tekst w wynikowym skompilowanym pliku .exe lub .dll. W związku z tym te wartości domyślne są z natury niezabezpieczone.

Konstruktory

DefaultSettingValueAttribute(String)

Inicjuje wystąpienie klasy DefaultSettingValueAttribute.

Właściwości

TypeId	Po zaimplementowaniu w klasie pochodnej pobiera unikatowy identyfikator dla tego elementu Attribute. (Odziedziczone po Attribute)
Value	Pobiera wartość domyślną właściwości ustawień aplikacji.

Metody

Equals(Object)	Zwraca wartość wskazującą, czy to wystąpienie jest równe podanemu obiektowi. (Odziedziczone po Attribute)
GetHashCode()	Zwraca wartość skrótu dla tego wystąpienia. (Odziedziczone po Attribute)
GetType()	Type Pobiera bieżące wystąpienie. (Odziedziczone po Object)
IsDefaultAttribute()	W przypadku zastąpienia w klasie pochodnej wskazuje, czy wartość tego wystąpienia jest wartością domyślną klasy pochodnej. (Odziedziczone po Attribute)
Match(Object)	W przypadku zastąpienia w klasie pochodnej zwraca wartość wskazującą, czy to wystąpienie jest równe określonemu obiektowi. (Odziedziczone po Attribute)
MemberwiseClone()	Tworzy płytkią kopię bieżącego Objectelementu . (Odziedziczone po Object)
ToString()	Zwraca ciąg reprezentujący bieżący obiekt. (Odziedziczone po Object)

Zobacz też

• SettingsProvider
• LocalFileSettingsProvider
• SettingsSerializeAsAttribute
• Ustawienia aplikacji dla Windows Forms