Class RadTaskBoardColumnElement

Represents a column element within a RadTaskBoard control that contains and manages task cards with scrolling, collapsing, and task card addition functionality.

Inheritance
System.Object
DisposableObject
RadObject
RadElement
VisualElement
RadComponentElement
RadItem
UIItemBase
LightVisualElement
RadTaskBoardColumnElement
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 RadTaskBoardColumnElement : LightVisualElement, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IComponent, IDisposable, IBindableComponent, ISupportDrag, ISupportDrop, IShortcutProvider, IStylableElement, IStylableNode, IPrimitiveElement, IShapedElement, IFillElement, IBorderElement, IBoxStyle, IBoxElement, IDrawFillElement, IImageElement, ITextPrimitive, ITextProvider

Constructors

RadTaskBoardColumnElement()

Declaration
public RadTaskBoardColumnElement()

Fields

AddButtonHeightProperty

Declaration
public static RadProperty AddButtonHeightProperty
Field Value
RadProperty

CollapsedColumnWidthProperty

Declaration
public static RadProperty CollapsedColumnWidthProperty
Field Value
RadProperty

ColumnWidthProperty

Declaration
public static RadProperty ColumnWidthProperty
Field Value
RadProperty

HeaderHeightProperty

Declaration
public static RadProperty HeaderHeightProperty
Field Value
RadProperty

ScrollBarThicknessProperty

Declaration
public static RadProperty ScrollBarThicknessProperty
Field Value
RadProperty

ScrollBarVisibilityProperty

Declaration
public static RadProperty ScrollBarVisibilityProperty
Field Value
RadProperty

Properties

AddButtonHeight

Gets or sets the height of the add task card button in pixels. Setting this value unbinds the property from the DefaultAddButtonHeight property. Use ResetAddButtonHeight() to restore binding.

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

AddTaskCardButton

Gets the button element that allows users to add new task cards to the column.

Declaration
public LightVisualButtonElement AddTaskCardButton { get; }
Property Value
LightVisualButtonElement

CollapseButton

Gets the collapse button element that allows users to collapse or expand the column to save screen space.

Declaration
public RadCollapseButtonElement CollapseButton { get; }
Property Value
RadCollapseButtonElement

CollapsedColumnWidth

Gets or sets the width of the column when collapsed in pixels. Setting this value unbinds the property from the DefaultCollapsedColumnWidth property. Use ResetCollapsedColumnWidth() to restore binding.

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

ColumnWidth

Gets or sets the width of the column in pixels. Setting this value unbinds the property from the DefaultColumnWidth property. Use ResetColumnWidth() to restore binding.

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

HeaderElement

Gets the header element that displays the column title, subtitle, and provides collapse functionality.

Declaration
public RadTaskBoardColumnHeaderElement HeaderElement { get; }
Property Value
RadTaskBoardColumnHeaderElement

HeaderHeight

Gets or sets the height of the column header in pixels. Setting this value unbinds the property from the DefaultHeaderHeight property. Use ResetHeaderHeight() to restore binding.

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

IsCollapsed

Gets or sets a value indicating whether the column is collapsed, hiding task cards and showing only the header.

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

IsHeaderHighlighted

Gets or sets a value indicating whether the column header is visually highlighted to draw user attention.

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

ScrollBar

Gets the vertical scrollbar element that enables scrolling through task cards when content exceeds the visible area.

Declaration
public RadScrollBarElement ScrollBar { get; }
Property Value
RadScrollBarElement

ScrollBarThickness

Gets or sets the thickness of the scrollbar in pixels. Setting this value unbinds the property from the DefaultColumnScrollBarThickness property. Use ResetScrollBarThickness() to restore binding.

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

Subtitle

Gets or sets the secondary subtitle text displayed below the main title in the column header.

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

TaskCardCollection

Gets a collection of RadTaskCardElement objects that represents the task cards contained within this column.

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

TaskCardComparer

Gets or sets the custom comparer used for sorting task cards within this column when the Sort() method is called. If not set, uses the default TaskCardComparer.

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

TaskCardsLayout

Gets the stack layout panel that vertically arranges and positions task cards within the column.

Declaration
public StackLayoutPanel TaskCardsLayout { get; }
Property Value
StackLayoutPanel

Text

This property is not relevant for this class.

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

Overrides

Title

Gets or sets the main title text displayed in the column header.

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

Methods

ArrangeOverride(SizeF)

Arranges the column's child elements within the final allocated space, handling both collapsed and expanded layout configurations.

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

The final size allocated for the column element.
Returns
System.Drawing.SizeF

The actual size used by the column element.
Overrides

CreateAddTaskCardButtonElement()

Creates and returns a new add task card button element. Override this method to provide custom button functionality.

Declaration
protected virtual LightVisualButtonElement CreateAddTaskCardButtonElement()
Returns
LightVisualButtonElement

A new instance of LightVisualButtonElement.

CreateChildElements()

Creates and configures the child elements including scrollbar, task cards layout, header, and add task card button.

Declaration
protected override void CreateChildElements()
Overrides

CreateHeaderElement()

Creates and returns a new header element for the column. Override this method to provide custom header functionality.

