Class RadTaskBoard

Represent a task board control that can display and arrange card tasks.

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 of the AddTaskCardButton element for all columns.

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

AddButtonToolTipText

Gets or sets the tooltip text of the AddTaskCardButton element for all columns.

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

Columns

Gets a collection of RadTaskBoardColumnElement objects that represents the columns holding the task cards.

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

DefaultAddButtonHeight

Gets or sets the default add button height for the task board. This default value is used to set the height of all "+ Add a card" buttons in the task board.

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

DefaultCollapsedColumnWidth

Gets or sets the default collapsed column width for the task board. This default value is used to set the width of all collapsed columns in the task board.

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

DefaultColumnScrollBarThickness

Gets or sets the default columns' scrollbar thickness for the task board. This default value is used to set the width of all columns' scrollabrs in the task board.

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

DefaultColumnWidth

Gets or sets the default column width for the task board. This default value is used to set the width of all columns in the task board.

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

DefaultHeaderHeight

Gets or sets the default header hight for the task board. This default value is used to set the height of all headers in the task board.

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

DefaultIsHeaderHighlighted

Gets or sets the default header highlighted state for all columns. This default value is used to set the header highlighted state of all columns in the task board.

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

DefaultSize

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

DefaultTaskCardMinimumHeight

Gets or sets the default minimum height for all task card. This default value is used to set the minimum height of all task cards in the task board.

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

IsDragMouseCentered

True, if while dragging the mouse position is centered on the card. False, if the mouse position does not change.

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

ScrollBarThickness

Gets or sets the task board's scrollbar thickness.

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

SelectedCard

Gets or sets the selected card in the task board.

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

Tags

Gets a collection of TagInfo objects that represents the tags that are added to the task cards. It can contain only unique tags.

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

TaskBoardElement

Gets the RadTaskBoardElement that represents the main element of the 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 set the tooltip string for the collapse button, when the column is collapsed - "Expand the column"

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

ToolTipExpand

Gets or set the tooltip string for the collapse button, when the column is collapsed - "Expand the column"

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

Users

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

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

XmlSerializationInfo

Gets the serialization info for RadTaskBoard used by Save/Load layout methods to persist the layout to/from XML. By default or when set to null the ComponentXmlSerializationInfo provided by GetDefaultXmlSerializationInfo() will be used.

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

Methods

CreateAccessibilityInstance()

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

CreateChildItems(RadElement)

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

Overrides

CreateTaskBoardElement()

Declaration
protected virtual RadTaskBoardElement CreateTaskBoardElement()
Returns
RadTaskBoardElement

Dispose(Boolean)

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

Overrides

GetDefaultXmlSerializationInfo()

Gets the default serialization info for RadTaskBoard used by Save/Load layout methods to persist the layout to/from XML.

Declaration
protected virtual ComponentXmlSerializationInfo GetDefaultXmlSerializationInfo()
Returns
ComponentXmlSerializationInfo

The default serialization info.

LoadLayout(Stream)

Loads RadTaskBoard's layout state from XML file, using the serialization information provided by the XmlSerializationInfo property.

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

The stream to read from.

LoadLayout(String)

Loads RadTaskBoard's layout state from XML file, using the serialization information provided by the XmlSerializationInfo property.

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

The file to read from.

LoadLayout(XmlReader)

Loads RadTaskBoard's layout state from XML file, using the serialization information provided by the XmlSerializationInfo property.

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

The XmlReader to read the XML from.

ResetDefaultAddButtonHeight()

Resets the DefaultAddButtonHeight property to the default value.

Declaration
public void ResetDefaultAddButtonHeight()

ResetDefaultCollapsedColumnWidth()

Resets the DefaultCollapsedColumnWidth property to the default value.

Declaration
public void ResetDefaultCollapsedColumnWidth()

ResetDefaultColumnScrollBarThickness()

Resets the DefaultColumnScrollBarThickness property to the default value.

Declaration
public void ResetDefaultColumnScrollBarThickness()

ResetDefaultColumnWidth()

Resets the DefaultColumnWidth property to the default value.

Declaration
public void ResetDefaultColumnWidth()

ResetDefaultHeaderHeight()

Resets the DefaultHeaderHeight property to the default value.

Declaration
public void ResetDefaultHeaderHeight()

ResetDefaultIsHeaderHighlighted()

Resets the DefaultIsHeaderHighlighted property to the default value.

Declaration
public void ResetDefaultIsHeaderHighlighted()

ResetDefaultTaskCardMinimumHeight()

Resets the DefaultTaskCardMinimumHeight property to the default value.

Declaration
public void ResetDefaultTaskCardMinimumHeight()

SaveLayout(Stream)

Stores RadTaskboard's layout state in XML format, using the serialization information provided by the XmlSerializationInfo property.

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

The stream to write to.

SaveLayout(String)

Stores RadTaskBoard's layout state in XML format, using the serialization information provided by the XmlSerializationInfo property.

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

The file to write to.

SaveLayout(XmlWriter)

Stores RadTaskBoard's layout state in XML format, using the serialization information provided by the XmlSerializationInfo property.

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

XmlWriter to use by the built-in serializer

SortColumns()

Sorts the task cards in a specified column. Note that the sorting in TaskBoard is a one-time operation, and once performed, changes in the state of the RadTaskBoardColumnElement objects are not monitored, as this would lead to inconsistent behavior and break other control functionality such as drag and drop.

Declaration
public void SortColumns()
Remarks

The sort operation will use the default ColumnComparer, which sorts the RadTaskBoardColumnElements by the Title property. If you need custom sorting to be applied you need to create a custom comparer and assign it to the ColumnComparer property.

SortTasks()

Sorts the task cards in all columns. Note that the sorting in TaskBoard is a one-time operation, and once performed, changes in the state of the RadTaskCardElement objects are not monitored, as this would lead to inconsistent behavior and break other control functionality such as drag and drop.

Declaration
public void SortTasks()
Remarks

The sort operation will use the default TaskCardComparer, which sorts the RadTaskCardElements by the TitleText property. If you need custom sorting to be applied for speciffic column(s) you need to create a custom comparer and assign it to the TaskCardComparer property.

SortTasks(RadTaskBoardColumnElement)

Sorts the task cards in a specified column. Note that the sorting in TaskBoard is a one-time operation, and once performed, changes in the state of the RadTaskCardElement objects are not monitored, as this would lead to inconsistent behavior and break other control functionality such as drag and drop.

Declaration
public void SortTasks(RadTaskBoardColumnElement column)
Parameters
RadTaskBoardColumnElement column

The column whoose task cards will be sorted.
Remarks

The sort operation will use the default TaskCardComparer, which sorts the RadTaskCardElements by the TitleText property. If you need custom sorting to be applied for the soecified column you need to create a custom comparer and assign it to the TaskCardComparer property.

Events

TaskCardSelected

The Event is fired, when a task card has been selected.

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

TaskCardSelecting

The Event is fired, when selecting a task card.

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

Extension Methods