WinForms › Tree List View › MultiColumnDropDownWindowConfiguration

MultiColumnDropDownWindowConfiguration

class.NET 6 / 8 / 10.NET Framework 4.8Binarymission.WinForms.Controls.TreeControls

The look of the header, footer and column headings of a BinaryTreeListViewComboBoxColumn's multi-column drop-down.

public class MultiColumnDropDownWindowConfiguration

Remarks

Set it through BinaryTreeListViewComboBoxColumn.MultiColumnDropDownWindowConfiguration. Each value is copied to the cell's editor when editing starts. The header and footer settings show only while the column's BinaryTreeListViewComboBoxColumn.EnableDrawingHeaderFooterWhenInMultiColumnMode is on.

Examples

supplierColumn.DropStyleIsMultiColumn = true;
supplierColumn.EnableDrawingHeaderFooterWhenInMultiColumnMode = true;
supplierColumn.MultiColumnDropDownWindowConfiguration.HeaderText = "Approved suppliers";
supplierColumn.MultiColumnDropDownWindowConfiguration.FooterText = "Double-click a supplier to choose it";
supplierColumn.MultiColumnDropDownWindowConfiguration.HeaderControlRenderingStartColor = Color.FromArgb(232, 240, 250);
supplierColumn.MultiColumnDropDownWindowConfiguration.HeaderControlRenderingEndColor = Color.White;

Members at a glance

Properties
`ColumnHeaderFont`	Gets or sets the font of the column headings in the multi-column drop-down.
`DrawFooter`	Gets or sets whether the footer band is drawn below the rows.
`DropListWindowBackColor`	Gets or sets the background colour of the multi-column drop-down window.
`FooterCaptionFont`	Gets or sets the font of `FooterText`.
`FooterSurfaceHeight`	Gets or sets the height of the footer band.
`FooterText`	Gets or sets the text of the footer band below the rows.
`HeaderAndFooterTextForeColor`	Gets or sets the colour of `HeaderText` and `FooterText`.
`HeaderBitmap`	Gets or sets the picture shown in the header when `HeaderImageType` is `HeaderImageStyle.Bitmap`.
`HeaderCaptionFont`	Gets or sets the font of `HeaderText`.
`HeaderControlRenderingEndColor`	Gets or sets the colour the header and footer bands' gradient ends at.
`HeaderControlRenderingStartColor`	Gets or sets the colour the header and footer bands' gradient starts from.
`HeaderIcon`	Gets or sets the icon shown in the header when `HeaderImageType` is `HeaderImageStyle.Icon`.
`HeaderImageType`	Gets or sets whether the header shows `HeaderIcon` or `HeaderBitmap`.
`HeaderSurfaceHeight`	Gets or sets the height of the header band.
`HeaderText`	Gets or sets the caption of the header band above the rows.
`NoDataToDisplayMessageText`	Gets or sets the message the multi-column drop-down shows when it has no rows.
Methods
`ToString`	Returns the text the Properties window shows for the collapsed configuration.

Properties

ColumnHeaderFont

public Font ColumnHeaderFont

Gets or sets the font of the column headings in the multi-column drop-down.

Value: A 12-point font of the system message-box font family by default.

DrawFooter

public bool DrawFooter

Gets or sets whether the footer band is drawn below the rows.

Value: true by default.

DropListWindowBackColor

public Color DropListWindowBackColor

Gets or sets the background colour of the multi-column drop-down window.

Value: SystemColors.Window by default.

FooterCaptionFont

public Font FooterCaptionFont

Gets or sets the font of FooterText.

Value: Control.DefaultFont by default.

FooterSurfaceHeight

public int FooterSurfaceHeight

Gets or sets the height of the footer band.

Value: In logical pixels; 20 by default. The editor scales it to the display.

FooterText

public string FooterText

Gets or sets the text of the footer band below the rows.

Value: An empty string by default.

HeaderAndFooterTextForeColor

public Color HeaderAndFooterTextForeColor

Gets or sets the colour of HeaderText and FooterText.

Value: SystemColors.WindowText by default.

HeaderBitmap

public Bitmap HeaderBitmap

Gets or sets the picture shown in the header when HeaderImageType is HeaderImageStyle.Bitmap.

Value: null, the default, for no picture.

HeaderCaptionFont

public Font HeaderCaptionFont

Gets or sets the font of HeaderText.

Value: Control.DefaultFont by default.

HeaderControlRenderingEndColor

public Color HeaderControlRenderingEndColor

Gets or sets the colour the header and footer bands' gradient ends at.

Value: SystemColors.Window by default.

HeaderControlRenderingStartColor

public Color HeaderControlRenderingStartColor

Gets or sets the colour the header and footer bands' gradient starts from.

Value: SystemColors.Control by default.

HeaderIcon

public Icon HeaderIcon

Gets or sets the icon shown in the header when HeaderImageType is HeaderImageStyle.Icon.

Value: null, the default, for no icon.

HeaderImageType

public Binarymission.WinForms.Controls.ListControls.HeaderImageStyle HeaderImageType

Gets or sets whether the header shows HeaderIcon or HeaderBitmap.

Value: HeaderImageStyle.Icon by default.

HeaderSurfaceHeight

public int HeaderSurfaceHeight

Gets or sets the height of the header band.

Value: In logical pixels; 20 by default. The editor scales it to the display.

HeaderText

public string HeaderText

Gets or sets the caption of the header band above the rows.

Value: An empty string by default.

NoDataToDisplayMessageText

public string NoDataToDisplayMessageText

Gets or sets the message the multi-column drop-down shows when it has no rows.

Value: "There are no items to display." by default.

Methods

ToString

public override string ToString()

Returns the text the Properties window shows for the collapsed configuration.

Returns

Always "MultiColumnDropDownWindowConfiguration settings...".