IPersistComponentSettings.SettingsKey Özellik

Tanım

Denetimin geçerli örneği için uygulama ayarları anahtarının değerini alır veya ayarlar.

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

Özellik Değeri

String Denetimin geçerli örneği için ayarlar anahtarını içeren.

Açıklamalar

SettingsKey Aynı sarmalayıcı sınıfının birden çok örneği olduğunda uygulama ayarları özellikleri gruplarının belirsiz olmasını sağlamak için özelliğini kullanın. Örneğin, bir denetim ilişkili bir sarmalayıcı sınıfı içeriyorsa, aynı denetimin birden çok örneğini aynı uygulamaya yerleştirmek genellikle sarmalayıcı sınıfının birden çok örneğine neden olur. Bir ayar anahtarı yalnızca yapılandırma verileri örnek bazında farklılık gösterdiğinde gereklidir; örneğin, dinamik olarak konumlandırılan denetimlerin konumu.

Kullanımı için SettingsKeyaşağıdaki genel kurallar geçerlidir:

  • Herhangi bir sınıf gibi bir denetim, öğesinden ApplicationSettingsBasetüretilmiş sıfır veya daha fazla uygulama ayarları sınıfı içerebilir. Her ayarlar sınıfı, bu sınıfın birden çok örneğini belirlemeye yardımcı olan kendi ApplicationSettingsBase.SettingsKey özelliğini içerir.

  • Denetim, örnek başına verilerini ve paylaşılan verilerini farklı ayar sınıflarına ayırmalıdır.

  • Örnek başına yapılandırma verilerine sahip bir denetim için, özelliğin getSettingsKey erişimcisi varsayılan olarak Name denetimin öğesine ayarlanmalıdır. Çoğu durumda denetimin adı bir uygulama içinde benzersiz olur. Denetim yalnızca paylaşılan yapılandırma verileri içeriyorsa, get varsayılan olarak nullolmalıdır.

  • Bu özelliğin set erişimcisi, örnek başına ve paylaşılan yapılandırma verilerini içeren ayarlar sınıflarını ayırt etmek için uygulanmalıdır. Örnek başına veri içeren her bir ayarlar sınıfı için, set ayarlar sınıfının özelliğine ApplicationSettingsBase.SettingsKey geçiş yapmalıdır. Paylaşılan verileri içeren ayarlar sınıfları için bu set ayarlar sınıfı için hiçbir eylem gerçekleştirmemelidir.

Şunlara uygulanır

Ayrıca bkz.