MethodData Class

 
clsCompliantAlternativeNone

Provides support for the IntelliSense method tip operation.

Namespace:   Microsoft.VisualStudio.Package
Assembly:  Microsoft.VisualStudio.Package.LanguageService.14.0 (in Microsoft.VisualStudio.Package.LanguageService.14.0.dll)

System.Object
  Microsoft.VisualStudio.Package.MethodData

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

NameDescription
System_CAPS_pubmethodMethodData(IServiceProvider)

Initializes a new instance of the MethodData class.

NameDescription
System_CAPS_pubpropertyIsDisplayed

Determines if the method tip is visible.

System_CAPS_protpropertyMethods

Determines the list of method signatures that can be displayed in the method tip.

System_CAPS_protpropertyMethodTipWindow

Determines the method tip window as represented by an IVsMethodTipWindow interface.

System_CAPS_protpropertyProvider

Determines the service provider.

System_CAPS_protpropertyTextView

Determines the view the method tip is displayed on.

NameDescription
System_CAPS_pubmethodAdjustCurrentParameter(Int32)

Update the current parameter, either forward or backward, by the specified amount.

System_CAPS_pubmethodClose()

Closes the method tip and clears the MethodData object.

System_CAPS_pubmethodDismiss()

Dismisses the method tip from view.

System_CAPS_pubmethodDispose()

Frees any allocations made just before the MethodData object is destroyed.

System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_protmethodFinalize()

(Inherited from Object.)

System_CAPS_pubmethodGetContextStream(Int32, Int32)

Converts the current context span to a file position and length.

System_CAPS_pubmethodGetCurMethod()

Returns the currently visible method signature.

System_CAPS_pubmethodGetCurrentParameter(Int32)

Returns the current parameter being edited in the specified method signature.

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetMethodText(Int32, MethodTextType)

Returns the specified text for the specified method signature.

System_CAPS_pubmethodGetOverloadCount()

Returns the number of method signatures that can be shown.

System_CAPS_pubmethodGetParameterCount(Int32)

Returns the number of parameters available for the specified method signature.

System_CAPS_pubmethodGetParameterText(Int32, Int32, ParameterTextType)

Returns the specified parameter text for the specified method signature.

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

(Inherited from Object.)

System_CAPS_pubmethodNextMethod()

Moves to the next method signature and returns the index of the current method signature.

System_CAPS_pubmethodOnDismiss()

Called after the method tip is removed from view.

System_CAPS_pubmethodPrevMethod()

Moves to the previous method signature and returns the index of the current method signature.

System_CAPS_pubmethodRefresh(IVsTextView, Methods, Int32, TextSpan)

Displays the method tip with the given method signatures.

System_CAPS_pubmethodToString()

(Inherited from Object.)

System_CAPS_pubmethodUpdateView()

Updates the method tip display.

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.

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

Return to top
Show: