WinForms › Popup Container › PopupEditor

PopupEditor

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

A custom control that provides a combination of a text display section and a visual that provides a mechanism to display a popup window that can host any content inside it for display.

public class PopupEditor : Control

Inherits from / implements: Control

Members at a glance

`PopupEditor`	Initializes a new instance of the `PopupEditor` class.
`BorderThickness`	Gets or sets the border thickness.
`DisplayLocation`	Gets or sets the display location.
`DisplayText`	Gets or sets the display text.
`DisplayTextVisualToTotalSizeRatio`	Gets or sets the ratio of sizes between its display text visual to its total size ratio.
`DropDownContentPadding`	Gets or sets the dropdown content padding.
`DropDownResizeGripperColor`	Gets or sets the color of the dropdown resize gripper.
`DropDownResizeSectionBorderColor`	Gets or sets the color of the dropdown resize section border.
`DropDownResizeSectionFillColor`	Gets or sets the color of the dropdown resize section fill.
`DropDownSize`	Gets or sets the size of the drop-down's content area, in logical (96 DPI) units.
`EnableDropDownResizing`	Gets or sets a value indicating whether the control should enable resizing the drop-down view.
`PopupCommandVisualBorderColor`	Gets or sets the color of the popup command visual border.
`PopupCommandVisualBorderColorOnHover`	Gets or sets the popup command visual border color on hover.
`PopupCommandVisualBorderColorOnPressed`	Gets or sets the popup command visual border color when it is on its pressed state.
`PopupCommandVisualFont`	Gets or sets the popup command visual's font.
`PopupCommandVisualHoverStateImage`	Gets or sets the popup command visual hover state image.
`PopupCommandVisualHoveredBackColor`	Gets or sets the backcolor of the popup command visual when it is on its hovered state.
`PopupCommandVisualMaximumInternalImageDrawingSize`	Gets or sets the maximum size for drawing the internal image for the PopupCommandVisual, in logical (96 DPI) units - scaled to the display as the button paints. The default is 32 x 32.
`PopupCommandVisualNormalBackColor`	Gets or sets the backcolor of the popup command visual when it is on its normal (default) state.
`PopupCommandVisualNormalStateImage`	Gets or sets the popup command visual normal state image.
`PopupCommandVisualPressedBackColor`	Gets or sets the backcolor of the popup command visual when it is on its pressed state.
`PopupCommandVisualPressedStateImage`	Gets or sets the popup command visual pressed state image.
`PopupCommandVisualShouldApplyPaddingWhilePositioningImage`	Gets or sets a value indicating whether the popup command visual should apply padding while positioning its image.
`PopupCommandVisualText`	Gets or sets the popup command visual's text.
`PopupCommandVisualTextForeColor`	Gets or sets the color of the popup command visual text foreground.
`PopupContentHost`	Gets or sets the popup content host.
`ShouldDrawBidirectionalResizeGripper`	Gets or sets a value indicating whether [should draw bidirectional resize gripper].
`ShouldDrawDropDownResizeSectionWith3DBorder`	Gets or sets a value indicating whether [should draw dropdown resize section with3 d border].
`ShouldDrawDropShadow`	Gets or sets a value indicating whether the control should draw drop shadow.
`ShouldDrawVerticalResizeGripper`	Gets or sets a value indicating whether [should draw vertical resize gripper].
`ShouldRememberUserSizedDropDownSize`	Gets or sets a value indicating whether the control should remember the size for the drop-down setup by the user at runtime.
`TextDisplayVisualBackColor`	Gets or sets the text display visual back color.
`TextDisplayVisualBorderColor`	Gets or sets the text display visual border color.
`TextDisplayVisualBorderThickness`	Gets or sets the text display visual border thickness.
`TextDisplayVisualFont`	Gets or sets the text display visual's font.
`TextDisplayVisualTextForeColor`	Gets or sets the color of the text display visual text foreground.
`ClosePopup`	Closes the popup.
`OnDropDownPopupClosed`	Called once the drop-down has left the screen.
`OnDropDownPopupClosing`	Called as the drop-down begins to close, before it leaves the screen.
`OnDropDownPopupOpened`	Called once the drop-down is on screen. Override to react to it without attaching to the popup yourself.
`OnHandleCreated`	Raises the `HandleCreated` event.
`OnSizeChanged`	Raises the `SizeChanged` event.
`Show`	Displays the popup view to the user.
`DropDownPopupClosed`	Occurs when the dropped-down popup has closed.
`DropDownPopupClosing`	Occurs when the dropped-down popup is closing.
`DropDownPopupOpened`	Occurs when the drop-down popup has opened.

