Partilhar via


IPropertySymbol Interface

Definição

Representa uma propriedade ou 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
Implementações

Comentários

Essa interface é reservada para implementação por suas APIs associadas. Reservamos o direito de mudá-lo no futuro.

Propriedades

CanBeReferencedByName

Retornará true se esse símbolo puder ser referenciado por seu nome no código.

(Herdado de ISymbol)
ContainingAssembly

Obtém o IAssemblySymbol assembly que contém. Retornará nulo se o símbolo for compartilhado em vários assemblies.

(Herdado de ISymbol)
ContainingModule

Obtém o IModuleSymbol módulo que contém. Retornará nulo se o símbolo for compartilhado em vários módulos.

(Herdado de ISymbol)
ContainingNamespace

Obtém o INamespaceSymbol namespace de cercamento mais próximo. Retornará nulo se o símbolo não estiver contido em um namespace.

(Herdado de ISymbol)
ContainingSymbol

Obtém o ISymbol símbolo que contém imediatamente.

(Herdado de ISymbol)
ContainingType

Obtém o INamedTypeSymbol tipo que contém. Retornará nulo se o símbolo não estiver contido em um tipo.

(Herdado de ISymbol)
DeclaredAccessibility

Obtém uma Accessibility indicação da acessibilidade declarada para o símbolo. Retornará NotApplicable se nenhuma acessibilidade for declarada.

(Herdado de ISymbol)
DeclaringSyntaxReferences

Obtenha os nós de sintaxe em que esse símbolo foi declarado na origem. Alguns símbolos (por exemplo, classes parciais) podem ser definidos em mais de um local. Essa propriedade deve retornar um ou mais nós de sintaxe somente se o símbolo foi declarado no código-fonte e também não foi declarado implicitamente (consulte a propriedade IsImplicitlyDeclared).

Observe que, para o símbolo de namespace, a sintaxe de declaração pode estar declarando um namespace aninhado. Por exemplo, o nó de sintaxe de declaração para N1 no "namespace N1. N2 {...}" é toda a NamespaceDeclarationSyntax para N1. N2. Para o namespace global, a sintaxe de declaração será a CompilationUnitSyntax.

(Herdado de ISymbol)
ExplicitInterfaceImplementations

Retorna propriedades de interface explicitamente implementadas por essa propriedade.

GetMethod

O acessador 'get' da propriedade ou nulo se a propriedade for somente gravação.

HasUnsupportedMetadata

Indica que esse símbolo usa metadados que não podem ser suportados pelo idioma.

Os exemplos incluem:

  • Tipos de ponteiro no VB
  • Tipo de retorno ByRef
  • Modificadores personalizados necessários

Isso é diferenciado de, por exemplo, referências a símbolos de metadados definidos em assemblies que não foram referenciados. Símbolos em que isso retorna true nunca podem ser usados com êxito e, portanto, nunca devem aparecer em nenhum recurso de IDE.

Isso é definido para símbolos de metadados, da seguinte maneira:

  • Tipo - se um tipo não for compatível (por exemplo, um tipo de ponteiro)
  • Método – parâmetro ou tipo de retorno não tem suporte
  • Campo – o tipo não tem suporte
  • Evento – o tipo não tem suporte
  • Propriedade – o tipo não tem suporte
  • Parâmetro – o tipo não tem suporte

(Herdado de ISymbol)
IsAbstract

Obtém um valor que indica se o símbolo é abstrato.

(Herdado de ISymbol)
IsDefinition

Obtém um valor que indica se o símbolo é a definição original. Retornará false se o símbolo for derivado de outro símbolo, por substituição de tipo, por exemplo.

(Herdado de ISymbol)
IsExtern

Obtém um valor que indica se o símbolo é definido externamente.

(Herdado de ISymbol)
IsImplicitlyDeclared

Retorna true se esse símbolo foi criado automaticamente pelo compilador e não tem uma declaração de código-fonte correspondente explícita.

(Herdado de ISymbol)
IsIndexer

Retorna se a propriedade é realmente um indexador.

IsOverride

Obtém um valor que indica se o símbolo é uma substituição de um símbolo de classe base.

(Herdado de ISymbol)
IsReadOnly

True se esta for uma propriedade somente leitura; ou seja, uma propriedade sem acessador definido.

IsRequired

True se essa propriedade for necessária para ser definida em um inicializador de objeto durante a construção.

IsSealed

Obtém um valor que indica se o símbolo está lacrado.

(Herdado de ISymbol)
IsStatic

Obtém um valor que indica se o símbolo é estático.

(Herdado de ISymbol)
IsVirtual

Obtém um valor que indica se o símbolo é virtual.

(Herdado de ISymbol)
IsWithEvents

Retorna true se essa propriedade for uma propriedade WithEvents criada automaticamente que ocorre de um membro de campo quando o campo é marcado como WithEvents.

