Class RadTaskBoardColumnHeaderElement

Represents the header element of a task board column that displays title, subtitle, and provides collapse/expand functionality with mouse interaction support for horizontal scrolling.

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

Constructors

RadTaskBoardColumnHeaderElement()

Declaration
public RadTaskBoardColumnHeaderElement()

Fields

IsCollapsedProperty

Declaration
public static RadProperty IsCollapsedProperty
Field Value
RadProperty

IsHighlightedProperty

Declaration
public static RadProperty IsHighlightedProperty
Field Value
RadProperty

Properties

CollapseButton

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

Declaration
public virtual RadCollapseButtonElement CollapseButton { get; }
Property Value
RadCollapseButtonElement

IsCollapsed

Gets or sets a value indicating whether the column header is in collapsed state, affecting layout and visual presentation.

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

IsHighlighted

Gets or sets a value indicating whether the header is visually highlighted. Setting this value unbinds the property from the DefaultIsHeaderHighlighted property. Use ResetIsHighlighted() to restore binding.

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

Subtitle

Gets or sets the secondary subtitle text displayed below the main title for additional context information.

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

SubTitleElement

Gets the visual element that displays the secondary subtitle text below the main title.

Declaration
public virtual LightVisualElement SubTitleElement { get; }
Property Value
LightVisualElement

Title

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

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

TitleElement

Gets the visual element that displays the main title text of the column header.

Declaration
public virtual LightVisualElement TitleElement { get; }
Property Value
LightVisualElement

Methods

ArrangeOverride(SizeF)

Arranges the header's child elements within the final allocated space, positioning title, subtitle, and collapse button according to the current collapsed state.

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

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

The actual size used by the header element.
Overrides

CreateChildElements()

Creates and configures the child elements including title, subtitle, and collapse button with their styling and event handlers.

Declaration
protected override void CreateChildElements()
Overrides

CreateCollapseButton()

Creates and returns a new collapse button element. Override this method to provide custom collapse button functionality.

Declaration
protected virtual RadCollapseButtonElement CreateCollapseButton()
Returns
RadCollapseButtonElement

A new instance of RadCollapseButtonElement.

InitializeFields()

Initializes the header element's properties including mouse input handling and drag-drop support.

Declaration
protected override void InitializeFields()
Overrides

MeasureOverride(SizeF)

Measures the desired size of the header element, handling both collapsed and expanded layout states with proper element sizing.

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 header element.
Overrides

OnMouseDown(MouseEventArgs)

Handles mouse down events, enabling capture mode and initiating horizontal scroll service tracking.

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

The mouse event arguments containing button and position information.
Overrides

OnMouseMove(MouseEventArgs)

Handles mouse move events, updating the scroll service with current mouse position for horizontal scrolling support.

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

The mouse event arguments containing position information.
Overrides

OnMouseUp(MouseEventArgs)

Handles mouse up events, completing scroll service tracking and releasing capture mode.

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

The mouse event arguments containing button and position information.
Overrides

ResetIsHighlighted()

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

Declaration
public void ResetIsHighlighted()

Extension Methods