IPersistComponentSettings.SettingsKey Propiedad

Definición

Espacio de nombres:

System.Configuration

Ensamblado:

System.Configuration.ConfigurationManager.dll

Paquete:

System.Configuration.ConfigurationManager v8.0.0

Source:

IPersistComponentSettings.cs

Obtiene o establece el valor de la clave de configuración de aplicación para la instancia actual del control.

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 propiedad

String

String que contiene la clave de configuración para la instancia actual del control.

Comentarios

Use la propiedad para eliminar la SettingsKey ambigüedad de los grupos de propiedades de configuración de la aplicación cuando hay varias instancias de la misma clase contenedora. Por ejemplo, si un control contiene una clase contenedora asociada, la colocación de varias instancias del mismo control en la misma aplicación normalmente dará lugar a varias instancias de la clase contenedora. Solo se requiere una clave de configuración cuando los datos de configuración difieren por instancia; por ejemplo, la ubicación de los controles colocados dinámicamente.

Las siguientes reglas generales se aplican al uso de SettingsKey:

• Un control, como cualquier clase, puede contener cero o más clases de configuración de aplicación, derivadas de ApplicationSettingsBase. Cada clase de configuración contiene su propia ApplicationSettingsBase.SettingsKey propiedad, lo que ayuda a eliminar la ambigüedad de varias instancias de esa clase.

• Un control debe separar sus datos por instancia y sus datos compartidos en diferentes clases de configuración.

• Para un control con cualquier dato de configuración por instancia, el get descriptor de acceso de la SettingsKey propiedad debe tener como valor predeterminado el Name del control . En la mayoría de los casos, el nombre del control será único dentro de una aplicación. Si el control solo contiene datos de configuración compartidos, get el valor predeterminado nulles .

• El set descriptor de acceso de esta propiedad debe implementarse para distinguir entre las clases de configuración que contienen datos de configuración por instancia y compartidos. Para cada clase de configuración que contenga datos por instancia, set solo debe pasarse a la ApplicationSettingsBase.SettingsKey propiedad de la clase settings. Para las clases de configuración que contienen datos compartidos, set no debe realizar ninguna acción para esa clase de configuración.

Consulte también

• SaveComponentSettings()
• SettingsKey
• Configuración de la aplicación para controles personalizados