TaskProvider Class
This class implements IVsTaskProvider. It provides a framework-friendly way to define a task provider and its associated services.
Inheritance Hierarchy
System.Object
Microsoft.VisualStudio.Shell.TaskProvider
Microsoft.VisualStudio.Shell.ErrorListProvider
Namespace: Microsoft.VisualStudio.Shell
Assembly: Microsoft.VisualStudio.Shell.11.0 (in Microsoft.VisualStudio.Shell.11.0.dll)
Syntax
‘선언
<ComVisibleAttribute(True)> _
Public Class TaskProvider _
Implements IVsTaskProvider2, IVsTaskProvider, IVsTaskProvider3, IDisposable
[ComVisibleAttribute(true)]
public class TaskProvider : IVsTaskProvider2,
IVsTaskProvider, IVsTaskProvider3, IDisposable
The TaskProvider type exposes the following members.
Constructors
Name | Description | |
---|---|---|
TaskProvider | Initializes a new instance of the TaskProvider with the supplied service provider. |
Top
Properties
Name | Description | |
---|---|---|
AlwaysVisible | Determines whether or not the provider is always visible in the dropdown menu even though it has no tasks. | |
DisableAutoRoute | Gets or sets whether autorouting should be disabled. | |
ImageList | Gets or sets the provider's image list (a list of icons for the tasks that belong to the provider). | |
MaintainInitialTaskOrder | Gets or sets whether or not the task list should maintain the task order given to it by the task provider. | |
ProviderGuid | Gets or sets the GUID of this provider. | |
ProviderName | Gets or sets a localized name for this provider. | |
Subcategories | Gets a collection of task subcategories. | |
Tasks | Gets a collection of tasks. | |
ToolbarGroup | Gets or sets a group GUID and toolbar ID indicating which toolbar should be displayed when this provider is active. | |
ToolbarId | Gets or sets this provider's toolbar ID. | |
VsTaskList | Gets the task list. |
Top
Methods
Name | Description | |
---|---|---|
Dispose() | Disposes this provider. | |
Dispose(Boolean) | Disposes the resources (task collection, task list, and image list) of this provider. | |
Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) | |
Finalize | Destroys the provider. (Overrides Object.Finalize().) | |
GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) | |
GetService | Gets the service of the specified type. | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
Navigate | Navigates from the task to the correct position in the document, shown in the specified logical view. | |
Refresh | Informs the task list that there are new or edited tasks. | |
ResumeRefresh | Restarts the refreshing of the task list after it has been suspended. | |
Show | Displays the task list window. | |
SuspendRefresh | Stops refreshing the task list until ResumeRefresh is called. | |
ToString | Returns a string that represents the current object. (Inherited from Object.) |
Top
Explicit Interface Implementations
Name | Description | |
---|---|---|
IVsTaskProvider.EnumTaskItems | Gets an enumerator over the task items. | |
IVsTaskProvider.ImageList | Gets this provider's image list. | |
IVsTaskProvider.OnTaskListFinalRelease | 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 | Gets the re-registration key. | |
IVsTaskProvider.SubcategoryList | Gets a list of subcategories for the tasks of this task provider. | |
IVsTaskProvider2.EnumTaskItems | Gets an enumerator over task items. | |
IVsTaskProvider2.ImageList | Gets this provider's image list. | |
IVsTaskProvider2.MaintainInitialTaskOrder | Gets or sets whether or not the task list should maintain the task order given to it by the task provider. | |
IVsTaskProvider2.OnTaskListFinalRelease | 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 | Gets the reregistration key. | |
IVsTaskProvider2.SubcategoryList | Gets a list of subcategories for the tasks of this task provider. | |
IVsTaskProvider3.GetColumn | Gets the definition of the column with the specified index. | |
IVsTaskProvider3.GetColumnCount | Gets the total number of columns supported by this provider, including columns that are not visible by default. | |
IVsTaskProvider3.GetProviderFlags | Gets the behavior flags for this provider. | |
IVsTaskProvider3.GetProviderGuid | 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 | Gets the name of the provider. | |
IVsTaskProvider3.GetProviderToolbar | Gets the provider's toolbar. | |
IVsTaskProvider3.GetSurrogateProviderGuid | 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 | Raised when the user begins editing a task in place. | |
IVsTaskProvider3.OnEndTaskEdit | Raised when the user finishes editing a task in-place. |
Top
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.