Share via


Methods Class

Represents a collection of method signatures obtained from a parsing operation in a language service.

This API is not CLS-compliant. 

Inheritance Hierarchy

Object
  Microsoft.VisualStudio.Package.Methods

Namespace:  Microsoft.VisualStudio.Package
Assemblies:   Microsoft.VisualStudio.Package.LanguageService.9.0 (in Microsoft.VisualStudio.Package.LanguageService.9.0.dll)
  Microsoft.VisualStudio.Package.LanguageService.10.0 (in Microsoft.VisualStudio.Package.LanguageService.10.0.dll)
  Microsoft.VisualStudio.Package.LanguageService (in Microsoft.VisualStudio.Package.LanguageService.dll)
  Microsoft.VisualStudio.Package.LanguageService.12.0 (in Microsoft.VisualStudio.Package.LanguageService.12.0.dll)
  Microsoft.VisualStudio.Package.LanguageService.11.0 (in Microsoft.VisualStudio.Package.LanguageService.11.0.dll)

Syntax

'Declaration
<CLSCompliantAttribute(False)> _
Public MustInherit Class Methods
[CLSCompliantAttribute(false)]
public abstract class Methods
[CLSCompliantAttribute(false)]
public ref class Methods abstract
[<AbstractClass>]
[<CLSCompliantAttribute(false)>]
type Methods =  class end
public abstract class Methods

The Methods type exposes the following members.

Constructors

  Name Description
Protected method Methods When implemented in a derived class, initializes a new instance of the Methods class.

Top

Properties

  Name Description
Public property CloseBracket Gets the character to use at the end of a method parameter list.
Public property DefaultMethod Gets the index of the initial method signature to show.
Public property Delimiter Gets the character that separates parameters in a method's parameter list.
Public property OpenBracket Gets the character to use at the start of a method's parameter list.
Public property TypePostfix Gets the string to place after the return type of a method.
Public property TypePrefix Gets the string to place before the return type of a method.
Public property TypePrefixed Gets whether a method's return type comes before or after the method signature.

Top

Methods

  Name Description
Public method Equals Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetCount When implemented in a derived class, gets the number of overloaded method signatures represented in this collection.
Public method GetDescription When implemented in a derived class, gets the description of the specified method signature.
Public method GetHashCode Serves as the default hash function. (Inherited from Object.)
Public method GetName When implemented in a derived class, gets the name of the specified method signature.
Public method GetParameterCount When implemented in a derived class, gets the number of parameters on the specified method signature.
Public method GetParameterInfo When implemented in a derived class, gets information about the specified parameter on the specified method signature.
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method GetType(Int32) When implemented in a derived class, gets the return type of the specified method signature.
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)

Top

Remarks

This abstract class is used primarily to support the IntelliSense method tip operation. The collection typically holds a single method and all of its overloaded signatures, the parameters and return type for each version.

This class also specifies the characters used to format a method signature for display. These include the parameter list's start and end characters, the character that separates parameters, and information about whether the type information precedes or follows each parameter and the method name itself. For example, in Visual C#, the parameter start and end characters are the open and close parentheses, respectively, the parameter separator is a comma, and the types appear before the method names.

Notes to Implementers

If you are going to support the IntelliSense method tip operation, you must provide a class derived from Methods. In order to instantiate this class you must derive a class from the AuthoringScope class and call the constructor of your derived class in your implementation of the GetMethods method.

Notes to Callers

The Methods class is used in the MethodData class to handle the method tip operation.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.VisualStudio.Package Namespace