WinForms › Combo Box › MultiColumnDropDownWindowConfiguration

MultiColumnDropDownWindowConfiguration

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

The appearance of the multi-column drop-down of a BinaryTextComboBox: its header and footer bands, its column headings and the message it shows when there are no rows.

public class MultiColumnDropDownWindowConfiguration

Remarks

Each combo box has one, in MultiColumnDropDownWindowConfigurationData. The window reads it every time it opens, so changes show the next time the user opens the drop-down.

The header and footer settings take effect only while EnableDrawingHeaderFooterWhenInMultiColumnMode is true. Heights are logical pixels.

A BinaryComboBoxColumn in a grid has settings of its own, in BinaryComboBoxColumn.MultiColumnDropDownWindowConfiguration, which it copies here for its editor.

Members at a glance

Properties
`ColumnHeaderFont`	Gets or sets the font of the column heading text.
`ColumnHeaderForeColor`	Gets or sets the colour of the column heading text.
`DrawFooter`	Gets or sets whether the footer band is drawn below the rows.
`DropListWindowBackColor`	Gets or sets the drop-down list's background colour. Kept for older applications; use `MultiColumnDropListBackColor`.
`FooterCaptionFont`	Gets or sets the font of `FooterText`.
`FooterSurfaceHeight`	Gets or sets the height of the footer band.
`FooterText`	Gets or sets the text in the footer band – a hint such as "Double-click a row to choose it".
`HeaderAndFooterTextForeColor`	Gets or sets the colour of the header and footer text.
`HeaderBitmap`	Gets or sets the picture drawn in the header band when `HeaderImageType` is `HeaderImageStyle.Bitmap`.
`HeaderCaptionFont`	Gets or sets the font of `HeaderText`.
`HeaderControlRenderingEndColor`	Gets or sets the ending colour of the gradient behind the header and footer bands and the column headings.
`HeaderControlRenderingStartColor`	Gets or sets the starting colour of the gradient behind the header and footer bands and the column headings, and the colour of the window's frame.
`HeaderIcon`	Gets or sets the icon drawn in the header band when `HeaderImageType` is `HeaderImageStyle.Icon`.
`HeaderImageType`	Gets or sets which picture, if any, the header band shows: `HeaderIcon` or `HeaderBitmap`.
`HeaderSurfaceHeight`	Gets or sets the height of the header band.
`HeaderText`	Gets or sets the caption in the header band.
`NoDataToDisplayMessageText`	Gets or sets the message the drop-down shows when the data source has no rows.
Methods
`ToString`	Returns the fixed text the Properties window shows for the settings while they are folded.

Properties

ColumnHeaderFont

public Font ColumnHeaderFont

Gets or sets the font of the column heading text.

Value: The heading font. The default is the system message-box font family at 12 points.

Remarks

When the window sizes itself to its columns, each column is made wide enough for its heading in this font.

ColumnHeaderForeColor

public Color ColumnHeaderForeColor

Gets or sets the colour of the column heading text.

Value: The heading text colour. The default is SystemColors.WindowText.

DrawFooter

public bool DrawFooter

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

Value: true to draw the footer. The default is true.

Remarks

A window that sizes itself is made taller by FooterSurfaceHeight to hold it.

DropListWindowBackColor Obsolete

public Color DropListWindowBackColor

Gets or sets the drop-down list's background colour. Kept for older applications; use MultiColumnDropListBackColor.

Value: The background colour. The default is SystemColors.Window.

Remarks

MultiColumnDropListBackColor sets this as well, and the list uses that value; the property is hidden from the Properties window and not saved by the designer.

FooterCaptionFont

public Font FooterCaptionFont

Gets or sets the font of FooterText.

Value: The font. The default is Control.DefaultFont.

FooterSurfaceHeight

public int FooterSurfaceHeight

Gets or sets the height of the footer band.

Value: The height in logical pixels, scaled to the display the window opens on. The default is 20.

FooterText

public string FooterText

Gets or sets the text in the footer band – a hint such as "Double-click a row to choose it".

Value: The footer text. The default is an empty string.

HeaderAndFooterTextForeColor

public Color HeaderAndFooterTextForeColor

Gets or sets the colour of the header and footer text.

Value: The text colour. The default is SystemColors.WindowText.

HeaderBitmap

public Bitmap HeaderBitmap

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

Value: The picture, or null (the default) for none.

HeaderCaptionFont

public Font HeaderCaptionFont

Gets or sets the font of HeaderText.

Value: The font. The default is Control.DefaultFont.

HeaderControlRenderingEndColor

public Color HeaderControlRenderingEndColor

Gets or sets the ending colour of the gradient behind the header and footer bands and the column headings.

Value: The end colour. The default is SystemColors.Window.

HeaderControlRenderingStartColor

public Color HeaderControlRenderingStartColor

Gets or sets the starting colour of the gradient behind the header and footer bands and the column headings, and the colour of the window's frame.

Value: The start colour. The default is Color.Empty, which the combo box replaces with its CustomPaintingColor.

Remarks

The gradient runs to HeaderControlRenderingEndColor.

HeaderIcon

public Icon HeaderIcon

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

Value: The icon, or null (the default) for none.

HeaderImageType

public Binarymission.WinForms.Controls.ListControls.HeaderImageStyle HeaderImageType

Gets or sets which picture, if any, the header band shows: HeaderIcon or HeaderBitmap.

Value: One of the HeaderImageStyle values. The default is HeaderImageStyle.Icon.

HeaderSurfaceHeight

public int HeaderSurfaceHeight

Gets or sets the height of the header band.

Value: The height in logical pixels, scaled to the display the window opens on. The default is 20.

HeaderText

public string HeaderText

Gets or sets the caption in the header band.

Value: The caption. The default is an empty string.

NoDataToDisplayMessageText

public string NoDataToDisplayMessageText

Gets or sets the message the drop-down shows when the data source has no rows.

Value: The message. The default is "There are no items to display.".

Remarks

The window then opens as a short strip, as wide as the combo box, holding only this message. It opens at all only while ShowEmptyDropListViewWhenThereAreNoData is true.

Methods

ToString

public override string ToString()

Returns the fixed text the Properties window shows for the settings while they are folded.

Returns

The text "MultiColumnDropDownWindowConfiguration settings...".