Share via


IPropertySymbol Interfaz

Definición

Representa una propiedad o indexador.

public interface class IPropertySymbol : IEquatable<Microsoft::CodeAnalysis::ISymbol ^>, Microsoft::CodeAnalysis::ISymbol
public interface IPropertySymbol : IEquatable<Microsoft.CodeAnalysis.ISymbol>, Microsoft.CodeAnalysis.ISymbol
type IPropertySymbol = interface
    interface ISymbol
    interface IEquatable<ISymbol>
Public Interface IPropertySymbol
Implements IEquatable(Of ISymbol), ISymbol
Implementaciones

Comentarios

Esta interfaz está reservada para su implementación por sus API asociadas. Nos reservamos el derecho de cambiarlo en el futuro.

Propiedades

CanBeReferencedByName

Devuelve true si se puede hacer referencia a este símbolo por su nombre en el código.

(Heredado de ISymbol)
ContainingAssembly

Obtiene para IAssemblySymbol el ensamblado contenedor. Devuelve null si el símbolo se comparte entre varios ensamblados.

(Heredado de ISymbol)
ContainingModule

Obtiene para IModuleSymbol el módulo contenedor. Devuelve null si el símbolo se comparte entre varios módulos.

(Heredado de ISymbol)
ContainingNamespace

Obtiene para INamespaceSymbol el espacio de nombres envolvente más cercano. Devuelve null si el símbolo no está contenido en un espacio de nombres.

(Heredado de ISymbol)
ContainingSymbol

Obtiene para ISymbol el símbolo que contiene inmediatamente.

(Heredado de ISymbol)
ContainingType

Obtiene para INamedTypeSymbol el tipo contenedor. Devuelve null si el símbolo no está contenido dentro de un tipo.

(Heredado de ISymbol)
DeclaredAccessibility

Obtiene un valor Accessibility de tipo que indica la accesibilidad declarada para el símbolo. Devuelve NotApplicable si no se declara ninguna accesibilidad.

(Heredado de ISymbol)
DeclaringSyntaxReferences

Obtenga los nodos de sintaxis donde se declaró este símbolo en el origen. Algunos símbolos (por ejemplo, clases parciales) se pueden definir en más de una ubicación. Esta propiedad solo debe devolver uno o varios nodos de sintaxis si el símbolo se declaró en el código fuente y tampoco se declaró implícitamente (vea la propiedad IsImplicitlyDeclared).

Tenga en cuenta que, para el símbolo del espacio de nombres, la sintaxis declaratoria podría declarar un espacio de nombres anidado. Por ejemplo, el nodo de sintaxis declarante para N1 en "espacio de nombres N1. N2 {...}" es el espacio de nombres completoDeclarationSyntax para N1. N2. Para el espacio de nombres global, la sintaxis declaratoria será CompilationUnitSyntax.

(Heredado de ISymbol)
ExplicitInterfaceImplementations

Devuelve las propiedades de interfaz implementadas explícitamente por esta propiedad.

GetMethod

Descriptor de acceso "get" de la propiedad, o null si la propiedad es de solo escritura.

HasUnsupportedMetadata

Indica que este símbolo usa metadatos que no pueden ser compatibles con el idioma.

Entre los ejemplos se incluyen:

  • Tipos de puntero en VB
  • Tipo de valor devuelto ByRef
  • Modificadores personalizados necesarios

Esto se distingue de, por ejemplo, referencias a símbolos de metadatos definidos en ensamblados a los que no se ha hecho referencia. Los símbolos en los que devuelve true nunca se pueden usar correctamente y, por tanto, nunca deben aparecer en ninguna característica del IDE.

Esto se establece para los símbolos de metadatos, como se indica a continuación:

  • Tipo: si un tipo no es compatible (por ejemplo, un tipo de puntero)
  • Método: el parámetro o el tipo de valor devuelto no son compatibles
  • Campo: el tipo no es compatible
  • Evento: el tipo no es compatible
  • Propiedad: el tipo no es compatible
  • Parámetro: el tipo no es compatible
(Heredado de ISymbol)
IsAbstract

Obtiene un valor que indica si el símbolo es abstracto.

(Heredado de ISymbol)
IsDefinition

Obtiene un valor que indica si el símbolo es la definición original. Devuelve false si el símbolo se deriva de otro símbolo, por sustitución de tipos por ejemplo.

(Heredado de ISymbol)
IsExtern

Obtiene un valor que indica si el símbolo se define externamente.

(Heredado de ISymbol)
IsImplicitlyDeclared

Devuelve true si el compilador creó automáticamente este símbolo y no tiene una declaración de código fuente correspondiente explícita.

(Heredado de ISymbol)
IsIndexer

Devuelve si la propiedad es realmente un indexador.

IsOverride

Obtiene un valor que indica si el símbolo es una invalidación de un símbolo de clase base.

(Heredado de ISymbol)
IsReadOnly

True si se trata de una propiedad de solo lectura; es decir, una propiedad sin descriptor de acceso set.

IsRequired

True si es necesario establecer esta propiedad en un inicializador de objeto durante la construcción.

IsSealed

Obtiene un valor que indica si el símbolo está sellado.

(Heredado de ISymbol)
IsStatic

Obtiene un valor que indica si el símbolo es estático.

(Heredado de ISymbol)
IsVirtual

Obtiene un valor que indica si el símbolo es virtual.

(Heredado de ISymbol)
IsWithEvents

Devuelve true si esta propiedad es una propiedad WithEvents creada automáticamente que tiene lugar de un miembro de campo cuando el campo se marca como WithEvents.

IsWriteOnly

True si se trata de una propiedad de solo escritura; es decir, una propiedad sin descriptor de acceso get.

Kind

Obtiene el SymbolKind que indica qué tipo de símbolo es.

(Heredado de ISymbol)
Language

Obtiene el lenguaje de origen ("C#" o "Visual Basic").

(Heredado de ISymbol)
Locations

Obtiene las ubicaciones en las que se definió originalmente el símbolo, ya sea en el origen o en los metadatos. Algunos símbolos (por ejemplo, clases parciales) se pueden definir en más de una ubicación.

(Heredado de ISymbol)
MetadataName

Obtiene el nombre de un símbolo tal como aparece en los metadatos. La mayoría de las veces, es lo mismo que la propiedad Name, con las siguientes excepciones:

  1. El nombre de metadatos de tipos genéricos incluye el sufijo "'1", "'2", etc., que indica el número de parámetros de tipo (no incluye, sin embargo, nombres de tipos o espacios de nombres que contienen).
  2. El nombre de metadatos de los nombres de interfaz explícitos tiene espacios quitados, en comparación con la propiedad name.
  3. La longitud de los nombres se limita a no superar las restricciones de metadatos.
(Heredado de ISymbol)
MetadataToken

Obtiene el token de metadatos asociado a este símbolo o 0 si el símbolo no se carga desde los metadatos.

(Heredado de ISymbol)
Name

Obtiene el nombre del símbolo. Devuelve la cadena vacía si no tiene nombre.

(Heredado de ISymbol)
NullableAnnotation

Representa una propiedad o indexador.

OriginalDefinition

Definición original de la propiedad . Si la propiedad se construye a partir de otro símbolo por sustitución de tipos, OriginalDefinition obtiene el símbolo original, tal como se definió en el origen o los metadatos.

OverriddenProperty

Devuelve la propiedad invalidada o null.

Parameters

Parámetros de esta propiedad. Si esta propiedad no tiene parámetros, devuelve una lista vacía. Los parámetros solo están presentes en los indexadores o en algunas propiedades importadas desde una interfaz COM.

RefCustomModifiers

Modificadores personalizados asociados con el modificador ref o una matriz vacía si no hay ninguno.

RefKind

Devuelve el RefKind de la propiedad .

ReturnsByRef

Devuelve true si esta propiedad devuelve por referencia.

ReturnsByRefReadonly

Devuelve true si esta propiedad devuelve por referencia a una variable de solo lectura.

SetMethod

Descriptor de acceso "set" de la propiedad o null si la propiedad es de solo lectura.

Type

Tipo de la propiedad.

TypeCustomModifiers

Lista de modificadores personalizados, si los hay, asociados al tipo de la propiedad .

Métodos

Accept(SymbolVisitor)

Representa una propiedad o indexador.

(Heredado de ISymbol)
Accept<TArgument,TResult>(SymbolVisitor<TArgument,TResult>, TArgument)

Representa una propiedad o indexador.

(Heredado de ISymbol)
Accept<TResult>(SymbolVisitor<TResult>)

Representa una propiedad o indexador.

(Heredado de ISymbol)
Equals(ISymbol, SymbolEqualityComparer)

Determina si este símbolo es igual a otro, según las reglas del proporcionado. SymbolEqualityComparer

(Heredado de ISymbol)
GetAttributes()

Obtiene los atributos del símbolo. Devuelve un valor vacío IEnumerable<T> si no hay atributos.

(Heredado de ISymbol)
GetDocumentationCommentId()

Devuelve el identificador de comentario de documentación para el símbolo o null si el símbolo no admite comentarios de documentación.

(Heredado de ISymbol)
GetDocumentationCommentXml(CultureInfo, Boolean, CancellationToken)

Obtiene el XML (como texto) del comentario asociado al símbolo.

(Heredado de ISymbol)
ToDisplayParts(SymbolDisplayFormat)

Convierta un símbolo en una matriz de partes de cadena, cada una de las cuales tiene un tipo . Útil para colorear la cadena de presentación.

(Heredado de ISymbol)
ToDisplayString(SymbolDisplayFormat)

Convierte el símbolo en una representación de cadena.

(Heredado de ISymbol)
ToMinimalDisplayParts(SemanticModel, Int32, SymbolDisplayFormat)

Convierta un símbolo en una matriz de partes de cadena, cada una de las cuales tiene un tipo . Puede adaptarse a una ubicación específica en el código fuente. Útil para colorear la cadena de presentación.

(Heredado de ISymbol)
ToMinimalDisplayString(SemanticModel, Int32, SymbolDisplayFormat)

Convierta un símbolo en una cadena que se pueda mostrar al usuario. Puede adaptarse a una ubicación específica en el código fuente.

(Heredado de ISymbol)

Métodos de extensión

IsDefault(IPropertySymbol)

Representa una propiedad o indexador.

IsMustOverride(ISymbol)

Representa una propiedad o indexador.

IsNotOverridable(ISymbol)

Representa una propiedad o indexador.

IsOverloads(IPropertySymbol)

Representa una propiedad o indexador.

IsOverridable(ISymbol)

Representa una propiedad o indexador.

IsOverrides(ISymbol)

Representa una propiedad o indexador.

IsShared(ISymbol)

Determina si el símbolo es Compartido.

Se aplica a