TaskProvider TaskProvider TaskProvider TaskProvider Class

Definition

This class implements IVsTaskProvider. It provides a framework-friendly way to define a task provider and its associated services.

public ref class TaskProvider : IDisposable, Microsoft::VisualStudio::Shell::Interop::IVsTaskProvider2, Microsoft::VisualStudio::Shell::Interop::IVsTaskProvider3
[System.Runtime.InteropServices.ComVisible(true)]
public class TaskProvider : IDisposable, Microsoft.VisualStudio.Shell.Interop.IVsTaskProvider2, Microsoft.VisualStudio.Shell.Interop.IVsTaskProvider3
type TaskProvider = class
    interface IVsTaskProvider
    interface IVsTaskProvider2
    interface IVsTaskProvider3
    interface IDisposable
Public Class TaskProvider
Implements IDisposable, IVsTaskProvider2, IVsTaskProvider3
Inheritance
TaskProviderTaskProviderTaskProviderTaskProvider
Derived
Attributes
Implements

Constructors

TaskProvider(IServiceProvider) TaskProvider(IServiceProvider) TaskProvider(IServiceProvider) TaskProvider(IServiceProvider)

Initializes a new instance of the TaskProvider with the supplied service provider.

Properties

AlwaysVisible AlwaysVisible AlwaysVisible AlwaysVisible

Determines whether or not the provider is always visible in the dropdown menu even though it has no tasks.

DisableAutoRoute DisableAutoRoute DisableAutoRoute DisableAutoRoute

Gets or sets whether autorouting should be disabled.

ImageList ImageList ImageList ImageList

Gets or sets the provider's image list (a list of icons for the tasks that belong to the provider).

MaintainInitialTaskOrder MaintainInitialTaskOrder MaintainInitialTaskOrder MaintainInitialTaskOrder

Gets or sets whether or not the task list should maintain the task order given to it by the task provider.

ProviderGuid ProviderGuid ProviderGuid ProviderGuid

Gets or sets the GUID of this provider.

ProviderName ProviderName ProviderName ProviderName

Gets or sets a localized name for this provider.

Subcategories Subcategories Subcategories Subcategories

Gets a collection of task subcategories.

Tasks Tasks Tasks Tasks

Gets a collection of tasks.

ToolbarGroup ToolbarGroup ToolbarGroup ToolbarGroup

Gets or sets a group GUID and toolbar ID indicating which toolbar should be displayed when this provider is active.

ToolbarId ToolbarId ToolbarId ToolbarId

Gets or sets this provider's toolbar ID.

VsTaskList VsTaskList VsTaskList VsTaskList

Gets the task list.

Methods

Dispose() Dispose() Dispose() Dispose()

Disposes this provider.

Dispose(Boolean) Dispose(Boolean) Dispose(Boolean) Dispose(Boolean)

Disposes the resources (task collection, task list, and image list) of this provider.

Finalize() Finalize() Finalize() Finalize()

Destroys the provider.

GetService(Type) GetService(Type) GetService(Type) GetService(Type)

Gets the service of the specified type.

Navigate(Task, Guid) Navigate(Task, Guid) Navigate(Task, Guid) Navigate(Task, Guid)

Navigates from the task to the correct position in the document, shown in the specified logical view.

Refresh() Refresh() Refresh() Refresh()

Informs the task list that there are new or edited tasks.

ResumeRefresh() ResumeRefresh() ResumeRefresh() ResumeRefresh()

Restarts the refreshing of the task list after it has been suspended.

Show() Show() Show() Show()

Displays the task list window.

SuspendRefresh() SuspendRefresh() SuspendRefresh() SuspendRefresh()

Stops refreshing the task list until ResumeRefresh() is called.

Explicit Interface Implementations

IVsTaskProvider.EnumTaskItems(IVsEnumTaskItems) IVsTaskProvider.EnumTaskItems(IVsEnumTaskItems) IVsTaskProvider.EnumTaskItems(IVsEnumTaskItems) IVsTaskProvider.EnumTaskItems(IVsEnumTaskItems)

Gets an enumerator over the task items.

IVsTaskProvider.ImageList(IntPtr) IVsTaskProvider.ImageList(IntPtr) IVsTaskProvider.ImageList(IntPtr) IVsTaskProvider.ImageList(IntPtr)

