IPersistComponentSettings.SettingsKey 屬性

定義

命名空間:

System.Configuration

組件:

System.Configuration.ConfigurationManager.dll

套件:

System.Configuration.ConfigurationManager v8.0.0

來源:

IPersistComponentSettings.cs

取得或設定目前控制項執行個體的應用程式設定索引鍵值。

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

屬性值

String

String，包含目前控制項執行個體的設定索引鍵。

備註

SettingsKey當同一個包裝函式類別有多個實例時，請使用 屬性來釐清應用程式設定屬性的群組。 例如，如果控件包含相關聯的包裝函式類別，則在相同的應用程式中放置相同控件的多個實例，通常會導致包裝函式類別的多個實例。 只有在每個實例的組態數據不同時，才需要設定索引鍵;例如，動態定位控制元件的位置。

下列一般規則適用於 的使用 SettingsKey：

• 與任何類別一樣，控件可能包含衍生自 ApplicationSettingsBase的零或多個應用程式設定類別。 每個設定類別都包含自己的 ApplicationSettingsBase.SettingsKey 屬性，有助於釐清該類別的多個實例。

• 控件應該將其每個實例的數據及其共享數據分隔成不同的設定類別。

• 對於具有任何個別實例組態數據的控件， get 屬性的 SettingsKey 存取子應該預設為 Name 控件的 。 在大部分情況下，控件的名稱在應用程式中會是唯一的。 如果控制檔只包含共享元件資料， get 則應該預設為 null。

• set應該實作這個屬性的存取子，以區分包含每個實例和共用組態數據的設定類別。 針對包含每個實例數據的每個設定類別， set 應該只傳遞至 ApplicationSettingsBase.SettingsKey 設定類別的屬性。 對於包含共用數據的設定類別， set 應該不會針對該設定類別執行任何動作。

另請參閱

• SaveComponentSettings()
• SettingsKey
• 自訂控制項的應用程式設定