RecommendedAsConfigurableAttribute Clase

Definición

Advertencia

Esta API está ya obsoleta.

Especifica que la propiedad se puede utilizar como configuración de la aplicación.Specifies that the property can be used as an application setting.

public ref class RecommendedAsConfigurableAttribute : Attribute
[System.AttributeUsage(System.AttributeTargets.Property)]
[System.Obsolete("Use System.ComponentModel.SettingsBindableAttribute instead to work with the new settings model.")]
public class RecommendedAsConfigurableAttribute : Attribute
type RecommendedAsConfigurableAttribute = class
    inherit Attribute
Public Class RecommendedAsConfigurableAttribute
Inherits Attribute
Herencia
RecommendedAsConfigurableAttribute
Atributos

Ejemplos

En el ejemplo siguiente se marca una propiedad como utilizable como una configuración de la aplicación.The following example marks a property as usable as an application setting.

public:
   [RecommendedAsConfigurable(true)]
   property int MyProperty 
   {
      int get()
      {
         // Insert code here.
         return 0;
      }
      void set( int /*value*/ )
      {
         // Insert code here.
      }
   }
[RecommendedAsConfigurable(true)]
 public int MyProperty {
    get {
       // Insert code here.
       return 0;
    }
    set {
       // Insert code here.
    }
 }
<RecommendedAsConfigurable(True)> _
Public Property MyProperty() As Integer
    Get
        ' Insert code here.
        Return 0
    End Get
    Set
        ' Insert code here.
    End Set 
End Property

En el ejemplo siguiente se muestra cómo comprobar el valor de RecommendedAsConfigurableAttribute para MyProperty.The next example shows how to check the value of the RecommendedAsConfigurableAttribute for MyProperty. En primer lugar, el PropertyDescriptorCollection código obtiene una con todas las propiedades del objeto.First the code gets a PropertyDescriptorCollection with all the properties for the object. A continuación, se indexa en PropertyDescriptorCollection el para MyPropertyobtener.Next it indexes into the PropertyDescriptorCollection to get MyProperty. A continuación, devuelve los atributos de esta propiedad y los guarda en la variable Attributes.Then it returns the attributes for this property and saves them in the attributes variable.

Este ejemplo presenta dos maneras diferentes de comprobar el valor de RecommendedAsConfigurableAttribute.This example presents two different ways of checking the value of the RecommendedAsConfigurableAttribute. En el segundo fragmento de código, el ejemplo llama Equals al método.In the second code fragment, the example calls the Equals method. En el último fragmento de código, en el ejemplo RecommendedAsConfigurable se utiliza la propiedad para comprobar el valor.In the last code fragment, the example uses the RecommendedAsConfigurable property to check the value.

// Gets the attributes for the property.
AttributeCollection^ attributes = TypeDescriptor::GetProperties( this )[ "MyProperty" ]->Attributes;

// Checks to see if the value of the RecommendedAsConfigurableAttribute is Yes.
if ( attributes[ RecommendedAsConfigurableAttribute::typeid ]->Equals( RecommendedAsConfigurableAttribute::Yes ) )
{
   // Insert code here.
}

// This is another way to see if the property is recommended as configurable.
RecommendedAsConfigurableAttribute^ myAttribute = dynamic_cast<RecommendedAsConfigurableAttribute^>(attributes[ RecommendedAsConfigurableAttribute::typeid ]);
if ( myAttribute->RecommendedAsConfigurable )
{
   // Insert code here.
}
// Gets the attributes for the property.
AttributeCollection attributes = 
   TypeDescriptor.GetProperties(this)["MyProperty"].Attributes;
 
// Checks to see if the value of the RecommendedAsConfigurableAttribute is Yes.
if(attributes[typeof(RecommendedAsConfigurableAttribute)].Equals(RecommendedAsConfigurableAttribute.Yes)) {
   // Insert code here.
}
 
// This is another way to see if the property is recommended as configurable.
RecommendedAsConfigurableAttribute myAttribute = 
   (RecommendedAsConfigurableAttribute)attributes[typeof(RecommendedAsConfigurableAttribute)];
if(myAttribute.RecommendedAsConfigurable) {
   // Insert code here.
}
' Gets the attributes for the property.
Dim attributes As AttributeCollection = TypeDescriptor.GetProperties(Me)("MyProperty").Attributes

' Checks to see if the value of the RecommendedAsConfigurableAttribute is Yes.
If attributes(GetType(RecommendedAsConfigurableAttribute)).Equals(RecommendedAsConfigurableAttribute.Yes) Then
    ' Insert code here.
End If 

' This is another way to see if the property is recommended as configurable.
Dim myAttribute As RecommendedAsConfigurableAttribute = _
    CType(attributes(GetType(RecommendedAsConfigurableAttribute)), RecommendedAsConfigurableAttribute)
If myAttribute.RecommendedAsConfigurable Then
    ' Insert code here.
End If

Si marcó una clase con RecommendedAsConfigurableAttribute, use el código siguiente para comprobar el valor.If you marked a class with the RecommendedAsConfigurableAttribute, use the following code to check the value.

AttributeCollection^ attributes = TypeDescriptor::GetAttributes( MyProperty );
if ( attributes[ RecommendedAsConfigurableAttribute::typeid ]->Equals( RecommendedAsConfigurableAttribute::Yes ) )
{
   // Insert code here.
}
AttributeCollection attributes = 
   TypeDescriptor.GetAttributes(MyProperty);
