HypernovaDesktop Components · docs
Binarymission
WinForms › Tree List View › BinaryTreeListViewExtendedTextBoxColumn

BinaryTreeListViewExtendedTextBoxColumn

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

A BinaryTreeListView column whose cells are edited in a BinaryExtendedText – a text box with a flat, coloured border.

public class BinaryTreeListViewExtendedTextBoxColumn : DataGridViewColumn

Inherits from / implements: DataGridViewColumn

Remarks

Add it to the tree list view's Columns like any other column. Its cells show their value as plain text; the editor appears only while a cell is being edited. The border settings of the column are copied to the editor each time an edit starts, so a change shows from the next edit.

The defaults differ from those of a stand-alone BinaryExtendedText: the flat border is off (ExtendedState is false), so the editor shows the sunken edge of a standard text box until you turn it on, and both border colours are red.

Examples

var column = new BinaryTreeListViewExtendedTextBoxColumn
{
    HeaderText = "Notes",
    ExtendedState = true,                     // the flat, coloured border
    BorderColor = SystemColors.Highlight,
    ShowBorderAlways = true
};
treeListView.Columns.Add(column);

See also

Members at a glance

Constructors
BinaryTreeListViewExtendedTextBoxColumnCreates the column, with BinaryTreeListViewExtendedTextBoxCell as its cell template and the border settings at their defaults.
Properties
BorderColorGets or sets the colour of the editor's border.
BorderColorWhenControlIsNotInFocusGets or sets the editor's border colour while it has neither the focus nor the pointer over it, when ShowBorderAlways is false.
DotBorderDepthGets or sets the length of each dash in the editor's dotted border.
DotBorderGapGets or sets the space between the dashes of the editor's dotted border.
ExtendedStateGets or sets whether the editor draws its flat, coloured border instead of the sunken 3-D edge of a standard text box.
ShowBorderAlwaysGets or sets whether the editor's border is always drawn in BorderColor, rather than only while the pointer is over it or it has the focus.
UseEnhancedPasswordCharGets or sets whether the editor masks a password with round bullets (●) instead of its password character.
Methods
CloneCreates a copy of the column, including its border settings.

Constructors

BinaryTreeListViewExtendedTextBoxColumn

public BinaryTreeListViewExtendedTextBoxColumn() : base()

Creates the column, with BinaryTreeListViewExtendedTextBoxCell as its cell template and the border settings at their defaults.

Properties

BorderColor

public Color BorderColor

Gets or sets the colour of the editor's border.

Value
The border colour. The default is Color.Red.
Remarks

Used only while ExtendedState is true. With ShowBorderAlways false, this is the colour while the editor has the focus or the pointer over it.

See also

BorderColorWhenControlIsNotInFocus

public Color BorderColorWhenControlIsNotInFocus

Gets or sets the editor's border colour while it has neither the focus nor the pointer over it, when ShowBorderAlways is false.

Value
The resting border colour. The default is Color.Red.
Remarks

Used only while ExtendedState is true.

See also

DotBorderDepth

public int DotBorderDepth

Gets or sets the length of each dash in the editor's dotted border.

Value
The dash length in logical pixels. The default is 2.
Remarks

The column does not make the editor's border dotted – the editor draws a solid border – so this value has no visible effect in a cell.

See also

DotBorderGap

public int DotBorderGap

Gets or sets the space between the dashes of the editor's dotted border.

Value
The gap in logical pixels. The default is 2.
Remarks

The column does not make the editor's border dotted – the editor draws a solid border – so this value has no visible effect in a cell.

See also

ExtendedState

public bool ExtendedState

Gets or sets whether the editor draws its flat, coloured border instead of the sunken 3-D edge of a standard text box.

Value
true for the flat border. The default is false.
Remarks

While it is false the other border settings of the column have no effect.

See also

ShowBorderAlways

public bool ShowBorderAlways

Gets or sets whether the editor's border is always drawn in BorderColor, rather than only while the pointer is over it or it has the focus.

Value
true for a constant border; the default is true.
Remarks

Used only while ExtendedState is true. The editor has the focus for as long as the cell is being edited, so with either setting the border is normally BorderColor.

See also

UseEnhancedPasswordChar

public bool UseEnhancedPasswordChar

Gets or sets whether the editor masks a password with round bullets (●) instead of its password character.

Value
true to use the round bullet; the default is true.
Remarks

It applies only to an editor that has a password character, and the column does not give it one, so in a cell the setting has no visible effect.

Methods

Clone

public override object Clone()

Creates a copy of the column, including its border settings.

Returns

The new BinaryTreeListViewExtendedTextBoxColumn.