Freigeben über


IPropertySymbol Schnittstelle

Definition

Stellt eine Eigenschaft oder einen Indexer dar.

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
Implementiert

Hinweise

Diese Schnittstelle ist für die Implementierung durch ihre zugeordneten APIs reserviert. Wir behalten uns das Recht vor, sie künftig zu ändern.

Eigenschaften

CanBeReferencedByName

Gibt true zurück, wenn dieses Symbol durch seinen Namen im Code verwiesen werden kann.

(Geerbt von ISymbol)
ContainingAssembly

Ruft die für die IAssemblySymbol enthaltende Assembly ab. Gibt null zurück, wenn das Symbol über mehrere Assemblys freigegeben wird.

(Geerbt von ISymbol)
ContainingModule

Ruft das IModuleSymbol enthaltende Modul ab. Gibt null zurück, wenn das Symbol über mehrere Module freigegeben wird.

(Geerbt von ISymbol)
ContainingNamespace

Ruft den INamespaceSymbol nächsten eingeschlossenen Namespace ab. Gibt null zurück, wenn das Symbol nicht in einem Namespace enthalten ist.

(Geerbt von ISymbol)
ContainingSymbol

Ruft das ISymbol sofort enthaltende Symbol ab.

(Geerbt von ISymbol)
ContainingType

Ruft den INamedTypeSymbol enthaltenden Typ ab. Gibt null zurück, wenn das Symbol nicht innerhalb eines Typs enthalten ist.

(Geerbt von ISymbol)
DeclaredAccessibility

Ruft eine Accessibility Angabe der deklarierten Barrierefreiheit für das Symbol ab. Gibt NotApplicable zurück, wenn keine Barrierefreiheit deklariert wird.

(Geerbt von ISymbol)
DeclaringSyntaxReferences

Rufen Sie die Syntaxknoten(n) ab, in denen dieses Symbol in der Quelle deklariert wurde. Einige Symbole (z. B. Teilklassen) können an mehreren Speicherorten definiert werden. Diese Eigenschaft sollte nur einen oder mehrere Syntaxknoten zurückgeben, wenn das Symbol im Quellcode deklariert wurde und auch nicht implizit deklariert wurde (siehe die IsImplicitlyDeclared-Eigenschaft).

Beachten Sie, dass für das Namespacesymbol die deklarierende Syntax möglicherweise einen geschachtelten Namespace deklariert. So wird beispielsweise der deklarierende Syntaxknoten für N1 in "Namespace N1" deklariert. N2 {...}" ist der gesamte NamespaceDeclarationSyntax für N1. N2. Für den globalen Namespace wird die deklarierende Syntax die CompilationUnitSyntax sein.

(Geerbt von ISymbol)
ExplicitInterfaceImplementations

Gibt Die von dieser Eigenschaft implementierten Schnittstelleneigenschaften explizit zurück.

GetMethod

Der "get"-Accessor der Eigenschaft oder null, wenn die Eigenschaft schreibgeschützt ist.

HasUnsupportedMetadata

Gibt an, dass dieses Symbol Metadaten verwendet, die von der Sprache nicht unterstützt werden können.

Beispiele:

  • Zeigertypen in VB
  • ByRef-Rückgabetyp
  • Erforderliche benutzerdefinierte Modifizierer

Dies unterscheidet sich beispielsweise von Verweisen auf Metadatensymbole, die in Assemblys definiert sind, die nicht referenziert wurden. Symbole, bei denen "true" zurückgegeben wird, können niemals erfolgreich verwendet werden und sollten daher niemals in einem IDE-Feature angezeigt werden.

Dies ist für Metadatensymbole wie folgt festgelegt:

  • Typ – wenn ein Typ nicht unterstützt wird (z. B. ein Zeigertyp)
  • Methode - Parameter oder Rückgabetyp wird nicht unterstützt
  • Feld – Typ wird nicht unterstützt
  • Ereignis – Typ wird nicht unterstützt
  • Eigenschaft – Typ wird nicht unterstützt
  • Parameter – Typ wird nicht unterstützt

(Geerbt von ISymbol)
IsAbstract

Ruft einen Wert ab, der angibt, ob das Symbol abstrahiert ist.

(Geerbt von ISymbol)
IsDefinition

