Declarations Class

Manages a list of declarations to be shown in an IntelliSense drop-down list.

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

Namespace:  Microsoft.VisualStudio.Package
Assemblies:   Microsoft.VisualStudio.Package.LanguageService (in Microsoft.VisualStudio.Package.LanguageService.dll)
  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)

Syntax

'Declaration
<CLSCompliantAttribute(False)> _
Public MustInherit Class Declarations _
    Implements IDisposable
'Usage
Dim instance As Declarations

[CLSCompliantAttribute(false)]
public abstract class Declarations : IDisposable

[CLSCompliantAttribute(false)]
public ref class Declarations abstract : IDisposable

[<AbstractClassAttribute>]
[<CLSCompliantAttribute(false)>]
type Declarations =  
    class
        interface IDisposable
    end

public abstract class Declarations implements IDisposable

Remarks

This abstract class is used to manage a list of identifiers or declarations that are shown in an IntelliSense member completion list. If you intend to support IntelliSense in your application, you must provide a concrete class that derives from this class.

Notes to Implementers

The implemented methods of this class assume that the declarations are stored in a list that is sorted in ascending order.

If you intend to support the IntelliSense completion list, you must derive a class from the Declarations class and implement the following abstract methods:

Abstract Method	Description
GetCount	Returns number of items in declarations list
GetDescription	Returns description for specified item.
GetDisplayText	Returns text to be shown in the completion list for the specified item.
GetGlyph	Returns an index into an image list for the specified item.
GetName	Returns the text to be inserted for the specified item.

Notes to Callers

An instance of this class is returned from the GetDeclarations method in the AuthoringScope class. The GetDeclarations method must be implemented in a class derived from the AuthoringScope class. How your version of the Declarations class is populated is entirely up to you. The Declarations class is populated by the parser.

Inheritance Hierarchy

System.Object
  Microsoft.VisualStudio.Package.Declarations

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

Declarations Members

Microsoft.VisualStudio.Package Namespace