property (C++/CLI y C++/CX)

Declara una propiedad, que es una función miembro que se comporta y a la que se tiene acceso como un miembro de datos o un elemento de matriz.

Todos los runtimes

Puede declarar uno de los siguientes tipos de propiedades.

• propiedad simple
  De manera predeterminada, crea un descriptor de acceso set que asigna el valor de propiedad, un descriptor de acceso get que recupera el valor de propiedad y un miembro de datos privado generado por el compilador que contiene el valor de propiedad.

• bloque de propiedades
  Use un bloque de propiedades para crear descriptores de acceso get o set definidos por el usuario. La propiedad es de lectura y escritura si están definidos los descriptores de acceso get y set, de solo lectura si solo está definido el descriptor de acceso get y de solo lectura si solo está definido el descriptor de acceso set.

  Debe declarar explícitamente un miembro de datos que contenga el valor de propiedad.

• propiedad indizada
  Un bloque de propiedades que puede usar para obtener y establecer un valor de propiedad especificado por uno o más índices.

  Puede crear una propiedad indizada que tenga un nombre de propiedad definido por el usuario o un nombre de propiedad predeterminado. El nombre de una propiedad de índice predeterminado es el nombre de la clase en la que se define la propiedad. Para declarar una propiedad predeterminada, especifique la palabra clave default en lugar del nombre de propiedad.

Declare explícitamente un miembro de datos que contenga el valor de propiedad. Para una propiedad indizada, el miembro de datos suele ser una matriz o una colección.

Sintaxis

property type property_name;

property type property_name {
   access-modifier type get() inheritance-modifier {property_body};
   access-modifier void set(type value) inheritance-modifier {property_body};
}

property type property_name[index_list] {
   access-modifier type get(index_list) inheritance-modifier {property_body};
   access-modifier void set(index_list, value) inheritance-modifier {property_body};
}

property type default[index_list] {
   access-modifier type get(index_list) inheritance-modifier {property_body};
   access-modifier void set(index_list, value) inheritance-modifier {property_body};
}

Parámetros

type
El tipo de datos del valor de propiedad y de la propiedad en sí.

property_name
El nombre de la propiedad.

access-modifier
Un calificador de acceso. Los calificadores válidos son static y virtual.

Los descriptores de acceso get o set no pueden coincidir con el calificador virtual, pero deben hacerlo con el calificador static.

inheritance-modifier
Un calificador de herencia. Los calificadores válidos son abstract y sealed.

index_list
Una lista delimitada por comas de uno o más índices. Cada índice consta de un tipo de índice y un identificador opcional que puede utilizarse en el cuerpo del método de propiedad.

value
El valor que se va a asignar a la propiedad en una operación set o que se va a recuperar en una operación get.

property_body
El cuerpo del método de propiedad del descriptor de acceso set o get. property_body puede utilizar index_list para acceder al miembro de datos de propiedad subyacente, o como parámetros en el procesamiento definido por el usuario.

Windows en tiempo de ejecución

Para obtener más información, consulte Propiedades (C++/CX).

Requisitos

Opción del compilador: /ZW

Common Language Runtime

Sintaxis

modifier property type property_name;

modifier property type property_name {
   modifier void set(type);
   modifier type get();
}
modifier property type property_name[index-list, value] {
   modifier void set(index-list, value);
   modifier type get(index-list);

modifier property type default[index];
}

Parámetros

modifier
Un modificador que se puede utilizar en la declaración de propiedad o en un método de descriptor de acceso get/set. Los valores posibles son static y virtual.

type
El tipo del valor representado por la propiedad.

property_name
Parámetros del método raise; debe coincidir con la signatura del delegado.

index_list
Una lista delimitada por comas de uno o varios índices especificados entre corchetes (el operador de subíndice, []). Para cada índice, especifique un tipo y, de forma opcional, un identificador que pueden utilizarse en el cuerpo del método de propiedad.

Comentarios

En el primer ejemplo de sintaxis se muestra una propiedad simple, que declara implícitamente un método set y get. El compilador crea automáticamente un campo privado para almacenar el valor de la propiedad.

En el segundo ejemplo de sintaxis se muestra un bloque de propiedades, que declara explícitamente un método set y get.

En el tercer ejemplo de sintaxis se muestra una propiedad de índice definida por el cliente. Una propiedad de índice toma parámetros además del valor que se debe establecer o recuperar. Especifique un nombre para la propiedad. A diferencia de una propiedad simple, los métodos set y get de una propiedad de índice se deben definir explícitamente y se debe especificar un nombre para la propiedad.

En el cuarto ejemplo de sintaxis se muestra una propiedad predeterminada, que proporciona acceso de tipo matriz a una instancia del tipo. La palabra clave, default, solo sirve para especificar una propiedad predeterminada. El nombre de la propiedad predeterminada es el nombre del tipo en el que se define la propiedad.

La palabra clave property puede aparecer en una clase, interfaz o tipo de valor. Una propiedad puede tener una función get (solo lectura), una función set (solo escritura) o ambas (lectura y escritura).

El nombre de propiedad no puede coincidir con el nombre de la clase administrada que lo contiene. El tipo de valor devuelto de la función captadora debe coincidir con el tipo del último parámetro de una función establecedora correspondiente.

En cuanto al código de cliente, una propiedad tiene el aspecto de un miembro de datos normal, y puede escribirse en o leerse de con la misma sintaxis que un miembro de datos.

Los métodos get y set no pueden coincidir con el modificador virtual.

La accesibilidad del método get puede ser diferente de la del método set.

La definición de un método de propiedad puede aparecer fuera del cuerpo de la clase, como en un método normal.

Los métodos get y set de una propiedad deben coincidir con el modificador static.

Una propiedad es escalar si sus métodos get y set se ajustan a la descripción siguiente:

• El método get no tiene parámetros y tiene el tipo de valor devuelto T.

• El método set tiene un parámetro de tipo T y el tipo de valor devuelto void.

Debe haber solo una propiedad escalar declarada en un ámbito con el mismo identificador. Las propiedades escalares no se pueden sobrecargar.

Cuando se declara un miembro de datos de propiedad, el compilador inserta un miembro de datos (a veces denominado "memoria auxiliar") en la clase. Sin embargo, el nombre del miembro de datos está formado para que no pueda hacerse referencia al miembro en el origen como si fuera un miembro de datos reales de la clase contenedora. Use ildasm.exe para ver los metadatos para el tipo y ver el nombre generado por el compilador de la memoria auxiliar de la propiedad.

Se permite la accesibilidad diferente para los métodos del descriptor de acceso en un bloque de propiedades. Es decir, el método set puede ser public y el método get puede ser private. Sin embargo, es un error que un método del descriptor de acceso tenga una accesibilidad menos restrictiva que la de la declaración misma de la propiedad.

property es una palabra clave contextual. Para obtener más información, consulte Palabras clave contextuales.

Requisitos

Opción del compilador: /clr

Ejemplos

En el ejemplo siguiente se muestra la declaración y el uso de un miembro de datos de propiedad y un bloque de propiedades. También se muestra que se puede definir un descriptor de acceso de propiedad fuera de la clase.

// mcppv2_property.cpp
// compile with: /clr
using namespace System;
public ref class C {
   int MyInt;
public:

   // property data member
   property String ^ Simple_Property;

   // property block
   property int Property_Block {

      int get();

      void set(int value) {
         MyInt = value;
      }
   }
};

int C::Property_Block::get() {
   return MyInt;
}

int main() {
   C ^ MyC = gcnew C();
   MyC->Simple_Property = "test";
   Console::WriteLine(MyC->Simple_Property);

   MyC->Property_Block = 21;
   Console::WriteLine(MyC->Property_Block);
}

test

21

Consulte también

Extensiones de componentes de .NET y UWP