Declaration
protected virtual RadTaskBoardColumnHeaderElement CreateHeaderElement()
Returns
RadTaskBoardColumnHeaderElement

A new instance of RadTaskBoardColumnHeaderElement.

DisposeManagedResources()

Releases managed resources and unsubscribes from event handlers to prevent memory leaks.

Declaration
protected override void DisposeManagedResources()
Overrides

InitializeFields()

Initializes the column element's visual properties including styling, margin, drag-drop support, and background appearance.

Declaration
protected override void InitializeFields()
Overrides

MeasureOverride(SizeF)

Measures the desired size of the column element, handling both collapsed and expanded states with scrollbar considerations.

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

The available space for layout measurement.
Returns
System.Drawing.SizeF

The desired size of the column element.
Overrides

OnBubbleEvent(RadElement, RoutedEventArgs)

Handles bubbled events from child elements, specifically managing mouse up events to complete drag-and-drop operations.

Declaration
protected override void OnBubbleEvent(RadElement sender, RoutedEventArgs args)
Parameters
RadElement sender

The element that originally raised the event.
RoutedEventArgs args

The routed event arguments containing event data and cancellation information.
Overrides

OnMouseEnter(EventArgs)

Handles mouse enter events, setting focus and tracking mouse presence for scroll wheel functionality.

Declaration
protected override void OnMouseEnter(EventArgs e)
Parameters
System.EventArgs e

The event arguments.
Overrides

OnMouseLeave(EventArgs)

Handles mouse leave events, removing focus and clearing mouse presence tracking.

Declaration
protected override void OnMouseLeave(EventArgs e)
Parameters
System.EventArgs e

The event arguments.
Overrides

OnMouseWheel(MouseEventArgs)

Handles mouse wheel events to enable vertical scrolling within the column when the mouse is over the column area.

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

The mouse event arguments containing wheel delta information.
Overrides

OnTaskCardCollectionChanged(RadItemCollection, RadItem, ItemsChangeOperation)

Handles changes to the task card collection, setting up property bindings and tag management for new task cards.

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

The collection that was modified.
RadItem target

The target item that was added, removed, or changed.
ItemsChangeOperation operation

The type of operation performed on the collection.

PerformAddTaskCard()

Handles the add task card button click event and creates a new task card with default properties. Override this method to customize task card creation behavior.

Declaration
protected virtual void PerformAddTaskCard()

ResetAddButtonHeight()

Resets the AddButtonHeight property to its default value and restores binding to the task board's default setting.

Declaration
public void ResetAddButtonHeight()

ResetCollapsedColumnWidth()

Resets the CollapsedColumnWidth property to its default value and restores binding to the task board's default setting.

Declaration
public void ResetCollapsedColumnWidth()

ResetColumnWidth()

Resets the ColumnWidth property to its default value and restores binding to the task board's default setting.

Declaration
public void ResetColumnWidth()

ResetHeaderHeight()

Resets the HeaderHeight property to its default value and restores binding to the task board's default setting.

Declaration
public void ResetHeaderHeight()

ResetIsHeaderHighlighted()

Resets the IsHeaderHighlighted property to its default value and restores binding to the task board's default setting.

Declaration
public void ResetIsHeaderHighlighted()

ResetScrollBarThickness()

Resets the ScrollBarThickness property to its default value and restores binding to the task board's default setting.

Declaration
public void ResetScrollBarThickness()

ScrollView(Int32)

Scrolls the column view by the specified offset amount.

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

The scroll offset amount in pixels.

ScrollView(Int32, Boolean)

Scrolls the column view by the specified offset amount with optional buffering to improve performance during frequent calls.

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

The scroll offset amount in pixels.
System.Boolean buffered

True to enable buffering for better performance when called frequently; otherwise, false.

Sort()

Sorts the task cards in the TaskCardCollection using the configured TaskCardComparer. This is a one-time operation and changes to task card state after sorting are not automatically monitored.

Declaration
public void Sort()

UpdateScrollBar(SizeF)

Updates the scrollbar configuration including visibility, range, and scroll position based on content size and available space.

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

The available space for calculating scrollbar parameters.

Events

IsCollapsedChanged

Occurs after the column's collapsed state has changed successfully.

Declaration
public event EventHandler IsCollapsedChanged
Event Type
System.EventHandler

IsCollapsedChanging

Occurs before the column's collapsed state changes, allowing the operation to be canceled.

Declaration
public event CancelEventHandler IsCollapsedChanging
Event Type
System.ComponentModel.CancelEventHandler

TaskCardAdded

Occurs after a new task card has been successfully added to the column via the add button.

Declaration
public event RadTaskBoardColumnElement.TaskCardAddedDelegate TaskCardAdded
Event Type
RadTaskBoardColumnElement.TaskCardAddedDelegate

TaskCardAdding

Occurs before a new task card is added to the column via the add button, allowing customization or cancellation of the operation.

Declaration
public event RadTaskBoardColumnElement.TaskCardAddingDelegate TaskCardAdding
Event Type
RadTaskBoardColumnElement.TaskCardAddingDelegate

Extension Methods