IPersistComponentSettings.SettingsKey Propriedade

Definição

Espaço de Nomes:
System.Configuration
Assemblagem:
System.dll

Obtém ou define o valor da chave de definições da aplicação para a instância atual do controlo.

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 de Propriedade

String

A String contendo a tecla de definições para a instância atual do controlo.

Observações

Use a SettingsKey propriedade para desambiguar grupos de propriedades das definições da aplicação quando existem múltiplas instâncias da mesma classe de wrapper. Por exemplo, se um controlo contiver uma classe wrapper associada, então colocar múltiplas instâncias do mesmo controlo na mesma aplicação normalmente resultará em múltiplas instâncias da classe wrapper. Uma chave de definições é necessária apenas quando os dados de configuração diferem por instância; por exemplo, a localização de controlos posicionados dinamicamente.

As seguintes regras gerais aplicam-se ao uso de SettingsKey:

  • Um controlo, como qualquer classe, pode conter zero ou mais classes de configurações de aplicação, derivadas de ApplicationSettingsBase. Cada classe settings contém a sua própria ApplicationSettingsBase.SettingsKey propriedade, o que ajuda a desambiguar múltiplas instâncias dessa classe.

  • Um controlo deve separar os seus dados por instância e os dados partilhados em diferentes classes de definição.

  • Para um controlo com qualquer dado de configuração por instância, o get acessório da SettingsKey propriedade deve ser o Name do controlo por defeito. Na maioria dos casos, o nome do controlo será único dentro de uma aplicação. Se o controlo contiver apenas dados de configuração partilhados, get deve ser por defeito .null

  • O set acessório para esta propriedade deve ser implementado para distinguir entre classes de definições que contêm dados de configuração por instância e dados de configuração partilhados. Para cada classe de settings que contenha dados por instância, set deve simplesmente passar para a ApplicationSettingsBase.SettingsKey propriedade da classe settings. Para classes de definição que contenham dados partilhados, set não devem executar nenhuma ação para essa classe de definições.

Aplica-se a

Ver também