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, ITextProviderInheritance: objectDisposableObjectRadObjectRadElementVisualElementRadComponentElementRadItemUIItemBaseLightVisualElementRadTaskBoardColumnElement...
Implements:
Inherited Members
Constructors
public RadTaskBoardColumnElement()Fields
public static RadProperty AddButtonHeightPropertypublic static RadProperty CollapsedColumnWidthPropertypublic static RadProperty ColumnWidthPropertypublic static RadProperty HeaderHeightPropertypublic static RadProperty ScrollBarThicknessPropertypublic static RadProperty ScrollBarVisibilityPropertyProperties
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.
public int AddButtonHeight { get; set; }Gets the button element that allows users to add new task cards to the column.
[Browsable(false)]
public LightVisualButtonElement AddTaskCardButton { get; }Gets the collapse button element that allows users to collapse or expand the column to save screen space.
[Browsable(false)]
public RadCollapseButtonElement CollapseButton { get; }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.
public int CollapsedColumnWidth { get; set; }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.
public int ColumnWidth { get; set; }Gets the header element that displays the column title, subtitle, and provides collapse functionality.
[Browsable(false)]
public RadTaskBoardColumnHeaderElement HeaderElement { get; }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.
public int HeaderHeight { get; set; }Gets or sets a value indicating whether the column is collapsed, hiding task cards and showing only the header.
public bool IsCollapsed { get; set; }Gets or sets a value indicating whether the column header is visually highlighted to draw user attention.
public bool IsHeaderHighlighted { get; set; }Gets the vertical scrollbar element that enables scrolling through task cards when content exceeds the visible area.
public RadScrollBarElement ScrollBar { get; }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.
public int ScrollBarThickness { get; set; }Gets or sets the secondary subtitle text displayed below the main title in the column header.
public string Subtitle { get; set; }Gets a collection of RadTaskCardElement objects that represents the task cards contained within this column.
[RadEditItemsAction]
[Browsable(true)]
public RadItemOwnerCollection TaskCardCollection { get; }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.
[Browsable(false)]
public TaskCardComparer TaskCardComparer { get; set; }Gets the stack layout panel that vertically arranges and positions task cards within the column.
[Browsable(false)]
public StackLayoutPanel TaskCardsLayout { get; }Methods
Arranges the column's child elements within the final allocated space, handling both collapsed and expanded layout configurations.
Creates and returns a new add task card button element. Override this method to provide custom button functionality.
protected virtual LightVisualButtonElement CreateAddTaskCardButtonElement()A new instance of LightVisualButtonElement.
Creates and configures the child elements including scrollbar, task cards layout, header, and add task card button.
protected override void CreateChildElements()Overrides:
Creates and returns a new header element for the column. Override this method to provide custom header functionality.
protected virtual RadTaskBoardColumnHeaderElement CreateHeaderElement()RadTaskBoardColumnHeaderElement
A new instance of RadTaskBoardColumnHeaderElement.
Releases managed resources and unsubscribes from event handlers to prevent memory leaks.
protected override void DisposeManagedResources()Overrides:
Initializes the column element's visual properties including styling, margin, drag-drop support, and background appearance.
protected override void InitializeFields()Overrides:
Measures the desired size of the column element, handling both collapsed and expanded states with scrollbar considerations.
Handles bubbled events from child elements, specifically managing mouse up events to complete drag-and-drop operations.
protected override void OnBubbleEvent(RadElement sender, RoutedEventArgs args)The element that originally raised the event.
argsRoutedEventArgsThe routed event arguments containing event data and cancellation information.
Overrides:
Handles mouse enter events, setting focus and tracking mouse presence for scroll wheel functionality.
protected override void OnMouseEnter(EventArgs e)The event arguments.
Overrides:
Handles mouse leave events, removing focus and clearing mouse presence tracking.
protected override void OnMouseLeave(EventArgs e)The event arguments.
Overrides:
Handles mouse wheel events to enable vertical scrolling within the column when the mouse is over the column area.
protected override void OnMouseWheel(MouseEventArgs e)The mouse event arguments containing wheel delta information.
Overrides:
Handles changes to the task card collection, setting up property bindings and tag management for new task cards.
protected virtual void OnTaskCardCollectionChanged(RadItemCollection changed, RadItem target, ItemsChangeOperation operation)The collection that was modified.
targetRadItemThe target item that was added, removed, or changed.
operationItemsChangeOperationThe type of operation performed on the collection.
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.
protected virtual void PerformAddTaskCard()Resets the AddButtonHeight property to its default value and restores binding to the task board's default setting.
public void ResetAddButtonHeight()Resets the CollapsedColumnWidth property to its default value and restores binding to the task board's default setting.
public void ResetCollapsedColumnWidth()Resets the ColumnWidth property to its default value and restores binding to the task board's default setting.
public void ResetColumnWidth()Resets the HeaderHeight property to its default value and restores binding to the task board's default setting.
public void ResetHeaderHeight()Resets the IsHeaderHighlighted property to its default value and restores binding to the task board's default setting.
public void ResetIsHeaderHighlighted()Resets the ScrollBarThickness property to its default value and restores binding to the task board's default setting.
public void ResetScrollBarThickness()Scrolls the column view by the specified offset amount with optional buffering to improve performance during frequent calls.
Scrolls the column view by the specified offset amount.
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.
public void Sort()Updates the scrollbar configuration including visibility, range, and scroll position based on content size and available space.
protected virtual void UpdateScrollBar(SizeF availableSize)The available space for calculating scrollbar parameters.
Events
Occurs after the column's collapsed state has changed successfully.
public event EventHandler IsCollapsedChangedOccurs before the column's collapsed state changes, allowing the operation to be canceled.
public event CancelEventHandler IsCollapsedChangingOccurs after a new task card has been successfully added to the column via the add button.
public event RadTaskBoardColumnElement.TaskCardAddedDelegate TaskCardAddedOccurs before a new task card is added to the column via the add button, allowing customization or cancellation of the operation.
public event RadTaskBoardColumnElement.TaskCardAddingDelegate TaskCardAdding