Ruft einen Wert ab, der angibt, ob das Symbol die ursprüngliche Definition ist. Gibt "false" zurück, wenn das Symbol aus einem anderen Symbol abgeleitet wird, indem der Typ ersetzt wird, z. B.

(Geerbt von ISymbol)
IsExtern

Ruft einen Wert ab, der angibt, ob das Symbol extern definiert ist.

(Geerbt von ISymbol)
IsImplicitlyDeclared

Gibt true zurück, wenn dieses Symbol automatisch vom Compiler erstellt wurde und keine explizite entsprechende Quellcodedeklaration aufweist.

(Geerbt von ISymbol)
IsIndexer

Gibt zurück, ob die Eigenschaft wirklich ein Indexer ist.

IsOverride

Ruft einen Wert ab, der angibt, ob das Symbol eine Außerkraftsetzung eines Basisklassesymbols ist.

(Geerbt von ISymbol)
IsReadOnly

True, wenn dies eine schreibgeschützte Eigenschaft ist; das heißt, eine Eigenschaft ohne Set-Accessor.

IsRequired

True, wenn diese Eigenschaft während der Konstruktion in einem Objekt-Initializer festgelegt werden muss.

IsSealed

Ruft einen Wert ab, der angibt, ob das Symbol versiegelt ist.

(Geerbt von ISymbol)
IsStatic

Ruft einen Wert ab, der angibt, ob das Symbol statisch ist.

(Geerbt von ISymbol)
IsVirtual

Ruft einen Wert ab, der angibt, ob das Symbol virtual ist.

(Geerbt von ISymbol)
IsWithEvents

Gibt true zurück, wenn diese Eigenschaft eine automatisch erstellte WithEvents-Eigenschaft ist, die ein Feldelement darstellt, wenn das Feld als WithEvents gekennzeichnet ist.

IsWriteOnly

True, wenn dies eine schreibgeschützte Eigenschaft ist; das heißt, eine Eigenschaft ohne Get Accessor.

Kind

Ruft den SymbolKind Hinweis ab, welche Art von Symbol es ist.

(Geerbt von ISymbol)
Language

Ruft die Quellsprache ("C#" oder "Visual Basic") ab.

(Geerbt von ISymbol)
Locations

Ruft die Speicherorte ab, an denen das Symbol ursprünglich definiert wurde, entweder in Quelle oder Metadaten. Einige Symbole (z. B. Teilklassen) können an mehreren Speicherorten definiert werden.

(Geerbt von ISymbol)
MetadataName

Ruft den Namen eines Symbols ab, wie es in Metadaten angezeigt wird. Dies entspricht der meisten Zeit der Name-Eigenschaft mit den folgenden Ausnahmen:

  1. Der Metadatenname der generischen Typen enthält das Suffix "'1", "'2" usw., das die Anzahl der Typparameter angibt (es enthält jedoch keine Namen von Typen oder Namespaces).
  2. Der Metadatenname expliziter Schnittstellennamen hat Leerzeichen entfernt, verglichen mit der Name-Eigenschaft.
  3. Die Länge der Namen ist beschränkt, um Metadateneinschränkungen nicht zu überschreiten.
(Geerbt von ISymbol)
MetadataToken

Ruft das Metadatentoken ab, das diesem Symbol zugeordnet ist, oder 0, wenn das Symbol nicht aus Metadaten geladen wird.

(Geerbt von ISymbol)
Name

Ruft den Symbolnamen ab. Gibt die leere Zeichenfolge zurück, wenn sie nicht benannt ist.

(Geerbt von ISymbol)
NullableAnnotation

Stellt eine Eigenschaft oder einen Indexer dar.

OriginalDefinition

Die ursprüngliche Definition der Eigenschaft. Wenn die Eigenschaft von einem anderen Symbol nach Typbesetzung erstellt wird, ruft OriginalDefinition das ursprüngliche Symbol ab, wie sie in Quell- oder Metadaten definiert wurde.

OverriddenProperty

Gibt die überschriebene Eigenschaft oder null zurück.

Parameters

Die Parameter dieser Eigenschaft. Wenn diese Eigenschaft keine Parameter aufweist, gibt eine leere Liste zurück. Parameter sind nur in Indexern vorhanden oder in einigen Eigenschaften, die aus einer COM-Schnittstelle importiert wurden.

