PopupEditor

Initialises a new popup editor with a chocolate-coloured drop-down button showing a white down arrow, and no drop-down content yet.

Set PopupContentHost before the user can open the drop-down.

Gets or sets the width of the border round the text box half of the editor.

The same setting as TextDisplayVisualBorderThickness, as a fractional value: whichever is set last applies. Set 0 for no border.

Gets or sets where on the screen the drop-down opens.

The point is fixed on the screen: it does not follow the editor if its window moves.

Gets or sets the text shown in the editor's text box – the value chosen in the drop-down.

The text box is read-only to the user: set this from your drop-down content when a choice is made. The text is centred on one line, ends in an ellipsis when it does not fit, and is also shown as the text box's tool tip.

Gets or sets how much of the editor's width the text box takes, the drop-down button having the rest.

// A wide button for a short editor.
colourEditor.DisplayTextVisualToTotalSizeRatio = 65f;

Gets or sets the space between the edge of the drop-down and its content.

Gets or sets the colour of the gripper lines drawn on the drop-down's resize strip.

Gets or sets a border colour for the drop-down's resize section.

The border is painted before the section's fill, which then covers it, so the colour does not show.

Gets or sets the background colour of the resize strip along the foot of the drop-down.

Gets or sets the size of the drop-down's content area.

The drop-down is 20 logical pixels taller than this, for the resize strip. When the user resizes the drop-down and ShouldRememberUserSizedDropDownSize is on, the new size is stored here as it closes and used the next time it opens.

Gets or sets whether the user can resize the drop-down by dragging the strip along its foot.

The bottom edge resizes the height and the bottom right corner both ways. The strip is 20 logical pixels tall and is part of the drop-down whether or not resizing is allowed; with resizing off its grippers are not drawn. Takes effect the next time the drop-down opens.

Gets or sets the colour of the one-pixel border of the drop-down button at the right of the editor.

Gets or sets the border colour of the drop-down button at the right of the editor while the pointer is over it.

Gets or sets the border colour of the drop-down button at the right of the editor while it is pressed.

Gets or sets the font of the text on the drop-down button at the right of the editor.

Used only when PopupCommandVisualText is set.

Gets or sets an image for the drop-down button at the right of the editor while the pointer is over it.

The value is stored, but the button keeps showing the built-in white arrow while hovered.

Gets or sets the fill colour of the drop-down button at the right of the editor while the pointer is over it.

Gets or sets the largest size the image on the drop-down button at the right of the editor is drawn at.

The image is drawn square, centred, and never larger than the button. Set Size.Empty to stretch the image over the whole button (see PopupCommandVisualShouldApplyPaddingWhilePositioningImage).

Gets or sets the fill colour of the drop-down button at the right of the editor.

Gets or sets the image shown on the drop-down button at the right of the editor, in place of the built-in white down arrow.

Set it before the editor is shown: the button takes its image when it is created on screen. Not shown while PopupCommandVisualText is set.

categoryEditor.PopupCommandVisualNormalStateImage = Properties.Resources.FolderTree16;
categoryEditor.PopupCommandVisualMaximumInternalImageDrawingSize = new Size(16, 16);

Gets or sets the fill colour of the drop-down button at the right of the editor while it is pressed.

Gets or sets an image for the drop-down button at the right of the editor while it is pressed.

The value is stored, but the button keeps showing the built-in white arrow while pressed.

Gets or sets whether the image on the drop-down button at the right of the editor keeps a margin from the button's edges when it is stretched.

Used only while PopupCommandVisualMaximumInternalImageDrawingSize is Size.Empty.

Gets or sets a short text to show on the drop-down button at the right of the editor in place of its image.

The text is centred, in PopupCommandVisualFont and PopupCommandVisualTextForeColor.

Gets or sets the colour of the text on the drop-down button at the right of the editor.

Gets or sets the control shown in the drop-down.

Must be set before the drop-down is opened; opening it without content throws. The control is moved into the drop-down while it is open, so do not also place it on a form.

Its size is the drop-down's size while DropDownSize is empty, and its Control.MinimumSize is the smallest the user can resize the drop-down to.

Gets or sets whether the standard diagonal size grip is drawn in the bottom right corner of the drop-down.

Drawn only while EnableDropDownResizing is on. The corner resizes the drop-down both ways whether or not the grip is drawn.

Gets or sets whether the resize section's border is drawn in 3-D rather than in DropDownResizeSectionBorderColor.

Either border is covered by the section's fill, so the setting does not change what is seen.

Gets or sets whether the drop-down casts the system drop shadow.

Gets or sets whether a small downward-pointing triangle of lines is drawn in the middle of the resize strip, showing the drop-down can be pulled taller.

Drawn only while EnableDropDownResizing is on, in DropDownResizeGripperColor.

Gets or sets whether a size the user drags the drop-down to is kept for the next time it opens.

Gets or sets the background colour of the text box.

Gets or sets the colour of the border round the text box.

Gets or sets the width of the border round the text box.

The same setting as BorderThickness: whichever is set last applies.

Gets or sets the font of the text box.

Gets or sets the colour of the text in the text box.

Closes the drop-down, if it is open.

Call it from your content once the user has made a choice. Raises DropDownPopupClosing and DropDownPopupClosed.

Raises the DropDownPopupClosed event.

Call the base implementation from an override so that handlers still run.

Raises the DropDownPopupClosing event.

Call the base implementation from an override so that handlers still run.

Raises the DropDownPopupOpened event.

A derived class can override this to react to the drop-down opening; call the base implementation so that handlers still run.

Raises the Control.HandleCreated event and puts the text box and button in place.

Raises the Control.SizeChanged event and lays out the text box and button for the new size.

Opens the drop-down, or closes it if it is already open – what a click on the drop-down button does.

The drop-down opens below the editor (or at DisplayLocation), holding PopupContentHost at DropDownSize, and raises DropDownPopupOpened. A click outside it closes it.

This hides Show, which makes a control visible; to make the editor itself visible, set Control.Visible.

// Open the drop-down from the keyboard as well.
dueDate.KeyDown += (s, e) =>
{
    if (e.KeyCode == Keys.F4 || (e.Alt && e.KeyCode == Keys.Down))
    {
        dueDate.Show();
    }
};

Occurs when the drop-down has closed, however it was closed.

Raised before a size the user dragged the drop-down to is written to DropDownSize.

Occurs as the drop-down begins to close, before it leaves the screen.

Occurs when the drop-down has opened and is on screen.

A good moment to bring the content up to date with the current value, or give it the focus.