AuthoringScope Class

 

Encapsulates information about the source as obtained from a parsing 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.AuthoringScope

[CLSCompliantAttribute(false)]
public abstract class AuthoringScope

NameDescription
System_CAPS_protmethodAuthoringScope()

Initializes an instance of the AuthoringScope class.

NameDescription
System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_protmethodFinalize()

(Inherited from Object.)

System_CAPS_pubmethodGetDataTipText(Int32, Int32, TextSpan)

Returns a string to be used for a tool tip based on the specified location.

System_CAPS_pubmethodGetDeclarations(IVsTextView, Int32, Int32, TokenInfo, ParseReason)

Returns a list of declarations based on the specified reason for parsing.

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetMethods(Int32, Int32, String)

Returns a list of overloaded method signatures for a specified method name.

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodGoto(VSConstants.VSStd97CmdID, IVsTextView, Int32, Int32, TextSpan)

Returns a URI (Universal Resource Identifier) based on the current location in the source and the specified command.

System_CAPS_protmethodMemberwiseClone()

(Inherited from Object.)

System_CAPS_pubmethodToString()

(Inherited from Object.)

AuthoringScope is used to contain the requested information from a parsing operation.

Notes to Implementers:

This class must be implemented in a derived class. If you support either IntelliSense or the Go to options (Go to Declaration, Go to Definition, and Find All References), you must implement the methods on your version of this class; otherwise, you can return null values from all methods. However, you must always return a non-null instance of your AuthoringScope object if the parse operation succeeded, even if you return a null value from all methods.

Notes to Callers:

An instance of this class is returned from a call to the ParseSource method that in turn is called on a background thread from the BeginParse method is called from many methods in the Source class and for many reasons.

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: