IPropertySymbol Interface
Définition
Important
Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.
Représente une propriété ou un indexeur.
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
- Implémente
Remarques
Cette interface est réservée à l’implémentation par ses API associées. Nous nous réservons le droit de le changer à l’avenir.
Propriétés
CanBeReferencedByName |
Retourne true si ce symbole peut être référencé par son nom dans le code. (Hérité de ISymbol) |
ContainingAssembly |
Obtient l’assembly IAssemblySymbol contenant. Renvoie la valeur Null si le symbole est partagé entre plusieurs assemblys. (Hérité de ISymbol) |
ContainingModule |
Obtient le IModuleSymbol module contenant. Renvoie la valeur Null si le symbole est partagé entre plusieurs modules. (Hérité de ISymbol) |
ContainingNamespace |
Obtient l’espace de noms englobant le INamespaceSymbol plus proche. Retourne null si le symbole n’est pas contenu dans un espace de noms. (Hérité de ISymbol) |
ContainingSymbol |
Obtient le ISymbol symbole immédiatement contenant. (Hérité de ISymbol) |
ContainingType |
Obtient le INamedTypeSymbol type contenant. Retourne null si le symbole n’est pas contenu dans un type. (Hérité de ISymbol) |
DeclaredAccessibility |
Obtient un Accessibility indicateur de l’accessibilité déclarée pour le symbole. Renvoie NotApplicable si aucune accessibilité n’est déclarée. (Hérité de ISymbol) |
DeclaringSyntaxReferences |
Obtenez le ou les nœuds de syntaxe où ce symbole a été déclaré dans la source. Certains symboles (par exemple, des classes partielles) peuvent être définis dans plusieurs emplacements. Cette propriété doit retourner un ou plusieurs nœuds de syntaxe uniquement si le symbole a été déclaré dans le code source et n’a pas été déclaré implicitement (voir la propriété IsImplicitlyDeclared). Notez que pour le symbole d’espace de noms, la syntaxe de déclaration peut déclarer un espace de noms imbriqué. Par exemple, le nœud de syntaxe de déclaration pour N1 dans « espace de noms N1 ». N2 {...} » est l’intégralité de NamespaceDeclarationSyntax pour N1. N2. Pour l’espace de noms global, la syntaxe de déclaration sera compilationUnitSyntax. (Hérité de ISymbol) |
ExplicitInterfaceImplementations |
Retourne les propriétés d’interface explicitement implémentées par cette propriété. |
GetMethod |
Accesseur « get » de la propriété ou null si la propriété est en écriture seule. |
HasUnsupportedMetadata |
Indique que ce symbole utilise des métadonnées qui ne peuvent pas être prises en charge par la langue. Voici quelques exemples :
Il s’agit, par exemple, de références aux symboles de métadonnées définis dans les assemblys qui n’ont pas été référencés. Les symboles dans lesquels cette valeur retourne true ne peuvent jamais être utilisées correctement, et ne doivent donc jamais apparaître dans n’importe quelle fonctionnalité IDE. Cette valeur est définie pour les symboles de métadonnées, comme suit :
|
IsAbstract |
Obtient une valeur indiquant si le symbole est abstrait. (Hérité de ISymbol) |
IsDefinition |
Obtient une valeur indiquant si le symbole est la définition d’origine. Retourne false si le symbole est dérivé d’un autre symbole, par substitution de type par exemple. (Hérité de ISymbol) |
IsExtern |
Obtient une valeur indiquant si le symbole est défini en externe. (Hérité de ISymbol) |
IsImplicitlyDeclared |
Retourne true si ce symbole a été créé automatiquement par le compilateur et n’a pas de déclaration de code source explicite. (Hérité de ISymbol) |
IsIndexer |
Retourne si la propriété est vraiment un indexeur. |
IsOverride |
Obtient une valeur indiquant si le symbole est un remplacement d’un symbole de classe de base. (Hérité de ISymbol) |
IsReadOnly |
True s’il s’agit d’une propriété en lecture seule ; autrement dit, une propriété sans accesseur défini. |
IsRequired |
True si cette propriété doit être définie dans un initialiseur d’objet pendant la construction. |
IsSealed |
Obtient une valeur indiquant si le symbole est scellé. (Hérité de ISymbol) |
IsStatic |
Obtient une valeur indiquant si le symbole est statique. (Hérité de ISymbol) |
IsVirtual |
Obtient une valeur indiquant si le symbole est virtuel. (Hérité de ISymbol) |
IsWithEvents |
Renvoie la valeur true si cette propriété est une propriété WithEvents créée automatiquement qui a lieu d’un membre de champ lorsque le champ est marqué comme WithEvents. |
IsWriteOnly |
True s’il s’agit d’une propriété en écriture seule ; autrement dit, une propriété sans accesseur. |
Kind |
Obtient l’indicateur SymbolKind du type de symbole qu’il est. (Hérité de ISymbol) |
Language |
Obtient le langage source (« C# » ou « Visual Basic »). (Hérité de ISymbol) |
Locations |
Obtient les emplacements où le symbole a été défini à l’origine, dans la source ou les métadonnées. Certains symboles (par exemple, des classes partielles) peuvent être définis dans plusieurs emplacements. (Hérité de ISymbol) |
MetadataName |
Obtient le nom d’un symbole tel qu’il apparaît dans les métadonnées. La plupart du temps, c’est le même que la propriété Name, avec les exceptions suivantes :
|
MetadataToken |
Obtient le jeton de métadonnées associé à ce symbole ou 0 si le symbole n’est pas chargé à partir de métadonnées. (Hérité de ISymbol) |
Name |
Obtient le nom du symbole. Retourne la chaîne vide si elle n’est pas nommée. (Hérité de ISymbol) |
NullableAnnotation |
Représente une propriété ou un indexeur. |
OriginalDefinition |
Définition d’origine de la propriété. Si la propriété est construite à partir d’un autre symbole par substitution de type, OriginalDefinition obtient le symbole d’origine, tel qu’il a été défini dans la source ou les métadonnées. |
OverriddenProperty |
Retourne la propriété substituée ou null. |
Parameters |
Paramètres de cette propriété. Si cette propriété n’a aucun paramètre, retourne une liste vide. Les paramètres sont présents uniquement sur les indexeurs ou sur certaines propriétés importées à partir d’une interface COM. |
RefCustomModifiers |
Modificateurs personnalisés associés au modificateur ref ou tableau vide s’il n’y en a aucun. |
RefKind |
Retourne le RefKind de la propriété. |
ReturnsByRef |
Retourne true si cette propriété retourne par référence. |
ReturnsByRefReadonly |
Renvoie la valeur true si cette propriété retourne par référence une variable en lecture seule. |
SetMethod |
Accesseur « set » de la propriété ou null si la propriété est en lecture seule. |
Type |
Type de la propriété. |
TypeCustomModifiers |
Liste des modificateurs personnalisés, le cas échéant, associée au type de la propriété. |
Méthodes
Accept(SymbolVisitor) |
Représente une propriété ou un indexeur. (Hérité de ISymbol) |
Accept<TArgument,TResult>(SymbolVisitor<TArgument,TResult>, TArgument) |
Représente une propriété ou un indexeur. (Hérité de ISymbol) |
Accept<TResult>(SymbolVisitor<TResult>) |
Représente une propriété ou un indexeur. (Hérité de ISymbol) |
Equals(ISymbol, SymbolEqualityComparer) |
Détermine si ce symbole est égal à un autre, en fonction des règles du symbole fourni SymbolEqualityComparer (Hérité de ISymbol) |
GetAttributes() |
Obtient les attributs du symbole. Retourne une valeur vide IEnumerable<T> s’il n’y a pas d’attributs. (Hérité de ISymbol) |
GetDocumentationCommentId() |
Retourne l’ID de commentaire de documentation du symbole ou null si le symbole ne prend pas en charge les commentaires de documentation. (Hérité de ISymbol) |
GetDocumentationCommentXml(CultureInfo, Boolean, CancellationToken) |
Obtient le code XML (en tant que texte) du commentaire associé au symbole. (Hérité de ISymbol) |
ToDisplayParts(SymbolDisplayFormat) |
Convertissez un symbole en tableau de parties de chaîne, chacun ayant un type. Utile pour coloriser la chaîne d’affichage. (Hérité de ISymbol) |
ToDisplayString(SymbolDisplayFormat) |
Convertit le symbole en représentation sous forme de chaîne. (Hérité de ISymbol) |
ToMinimalDisplayParts(SemanticModel, Int32, SymbolDisplayFormat) |
Convertissez un symbole en tableau de parties de chaîne, chacun ayant un type. Peut être adapté à un emplacement spécifique dans le code source. Utile pour coloriser la chaîne d’affichage. (Hérité de ISymbol) |
ToMinimalDisplayString(SemanticModel, Int32, SymbolDisplayFormat) |
Convertissez un symbole en chaîne qui peut être affiché à l’utilisateur. Peut être adapté à un emplacement spécifique dans le code source. (Hérité de ISymbol) |
Méthodes d’extension
IsDefault(IPropertySymbol) |
Représente une propriété ou un indexeur. |
IsMustOverride(ISymbol) |
Représente une propriété ou un indexeur. |
IsNotOverridable(ISymbol) |
Représente une propriété ou un indexeur. |
IsOverloads(IPropertySymbol) |
Représente une propriété ou un indexeur. |
IsOverridable(ISymbol) |
Représente une propriété ou un indexeur. |
IsOverrides(ISymbol) |
Représente une propriété ou un indexeur. |
IsShared(ISymbol) |
Détermine si le symbole est partagé. |