Gets this provider's image list.

IVsTaskProvider.OnTaskListFinalRelease(IVsTaskList) IVsTaskProvider.OnTaskListFinalRelease(IVsTaskList) IVsTaskProvider.OnTaskListFinalRelease(IVsTaskList) IVsTaskProvider.OnTaskListFinalRelease(IVsTaskList)

Notifies the client to unregister the task provider from the task list if it has not been unregistered by the time the task list is closing.

IVsTaskProvider.ReRegistrationKey(String) IVsTaskProvider.ReRegistrationKey(String) IVsTaskProvider.ReRegistrationKey(String) IVsTaskProvider.ReRegistrationKey(String)

Gets the re-registration key.

IVsTaskProvider.SubcategoryList(UInt32, String[], UInt32) IVsTaskProvider.SubcategoryList(UInt32, String[], UInt32) IVsTaskProvider.SubcategoryList(UInt32, String[], UInt32) IVsTaskProvider.SubcategoryList(UInt32, String[], UInt32)

Gets a list of subcategories for the tasks of this task provider.

IVsTaskProvider2.EnumTaskItems(IVsEnumTaskItems) IVsTaskProvider2.EnumTaskItems(IVsEnumTaskItems) IVsTaskProvider2.EnumTaskItems(IVsEnumTaskItems) IVsTaskProvider2.EnumTaskItems(IVsEnumTaskItems)

Gets an enumerator over task items.

IVsTaskProvider2.ImageList(IntPtr) IVsTaskProvider2.ImageList(IntPtr) IVsTaskProvider2.ImageList(IntPtr) IVsTaskProvider2.ImageList(IntPtr)

Gets this provider's image list.

IVsTaskProvider2.MaintainInitialTaskOrder(Int32) IVsTaskProvider2.MaintainInitialTaskOrder(Int32) IVsTaskProvider2.MaintainInitialTaskOrder(Int32) IVsTaskProvider2.MaintainInitialTaskOrder(Int32)

Gets or sets whether or not the task list should maintain the task order given to it by the task provider.

IVsTaskProvider2.OnTaskListFinalRelease(IVsTaskList) IVsTaskProvider2.OnTaskListFinalRelease(IVsTaskList) IVsTaskProvider2.OnTaskListFinalRelease(IVsTaskList) IVsTaskProvider2.OnTaskListFinalRelease(IVsTaskList)

Notifies the client to unregister the task provider from the task list if it has not been unregistered by the time the task list is closing.

IVsTaskProvider2.ReRegistrationKey(String) IVsTaskProvider2.ReRegistrationKey(String) IVsTaskProvider2.ReRegistrationKey(String) IVsTaskProvider2.ReRegistrationKey(String)

Gets the reregistration key.

IVsTaskProvider2.SubcategoryList(UInt32, String[], UInt32) IVsTaskProvider2.SubcategoryList(UInt32, String[], UInt32) IVsTaskProvider2.SubcategoryList(UInt32, String[], UInt32) IVsTaskProvider2.SubcategoryList(UInt32, String[], UInt32)

Gets a list of subcategories for the tasks of this task provider.

IVsTaskProvider3.GetColumn(Int32, VSTASKCOLUMN[]) IVsTaskProvider3.GetColumn(Int32, VSTASKCOLUMN[]) IVsTaskProvider3.GetColumn(Int32, VSTASKCOLUMN[]) IVsTaskProvider3.GetColumn(Int32, VSTASKCOLUMN[])

Gets the definition of the column with the specified index.

IVsTaskProvider3.GetColumnCount(Int32) IVsTaskProvider3.GetColumnCount(Int32) IVsTaskProvider3.GetColumnCount(Int32) IVsTaskProvider3.GetColumnCount(Int32)

Gets the total number of columns supported by this provider, including columns that are not visible by default.

IVsTaskProvider3.GetProviderFlags(UInt32) IVsTaskProvider3.GetProviderFlags(UInt32) IVsTaskProvider3.GetProviderFlags(UInt32) IVsTaskProvider3.GetProviderFlags(UInt32)

Gets the behavior flags for this provider.

IVsTaskProvider3.GetProviderGuid(Guid) IVsTaskProvider3.GetProviderGuid(Guid) IVsTaskProvider3.GetProviderGuid(Guid) IVsTaskProvider3.GetProviderGuid(Guid)

