RadTaskBoard
Represents a task board control that allows displaying and organizing task cards in multiple columns with drag-and-drop functionality.
Definition
Namespace:Telerik.WinControls.UI
Assembly:Telerik.WinControls.UI.dll
Syntax:
[TelerikToolboxCategory("Containers")]
public class RadTaskBoard : RadControl, IDropTarget, ISynchronizeInvoke, IWin32Window, IBindableComponent, IComponent, IDisposable, INotifyPropertyChanged, ISupportInitializeNotification, ISupportInitialize, IComponentTreeHandler, ILayoutHandler, IAnalyticsProvider
Inheritance: objectMarshalByRefObjectComponentControlScrollableControlRadControlRadTaskBoard...
Implements:
Inherited Members
Constructors
public RadTaskBoard()
Properties
Gets or sets the text displayed on the add task card buttons for all columns in the task board.
public string AddButtonText { get; set; }
Gets or sets the tooltip text displayed when hovering over add task card buttons for all columns in the task board.
public string AddButtonToolTipText { get; set; }
Gets a collection of RadTaskBoardColumnElement objects that represents the columns containing task cards in the task board.
[Browsable(true)]
[RadEditItemsAction]
public RadItemOwnerCollection Columns { get; }
Gets or sets the default height for add card buttons that appear at the bottom of each column.
public int DefaultAddButtonHeight { get; set; }
Gets or sets the default width for collapsed columns in the task board.
public int DefaultCollapsedColumnWidth { get; set; }
Gets or sets the default thickness of the scrollbars within individual columns in the task board.
public int DefaultColumnScrollBarThickness { get; set; }
Gets or sets the default column width for all columns in the task board.
public int DefaultColumnWidth { get; set; }
Gets or sets the default height for column headers in the task board.
public int DefaultHeaderHeight { get; set; }
Gets or sets the default highlighted state for column headers across all columns in the task board.
public bool DefaultIsHeaderHighlighted { get; set; }
Gets the default size for the RadTaskBoard control when no explicit size is specified.
protected override Size DefaultSize { get; }
Overrides:
Gets or sets the default minimum height for task cards across all columns in the task board.
public int DefaultTaskCardMinimumHeight { get; set; }
Gets or sets a value indicating whether the mouse cursor is centered on a task card during drag operations.
public bool IsDragMouseCentered { get; set; }
Gets or sets the thickness of the main horizontal scrollbar that allows navigation across columns in the task board.
public float ScrollBarThickness { get; set; }
Gets or sets the currently selected task card in the task board.
public RadTaskCardElement SelectedCard { get; set; }
Gets a collection of TagInfo objects representing unique tags that can be applied to task cards within the task board.
[Browsable(true)]
public ObservableHashSet<TagInfo> Tags { get; }
Gets the RadTaskBoardElement that represents the main element providing the core functionality of the task board control.
[Browsable(false)]
public RadTaskBoardElement TaskBoardElement { get; }
Gets or sets the tooltip text displayed on the collapse button when a column is expanded and can be collapsed.
public string ToolTipCollapse { get; set; }
Gets or sets the tooltip text displayed on the collapse button when a column is collapsed and can be expanded.
public string ToolTipExpand { get; set; }
Gets a collection of UserInfo objects representing users that can be assigned to task cards within the task board.
[Browsable(true)]
public ObservableCollection<UserInfo> Users { get; }
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.
[Browsable(false)]
public ComponentXmlSerializationInfo XmlSerializationInfo { get; set; }
Methods
Creates and returns an accessibility object for the RadTaskBoard control to support assistive technologies.
protected override AccessibleObject CreateAccessibilityInstance()
An AccessibleObject that provides accessibility support for this control.
Overrides:
Creates child elements for the RadTaskBoard control and establishes the main task board element structure.
protected override void CreateChildItems(RadElement parent)
The parent RadElement that will contain the child elements.
Overrides:
Creates and returns a new instance of RadTaskBoardElement that provides the core functionality for the task board.
protected virtual RadTaskBoardElement CreateTaskBoardElement()
A new RadTaskBoardElement instance.
Releases the managed resources used by the RadTaskBoard control and properly disposes of event handlers.
Gets the default XML serialization information for the RadTaskBoard control, defining which properties should be included in layout persistence.
protected virtual ComponentXmlSerializationInfo GetDefaultXmlSerializationInfo()
A ComponentXmlSerializationInfo object containing the default serialization metadata.
Loads the layout state of the RadTaskBoard from the specified Stream using the serialization information from XmlSerializationInfo.
Loads the layout state of the RadTaskBoard from the specified file using the serialization information from XmlSerializationInfo.
public virtual void LoadLayout(string fileName)
The path to the file containing the layout data to load.
Loads the layout state of the RadTaskBoard from the specified XmlReader using the serialization information from XmlSerializationInfo.
Resets the DefaultAddButtonHeight property to its default value.
public void ResetDefaultAddButtonHeight()
Resets the DefaultCollapsedColumnWidth property to its default value.
public void ResetDefaultCollapsedColumnWidth()
Resets the DefaultColumnScrollBarThickness property to its default value.
public void ResetDefaultColumnScrollBarThickness()
Resets the DefaultColumnWidth property to its default value.
public void ResetDefaultColumnWidth()
Resets the DefaultHeaderHeight property to its default value.
public void ResetDefaultHeaderHeight()
Resets the DefaultIsHeaderHighlighted property to its default value.
public void ResetDefaultIsHeaderHighlighted()
Resets the DefaultTaskCardMinimumHeight property to its default value.
public void ResetDefaultTaskCardMinimumHeight()
Saves the current layout state of the RadTaskBoard to the specified Stream using the serialization information from XmlSerializationInfo.
Saves the current layout state of the RadTaskBoard to the specified file using the serialization information from XmlSerializationInfo.
public virtual void SaveLayout(string fileName)
The path to the file where the layout data will be saved.
Saves the current layout state of the RadTaskBoard to the specified XmlWriter using the serialization information from XmlSerializationInfo.
Sorts all columns in the task board using the default ColumnComparer based on column titles.
public void SortColumns()
Sorts task cards in all columns using the default TaskCardComparer based on task card titles.
public void SortTasks()
Sorts task cards in the specified column using the default TaskCardComparer or the column's custom comparer if set.
public void SortTasks(RadTaskBoardColumnElement column)
The RadTaskBoardColumnElement whose task cards will be sorted.
Events
Occurs after a task card has been successfully selected in the task board.
public event RadTaskBoardElement.TaskCardSelectedDelegate TaskCardSelected
Occurs when a task card is about to be selected, allowing the selection to be cancelled before it occurs.
public event RadTaskBoardElement.TaskCardSelectingDelegate TaskCardSelecting