WinForms › Panel Bar › BinaryPanelBarButton

BinaryPanelBarButton

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

An extended control that acts as a panel button that will activate a panel (that will host an array of UI controls as desired) within the BinaryPanelBar control.

public class BinaryPanelBarButton : UserControl

Inherits from / implements: UserControl

Remarks

An extended control that acts as a panel button that will activate a panel (that will host an array of UI controls as desired) within the BinaryPanelBar control.

Members at a glance

`BinaryPanelBarButton`	Initializes a new instance of the `BinaryPanelBarButton` class.
`BinaryPanelBarButton`	Creates a new instance of `BinaryPanelBarButton` object.
`ButtonBorderStyle`	Gets or sets the border style for this instance of `BinaryPanelBarButton` object.
`ButtonImage`	Gets or sets the main (bigger) `Bitmap` that will used to draw on the left hand side of this instance of `BinaryPanelBarButton` object.
`ButtonSmallImage`	Gets or sets the small sized image for this object.
`ButtonText`	Gets or sets the text for this instance of object.
`ContainedPanel`	Gets or sets the `BinaryPanelBarContainedPanel` object that this instance of object holds.
`EndColor`	Gets or sets the end color to use, to draw this instance of `BinaryPanelBarButton` object.
`HoverEndColor`	Gets or sets the gradient end colour drawn when the pointer is over this button.
`HoverSelectedEndColor`	Gets or sets the gradient end colour drawn when the pointer is over the selected button.
`HoverSelectedStartColor`	Gets or sets the gradient start colour drawn when the pointer is over the selected button.
`HoverStartColor`	Gets or sets the gradient start colour drawn when the pointer is over this button.
`ItemColorRenderingStyle`	Gets or sets the rendering style for drawing the menu item selection rectangle area.
`NotAvailableForUse`	Gets or sets whether this button object is available for use by the user.
`ParentControl`	Gets or sets the parent control.
`SelectedEndColor`	Gets or sets the gradient end colour drawn when this button is the selected one.
`SelectedStartColor`	Gets or sets the gradient start colour drawn when this button is the selected one.
`StartColor`	Gets or sets the start color to use, to draw this instance of `BinaryPanelBarButton` object.
`WirePanelBarButtonClickEventToBaseBarButton`	Gets or sets whether any click event handler that you have attached to the `BinaryPanelBarButton` object should be wired into the small / minimized "related" button (that sits in the base bar) click event.
`Dispose`	Refer the base class documentation for this method.
`ToString`	Provides a custom implementation of `ToString()` method.

Constructors

BinaryPanelBarButton

public BinaryPanelBarButton(BinaryPanelBar parentHost) : this()

Initializes a new instance of the BinaryPanelBarButton class.

BinaryPanelBarButton

public BinaryPanelBarButton()

Creates a new instance of BinaryPanelBarButton object.

Properties

ButtonBorderStyle

public PanelBarBorderStyle ButtonBorderStyle

Gets or sets the border style for this instance of BinaryPanelBarButton object.

A valid value from the enumeration PanelBarBorderStyle.

ButtonImage

public Bitmap ButtonImage

Gets or sets the main (bigger) Bitmap that will used to draw on the left hand side of this instance of BinaryPanelBarButton object.

ButtonSmallImage

public Bitmap ButtonSmallImage

Gets or sets the small sized image for this object.

Small sized images are useful to display in the BinaryPanelBar's base icon area when a BinaryPanelBarButton object instance is minimized/collapsed to the icon area.

ButtonText

public string ButtonText

Gets or sets the text for this instance of object.

ContainedPanel

public BinaryPanelBarContainedPanel ContainedPanel

Gets or sets the BinaryPanelBarContainedPanel object that this instance of object holds.

Each of the BinaryPanelBarButton instance can activate a panel object that can host several UI objects that you want to display when this instance of the BinaryPanelBarButton is clicked or activated.

EndColor

public Color EndColor

Gets or sets the end color to use, to draw this instance of BinaryPanelBarButton object.

HoverEndColor

public Color HoverEndColor

Gets or sets the gradient end colour drawn when the pointer is over this button.

HoverSelectedEndColor

public Color HoverSelectedEndColor

Gets or sets the gradient end colour drawn when the pointer is over the selected button.

HoverSelectedStartColor

public Color HoverSelectedStartColor

Gets or sets the gradient start colour drawn when the pointer is over the selected button.

HoverStartColor

public Color HoverStartColor

Gets or sets the gradient start colour drawn when the pointer is over this button.

The six state colours on this button were literals inside its own paint until 2026-09-09 and could not be reached from anywhere. Their defaults are those literals. HANDOVER.md 3ae.

ItemColorRenderingStyle

public PanelBarItemColorRenderingStyle ItemColorRenderingStyle

Gets or sets the rendering style for drawing the menu item selection rectangle area.

NotAvailableForUse

public bool NotAvailableForUse

Gets or sets whether this button object is available for use by the user.

If set to false, this instance of button object is neither visible in the controls list of object, nor it is collapsed to the control's minimized icons bar.

ParentControl

public BinaryPanelBar ParentControl

Gets or sets the parent control.

SelectedEndColor

public Color SelectedEndColor

Gets or sets the gradient end colour drawn when this button is the selected one.

SelectedStartColor

public Color SelectedStartColor

Gets or sets the gradient start colour drawn when this button is the selected one.

StartColor

public Color StartColor

Gets or sets the start color to use, to draw this instance of BinaryPanelBarButton object.

WirePanelBarButtonClickEventToBaseBarButton

public bool WirePanelBarButtonClickEventToBaseBarButton

Gets or sets whether any click event handler that you have attached to the BinaryPanelBarButton object should be wired into the small / minimized "related" button (that sits in the base bar) click event.

Methods

Dispose

protected override void Dispose(bool disposing)

Refer the base class documentation for this method.

ToString

public override string ToString()

Provides a custom implementation of ToString() method.

Returns. A String representation of the object. Typically this returns the Button text for this instance.