Class RadTaskBoard

Represents a task board control that allows displaying and organizing task cards in multiple columns with drag-and-drop functionality.

Inheritance
System.Object
RadControl
RadTaskBoard
Inherited Members
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.UI.dll

Syntax

[TelerikToolboxCategory("Containers")]
public class RadTaskBoard : RadControl, INotifyPropertyChanged, ISupportInitializeNotification, ISupportInitialize, IComponentTreeHandler, ILayoutHandler, IPCHost, IAnalyticsProvider

Constructors

RadTaskBoard()

Declaration
public RadTaskBoard()

Properties

AddButtonText

Gets or sets the text displayed on the add task card buttons for all columns in the task board.

Declaration
public string AddButtonText { get; set; }
Property Value
System.String

AddButtonToolTipText

Gets or sets the tooltip text displayed when hovering over add task card buttons for all columns in the task board.

Declaration
public string AddButtonToolTipText { get; set; }
Property Value
System.String

Columns

Gets a collection of RadTaskBoardColumnElement objects that represents the columns containing task cards in the task board.

Declaration
[RadEditItemsAction]
public RadItemOwnerCollection Columns { get; }
Property Value
RadItemOwnerCollection

DefaultAddButtonHeight

Gets or sets the default height for add card buttons that appear at the bottom of each column.

Declaration
public int DefaultAddButtonHeight { get; set; }
Property Value
System.Int32

DefaultCollapsedColumnWidth

Gets or sets the default width for collapsed columns in the task board.

Declaration
public int DefaultCollapsedColumnWidth { get; set; }
Property Value
System.Int32

DefaultColumnScrollBarThickness

Gets or sets the default thickness of the scrollbars within individual columns in the task board.

Declaration
public int DefaultColumnScrollBarThickness { get; set; }
Property Value
System.Int32

DefaultColumnWidth

Gets or sets the default column width for all columns in the task board.

Declaration
public int DefaultColumnWidth { get; set; }
Property Value
System.Int32

DefaultHeaderHeight

Gets or sets the default height for column headers in the task board.

Declaration
public int DefaultHeaderHeight { get; set; }
Property Value
System.Int32

DefaultIsHeaderHighlighted

Gets or sets the default highlighted state for column headers across all columns in the task board.

Declaration
public bool DefaultIsHeaderHighlighted { get; set; }
Property Value
System.Boolean

DefaultSize

Gets the default size for the RadTaskBoard control when no explicit size is specified.

Declaration
protected override Size DefaultSize { get; }
Property Value
System.Drawing.Size

DefaultTaskCardMinimumHeight

Gets or sets the default minimum height for task cards across all columns in the task board.

Declaration
public int DefaultTaskCardMinimumHeight { get; set; }
Property Value
System.Int32

IsDragMouseCentered

Gets or sets a value indicating whether the mouse cursor is centered on a task card during drag operations.

Declaration
public bool IsDragMouseCentered { get; set; }
Property Value
System.Boolean

ScrollBarThickness

Gets or sets the thickness of the main horizontal scrollbar that allows navigation across columns in the task board.

Declaration
public float ScrollBarThickness { get; set; }
Property Value
System.Single

SelectedCard

Gets or sets the currently selected task card in the task board.

Declaration
public RadTaskCardElement SelectedCard { get; set; }
Property Value
RadTaskCardElement

Tags

Gets a collection of TagInfo objects representing unique tags that can be applied to task cards within the task board.

Declaration
public ObservableHashSet<TagInfo> Tags { get; }
Property Value
ObservableHashSet<TagInfo>

TaskBoardElement

Gets the RadTaskBoardElement that represents the main element providing the core functionality of the task board control.

Declaration
public RadTaskBoardElement TaskBoardElement { get; }
Property Value
RadTaskBoardElement

Text

This property is not relevant for this class.

Declaration
public override string Text { get; set; }
Property Value
System.String

Overrides

ToolTipCollapse

Gets or sets the tooltip text displayed on the collapse button when a column is expanded and can be collapsed.

Declaration
public string ToolTipCollapse { get; set; }
Property Value
System.String

ToolTipExpand

Gets or sets the tooltip text displayed on the collapse button when a column is collapsed and can be expanded.

Declaration
public string ToolTipExpand { get; set; }
Property Value
System.String

Users

Gets a collection of UserInfo objects representing users that can be assigned to task cards within the task board.

Declaration
public ObservableCollection<UserInfo> Users { get; }
Property Value
System.Collections.ObjectModel.ObservableCollection<UserInfo>

XmlSerializationInfo

Gets or sets the serialization information used by the save and load layout methods to persist the task board layout to and from XML format.

Declaration
public ComponentXmlSerializationInfo XmlSerializationInfo { get; set; }
Property Value
ComponentXmlSerializationInfo

Methods

CreateAccessibilityInstance()

Creates and returns an accessibility object for the RadTaskBoard control to support assistive technologies.

Declaration
protected override AccessibleObject CreateAccessibilityInstance()
Returns
System.Windows.Forms.AccessibleObject

An System.Windows.Forms.AccessibleObject that provides accessibility support for this control.

CreateChildItems(RadElement)

Creates child elements for the RadTaskBoard control and establishes the main task board element structure.