if(attributes[typeof(RecommendedAsConfigurableAttribute)].Equals(RecommendedAsConfigurableAttribute.Yes)) {
   // Insert code here.
}
Dim attributes As AttributeCollection = TypeDescriptor.GetAttributes(MyProperty)
If attributes(GetType(RecommendedAsConfigurableAttribute)).Equals(RecommendedAsConfigurableAttribute.Yes) Then
    ' Insert code here.
End If 

Comentarios

Propiedades que están marcadas con RecommendedAsConfigurableAttribute el conjunto true que se va a mostrar al expandir la línea ConfigurableProperties en la ventana propiedades .Properties that are marked with the RecommendedAsConfigurableAttribute set to true display when you expand the ConfigurableProperties line in the Properties window. Una propiedad que no tiene ninguna configuración recomendada o que está marcada RecommendedAsConfigurableAttribute con establecido false en no se muestra y es improbable que sea una opción de configuración de la aplicación.A property that has no recommended setting or that is marked with RecommendedAsConfigurableAttribute set to false is not shown and is an unlikely candidate for being an application setting. De manera predeterminada, es false.The default is false.

Puede enlazar una propiedad que no tenga RecommendedAsConfigurableAttribute un a una configuración de Visual Studio haciendo clic en el botón de puntos suspensivos (...) en configuración en la ventana propiedades y seleccionando la propiedad adecuada de la lista.You can bind a property that does not have a RecommendedAsConfigurableAttribute to a setting in Visual Studio by clicking the ellipsis button (…) under Settings in the Properties window and selecting the appropriate property from the list.

Nota

Cuando se marca una propiedad con RecommendedAsConfigurableAttribute establecido en true, el valor de este atributo se establece en el miembro Yesde constante.When you mark a property with RecommendedAsConfigurableAttribute set to true, the value of this attribute is set to the constant member Yes. Para una propiedad marcada con RecommendedAsConfigurableAttribute establecido en Value false, el valor es No.For a property marked with RecommendedAsConfigurableAttribute set to value false, the value is No. Por lo tanto, si desea comprobar el valor de este atributo en el código, debe especificar el atributo como RecommendedAsConfigurableAttribute.Yes o. RecommendedAsConfigurableAttribute.NoTherefore, when you want to check the value of this attribute in your code, you must specify the attribute as RecommendedAsConfigurableAttribute.Yes or RecommendedAsConfigurableAttribute.No.

Para obtener más información, consulte Attributes (Atributos).For more information, see Attributes.

..

Constructores

RecommendedAsConfigurableAttribute(Boolean)

Inicializa una nueva instancia de la clase RecommendedAsConfigurableAttribute.Initializes a new instance of the RecommendedAsConfigurableAttribute class.

Campos

Default

Especifica el valor predeterminado de RecommendedAsConfigurableAttribute, que es No.Specifies the default value for the RecommendedAsConfigurableAttribute, which is No. Este campo static es de solo lectura.This static field is read-only.

No

Especifica que no se puede utilizar una propiedad como configuración de la aplicación.Specifies that a property cannot be used as an application setting. Este campo static es de solo lectura.This static field is read-only.

Yes

Especifica que una propiedad puede utilizarse como configuración de la aplicación.Specifies that a property can be used as an application setting. Este campo static es de solo lectura.This static field is read-only.

Propiedades

RecommendedAsConfigurable

Obtiene un valor que indica si la propiedad a la que está enlazado este atributo se puede utilizar como configuración de la aplicación.Gets a value indicating whether the property this attribute is bound to can be used as an application setting.

TypeId

Cuando se implementa en una clase derivada, obtiene un identificador único para este Attribute.When implemented in a derived class, gets a unique identifier for this Attribute.

(Heredado de Attribute)

Métodos

Equals(Object)

Indica si esta instancia y un objeto especificado son iguales.Indicates whether this instance and a specified object are equal.

GetHashCode()

Devuelve el código hash de esta instancia.Returns the hash code for this instance.

GetType()

Obtiene el Type de la instancia actual.Gets the Type of the current instance.

(Heredado de Object)
IsDefaultAttribute()

Indica si el valor de esta instancia es el valor predeterminado de la clase.Indicates whether the value of this instance is the default value for the class.

Match(Object)

Cuando se invalida en una clase derivada, devuelve un valor que indica si esta instancia es igual a un objeto especificado.When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Heredado de Attribute)
MemberwiseClone()

Crea una copia superficial del Object actual.Creates a shallow copy of the current Object.

(Heredado de Object)
ToString()

Devuelve un valor de tipo string que representa el objeto actual.Returns a string that represents the current object.

(Heredado de Object)

Implementaciones de interfaz explícitas

_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)

Asigna un conjunto de nombres a un conjunto correspondiente de identificadores de envío.Maps a set of names to a corresponding set of dispatch identifiers.

(Heredado de Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Obtiene la información de tipos de un objeto, que puede utilizarse para obtener la información de tipos de una interfaz.Retrieves the type information for an object, which can be used to get the type information for an interface.

(Heredado de Attribute)
_Attribute.GetTypeInfoCount(UInt32)

Recupera el número de interfaces de información de tipo que proporciona un objeto (0 ó 1).Retrieves the number of type information interfaces that an object provides (either 0 or 1).

(Heredado de Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Proporciona acceso a las propiedades y los métodos expuestos por un objeto.Provides access to properties and methods exposed by an object.

(Heredado de Attribute)

Se aplica a

Consulte también: