Share via


IVsTaskProvider3 Interface

Definition

Supports adding content to the Task View window. Defines the provider of information along with manipulating the window columns.

public interface class IVsTaskProvider3
public interface class IVsTaskProvider3
__interface IVsTaskProvider3
[System.Runtime.InteropServices.Guid("AFA6B21D-D599-43F9-A3AB-0840359F11C3")]
[System.Runtime.InteropServices.InterfaceType(1)]
public interface IVsTaskProvider3
[<System.Runtime.InteropServices.Guid("AFA6B21D-D599-43F9-A3AB-0840359F11C3")>]
[<System.Runtime.InteropServices.InterfaceType(1)>]
type IVsTaskProvider3 = interface
Public Interface IVsTaskProvider3
Derived
Attributes

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.

Methods

GetColumn(Int32, VSTASKCOLUMN[])

Gets the definition of an indexed column (0 <= iColumn < nColumns)

GetColumnCount(Int32)

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

GetProviderFlags(UInt32)

Returns the behavior flags for this provider.

GetProviderGuid(Guid)

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(String)

Returns a localized human-readable name for this data provider.

GetProviderToolbar(Guid, UInt32)

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

GetSurrogateProviderGuid(Guid)

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(IVsTaskItem)

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(IVsTaskItem, Int32, Int32)

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.

Applies to