RefCustomModifiers

Benutzerdefinierte Modifizierer, die dem Ref modifier zugeordnet sind, oder ein leeres Array, wenn keine vorhanden sind.

RefKind

Gibt das RefKind der Eigenschaft zurück.

ReturnsByRef

Gibt true zurück, wenn diese Eigenschaft nach Referenz zurückgegeben wird.

ReturnsByRefReadonly

Gibt true zurück, wenn diese Eigenschaft durch Verweis auf eine Readonly-Variable zurückgegeben wird.

SetMethod

Der 'set'-Accessor der Eigenschaft oder null, wenn die Eigenschaft schreibgeschützt ist.

Type

Den Typ der Eigenschaft.

TypeCustomModifiers

Die Liste der benutzerdefinierten Modifizierer, sofern vorhanden, dem Typ der Eigenschaft zugeordnet.

Methoden

Accept(SymbolVisitor)

Stellt eine Eigenschaft oder einen Indexer dar.

(Geerbt von ISymbol)
Accept<TArgument,TResult>(SymbolVisitor<TArgument,TResult>, TArgument)

Stellt eine Eigenschaft oder einen Indexer dar.

(Geerbt von ISymbol)
Accept<TResult>(SymbolVisitor<TResult>)

Stellt eine Eigenschaft oder einen Indexer dar.

(Geerbt von ISymbol)
Equals(ISymbol, SymbolEqualityComparer)

Bestimmt, ob dieses Symbol einer anderen entspricht, gemäß den Regeln der bereitgestellten SymbolEqualityComparer

(Geerbt von ISymbol)
GetAttributes()

Ruft die Attribute für das Symbol ab. Gibt einen leeren IEnumerable<T> Wert zurück, wenn keine Attribute vorhanden sind.

(Geerbt von ISymbol)
GetDocumentationCommentId()

Gibt die Dokumentationskommentar-ID für das Symbol oder null zurück, wenn das Symbol keine Dokumentationskommentare unterstützt.

(Geerbt von ISymbol)
GetDocumentationCommentXml(CultureInfo, Boolean, CancellationToken)

Ruft den XML-Code (als Text) für den Kommentar ab, der dem Symbol zugeordnet ist.

(Geerbt von ISymbol)
ToDisplayParts(SymbolDisplayFormat)

Konvertieren Sie ein Symbol in ein Array von Zeichenfolgenteilen, die jeweils eine Art haben. Nützlich für die Farbisierung der Anzeigezeichenfolge.

(Geerbt von ISymbol)
ToDisplayString(SymbolDisplayFormat)

Konvertiert das Symbol in eine Zeichenfolgendarstellung.

(Geerbt von ISymbol)
ToMinimalDisplayParts(SemanticModel, Int32, SymbolDisplayFormat)

Konvertieren Sie ein Symbol in ein Array von Zeichenfolgenteilen, die jeweils eine Art haben. Kann an einen bestimmten Speicherort im Quellcode angepasst werden. Nützlich für die Farbisierung der Anzeigezeichenfolge.

(Geerbt von ISymbol)
ToMinimalDisplayString(SemanticModel, Int32, SymbolDisplayFormat)

Konvertieren Sie ein Symbol in eine Zeichenfolge, die dem Benutzer angezeigt werden kann. Kann an einen bestimmten Speicherort im Quellcode angepasst werden.

(Geerbt von ISymbol)

Erweiterungsmethoden

IsDefault(IPropertySymbol)

Stellt eine Eigenschaft oder einen Indexer dar.

IsMustOverride(ISymbol)

Stellt eine Eigenschaft oder einen Indexer dar.

IsNotOverridable(ISymbol)

Stellt eine Eigenschaft oder einen Indexer dar.

IsOverloads(IPropertySymbol)

Stellt eine Eigenschaft oder einen Indexer dar.

IsOverridable(ISymbol)

Stellt eine Eigenschaft oder einen Indexer dar.

IsOverrides(ISymbol)

Stellt eine Eigenschaft oder einen Indexer dar.

IsShared(ISymbol)

Bestimmt, ob das Symbol freigegeben ist.

Gilt für: