TaskProvider Class

 

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

Namespace:   Microsoft.VisualStudio.Shell
Assembly:  Microsoft.VisualStudio.Shell.14.0 (in Microsoft.VisualStudio.Shell.14.0.dll)


[ComVisibleAttribute(true)]
public class TaskProvider : IVsTaskProvider, IVsTaskProvider2, 
	IVsTaskProvider3, IDisposable

NameDescription
System_CAPS_pubmethodTaskProvider(IServiceProvider)

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

NameDescription
System_CAPS_pubpropertyAlwaysVisible

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

System_CAPS_pubpropertyDisableAutoRoute

Gets or sets whether autorouting should be disabled.

System_CAPS_pubpropertyImageList

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

System_CAPS_pubpropertyMaintainInitialTaskOrder

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

System_CAPS_pubpropertyProviderGuid

Gets or sets the GUID of this provider.

System_CAPS_pubpropertyProviderName

Gets or sets a localized name for this provider.

System_CAPS_pubpropertySubcategories

Gets a collection of task subcategories.

System_CAPS_pubpropertyTasks

Gets a collection of tasks.

System_CAPS_pubpropertyToolbarGroup

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

System_CAPS_pubpropertyToolbarId

Gets or sets this provider's toolbar ID.

System_CAPS_protpropertyVsTaskList

Gets the task list.

NameDescription
System_CAPS_pubmethodDispose()

Disposes this provider.

System_CAPS_protmethodDispose(Boolean)

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

System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_protmethodFinalize()

Destroys the provider.(Overrides Object.Finalize().)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_protmethodGetService(Type)

Gets the service of the specified type.

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

(Inherited from Object.)

System_CAPS_pubmethodNavigate(Task, Guid)

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

System_CAPS_pubmethodRefresh()

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

System_CAPS_pubmethodResumeRefresh()

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

System_CAPS_pubmethodShow()

Displays the task list window.

System_CAPS_pubmethodSuspendRefresh()

Stops refreshing the task list until ResumeRefresh is called.

System_CAPS_pubmethodToString()

(Inherited from Object.)

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethodIVsTaskProvider.EnumTaskItems(IVsEnumTaskItems)

Gets an enumerator over the task items.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIVsTaskProvider.ImageList(IntPtr)

Gets this provider's image list.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIVsTaskProvider.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.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIVsTaskProvider.ReRegistrationKey(String)

Gets the re-registration key.

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

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

System_CAPS_pubinterfaceSystem_CAPS_privmethodIVsTaskProvider2.EnumTaskItems(IVsEnumTaskItems)

Gets an enumerator over task items.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIVsTaskProvider2.ImageList(IntPtr)

Gets this provider's image list.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIVsTaskProvider2.MaintainInitialTaskOrder(Int32)

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

System_CAPS_pubinterfaceSystem_CAPS_privmethodIVsTaskProvider2.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.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIVsTaskProvider2.ReRegistrationKey(String)

Gets the reregistration key.

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

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

System_CAPS_pubinterfaceSystem_CAPS_privmethodIVsTaskProvider3.GetColumn(Int32, VSTASKCOLUMN[])

Gets the definition of the column with the specified index.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIVsTaskProvider3.GetColumnCount(Int32)

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

System_CAPS_pubinterfaceSystem_CAPS_privmethodIVsTaskProvider3.GetProviderFlags(UInt32)

Gets the behavior flags for this provider.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIVsTaskProvider3.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.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIVsTaskProvider3.GetProviderName(String)

Gets the name of the provider.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIVsTaskProvider3.GetProviderToolbar(Guid, UInt32)

Gets the provider's toolbar.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIVsTaskProvider3.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.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIVsTaskProvider3.OnBeginTaskEdit(IVsTaskItem)

Raised when the user begins editing a task in place.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIVsTaskProvider3.OnEndTaskEdit(IVsTaskItem, Int32, Int32)

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

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: