Click or drag to resize

IMethodSymbol Interface



Represents a method or method-like symbol (including constructor, destructor, operator, or property/event accessor).

Namespace:  Microsoft.CodeAnalysis
Assembly:  Microsoft.CodeAnalysis (in Microsoft.CodeAnalysis.dll) Version: 2.3.0-dev-56735-00. Commit Hash: <developer build>
Syntax
public interface IMethodSymbol : ISymbol, 
	IEquatable

The IMethodSymbol type exposes the following members.

Properties
  NameDescription
Public propertyArity
Returns the arity of this method, or the number of type parameters it takes. A non-generic method has zero arity.
Public propertyAssociatedAnonymousDelegate
If this method is a Lambda method (MethodKind = MethodKind.LambdaMethod) and there is an anonymous delegate associated with it, returns this delegate. Returns null if the symbol is not a lambda or if it does not have an anonymous delegate associated with it.
Public propertyAssociatedSymbol
Returns a symbol (e.g. property, event, etc.) associated with the method.
Public propertyCanBeReferencedByName
Returns true if this symbol can be referenced by its name in code.
(Inherited from ISymbol.)
Public propertyConstructedFrom
Returns the method symbol that this method was constructed from. The resulting method symbol has the same containing type (if any), but has type arguments that are the same as the type parameters (although its containing type might not).
Public propertyContainingAssembly
Gets the IAssemblySymbol for the containing assembly. Returns null if the symbol is shared across multiple assemblies.
(Inherited from ISymbol.)
Public propertyContainingModule
Gets the IModuleSymbol for the containing module. Returns null if the symbol is shared across multiple modules.
(Inherited from ISymbol.)
Public propertyContainingNamespace
Gets the INamespaceSymbol for the nearest enclosing namespace. Returns null if the symbol isn't contained in a namespace.
(Inherited from ISymbol.)
Public propertyContainingSymbol
Gets the ISymbol for the immediately containing symbol.
(Inherited from ISymbol.)
Public propertyContainingType
Gets the INamedTypeSymbol for the containing type. Returns null if the symbol is not contained within a type.
(Inherited from ISymbol.)
Public propertyDeclaredAccessibility
Gets a Accessibility indicating the declared accessibility for the symbol. Returns NotApplicable if no accessibility is declared.
(Inherited from ISymbol.)
Public propertyDeclaringSyntaxReferences
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.)
Public propertyExplicitInterfaceImplementations
Returns interface methods explicitly implemented by this method.
Public propertyHasUnsupportedMetadata
Indicates that this symbol uses metadata that cannot be supported by the language. Examples include: - Pointer types in VB - ByRef return type - Required custom modifiers 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: Type - if a type is unsupported (e.g., a pointer type, etc.) Method - parameter or return type is unsupported Field - type is unsupported Event - type is unsupported Property - type is unsupported Parameter - type is unsupported
(Inherited from ISymbol.)
Public propertyHidesBaseMethodsByName
Returns true if this method hides base methods by name. This cannot be specified directly in the C# language, but can be true for methods defined in other languages imported from metadata. The equivalent of the "hidebyname" flag in metadata.
Public propertyIsAbstract
Gets a value indicating whether the symbol is abstract.
(Inherited from ISymbol.)
Public propertyIsAsync
Returns true if this method is an async method
Public propertyIsCheckedBuiltin
Returns whether this built-in operator checks for integer overflow.
Public propertyIsDefinition
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.)
Public propertyIsExtensionMethod
Returns true if this method is an extension method.
Public propertyIsExtern
Gets a value indicating whether the symbol is defined externally.
(Inherited from ISymbol.)
Public propertyIsGenericMethod
Returns whether this method is generic; i.e., does it have any type parameters?
Public propertyIsImplicitlyDeclared
Returns true if this symbol was automatically created by the compiler, and does not have an explicit corresponding source code declaration.
(Inherited from ISymbol.)
Public propertyIsOverride
Gets a value indicating whether the symbol is an override of a base class symbol.
(Inherited from ISymbol.)
Public propertyIsSealed
Gets a value indicating whether the symbol is sealed.
(Inherited from ISymbol.)
Public propertyIsStatic
Gets a value indicating whether the symbol is static.
(Inherited from ISymbol.)
Public propertyIsVararg
Returns whether this method is using CLI VARARG calling convention. This is used for C-style variable argument lists. This is used extremely rarely in C# code and is represented using the undocumented "__arglist" keyword. Note that methods with "params" on the last parameter are indicated with the "IsParams" property on ParameterSymbol, and are not represented with this property.
Public propertyIsVirtual
Gets a value indicating whether the symbol is virtual.
(Inherited from ISymbol.)
Public propertyKind
Gets the SymbolKind indicating what kind of symbol it is.
(Inherited from ISymbol.)
Public propertyLanguage
Gets the source language ("C#" or "Visual Basic").
(Inherited from ISymbol.)
Public propertyLocations
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.)
Public propertyMetadataName
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: 1) The metadata name of generic types includes the "`1", "`2" etc. suffix that indicates the number of type parameters (it does not include, however, names of containing types or namespaces). 2) The metadata name of explicit interface names have spaces removed, compared to the name property. 3) The length of names is limited to not exceed metadata restrictions.
(Inherited from ISymbol.)
Public propertyMethodKind
Gets what kind of method this is. There are several different kinds of things in the C# language that are represented as methods. This property allow distinguishing those things without having to decode the name of the method.
Public propertyName
Gets the symbol name. Returns the empty string if unnamed.
(Inherited from ISymbol.)
Public propertyOriginalDefinition
Get the original definition of this symbol. If this symbol is derived from another symbol by (say) type substitution, this gets the original symbol, as it was defined in source or metadata.
Public propertyOverriddenMethod
If this method overrides another method (because it both had the override modifier and there correctly was a method to override), returns the overridden method.
Public propertyParameters
Gets the parameters of this method. If this method has no parameters, returns an empty list.
Public propertyPartialDefinitionPart
If this is a partial method implementation part, returns the corresponding definition part. Otherwise null.
Public propertyPartialImplementationPart
If this is a partial method declaration without a body, and the method is implemented with a body, returns that implementing definition. Otherwise null.
Public propertyReceiverType
If this method can be applied to an object, returns the type of object it is applied to.
Public propertyReducedFrom
If this method is a reduced extension method, returns the definition of extension method from which this was reduced. Otherwise, returns null.
Public propertyRefCustomModifiers
Custom modifiers associated with the ref modifier, or an empty array if there are none.
Public propertyReturnsByRef
Returns true if this method returns by reference.
Public propertyReturnsVoid
Returns true if this method has no return type; i.e., returns "void".
Public propertyReturnType
Gets the return type of the method.
Public propertyReturnTypeCustomModifiers
Returns the list of custom modifiers, if any, associated with the return type.
Public propertyTypeArguments
Returns the type arguments that have been substituted for the type parameters. If nothing has been substituted for a given type parameter, then the type parameter itself is consider the type argument.
Public propertyTypeParameters
Get the type parameters on this method. If the method has not generic, returns an empty list.
Top
Methods
  NameDescription