Constructors

PopupEditor

public PopupEditor()

Initializes a new instance of the PopupEditor class.

Properties

BorderThickness

public float BorderThickness

Gets or sets the border thickness.

DisplayLocation

public Point DisplayLocation

Gets or sets the display location.

Value. The display location.

DisplayText

public string DisplayText

Gets or sets the display text.

Value. The display text.

DisplayTextVisualToTotalSizeRatio

public float DisplayTextVisualToTotalSizeRatio

Gets or sets the ratio of sizes between its display text visual to its total size ratio.

DropDownContentPadding

public Padding DropDownContentPadding

Gets or sets the dropdown content padding.

Value. The dropdown content padding.

DropDownResizeGripperColor

public Color DropDownResizeGripperColor

Gets or sets the color of the dropdown resize gripper.

Value. The color of the dropdown resize gripper.

DropDownResizeSectionBorderColor

public Color DropDownResizeSectionBorderColor

Gets or sets the color of the dropdown resize section border.

Value. The color of the dropdown resize section border.

DropDownResizeSectionFillColor

public Color DropDownResizeSectionFillColor

Gets or sets the color of the dropdown resize section fill.

Value. The color of the dropdown resize section fill.

DropDownSize

public Size DropDownSize

Gets or sets the size of the drop-down's content area, in logical (96 DPI) units.

Value. The size of the dropdown.

Scaled to the display the editor is on as the drop-down opens, like every metric in the suite. Empty, the default, opens the drop-down at the size of PopupContentHost as it stands. When the user resizes the drop-down and ShouldRememberUserSizedDropDownSize is set, the size they chose is stored here and used next time.

EnableDropDownResizing

public bool EnableDropDownResizing

Gets or sets a value indicating whether the control should enable resizing the drop-down view.

PopupCommandVisualBorderColor

public Color PopupCommandVisualBorderColor

Gets or sets the color of the popup command visual border.

Value. The color of the popup command visual border.

PopupCommandVisualBorderColorOnHover

public Color PopupCommandVisualBorderColorOnHover

Gets or sets the popup command visual border color on hover.

Value. The popup command visual border color on hover.

PopupCommandVisualBorderColorOnPressed

public Color PopupCommandVisualBorderColorOnPressed

Gets or sets the popup command visual border color when it is on its pressed state.

Value. The popup command visual border color when it is on its pressed state.

PopupCommandVisualFont

public Font PopupCommandVisualFont

Gets or sets the popup command visual's font.

PopupCommandVisualHoverStateImage

public Bitmap PopupCommandVisualHoverStateImage

Gets or sets the popup command visual hover state image.

Value. The popup command visual hover state image.

PopupCommandVisualHoveredBackColor

public Color PopupCommandVisualHoveredBackColor

Gets or sets the backcolor of the popup command visual when it is on its hovered state.

Value. The backcolor of the popup command visual when it is on its hovered state.

PopupCommandVisualMaximumInternalImageDrawingSize

public Size PopupCommandVisualMaximumInternalImageDrawingSize

Gets or sets the maximum size for drawing the internal image for the PopupCommandVisual, in logical (96 DPI) units - scaled to the display as the button paints. The default is 32 x 32.

PopupCommandVisualNormalBackColor

public Color PopupCommandVisualNormalBackColor

Gets or sets the backcolor of the popup command visual when it is on its normal (default) state.

Value. The backcolor of the popup command visual when it is on its normal (default) state.

PopupCommandVisualNormalStateImage

