IPersistComponentSettings.SettingsKey Propriedade

Definição

Namespace:

System.Configuration

Assembly:

System.Configuration.ConfigurationManager.dll

Pacote:

System.Configuration.ConfigurationManager v8.0.0

Origem:

IPersistComponentSettings.cs

Obtém ou define o valor da chave de configurações do aplicativo para a instância atual do controle.

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

public string SettingsKey { get; set; }

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 a instância atual do controle.

Comentários

Use a SettingsKey propriedade para desambiguar grupos de propriedades de configurações de aplicativo quando houver várias instâncias da mesma classe wrapper. Por exemplo, se um controle contiver uma classe wrapper associada, colocar várias instâncias do mesmo controle no mesmo aplicativo normalmente resultará em várias instâncias da classe wrapper. Uma chave de configurações é necessária somente quando os dados de configuração diferem por instância; por exemplo, o local dos controles posicionados dinamicamente.

As seguintes regras gerais se aplicam ao uso de SettingsKey:

• Um controle, como qualquer classe, pode conter zero ou mais classes de configurações de aplicativo, derivadas de ApplicationSettingsBase. Cada classe de configurações contém sua própria ApplicationSettingsBase.SettingsKey propriedade, o que ajuda a desambiguar várias instâncias dessa classe.

• Um controle deve separar seus dados por instância e seus dados compartilhados em classes de configurações diferentes.

• Para um controle com qualquer dado de configuração por instância, o get acessador da SettingsKey propriedade deve usar como padrão o Name do controle. Na maioria dos casos, o nome do controle será exclusivo em um aplicativo. Se o controle contiver apenas dados de configuração compartilhados, get o padrão nullserá .

• O set acessador dessa propriedade deve ser implementado para distinguir entre as classes de configurações que contêm dados de configuração por instância e compartilhados. Para cada classe de configurações que contém dados por instância, set basta passar para a ApplicationSettingsBase.SettingsKey propriedade da classe de configurações. Para classes de configurações que contêm dados compartilhados, set não deve executar nenhuma ação para essa classe de configurações.

Confira também

• SaveComponentSettings()
• SettingsKey
• Configurações do aplicativo para controles personalizados