ITypeSymbol Interface
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Represents a type.
public interface class ITypeSymbol : IEquatable<Microsoft::CodeAnalysis::ISymbol ^>, Microsoft::CodeAnalysis::INamespaceOrTypeSymbol
public interface ITypeSymbol : IEquatable<Microsoft.CodeAnalysis.ISymbol>, Microsoft.CodeAnalysis.INamespaceOrTypeSymbol
type ITypeSymbol = interface
interface INamespaceOrTypeSymbol
interface ISymbol
interface IEquatable<ISymbol>
Public Interface ITypeSymbol
Implements IEquatable(Of ISymbol), INamespaceOrTypeSymbol
- Derived
- Implements
Remarks
This interface is reserved for implementation by its associated APIs. We reserve the right to change it in the future.
Properties
AllInterfaces |
The list of all interfaces of which this type is a declared subtype, excluding this type itself. This includes all declared base interfaces, all declared base interfaces of base types, and all declared base interfaces of those results (recursively). This also is the effective interface set of a type parameter. Each result appears exactly once in the list. This list is topologically sorted by the inheritance relationship: if interface type A extends interface type B, then A precedes B in the list. This is not quite the same as "all interfaces of which this type is a proper subtype" because it does not take into account variance: AllInterfaces for IEnumerable<string> will not include IEnumerable<object>. |
BaseType |
The declared base type of this type, or null. The object type, interface types, and pointer types do not have a base type. The base type of a type parameter is its effective base class. |
CanBeReferencedByName |
Returns true if this symbol can be referenced by its name in code. (Inherited from ISymbol) |
ContainingAssembly |
Gets the IAssemblySymbol for the containing assembly. Returns null if the symbol is shared across multiple assemblies. (Inherited from ISymbol) |
ContainingModule |
Gets the IModuleSymbol for the containing module. Returns null if the symbol is shared across multiple modules. (Inherited from ISymbol) |
ContainingNamespace |
Gets the INamespaceSymbol for the nearest enclosing namespace. Returns null if the symbol isn't contained in a namespace. (Inherited from ISymbol) |
ContainingSymbol |
Gets the ISymbol for the immediately containing symbol. (Inherited from ISymbol) |
ContainingType |
Gets the INamedTypeSymbol for the containing type. Returns null if the symbol is not contained within a type. (Inherited from ISymbol) |
DeclaredAccessibility |
Gets a Accessibility indicating the declared accessibility for the symbol. Returns NotApplicable if no accessibility is declared. (Inherited from ISymbol) |
DeclaringSyntaxReferences |
Get the syntax node(s) where this symbol was declared in source. Some symbols (for example, partial classes) may be defined in more than one location. This property should return one or more syntax nodes only if the symbol was declared in source code and also was not implicitly declared (see the IsImplicitlyDeclared property). Note that for namespace symbol, the declaring syntax might be declaring a nested namespace. For example, the declaring syntax node for N1 in "namespace N1.N2 {...}" is the entire NamespaceDeclarationSyntax for N1.N2. For the global namespace, the declaring syntax will be the CompilationUnitSyntax. (Inherited from ISymbol) |
HasUnsupportedMetadata |
Indicates that this symbol uses metadata that cannot be supported by the language. Examples include:
This is distinguished from, for example, references to metadata symbols defined in assemblies that weren't referenced. Symbols where this returns true can never be used successfully, and thus should never appear in any IDE feature. This is set for metadata symbols, as follows:
|
Interfaces |
Gets the set of interfaces that this type directly implements. This set does not include interfaces that are base interfaces of directly implemented interfaces. This does include the interfaces declared as constraints on type parameters. |
IsAbstract |
Gets a value indicating whether the symbol is abstract. (Inherited from ISymbol) |
IsAnonymousType |
Is this a symbol for an anonymous type (including anonymous VB delegate). |
IsDefinition |
Gets a value indicating whether the symbol is the original definition. Returns false if the symbol is derived from another symbol, by type substitution for instance. (Inherited from ISymbol) |
IsExtern |
Gets a value indicating whether the symbol is defined externally. (Inherited from ISymbol) |
IsImplicitlyDeclared |
Returns true if this symbol was automatically created by the compiler, and does not have an explicit corresponding source code declaration. (Inherited from ISymbol) |
IsNamespace |
Returns true if this symbol is a namespace. If it is not a namespace, it must be a type. (Inherited from INamespaceOrTypeSymbol) |
IsNativeIntegerType |
True if the type represents a native integer. In C#, the types represented by language keywords 'nint' and 'nuint'. |
IsOverride |
Gets a value indicating whether the symbol is an override of a base class symbol. (Inherited from ISymbol) |
IsReadOnly |
True if the type is readonly. |
IsRecord |
For source symbols, true if the type is a record. For metadata symbols, true if the type is a record and a reference type. |
IsReferenceType |
True if this type is known to be a reference type. It is never the case that IsReferenceType and IsValueType both return true. However, for an unconstrained type parameter, IsReferenceType and IsValueType will both return false. |
IsRefLikeType |
True if the type is ref-like, meaning it follows rules similar to CLR by-ref variables. False if the type is not ref-like or if the language has no concept of ref-like types. |
IsSealed |
Gets a value indicating whether the symbol is sealed. (Inherited from ISymbol) |
IsStatic |
Gets a value indicating whether the symbol is static. (Inherited from ISymbol) |
IsTupleType |
Is this a symbol for a tuple . |
IsType |
Returns true if this symbols is a type. If it is not a type, it must be a namespace. (Inherited from INamespaceOrTypeSymbol) |
IsUnmanagedType |
True if the type is unmanaged according to language rules. False if managed or if the language has no concept of unmanaged types. |
IsValueType |
True if this type is known to be a value type. It is never the case that IsReferenceType and IsValueType both return true. However, for an unconstrained type parameter, IsReferenceType and IsValueType will both return false. |
IsVirtual |
Gets a value indicating whether the symbol is virtual. (Inherited from ISymbol) |
Kind |
Gets the SymbolKind indicating what kind of symbol it is. (Inherited from ISymbol) |
Language |
Gets the source language ("C#" or "Visual Basic"). (Inherited from ISymbol) |
Locations |
Gets the locations where the symbol was originally defined, either in source or metadata. Some symbols (for example, partial classes) may be defined in more than one location. (Inherited from ISymbol) |
MetadataName |
Gets the name of a symbol as it appears in metadata. Most of the time, this is the same as the Name property, with the following exceptions:
|
MetadataToken |
Gets the metadata token associated with this symbol, or 0 if the symbol is not loaded from metadata. (Inherited from ISymbol) |
Name |
Gets the symbol name. Returns the empty string if unnamed. (Inherited from ISymbol) |
NullableAnnotation |
Nullable annotation associated with the type, or None if there are none. |
OriginalDefinition |
The original definition of this symbol. If this symbol is constructed from another symbol by type substitution then OriginalDefinition gets the original symbol as it was defined in source or metadata. |
SpecialType |
An enumerated value that identifies certain 'special' types such as Object. Returns None if the type is not special. |
TypeKind |
An enumerated value that identifies whether this type is an array, pointer, enum, and so on. |
Methods
Accept(SymbolVisitor) | (Inherited from ISymbol) |
Accept<TArgument,TResult>(SymbolVisitor<TArgument,TResult>, TArgument) | (Inherited from ISymbol) |
Accept<TResult>(SymbolVisitor<TResult>) | (Inherited from ISymbol) |
Equals(ISymbol, SymbolEqualityComparer) |
Determines if this symbol is equal to another, according to the rules of the provided SymbolEqualityComparer (Inherited from ISymbol) |
FindImplementationForInterfaceMember(ISymbol) |
Returns the corresponding symbol in this type or a base type that implements interfaceMember (either implicitly or explicitly), or null if no such symbol exists (which might be either because this type doesn't implement the container of interfaceMember, or this type doesn't supply a member that successfully implements interfaceMember). |
GetAttributes() |
Gets the attributes for the symbol. Returns an empty IEnumerable<T> if there are no attributes. (Inherited from ISymbol) |
GetDocumentationCommentId() |
Returns the Documentation Comment ID for the symbol, or null if the symbol doesn't support documentation comments. (Inherited from ISymbol) |
GetDocumentationCommentXml(CultureInfo, Boolean, CancellationToken) |
Gets the XML (as text) for the comment associated with the symbol. (Inherited from ISymbol) |
GetMembers() |
Get all the members of this symbol. (Inherited from INamespaceOrTypeSymbol) |
GetMembers(String) |
Get all the members of this symbol that have a particular name. (Inherited from INamespaceOrTypeSymbol) |
GetTypeMembers() |
Get all the members of this symbol that are types. (Inherited from INamespaceOrTypeSymbol) |
GetTypeMembers(String) |
Get all the members of this symbol that are types that have a particular name, of any arity. (Inherited from INamespaceOrTypeSymbol) |
GetTypeMembers(String, Int32) |
Get all the members of this symbol that are types that have a particular name and arity (Inherited from INamespaceOrTypeSymbol) |
ToDisplayParts(NullableFlowState, SymbolDisplayFormat) |
Converts a symbol to an array of string parts, each of which has a kind. Useful for colorizing the display string. |
ToDisplayParts(SymbolDisplayFormat) |
Convert a symbol to an array of string parts, each of which has a kind. Useful for colorizing the display string. (Inherited from ISymbol) |
ToDisplayString(NullableFlowState, SymbolDisplayFormat) |
Converts an |
ToDisplayString(SymbolDisplayFormat) |
Converts the symbol to a string representation. (Inherited from ISymbol) |
ToMinimalDisplayParts(SemanticModel, Int32, SymbolDisplayFormat) |
Convert a symbol to an array of string parts, each of which has a kind. May be tailored to a specific location in the source code. Useful for colorizing the display string. (Inherited from ISymbol) |
ToMinimalDisplayParts(SemanticModel, NullableFlowState, Int32, SymbolDisplayFormat) |
Convert a symbol to an array of string parts, each of which has a kind. May be tailored to a specific location in the source code. Useful for colorizing the display string. |
ToMinimalDisplayString(SemanticModel, Int32, SymbolDisplayFormat) |
Convert a symbol to a string that can be displayed to the user. May be tailored to a specific location in the source code. (Inherited from ISymbol) |
ToMinimalDisplayString(SemanticModel, NullableFlowState, Int32, SymbolDisplayFormat) |
Converts a symbol to a string that can be displayed to the user. May be tailored to a specific location in the source code. |
WithNullableAnnotation(NullableAnnotation) |
Returns the same type as this type but with the given nullable annotation. |
Extension Methods
IsMustOverride(ISymbol) | |
IsNotOverridable(ISymbol) | |
IsOverridable(ISymbol) | |
IsOverrides(ISymbol) | |
IsShared(ISymbol) |
Determines if symbol is Shared. |