IsWriteOnly

True se esta for uma propriedade somente gravação; ou seja, uma propriedade sem acessador get.

Kind

Obtém o SymbolKind que indica que tipo de símbolo ele é.

(Herdado de ISymbol)
Language

Obtém a linguagem de origem ("C#" ou "Visual Basic").

(Herdado de ISymbol)
Locations

Obtém os locais em que o símbolo foi originalmente definido, seja na origem ou nos metadados. Alguns símbolos (por exemplo, classes parciais) podem ser definidos em mais de um local.

(Herdado de ISymbol)
MetadataName

Obtém o nome de um símbolo como ele aparece em metadados. Na maioria das vezes, isso é o mesmo que a propriedade Name, com as seguintes exceções:

  1. O nome dos metadados de tipos genéricos inclui o sufixo "'1", "'2" etc. que indica o número de parâmetros de tipo (ele não inclui, no entanto, nomes de tipos ou namespaces contendo).
  2. O nome dos metadados de nomes de interface explícitos tem espaços removidos, em comparação com a propriedade name.
  3. O comprimento dos nomes é limitado para não exceder as restrições de metadados.
(Herdado de ISymbol)
MetadataToken

Obtém o token de metadados associado a esse símbolo ou 0 se o símbolo não for carregado de metadados.

(Herdado de ISymbol)
Name

Obtém o nome do símbolo. Retorna a cadeia de caracteres vazia se não for nomeada.

(Herdado de ISymbol)
NullableAnnotation

Representa uma propriedade ou indexador.

OriginalDefinition

A definição original da propriedade. Se a propriedade for construída a partir de outro símbolo por substituição de tipo, OriginalDefinition obterá o símbolo original, como foi definido na origem ou metadados.

OverriddenProperty

Retorna a propriedade substituída ou nula.

Parameters

Os parâmetros dessa propriedade. Se essa propriedade não tiver parâmetros, retornará uma lista vazia. Os parâmetros só estão presentes em indexadores ou em algumas propriedades importadas de uma interface COM.

RefCustomModifiers

Modificadores personalizados associados ao modificador de ref ou a uma matriz vazia se não houver nenhum.

RefKind

Retorna o RefKind da propriedade.

ReturnsByRef

Retornará true se essa propriedade retornar por referência.

ReturnsByRefReadonly

Retorna true se essa propriedade retornar por referência uma variável readonly.

SetMethod

O acessador 'set' da propriedade ou nulo se a propriedade for somente leitura.

Type

O tipo da propriedade.

TypeCustomModifiers

A lista de modificadores personalizados, se houver, associada ao tipo da propriedade.

Métodos

Accept(SymbolVisitor)

Representa uma propriedade ou indexador.

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

Representa uma propriedade ou indexador.

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

Representa uma propriedade ou indexador.

(Herdado de ISymbol)
Equals(ISymbol, SymbolEqualityComparer)

Determina se esse símbolo é igual a outro, de acordo com as regras do fornecido SymbolEqualityComparer

(Herdado de ISymbol)
GetAttributes()

Obtém os atributos do símbolo. Retorna um vazio IEnumerable<T> se não houver atributos.

(Herdado de ISymbol)
GetDocumentationCommentId()

Retorna a ID de Comentário da Documentação do símbolo ou nula se o símbolo não oferecer suporte a comentários de documentação.

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

Obtém o XML (como texto) para o comentário associado ao símbolo.

(Herdado de ISymbol)
ToDisplayParts(SymbolDisplayFormat)

Converta um símbolo em uma matriz de partes de cadeia de caracteres, cada uma com um tipo. Útil para colorir a cadeia de caracteres de exibição.

(Herdado de ISymbol)
ToDisplayString(SymbolDisplayFormat)

Converte o símbolo em uma representação de cadeia de caracteres.

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

Converta um símbolo em uma matriz de partes de cadeia de caracteres, cada uma com um tipo. Pode ser adaptado para um local específico no código-fonte. Útil para colorir a cadeia de caracteres de exibição.

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

Converta um símbolo em uma cadeia de caracteres que pode ser exibida para o usuário. Pode ser adaptado para um local específico no código-fonte.

(Herdado de ISymbol)

Métodos de Extensão

IsDefault(IPropertySymbol)

Representa uma propriedade ou indexador.

IsMustOverride(ISymbol)

Representa uma propriedade ou indexador.

IsNotOverridable(ISymbol)

Representa uma propriedade ou indexador.

IsOverloads(IPropertySymbol)

Representa uma propriedade ou indexador.

IsOverridable(ISymbol)

Representa uma propriedade ou indexador.

IsOverrides(ISymbol)

Representa uma propriedade ou indexador.

IsShared(ISymbol)

Determina se o símbolo é Compartilhado.

Aplica-se a