Share via


IWorkItemControl Interface

This interface covers the minimal definition of a work item tracking control.

Namespace:  Microsoft.TeamFoundation.WorkItemTracking.Controls
Assembly:  Microsoft.TeamFoundation.WorkItemTracking.Controls (in Microsoft.TeamFoundation.WorkItemTracking.Controls.dll)

Syntax

'Declaration
Public Interface IWorkItemControl
public interface IWorkItemControl
public interface class IWorkItemControl
type IWorkItemControl =  interface end
public interface IWorkItemControl

The IWorkItemControl type exposes the following members.

Properties

  Name Description
Public property Properties Gets or sets the custom properties that can be used to initialize control state
Public property ReadOnly Gets or sets a value indicating whether this control is read only or not.
Public property WorkItemDatasource Gets or sets the work item data source bound to this control.
Public property WorkItemFieldName The name of the field to be modified by the control.

Top

Methods

  Name Description
Public method Clear Clears the current value of the control.
Public method FlushToDatasource Flushes the current control value to the data source (bound field).
Public method InvalidateDatasource Invalidates the data source used by this control, which causes the control to reset its state based on the current field binding.
Public method SetSite Allows platform to provide ServiceProvider implementation to control.

Top

Events

  Name Description
Public event AfterUpdateDatasource This event is signaled by control implementations preceeded by BeforeUpdateDatasource to avoid invalidation notifications stemming from changes performed by the control itself.
Public event BeforeUpdateDatasource This event is signaled by control implementations when updating Data Source followed by a signal to AfterUpdateDatasource to avoid invalidation notifications stemming from changes performed by the control itself.

Top

See Also

Reference

Microsoft.TeamFoundation.WorkItemTracking.Controls Namespace

IWorkItemUserAction

IWorkItemClipboard

IWorkItemToolTip