Class RadTaskBoardElement

Represents the main visual element of the RadTaskBoard control that provides task board functionality with columns, cards, and drag-and-drop operations.

Inheritance
System.Object
DisposableObject
RadObject
RadElement
VisualElement
RadComponentElement
RadItem
UIItemBase
LightVisualElement
RadTaskBoardElement
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.UI.dll

Syntax

public class RadTaskBoardElement : LightVisualElement, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IComponent, IDisposable, IBindableComponent, ISupportDrag, ISupportDrop, IShortcutProvider, IStylableElement, IStylableNode, IPrimitiveElement, IShapedElement, IFillElement, IBorderElement, IBoxStyle, IBoxElement, IDrawFillElement, IImageElement, ITextPrimitive, ITextProvider

Constructors

RadTaskBoardElement()

Declaration
public RadTaskBoardElement()

Fields

DefaultAddButtonHeightProperty

Identifies the DefaultAddButtonHeight dependency property that defines the default height for add task card buttons.

Declaration
public static RadProperty DefaultAddButtonHeightProperty
Field Value
RadProperty

DefaultCollapsedColumnWidthProperty

Identifies the DefaultCollapsedColumnWidth dependency property that defines the default width for collapsed task board columns.

Declaration
public static RadProperty DefaultCollapsedColumnWidthProperty
Field Value
RadProperty

DefaultColumnScrollBarThicknessProperty

Identifies the DefaultColumnScrollBarThickness dependency property that defines the default thickness for column scrollbars.

Declaration
public static RadProperty DefaultColumnScrollBarThicknessProperty
Field Value
RadProperty

DefaultColumnWidthProperty

Identifies the DefaultColumnWidth dependency property that defines the default width for task board columns.

Declaration
public static RadProperty DefaultColumnWidthProperty
Field Value
RadProperty

DefaultHeaderHeightProperty

Identifies the DefaultHeaderHeight dependency property that defines the default height for task board column headers.

Declaration
public static RadProperty DefaultHeaderHeightProperty
Field Value
RadProperty

DefaultIsHeaderHighlightedProperty

Identifies the DefaultIsHeaderHighlighted dependency property that defines the default highlighted state for column headers.

Declaration
public static RadProperty DefaultIsHeaderHighlightedProperty
Field Value
RadProperty

DefaultTaskCardMinimumHeightProperty

Identifies the DefaultTaskCardMinimumHeight dependency property that defines the default minimum height for task cards.

Declaration
public static RadProperty DefaultTaskCardMinimumHeightProperty
Field Value
RadProperty

ItemDragHintProperty

Identifies the ItemDragHint dependency property that defines the visual hint displayed during drag operations.

Declaration
public static RadProperty ItemDragHintProperty
Field Value
RadProperty

Properties

AddButtonText

Gets or sets the text displayed on 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

ColumnComparer

Gets or sets the ColumnComparer used for sorting task board columns when the SortColumns() method is called.

Declaration
public ColumnComparer ColumnComparer { get; set; }
Property Value
ColumnComparer

Columns

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

Declaration
public RadItemOwnerGenericCollection<RadTaskBoardColumnElement> Columns { get; }
Property Value
RadItemOwnerGenericCollection<RadTaskBoardColumnElement>

ColumnsLayout

Gets the StackLayoutPanel that arranges and positions the task board columns.

Declaration
public StackLayoutPanel ColumnsLayout { get; }
Property Value
StackLayoutPanel

DefaultAddButtonHeight

Gets or sets the default height for add task 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 for scrollbars within individual columns in the task board.

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

DefaultColumnWidth

Gets or sets the default width for all columns in the task board when no specific width is specified.

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

DefaultHeaderHeight

Gets or sets the default height for column headers across all columns 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

DefaultTaskCardMinimumHeight

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

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

DragDropService

Gets or sets the RadDragDropService that handles drag-and-drop operations for reordering task cards between columns.

Declaration
public RadDragDropService DragDropService { get; set; }
Property Value
RadDragDropService

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

ItemDragHint

Gets or sets the RadImageShape that provides visual feedback indicating where a task card will be dropped during drag operations.

Declaration
[VsbBrowsable(true)]
public RadImageShape ItemDragHint { get; set; }
Property Value
RadImageShape

ScrollBar

Gets the RadScrollBarElement that enables navigation across the task board columns.

Declaration
public RadScrollBarElement ScrollBar { get; }
Property Value
RadScrollBarElement

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

ScrollService

Gets the ScrollService that manages kinetic scrolling behavior and mouse-based scrolling interactions.

Declaration
public ScrollService ScrollService { get; }
Property Value
ScrollService

SelectedCard

Gets or sets the currently selected task card in the task board, managing selection state and firing selection events.

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>

TaskCardComparer

Gets or sets the TaskCardComparer used for sorting task cards in columns that don't have their own custom comparer set.

Declaration
public TaskCardComparer TaskCardComparer { get; set; }
Property Value
TaskCardComparer

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>

Methods

ArrangeOverride(SizeF)

Arranges the task board child elements including the horizontal scrollbar and columns layout panel within the allocated space.

Declaration
protected override SizeF ArrangeOverride(SizeF finalSize)
Parameters
System.Drawing.SizeF finalSize

The final area within which this element should arrange itself and its child elements.
Returns
System.Drawing.SizeF

The actual size used by this element.
Overrides

CreateChildElements()

Creates and configures the child elements including the horizontal scrollbar, column layout panel, drag-drop service, and scroll service.

Declaration
protected override void CreateChildElements()
Overrides

DisposeManagedResources()

Releases managed resources by unsubscribing from event handlers for collections and child elements.

Declaration
protected override void DisposeManagedResources()
Overrides

InitializeFields()

Initializes the private fields and sets up the default configuration for the task board element.

Declaration
protected override void InitializeFields()
Overrides

MeasureOverride(SizeF)

Measures the required size for the task board element by calculating space needed for columns and the horizontal scrollbar.

Declaration
protected override SizeF MeasureOverride(SizeF availableSize)
Parameters
System.Drawing.SizeF availableSize

The available space that a parent element can allocate to this element.
Returns
System.Drawing.SizeF

The desired size of this element.
Overrides

OnColumnsCollectionChanged(RadItemCollection, RadItem, ItemsChangeOperation)

Handles changes to the columns collection by setting up property bindings and applying default values to newly added columns.

Declaration
protected virtual void OnColumnsCollectionChanged(RadItemCollection changed, RadItem target, ItemsChangeOperation operation)
Parameters
RadItemCollection changed

The collection that was changed.
RadItem target

The item that was affected by the change.
ItemsChangeOperation operation

The type of operation that was performed.

OnMouseDown(MouseEventArgs)

Handles mouse down events by capturing the mouse and initiating scroll service tracking.

Declaration
protected override void OnMouseDown(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

The System.Windows.Forms.MouseEventArgs containing event data.
Overrides

OnMouseMove(MouseEventArgs)

Handles mouse move events by updating the scroll service with the current mouse position for kinetic scrolling.

Declaration
protected override void OnMouseMove(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

The System.Windows.Forms.MouseEventArgs containing event data.
Overrides

OnMouseUp(MouseEventArgs)

Handles mouse up events by releasing mouse capture and ending scroll service tracking.

Declaration
protected override void OnMouseUp(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

The System.Windows.Forms.MouseEventArgs containing event data.
Overrides

OnMouseWheel(MouseEventArgs)

Handles mouse wheel events by scrolling the task board horizontally when the Shift key is pressed.

Declaration
protected override void OnMouseWheel(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

The System.Windows.Forms.MouseEventArgs containing event data.
Overrides

OnUsersCollectionChanged(Object, NotifyCollectionChangedEventArgs)

Handles changes to the users collection by automatically removing users from all task cards when they are removed from the collection.

Declaration
protected virtual void OnUsersCollectionChanged(object sender, NotifyCollectionChangedEventArgs e)
Parameters
System.Object sender

The source of the event.
System.Collections.Specialized.NotifyCollectionChangedEventArgs e

The System.Collections.Specialized.NotifyCollectionChangedEventArgs containing event data.

ResumeUserManagement()

Resumes automatic user management functionality, enabling users to be removed from task cards when removed from the Users collection.

Declaration
public void ResumeUserManagement()

ScrollView(Int32)

Scrolls the task board view horizontally by the specified offset amount.

Declaration
public void ScrollView(int offset)
Parameters
System.Int32 offset

The horizontal offset by which to scroll the view.

ScrollView(Int32, Boolean)

Scrolls the task board view horizontally by the specified offset amount with optional buffering for performance optimization.

Declaration
public void ScrollView(int offset, bool buffered)
Parameters
System.Int32 offset

The horizontal offset by which to scroll the view.
System.Boolean buffered

When true, enables performance optimization by buffering scroll operations when called frequently.

SortColumns()

Sorts all columns in the task board using the ColumnComparer which orders columns by their Title property.

Declaration
public void SortColumns()

SortTasks()

Sorts task cards in all columns using the TaskCardComparer which orders task cards by their title text property.

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 specific column(s) you need to create a custom comparer and assign it to the TaskCardComparer property.

SortTasks(RadTaskBoardColumnElement)

Sorts task cards in the specified column using either the column's custom TaskCardComparer or the default TaskCardComparer.

Declaration
public void SortTasks(RadTaskBoardColumnElement column)
Parameters
RadTaskBoardColumnElement column

The column whose 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 specified column you need to create a custom comparer and assign it to the TaskCardComparer property.

SuspendUserManagement()

Suspends automatic user management functionality, preventing users from being removed from task cards when removed from the Users collection.

Declaration
public void SuspendUserManagement()

UpdateScrollBar(SizeF)

Updates the horizontal scrollbar configuration based on the current layout size and column content.

Declaration
protected virtual void UpdateScrollBar(SizeF availableSize)
Parameters
System.Drawing.SizeF availableSize

The available space for the task board element.

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