ColumnHeaderLayout class Core

The layout of the built-in column header, shared by everything that has to agree on it: the renderer that draws the header (IColumnHeaderChrome) and the hit test and hosts that map a press back to a caption button, a filter box or a caret position.

public static class ColumnHeaderLayout
Namespace
ArionUI.Presentation
Package
ArionUI.Presentation · dotnet add package ArionUI.Presentation --prerelease

Fields

BandButtonSize

public const double BandButtonSize = 22;

Edge length of the button a header band shows before its label.

BandMarkerSlot

public const double BandMarkerSlot = 18;

Width of the marker slots of a header band: the fold marker before its label, the funnel at its right end.

FilterClearZone

public const double FilterClearZone = 16;

Width of the clear (×) button at the right of a filter box — drawn only while the column is filtered (text or value checklist).

FilterDropdownZone

public const double FilterDropdownZone = 16;

Width of the filter-dropdown (funnel) button INSIDE the filter box, at its right edge — shown only while the filter cell is hovered. This is the value-filter entry point when the filter row is on (it replaces the caption chevron there).

FilterOperatorZone

public const double FilterOperatorZone = 18;

Width of the operator button at the left of a filter box.

Properties

BandDetailStyle

public static TextStyle BandDetailStyle { get; }

Text style of an interactive header band's dim detail.

BandLabelStyle

public static TextStyle BandLabelStyle { get; }

Text style of an interactive header band's label (HeaderBand.IsInteractive).

FilterBoxStyle

public static TextStyle FilterBoxStyle { get; }

Text style of the filter-row box — ONE definition shared by the renderer (drawing) and the host (click-to-caret mapping).

Methods

BandLabelSpan

public static (double, double)? BandLabelSpan(double x0, double x1, double whole, bool startsHere, double minX, double maxX);

Where a band's label goes in one region of the header: the band's part there runs from x0 to x1 of its whole width, and the region shows minX to maxX (content coordinates). A band split by the freeze line is labelled once, in the region that holds its larger part (on a tie, the one it starts in), on the part in sight; null for the other region.

BandLayout

public static ColumnHeaderLayout.BandParts BandLayout(HeaderBand band, LogRect cell, double from, double to, Func<string, TextStyle, double> measure);

Where the parts of an interactive band stand - ONE layout for the renderer and the hit test. The group of button, fold marker, label and detail starts at the left of the part in sight (from to to) and is pushed back by the end of what is shown, so it never runs into the next band; the funnel stands at that end.

BandShown

public static ColumnHeaderLayout.BandSpan? BandShown(HeaderBand band, GridMetrics m, ColumnPins pins, double bandRowHeight, double viewportWidth);

The band's cell and the stretch of it that is in sight and labelled: the region (leading pinned block, scrolled columns, trailing pinned block) that holds the larger part of the band, clipped to what that region shows - the ONE answer the header draws by and hits by. Null when no region labels it in sight.

CaptionHead

public static LogRect CaptionHead(double columnLeft, double columnWidth, double captionHeight, int index, int count);

Head index of count a caption is split into (ColumnCaption.Heads): equal shares of the column, side by side.

CaptionHeadAt

public static int CaptionHeadAt(double columnLeft, double columnWidth, int count, double x);

Which head of count lies under x.

CaptionHeadFunnel

public static LogRect CaptionHeadFunnel(LogRect head);

The funnel of a caption head, at its right end; heads have none while the filter row is shown, like every caption.

CaptionHeadSort

public static LogRect CaptionHeadSort(LogRect head, bool filterable);

The sort arrow of a caption head, left of its funnel.

CaptionText

public static string CaptionText(string caption);

A caption as the theme shows captions: in capitals when it asks for them, made once per text.

DetailText

public static string DetailText(string detail);

A band's detail as shown, after its separator; made once per text.

HeaderBand

public static LogRect HeaderBand(double columnLeft, double columnWidth, double captionHeight);

The caption band of a column header — the rect the buttons are laid out into. One definition for drawing and hit-testing (see HeaderButtons).

Nested types

ColumnHeaderLayout.BandParts record struct
The parts of an interactive band (HeaderBand.IsInteractive).
ColumnHeaderLayout.BandSpan record struct
The stretch of a band in sight and labelled (ColumnHeaderLayout.BandShown).