ApplicationSettingsBase.SettingsKey Propriedade

Definição

Namespace:

System.Configuration

Assembly:

System.Configuration.ConfigurationManager.dll

Pacote:

System.Configuration.ConfigurationManager v8.0.0

Origem:

ApplicationSettingsBase.cs

Obtém ou define a chave de configurações para o grupo de configurações do aplicativo.

public:
 property System::String ^ SettingsKey { System::String ^ get(); void set(System::String ^ value); };

[System.ComponentModel.Browsable(false)]
public string SettingsKey { get; set; }

[<System.ComponentModel.Browsable(false)>]
member this.SettingsKey : string with get, set

Public Property SettingsKey As String

Valor da propriedade

String

Um String que contém a chave de configurações para o grupo de configurações atual.

Atributos

BrowsableAttribute

Comentários

A SettingsKey propriedade é fornecida para habilitar o código do cliente e, em particular, o provedor de configurações, para desambiguar entre várias instâncias da mesma classe de configurações de aplicativo.

A menos que a classe wrapper de configurações seja projetada usando o padrão singleton, pode haver várias instâncias da mesma classe de configurações de aplicativo em um único aplicativo. O valor de deve ser definido de SettingsKey acordo com a forma como os valores de propriedade devem ser compartilhados.

• Se as propriedades de configurações do wrapper forem destinadas a serem compartilhadas em todas as instâncias do wrapper no mesmo aplicativo, deverá SettingsKey ter o mesmo valor em todas as instâncias. Esse é o comportamento padrão da ApplicationSettingsBase classe .

• Se as propriedades de configurações do wrapper forem destinadas a ser por instância, deverá SettingsKey ter um valor exclusivo para cada instância. A ApplicationSettingsBase(String) versão do construtor permite inicializar SettingsKey para uma cadeia de caracteres exclusiva.

Por outro lado, a Context propriedade fornece dicas para o provedor de configurações para permitir que ele persista valores de maneira eficiente e ordenada.

A SettingChangingEventArgs classe contém uma propriedade semelhante SettingKey que ajuda a identificar a origem do SettingChanging evento.

Confira também

• Context
• SettingChangingEventArgs