MethodData Class

Article
02/04/2013

Provides support for the IntelliSense method tip operation.

This API is not CLS-compliant. The CLS-compliant alternative is [None].

Inheritance Hierarchy

System.Object
Microsoft.VisualStudio.Package.MethodData

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

Syntax

'Declaration
<CLSCompliantAttribute(False)> _
Public Class MethodData _
    Implements IVsMethodData, IDisposable

[CLSCompliantAttribute(false)]
public class MethodData : IVsMethodData, IDisposable

[CLSCompliantAttribute(false)]
public ref class MethodData : IVsMethodData, 
    IDisposable

[<CLSCompliantAttribute(false)>]
type MethodData =  
    class
        interface IVsMethodData
        interface IDisposable
    end

public class MethodData implements IVsMethodData, IDisposable

The MethodData type exposes the following members.

Constructors

	Name	Description
	MethodData	Initializes a new instance of the MethodData class.

Top

Properties

	Name	Description
	IsDisplayed	Determines if the method tip is visible.
	Methods	Determines the list of method signatures that can be displayed in the method tip.
	MethodTipWindow	Determines the method tip window as represented by an IVsMethodTipWindow interface.
	Provider	Determines the service provider.
	TextView	Determines the view the method tip is displayed on.

Top

Methods

	Name	Description
	AdjustCurrentParameter	Update the current parameter, either forward or backward, by the specified amount.
	Close	Closes the method tip and clears the MethodData object.
	Dismiss	Dismisses the method tip from view.
	Dispose	Frees any allocations made just before the MethodData object is destroyed.
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetContextStream	Converts the current context span to a file position and length.
	GetCurMethod	Returns the currently visible method signature.
	GetCurrentParameter	Returns the current parameter being edited in the specified method signature.
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetMethodText	Returns the specified text for the specified method signature.
	GetOverloadCount	Returns the number of method signatures that can be shown.
	GetParameterCount	Returns the number of parameters available for the specified method signature.
	GetParameterText	Returns the specified parameter text for the specified method signature.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	NextMethod	Moves to the next method signature and returns the index of the current method signature.
	OnDismiss	Called after the method tip is removed from view.
	PrevMethod	Moves to the previous method signature and returns the index of the current method signature.
	Refresh	Displays the method tip with the given method signatures.
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	UpdateView	Updates the method tip display.

Top

Remarks

This class is used by the Source class to implement the IntelliSense method tip operation. This class presents the tool tip and manages it as the user types the various parameters. This class uses a Methods object to contain all of the appropriate method signatures for the method currently being typed. This Methods object is filled in by the parser when the parsing reason MethodTip is given.

Notes to Implementers

The base class already implements most of everything needed to support the IntelliSense method tip operation, so there is little need to derive from this class. If your language requires more specialized formatting of method data, then you must derive a class from the MethodData class and override the GetMethodText method. You must also override the CreateMethodData method in the Source class to create an instance of your version of the MethodData class.

This class interacts with the Methods class to obtain information on how to format method signatures. Specifically, this class consults the properties, OpenBracket, CloseBracket, Delimiter, TypePrefixed, TypePrefix, and TypePostfix to format the method signatures in the method tip. Since all of this information is obtained through the Methods class, you should not need to override the MethodData class.

Notes to Callers

This class is instantiated in the CreateMethodData method in the Source class.

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.

Share via