Condividi tramite


IPersistComponentSettings.SettingsKey Proprietà

Definizione

Ottiene o imposta il valore della chiave delle impostazioni dell'applicazione per l'istanza corrente del controllo.

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

Valore della proprietà

Classe String che contiene la chiave delle impostazioni per l'istanza corrente del controllo.

Commenti

Utilizzare la SettingsKey proprietà per disambiguare i gruppi di proprietà delle impostazioni dell'applicazione quando sono presenti più istanze della stessa classe wrapper. Ad esempio, se un controllo contiene una classe wrapper associata, l'inserimento di più istanze dello stesso controllo nella stessa applicazione comporta in genere più istanze della classe wrapper. Una chiave di impostazioni è necessaria solo quando i dati di configurazione differiscono in base a ogni istanza; ad esempio, la posizione dei controlli posizionati dinamicamente.

Le regole generali seguenti si applicano all'uso di SettingsKey:

  • Un controllo, come qualsiasi classe, può contenere zero o più classi di impostazioni dell'applicazione, derivate da ApplicationSettingsBase. Ogni classe di impostazioni contiene la propria ApplicationSettingsBase.SettingsKey proprietà, che consente di disambiguare più istanze di tale classe.

  • Un controllo deve separare i dati per istanza e i relativi dati condivisi in classi di impostazioni diverse.

  • Per un controllo con tutti i dati di configurazione per istanza, la get funzione di accesso della SettingsKey proprietà deve essere predefinita all'oggetto Name del controllo. Nella maggior parte dei casi il nome del controllo sarà univoco all'interno di un'applicazione. Se il controllo contiene solo dati di configurazione condivisi, get deve essere impostato come predefinito su null.

  • La set funzione di accesso per questa proprietà deve essere implementata per distinguere tra le classi di impostazioni contenenti dati di configurazione per istanza e condivisi. Per ogni classe di impostazioni contenente dati per istanza, set è sufficiente passare la ApplicationSettingsBase.SettingsKey proprietà della classe impostazioni. Per le classi di impostazioni contenenti dati condivisi, set non deve eseguire alcuna azione per tale classe di impostazioni.

Si applica a

Vedi anche