IVsTaskProvider3 Interface
Supports adding content to the Task View window. Defines the provider of information along with manipulating the window columns.
Namespace: Microsoft.VisualStudio.Shell.Interop
Assembly: Microsoft.VisualStudio.Shell.Interop.8.0 (in Microsoft.VisualStudio.Shell.Interop.8.0.dll)
Syntax
'Declaration
<GuidAttribute("AFA6B21D-D599-43F9-A3AB-0840359F11C3")> _
<InterfaceTypeAttribute()> _
Public Interface IVsTaskProvider3
[GuidAttribute("AFA6B21D-D599-43F9-A3AB-0840359F11C3")]
[InterfaceTypeAttribute()]
public interface IVsTaskProvider3
[GuidAttribute(L"AFA6B21D-D599-43F9-A3AB-0840359F11C3")]
[InterfaceTypeAttribute()]
public interface class IVsTaskProvider3
[<GuidAttribute("AFA6B21D-D599-43F9-A3AB-0840359F11C3")>]
[<InterfaceTypeAttribute()>]
type IVsTaskProvider3 = interface end
public interface IVsTaskProvider3
The IVsTaskProvider3 type exposes the following members.
Methods
| Name | Description | |
|---|---|---|
.gif "Public method") |
GetColumn | Gets the definition of an indexed column (0 <= iColumn < nColumns) |
|
GetColumnCount | Returns the total number of columns supported by this provider, including columns that are not visible by default. |
|
GetProviderFlags | Returns the behavior flags for this provider. |
|
GetProviderGuid | Returns a unique Identifier for this provider. This is used to persist & restore per-provider data managed by the task list, such as user customizations of column width & order. If it is not practical to assign a GUID to this provider (e.g. the provider is dynamically created at run-time and the identity cannot be preserved across VS sessions), you may return GUID_NULL. However, you should be aware that certain functionality (such as UI settings persistence and the IVsTaskList2.SetActiveProvider method) will not work in that case. |
|
GetProviderName | Returns a localized human-readable name for this data provider. |
|
GetProviderToolbar | Returns a group GUID and toolbar ID indicating which toolbar should be displayed when this provider is active. |
|
GetSurrogateProviderGuid | If a provider implements this method, all its tasks will be listed under the surrogate provider in the list, as if they belong to the surrogate provider. |
|
OnBeginTaskEdit | Called when the user begins editing a task in-place. Providers may want to avoid scrolling the tasklist or changing the selection during editing, since these actions can force in-place edit mode to be canceled abruptly. |
|
OnEndTaskEdit | Called when the user finishes editing a task in-place. fCommitChanges indicates whether the user chose to commit the changes or discard them. This method may set *pfAllowChanges to FALSE to disallow the user from exiting edit mode. If fCommitChanges is TRUE, the changes will have already been persisted down to the task item. |
Top
Remarks
If you implement IVsTaskProvider3 you must also implement IVsTaskProvider. The converse is not true.
In addition, if you implement this interface, your tasks must implement IVsTaskItem3.