AuthoringScope Class
Encapsulates information about the source as obtained from a parsing operation.
This API is not CLS-compliant.
Inheritance Hierarchy
Object
Microsoft.VisualStudio.Package.AuthoringScope
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.11.0 (in Microsoft.VisualStudio.Package.LanguageService.11.0.dll)
Microsoft.VisualStudio.Package.LanguageService.12.0 (in Microsoft.VisualStudio.Package.LanguageService.12.0.dll)
Microsoft.VisualStudio.Package.LanguageService (in Microsoft.VisualStudio.Package.LanguageService.dll)
Syntax
'Declaration
<CLSCompliantAttribute(False)> _
Public MustInherit Class AuthoringScope
[CLSCompliantAttribute(false)]
public abstract class AuthoringScope
[CLSCompliantAttribute(false)]
public ref class AuthoringScope abstract
[<AbstractClass>]
[<CLSCompliantAttribute(false)>]
type AuthoringScope = class end
public abstract class AuthoringScope
The AuthoringScope type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
.gif "Protected method") |
AuthoringScope | Initializes an instance of the AuthoringScope class. |
Top
Methods
| Name | Description | |
|---|---|---|
.gif "Public method") |
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.) |
|
GetDataTipText | Returns a string to be used for a tool tip based on the specified location. |
|
GetDeclarations | Returns a list of declarations based on the specified reason for parsing. |
|
GetHashCode | Serves as the default hash function. (Inherited from Object.) |
|
GetMethods | Returns a list of overloaded method signatures for a specified method name. |
|
GetType | Gets the Type of the current instance. (Inherited from Object.) |
|
Goto | Returns a URI (Universal Resource Identifier) based on the current location in the source and the specified command. |
|
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
|
ToString | Returns a string that represents the current object. (Inherited from Object.) |
Top
Remarks
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 nulla null reference (Nothing in Visual Basic) values from all methods. However, you must always return a non-nulla null reference (Nothing in Visual Basic) instance of your AuthoringScope object if the parse operation succeeded, even if you return a nulla null reference (Nothing in Visual Basic) 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.
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