RadTaskBoardElement
Represents the main visual element of the RadTaskBoard control that provides task board functionality with columns, cards, and drag-and-drop operations.
Definition
Namespace:Telerik.WinControls.UI
Assembly:Telerik.WinControls.UI.dll
Syntax:
public class RadTaskBoardElement : LightVisualElement, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IBindableComponent, IComponent, IDisposable, ISupportDrag, ISupportDrop, IShortcutProvider, IStylableElement, IStylableNode, IPrimitiveElement, IShapedElement, IFillElement, IBorderElement, IBoxStyle, IBoxElement, IDrawFillElement, IImageElement, ITextPrimitive, ITextProviderInheritance: objectDisposableObjectRadObjectRadElementVisualElementRadComponentElementRadItemUIItemBaseLightVisualElementRadTaskBoardElement...
Implements:
Inherited Members
Constructors
public RadTaskBoardElement()Fields
Identifies the DefaultAddButtonHeight dependency property that defines the default height for add task card buttons.
public static RadProperty DefaultAddButtonHeightPropertyIdentifies the DefaultCollapsedColumnWidth dependency property that defines the default width for collapsed task board columns.
public static RadProperty DefaultCollapsedColumnWidthPropertyIdentifies the DefaultColumnScrollBarThickness dependency property that defines the default thickness for column scrollbars.
public static RadProperty DefaultColumnScrollBarThicknessPropertyIdentifies the DefaultColumnWidth dependency property that defines the default width for task board columns.
public static RadProperty DefaultColumnWidthPropertyIdentifies the DefaultHeaderHeight dependency property that defines the default height for task board column headers.
public static RadProperty DefaultHeaderHeightPropertyIdentifies the DefaultIsHeaderHighlighted dependency property that defines the default highlighted state for column headers.
public static RadProperty DefaultIsHeaderHighlightedPropertyIdentifies the DefaultTaskCardMinimumHeight dependency property that defines the default minimum height for task cards.
public static RadProperty DefaultTaskCardMinimumHeightPropertyIdentifies the ItemDragHint dependency property that defines the visual hint displayed during drag operations.
public static RadProperty ItemDragHintPropertyProperties
Gets or sets the text displayed on 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 or sets the ColumnComparer used for sorting task board columns when the SortColumns() method is called.
[Browsable(false)]
public ColumnComparer ColumnComparer { get; set; }Gets a collection of RadTaskBoardColumnElement objects that represents the columns containing task cards in the task board.
[Browsable(true)]
public RadItemOwnerGenericCollection<RadTaskBoardColumnElement> Columns { get; }Gets the StackLayoutPanel that arranges and positions the task board columns.
[Browsable(false)]
public StackLayoutPanel ColumnsLayout { get; }Gets or sets the default height for add task 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 for scrollbars within individual columns in the task board.
public int DefaultColumnScrollBarThickness { get; set; }Gets or sets the default width for all columns in the task board when no specific width is specified.
public int DefaultColumnWidth { get; set; }Gets or sets the default height for column headers across all columns 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 or sets the default minimum height for all task cards across the task board.
public int DefaultTaskCardMinimumHeight { get; set; }Gets or sets the RadDragDropService that handles drag-and-drop operations for reordering task cards between columns.
public RadDragDropService DragDropService { 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 RadImageShape that provides visual feedback indicating where a task card will be dropped during drag operations.
[Browsable(false)]
[VsbBrowsable(true)]
public RadImageShape ItemDragHint { get; set; }Gets the RadScrollBarElement that enables navigation across the task board columns.
public RadScrollBarElement ScrollBar { get; }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 the ScrollService that manages kinetic scrolling behavior and mouse-based scrolling interactions.
public ScrollService ScrollService { get; }Gets or sets the currently selected task card in the task board, managing selection state and firing selection events.
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.
public ObservableHashSet<TagInfo> Tags { get; }Gets or sets the TaskCardComparer used for sorting task cards in columns that don't have their own custom comparer set.
[Browsable(false)]
public TaskCardComparer TaskCardComparer { get; set; }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.
public ObservableCollection<UserInfo> Users { get; }Methods
Arranges the task board child elements including the horizontal scrollbar and columns layout panel within the allocated space.
Creates and configures the child elements including the horizontal scrollbar, column layout panel, drag-drop service, and scroll service.
protected override void CreateChildElements()Overrides:
Releases managed resources by unsubscribing from event handlers for collections and child elements.
protected override void DisposeManagedResources()Overrides:
Initializes the private fields and sets up the default configuration for the task board element.
protected override void InitializeFields()Overrides:
Measures the required size for the task board element by calculating space needed for columns and the horizontal scrollbar.
Handles changes to the columns collection by setting up property bindings and applying default values to newly added columns.
protected virtual void OnColumnsCollectionChanged(RadItemCollection changed, RadItem target, ItemsChangeOperation operation)The collection that was changed.
targetRadItemThe item that was affected by the change.
operationItemsChangeOperationThe type of operation that was performed.
Handles mouse down events by capturing the mouse and initiating scroll service tracking.
protected override void OnMouseDown(MouseEventArgs e)The MouseEventArgs containing event data.
Overrides:
Handles mouse move events by updating the scroll service with the current mouse position for kinetic scrolling.
protected override void OnMouseMove(MouseEventArgs e)The MouseEventArgs containing event data.
Overrides:
Handles mouse up events by releasing mouse capture and ending scroll service tracking.
protected override void OnMouseUp(MouseEventArgs e)The MouseEventArgs containing event data.
Overrides:
Handles mouse wheel events by scrolling the task board horizontally when the Shift key is pressed.
protected override void OnMouseWheel(MouseEventArgs e)The MouseEventArgs containing event data.
Overrides:
Handles changes to the users collection by automatically removing users from all task cards when they are removed from the collection.
protected virtual void OnUsersCollectionChanged(object sender, NotifyCollectionChangedEventArgs e)The source of the event.
eNotifyCollectionChangedEventArgsThe NotifyCollectionChangedEventArgs containing event data.
Resumes automatic user management functionality, enabling users to be removed from task cards when removed from the Users collection.
public void ResumeUserManagement()Scrolls the task board view horizontally by the specified offset amount with optional buffering for performance optimization.
Scrolls the task board view horizontally by the specified offset amount.
public void ScrollView(int offset)The horizontal offset by which to scroll the view.
Sorts all columns in the task board using the ColumnComparer which orders columns by their Title property.
public void SortColumns()Sorts task cards in all columns using the TaskCardComparer which orders task cards by their title text property.
public void SortTasks()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.
Sorts task cards in the specified column using either the column's custom TaskCardComparer or the default TaskCardComparer.
public void SortTasks(RadTaskBoardColumnElement column)The column whose task cards will be sorted.
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.
Suspends automatic user management functionality, preventing users from being removed from task cards when removed from the Users collection.
public void SuspendUserManagement()Updates the horizontal scrollbar configuration based on the current layout size and column content.
protected virtual void UpdateScrollBar(SizeF availableSize)The available space for the task board element.
Events
The Event is fired, when a task card has been selected.
public event RadTaskBoardElement.TaskCardSelectedDelegate TaskCardSelectedThe Event is fired, when selecting a task card.
public event RadTaskBoardElement.TaskCardSelectingDelegate TaskCardSelecting