public Bitmap PopupCommandVisualNormalStateImage

Gets or sets the popup command visual normal state image.

Value. The popup command visual normal state image.

PopupCommandVisualPressedBackColor

public Color PopupCommandVisualPressedBackColor

Gets or sets the backcolor of the popup command visual when it is on its pressed state.

Value. The backcolor of the popup command visual when it is on its pressed state.

PopupCommandVisualPressedStateImage

public Bitmap PopupCommandVisualPressedStateImage

Gets or sets the popup command visual pressed state image.

Value. The popup command visual pressed state image.

PopupCommandVisualShouldApplyPaddingWhilePositioningImage

public bool PopupCommandVisualShouldApplyPaddingWhilePositioningImage

Gets or sets a value indicating whether the popup command visual should apply padding while positioning its image.

PopupCommandVisualText

public string PopupCommandVisualText

Gets or sets the popup command visual's text.

PopupCommandVisualTextForeColor

public Color PopupCommandVisualTextForeColor

Gets or sets the color of the popup command visual text foreground.

Value. The color of the popup command visual text foreground.

PopupContentHost

public Control PopupContentHost

Gets or sets the popup content host.

Value. The popup content host.

ShouldDrawBidirectionalResizeGripper

public bool ShouldDrawBidirectionalResizeGripper

Gets or sets a value indicating whether [should draw bidirectional resize gripper].

Value. true if [should draw bidirectional resize gripper]; otherwise, false .

ShouldDrawDropDownResizeSectionWith3DBorder

public bool ShouldDrawDropDownResizeSectionWith3DBorder

Gets or sets a value indicating whether [should draw dropdown resize section with3 d border].

Value. true if [should draw dropdown resize section with3 d border]; otherwise, false .

ShouldDrawDropShadow

public bool ShouldDrawDropShadow

Gets or sets a value indicating whether the control should draw drop shadow.

ShouldDrawVerticalResizeGripper

public bool ShouldDrawVerticalResizeGripper

Gets or sets a value indicating whether [should draw vertical resize gripper].

Value. true if [should draw vertical resize gripper]; otherwise, false .

ShouldRememberUserSizedDropDownSize

public bool ShouldRememberUserSizedDropDownSize

Gets or sets a value indicating whether the control should remember the size for the drop-down setup by the user at runtime.

TextDisplayVisualBackColor

public Color TextDisplayVisualBackColor

Gets or sets the text display visual back color.

TextDisplayVisualBorderColor

public Color TextDisplayVisualBorderColor

Gets or sets the text display visual border color.

TextDisplayVisualBorderThickness

public int TextDisplayVisualBorderThickness

Gets or sets the text display visual border thickness.

TextDisplayVisualFont

public Font TextDisplayVisualFont

Gets or sets the text display visual's font.

TextDisplayVisualTextForeColor

public Color TextDisplayVisualTextForeColor

Gets or sets the color of the text display visual text foreground.

Methods

ClosePopup

public void ClosePopup()

Closes the popup.

OnDropDownPopupClosed

protected virtual void OnDropDownPopupClosed()

Called once the drop-down has left the screen.

OnDropDownPopupClosing

protected virtual void OnDropDownPopupClosing()

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

OnDropDownPopupOpened

protected virtual void OnDropDownPopupOpened()

Called once the drop-down is on screen. Override to react to it without attaching to the popup yourself.

OnHandleCreated

protected override void OnHandleCreated(EventArgs e)

Raises the HandleCreated event.

e: An EventArgs that contains the event data.

OnSizeChanged

protected override void OnSizeChanged(EventArgs e)

Raises the SizeChanged event.

e: An EventArgs that contains the event data.

Show

public new void Show()

Displays the popup view to the user.

Events

DropDownPopupClosed

public event EventHandler DropDownPopupClosed

Occurs when the dropped-down popup has closed.

DropDownPopupClosing

public event EventHandler DropDownPopupClosing

Occurs when the dropped-down popup is closing.

DropDownPopupOpened

public event EventHandler DropDownPopupOpened

Occurs when the drop-down popup has opened.