Gets a unique GUID for this provider. This is used to persist and restore provider-specific data managed by the task list, such as user customizations of column width and order.

IVsTaskProvider3.GetProviderName(String) IVsTaskProvider3.GetProviderName(String) IVsTaskProvider3.GetProviderName(String) IVsTaskProvider3.GetProviderName(String)

Gets the name of the provider.

IVsTaskProvider3.GetProviderToolbar(Guid, UInt32) IVsTaskProvider3.GetProviderToolbar(Guid, UInt32) IVsTaskProvider3.GetProviderToolbar(Guid, UInt32) IVsTaskProvider3.GetProviderToolbar(Guid, UInt32)

Gets the provider's toolbar.

IVsTaskProvider3.GetSurrogateProviderGuid(Guid) IVsTaskProvider3.GetSurrogateProviderGuid(Guid) IVsTaskProvider3.GetSurrogateProviderGuid(Guid) IVsTaskProvider3.GetSurrogateProviderGuid(Guid)

If this method is implemented, all the provider's tasks will be listed under the surrogate provider in the list as though they belonged to the surrogate provider.

IVsTaskProvider3.OnBeginTaskEdit(IVsTaskItem) IVsTaskProvider3.OnBeginTaskEdit(IVsTaskItem) IVsTaskProvider3.OnBeginTaskEdit(IVsTaskItem) IVsTaskProvider3.OnBeginTaskEdit(IVsTaskItem)

Raised when the user begins editing a task in place.

IVsTaskProvider3.OnEndTaskEdit(IVsTaskItem, Int32, Int32) IVsTaskProvider3.OnEndTaskEdit(IVsTaskItem, Int32, Int32) IVsTaskProvider3.OnEndTaskEdit(IVsTaskItem, Int32, Int32) IVsTaskProvider3.OnEndTaskEdit(IVsTaskItem, Int32, Int32)

Raised when the user finishes editing a task in-place.

Extension Methods

FindAncestor<TElementType>(TElementType, Func<TElementType,TElementType>, Func<TElementType,Boolean>) FindAncestor<TElementType>(TElementType, Func<TElementType,TElementType>, Func<TElementType,Boolean>) FindAncestor<TElementType>(TElementType, Func<TElementType,TElementType>, Func<TElementType,Boolean>) FindAncestor<TElementType>(TElementType, Func<TElementType,TElementType>, Func<TElementType,Boolean>)
FindAncestor<TAncestorType,TElementType>(TElementType, Func<TElementType,TElementType>) FindAncestor<TAncestorType,TElementType>(TElementType, Func<TElementType,TElementType>) FindAncestor<TAncestorType,TElementType>(TElementType, Func<TElementType,TElementType>) FindAncestor<TAncestorType,TElementType>(TElementType, Func<TElementType,TElementType>)

Microsoft internal use only.

FindAncestorOrSelf<TElementType>(TElementType, Func<TElementType,TElementType>, Func<TElementType,Boolean>) FindAncestorOrSelf<TElementType>(TElementType, Func<TElementType,TElementType>, Func<TElementType,Boolean>) FindAncestorOrSelf<TElementType>(TElementType, Func<TElementType,TElementType>, Func<TElementType,Boolean>) FindAncestorOrSelf<TElementType>(TElementType, Func<TElementType,TElementType>, Func<TElementType,Boolean>)
FindAncestorOrSelf<TAncestorType,TElementType>(TElementType, Func<TElementType,TElementType>) FindAncestorOrSelf<TAncestorType,TElementType>(TElementType, Func<TElementType,TElementType>) FindAncestorOrSelf<TAncestorType,TElementType>(TElementType, Func<TElementType,TElementType>) FindAncestorOrSelf<TAncestorType,TElementType>(TElementType, Func<TElementType,TElementType>)
IsAncestorOf<TElementType>(TElementType, TElementType, Func<TElementType,TElementType>) IsAncestorOf<TElementType>(TElementType, TElementType, Func<TElementType,TElementType>) IsAncestorOf<TElementType>(TElementType, TElementType, Func<TElementType,TElementType>) IsAncestorOf<TElementType>(TElementType, TElementType, Func<TElementType,TElementType>)

Microsoft internal use only.

Applies to