Declaration
protected override void CreateChildItems(RadElement parent)
Parameters
RadElement parent

The parent RadElement that will contain the child elements.
Overrides

CreateTaskBoardElement()

Creates and returns a new instance of RadTaskBoardElement that provides the core functionality for the task board.

Declaration
protected virtual RadTaskBoardElement CreateTaskBoardElement()
Returns
RadTaskBoardElement

A new RadTaskBoardElement instance.

Dispose(Boolean)

Releases the managed resources used by the RadTaskBoard control and properly disposes of event handlers.

Declaration
protected override void Dispose(bool disposing)
Parameters
System.Boolean disposing

Indicates whether the method is being called from a Dispose(Boolean) method or from a finalizer.
Overrides

GetDefaultXmlSerializationInfo()

Gets the default XML serialization information for the RadTaskBoard control, defining which properties should be included in layout persistence.

Declaration
protected virtual ComponentXmlSerializationInfo GetDefaultXmlSerializationInfo()
Returns
ComponentXmlSerializationInfo

A ComponentXmlSerializationInfo object containing the default serialization metadata.

LoadLayout(Stream)

Loads the layout state of the RadTaskBoard from the specified System.IO.Stream using the serialization information from XmlSerializationInfo.

Declaration
public virtual void LoadLayout(Stream stream)
Parameters
System.IO.Stream stream

The System.IO.Stream containing the layout data to load.

LoadLayout(String)

Loads the layout state of the RadTaskBoard from the specified file using the serialization information from XmlSerializationInfo.

Declaration
public virtual void LoadLayout(string fileName)
Parameters
System.String fileName

The path to the file containing the layout data to load.

LoadLayout(XmlReader)

Loads the layout state of the RadTaskBoard from the specified System.Xml.XmlReader using the serialization information from XmlSerializationInfo.

Declaration
public virtual void LoadLayout(XmlReader xmlReader)
Parameters
System.Xml.XmlReader xmlReader

The System.Xml.XmlReader containing the layout data to load.

ResetDefaultAddButtonHeight()

Resets the DefaultAddButtonHeight property to its default value.

Declaration
public void ResetDefaultAddButtonHeight()

ResetDefaultCollapsedColumnWidth()

Resets the DefaultCollapsedColumnWidth property to its default value.

Declaration
public void ResetDefaultCollapsedColumnWidth()

ResetDefaultColumnScrollBarThickness()

Resets the DefaultColumnScrollBarThickness property to its default value.

Declaration
public void ResetDefaultColumnScrollBarThickness()

ResetDefaultColumnWidth()

Resets the DefaultColumnWidth property to its default value.

Declaration
public void ResetDefaultColumnWidth()

ResetDefaultHeaderHeight()

Resets the DefaultHeaderHeight property to its default value.

Declaration
public void ResetDefaultHeaderHeight()

ResetDefaultIsHeaderHighlighted()

Resets the DefaultIsHeaderHighlighted property to its default value.

Declaration
public void ResetDefaultIsHeaderHighlighted()

ResetDefaultTaskCardMinimumHeight()

Resets the DefaultTaskCardMinimumHeight property to its default value.

Declaration
public void ResetDefaultTaskCardMinimumHeight()

SaveLayout(Stream)

Saves the current layout state of the RadTaskBoard to the specified System.IO.Stream using the serialization information from XmlSerializationInfo.

Declaration
public virtual void SaveLayout(Stream stream)
Parameters
System.IO.Stream stream

The System.IO.Stream to write the layout data to. The stream is left open after the operation.

SaveLayout(String)

Saves the current layout state of the RadTaskBoard to the specified file using the serialization information from XmlSerializationInfo.

Declaration
public virtual void SaveLayout(string fileName)
Parameters
System.String fileName

The path to the file where the layout data will be saved.

SaveLayout(XmlWriter)

Saves the current layout state of the RadTaskBoard to the specified System.Xml.XmlWriter using the serialization information from XmlSerializationInfo.

Declaration
public virtual void SaveLayout(XmlWriter writer)
Parameters
System.Xml.XmlWriter writer

The System.Xml.XmlWriter to write the layout data to.

SortColumns()

Sorts all columns in the task board using the default ColumnComparer based on column titles.

Declaration
public void SortColumns()

SortTasks()

Sorts task cards in all columns using the default TaskCardComparer based on task card titles.

Declaration
public void SortTasks()

SortTasks(RadTaskBoardColumnElement)

Sorts task cards in the specified column using the default TaskCardComparer or the column's custom comparer if set.

Declaration
public void SortTasks(RadTaskBoardColumnElement column)
Parameters
RadTaskBoardColumnElement column

The RadTaskBoardColumnElement whose task cards will be sorted.

Events

TaskCardSelected

Occurs after a task card has been successfully selected in the task board.

Declaration
public event RadTaskBoardElement.TaskCardSelectedDelegate TaskCardSelected
Event Type
RadTaskBoardElement.TaskCardSelectedDelegate

TaskCardSelecting

Occurs when a task card is about to be selected, allowing the selection to be cancelled before it occurs.

Declaration
public event RadTaskBoardElement.TaskCardSelectingDelegate TaskCardSelecting
Event Type
RadTaskBoardElement.TaskCardSelectingDelegate

Extension Methods