ClassRadTaskBoardColumnElement
Represents a column element within a RadTaskBoard control that contains and manages task cards with scrolling, collapsing, and task card addition functionality.
Definition
Namespace:Telerik.WinControls.UI
Assembly:Telerik.WinControls.UI.dll
Syntax:
public class RadTaskBoardColumnElement : LightVisualElement, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IBindableComponent, IComponent, IDisposable, ISupportDrag, ISupportDrop, IShortcutProvider, IStylableElement, IStylableNode, IPrimitiveElement, IShapedElement, IFillElement, IBorderElement, IBoxStyle, IBoxElement, IDrawFillElement, IImageElement, ITextPrimitive, ITextProvider
Inheritance: objectDisposableObjectRadObjectRadElementVisualElementRadComponentElementRadItemUIItemBaseLightVisualElementRadTaskBoardColumnElement
Implements:
Inherited Members
Constructors
RadTaskBoardColumnElement()
Declaration
public RadTaskBoardColumnElement()
Fields
AddButtonHeightProperty
Declaration
public static RadProperty AddButtonHeightProperty
Field Value
CollapsedColumnWidthProperty
Declaration
public static RadProperty CollapsedColumnWidthProperty
Field Value
HeaderHeightProperty
Declaration
public static RadProperty HeaderHeightProperty
Field Value
ScrollBarThicknessProperty
Declaration
public static RadProperty ScrollBarThicknessProperty
Field Value
ScrollBarVisibilityProperty
Declaration
public static RadProperty ScrollBarVisibilityProperty
Field Value
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.
AddTaskCardButton
Gets the button element that allows users to add new task cards to the column.
Declaration
[Browsable(false)]
public LightVisualButtonElement AddTaskCardButton { get; }
Property Value
CollapseButton
Gets the collapse button element that allows users to collapse or expand the column to save screen space.
Declaration
[Browsable(false)]
public RadCollapseButtonElement CollapseButton { get; }
Property Value
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.
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.
HeaderElement
Gets the header element that displays the column title, subtitle, and provides collapse functionality.
Declaration
[Browsable(false)]
public RadTaskBoardColumnHeaderElement HeaderElement { get; }
Property Value
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.
IsCollapsed
Gets or sets a value indicating whether the column is collapsed, hiding task cards and showing only the header.
IsHeaderHighlighted
Gets or sets a value indicating whether the column header is visually highlighted to draw user attention.
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
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.
Subtitle
Gets or sets the secondary subtitle text displayed below the main title in the column header.
TaskCardCollection
Gets a collection of RadTaskCardElement objects that represents the task cards contained within this column.
Declaration
[RadEditItemsAction]
[Browsable(true)]
public RadItemOwnerCollection TaskCardCollection { get; }
Property Value
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
[Browsable(false)]
public TaskCardComparer TaskCardComparer { get; set; }
Property Value
TaskCardsLayout
Gets the stack layout panel that vertically arranges and positions task cards within the column.
Declaration
[Browsable(false)]
public StackLayoutPanel TaskCardsLayout { get; }
Property Value
Methods
ArrangeOverride(SizeF)
Arranges the column's child elements within the final allocated space, handling both collapsed and expanded layout configurations.
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
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.
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
sender
The element that originally raised the event.
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
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
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
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
changed
The collection that was modified.
target
The target item that was added, removed, or changed.
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(int)
Scrolls the column view by the specified offset amount.
Declaration
public void ScrollView(int offset)
Parameters
offset
The scroll offset amount in pixels.
ScrollView(int, bool)
Scrolls the column view by the specified offset amount with optional buffering to improve performance during frequent calls.
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
availableSize
The available space for calculating scrollbar parameters.
Events
IsCollapsedChanged
Occurs after the column's collapsed state has changed successfully.
IsCollapsedChanging
Occurs before the column's collapsed state changes, allowing the operation to be canceled.
Declaration
public event CancelEventHandler IsCollapsedChanging
Event Value
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 Value
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 Value