Documentation

Class RadTaskBoardElement

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, IImageElement, ITextPrimitive, ITextProvider

Constructors

RadTaskBoardElement()

Declaration
public RadTaskBoardElement()

Fields

DefaultAddButtonHeightProperty

Declaration
public static RadProperty DefaultAddButtonHeightProperty
Field Value
RadProperty

DefaultCollapsedColumnWidthProperty

Declaration
public static RadProperty DefaultCollapsedColumnWidthProperty
Field Value
RadProperty

DefaultColumnScrollBarThicknessProperty

Declaration
public static RadProperty DefaultColumnScrollBarThicknessProperty
Field Value
RadProperty

DefaultColumnWidthProperty

Declaration
public static RadProperty DefaultColumnWidthProperty
Field Value
RadProperty

DefaultHeaderHeightProperty

Declaration
public static RadProperty DefaultHeaderHeightProperty
Field Value
RadProperty

DefaultIsHeaderHighlightedProperty

Declaration
public static RadProperty DefaultIsHeaderHighlightedProperty
Field Value
RadProperty

DefaultTaskCardMinimumHeightProperty

Declaration
public static RadProperty DefaultTaskCardMinimumHeightProperty
Field Value
RadProperty

ItemDragHintProperty

Declaration
public static RadProperty ItemDragHintProperty
Field Value
RadProperty

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

ColumnComparer

Gets or sets the column comparer used when TaskBoard columns are sorted.

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

Columns

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

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

ColumnsLayout

Gets the layout panel that arranges the columns.

Declaration
public StackLayoutPanel ColumnsLayout { get; }
Property Value
StackLayoutPanel

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

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

DragDropService

Gets or sets the RadDragDropService that is responsible for the drag-drop reorder of task cards.

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

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

ItemDragHint

Gets or sets the RadImageShape instance, which describes the hint that indicates, where a task card will be dropped after a drag operation.

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

ScrollBar

Gets the scrollbar of the task board.

Declaration
public RadScrollBarElement ScrollBar { get; }
Property Value
RadScrollBarElement

ScrollBarThickness

Gets or sets the task board's scrollbar thickness.

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

ScrollService

Gets the ScrollService that is responsible for kinetic scrolling behavior with the mouse pointer.

Declaration
public ScrollService ScrollService { get; }
Property Value
ScrollService

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>

TaskCardComparer

Gets or sets the task card comparer used for each column that has not set this value to its own. If you need custom sorting for a single column create custom comparer and set its TaskCardComparer property.

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

ToolTipCollapse

Gets or set the tooltip string for the collapse button, when the column is expanded - "Collapse 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>

Methods

ArrangeOverride(SizeF)

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

Returns
System.Drawing.SizeF

Overrides

CreateChildElements()

Declaration
protected override void CreateChildElements()
Overrides

DisposeManagedResources()

Declaration
protected override void DisposeManagedResources()
Overrides

InitializeFields()

Declaration
protected override void InitializeFields()
Overrides

MeasureOverride(SizeF)

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

Returns
System.Drawing.SizeF

Overrides

OnColumnsCollectionChanged(RadItemCollection, RadItem, ItemsChangeOperation)

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

RadItem target

ItemsChangeOperation operation

OnMouseDown(MouseEventArgs)

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

Overrides

OnMouseMove(MouseEventArgs)

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

Overrides

OnMouseUp(MouseEventArgs)

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

Overrides

OnMouseWheel(MouseEventArgs)

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

Overrides

OnUsersCollectionChanged(Object, NotifyCollectionChangedEventArgs)

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

System.Collections.Specialized.NotifyCollectionChangedEventArgs e

ResumeUserManagement()

Resumes user management functionality. Users will be removed from cards, when you remove them from Users.

Declaration
public void ResumeUserManagement()

ScrollView(Int32)

Scrolls the view with a specified offset.

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

The offset.

ScrollView(Int32, Boolean)

Scrolls the view with a specified offset.

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

The offset.
System.Boolean buffered

If the method is called too often, set this to [true] to improve performance.

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.

SuspendUserManagement()

Suspends user management functionality. Users will no longer be removed from cards, when you remove them from Users.

Declaration
public void SuspendUserManagement()

UpdateScrollBar(SizeF)

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

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