Public methodAccept(SymbolVisitor) (Inherited from ISymbol.)
Public methodAcceptTResult(SymbolVisitorTResult) (Inherited from ISymbol.)
Public methodConstruct
Returns a constructed method given its type arguments.
Public methodGetAttributes (Inherited from ISymbol.)
Public methodGetDllImportData
Platform invoke information, or null if the method isn't a P/Invoke.
Public methodGetDocumentationCommentId
Returns the Documentation Comment ID for the symbol, or null if the symbol doesn't support documentation comments.
(Inherited from ISymbol.)
Public methodGetDocumentationCommentXml
Gets the XML (as text) for the comment associated with the symbol.
(Inherited from ISymbol.)
Public methodGetReturnTypeAttributes
Returns the list of custom attributes, if any, associated with the returned value.
Public methodGetTypeInferredDuringReduction
If this method is a reduced extension method, returns a type inferred during reduction process for the type parameter.
Public methodReduceExtensionMethod
If this is an extension method that can be applied to a receiver of the given type, returns a reduced extension method symbol thus formed. Otherwise, returns null.
Public methodToDisplayParts
Convert a symbol to an array of string parts, each of which has a kind. Useful for colorizing the display string.
(Inherited from ISymbol.)
Public methodToDisplayString
Converts the symbol to a string representation.
(Inherited from ISymbol.)
Public methodToMinimalDisplayParts
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.)
Public methodToMinimalDisplayString
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.)
Top
Extension Methods
  NameDescription
Public Extension MethodGetConstructedReducedFrom
Returns the constructed form of the ReducedFrom property, including the type arguments that were either inferred during reduction or supplied at the call site.
(Defined by ISymbolExtensions.)
Public Extension MethodGetRootOperation (Defined by OperationExtensions.)
Public Extension MethodHandledEvents (Defined by VisualBasicExtensions.)
Public Extension MethodIsMustOverride (Defined by VisualBasicExtensions.)
Public Extension MethodIsNotOverridable (Defined by VisualBasicExtensions.)
Public Extension MethodIsOverloads (Defined by VisualBasicExtensions.)
Public Extension MethodIsOverridable (Defined by VisualBasicExtensions.)
Public Extension MethodIsOverrides (Defined by VisualBasicExtensions.)
Public Extension MethodIsShared
Determines if symbol is Shared.
(Defined by VisualBasicExtensions.)
Top
Remarks
This interface is reserved for implementation by its associated APIs. We reserve the right to change it in the future.
See Also