IBarRenderer Interface

Namespace:: ActiproSoftware.UI.WinForms.Controls.Bars

Assembly:: ActiproSoftware.Bars.WinForms.dll

Provides the base requirements for a renderer of bar controls.

[TypeConverter(typeof(GenericExpandableNullableObjectConverter))]
public interface IBarRenderer : IUIRenderer

Properties

DockableToolBarDockedPadding

The padding inside of docked dockable toolbars.

Padding DockableToolBarDockedPadding { get; set; }

Property Value

Padding

DockableToolBarFloatingBorderWidth

The border width of a floating dockable toolbar.

int DockableToolBarFloatingBorderWidth { get; set; }

Property Value

int

DockableToolBarFloatingPadding

The padding inside of floating dockable toolbars.

Padding DockableToolBarFloatingPadding { get; set; }

Property Value

Padding

DockableToolBarFloatingTitleBarPadding

The padding inside of floating dockable toolbar title bars.

Padding DockableToolBarFloatingTitleBarPadding { get; set; }

Property Value

Padding

DockableToolBarGripperExtent

The extent of a dockable toolbar gripper.

int DockableToolBarGripperExtent { get; set; }

Property Value

int

DockableToolBarOptionsButtonExtent

The extent of a dockable toolbar options button.

int DockableToolBarOptionsButtonExtent { get; set; }

Property Value

int

MenuBarPadding

The padding inside of menu bars.

Padding MenuBarPadding { get; set; }

Property Value

Padding

MenuDefaultColumnWidth

The default width of a menu column.

int MenuDefaultColumnWidth { get; set; }

Property Value

int

MenuGripperHeight

The height of a menu gripper.

int MenuGripperHeight { get; set; }

Property Value

int

MenuOverflowButtonHeight

The height of a menu overflow button.

int MenuOverflowButtonHeight { get; set; }

Property Value

int

MenuSeparatorHeight

The height of a menu separator.

int MenuSeparatorHeight { get; set; }

Property Value

int

MenuSplitButtonPopupExtent

The extent of the popup portion of a split button in a menu.

int MenuSplitButtonPopupExtent { get; set; }

Property Value

int

MenuTextMarginHorizontal

The horizontal padding around menu text.

int MenuTextMarginHorizontal { get; set; }

Property Value

int

MenuTextMarginVertical

The vertical padding around menu text.

int MenuTextMarginVertical { get; set; }

Property Value

int

PopupButtonLinkArrowStyle

The arrow style to use when drawing BarPopupButtonLink command links.

BarPopupButtonLinkArrowStyle PopupButtonLinkArrowStyle { get; set; }

Property Value

BarPopupButtonLinkArrowStyle

ToolBarAscentMargin

The ascent margin of a toolbar.

int ToolBarAscentMargin { get; set; }

Property Value

int

ToolBarExtentMargin

The extent margin of a toolbar.

int ToolBarExtentMargin { get; set; }

Property Value

int

ToolBarSeparatorExtent

The extent of a toolbar separator.

int ToolBarSeparatorExtent { get; set; }

Property Value

int

ToolBarSplitButtonPopupExtent

The extent of the popup portion of a split button in a toolbar.

int ToolBarSplitButtonPopupExtent { get; set; }

Property Value

int

Methods

ArrangeComboBoxChildControl(PaintEventArgs, Rectangle, BarComboBoxLink)

Arranges a BarComboBoxLink's child control.

void ArrangeComboBoxChildControl(PaintEventArgs e, Rectangle bounds, BarComboBoxLink link)

Parameter	Type	Description
e	PaintEventArgs	A PaintEventArgs that contains the event data.
bounds	Rectangle	The bounds in which to arrange.
link	BarComboBoxLink	The BarComboBoxLink being arranged.

ArrangeTextBoxChildControl(PaintEventArgs, Rectangle, BarTextBoxLink)

Arranges a BarTextBoxLink's child control.

void ArrangeTextBoxChildControl(PaintEventArgs e, Rectangle bounds, BarTextBoxLink link)

Parameter	Type	Description
e	PaintEventArgs	A PaintEventArgs that contains the event data.
bounds	Rectangle	The bounds in which to arrange.
link	BarTextBoxLink	The BarTextBoxLink being arranged.

DrawButtonLink(PaintEventArgs, Rectangle, BarButtonLink)

Draws a BarButtonLink.

void DrawButtonLink(PaintEventArgs e, Rectangle bounds, BarButtonLink link)

Parameter	Type	Description
e	PaintEventArgs	A PaintEventArgs that contains the event data.
bounds	Rectangle	The bounds in which to draw.
link	BarButtonLink	The BarButtonLink being painted.

DrawComboBoxLink(PaintEventArgs, Rectangle, BarComboBoxLink)

Draws a BarComboBoxLink.

void DrawComboBoxLink(PaintEventArgs e, Rectangle bounds, BarComboBoxLink link)

Parameter	Type	Description
e	PaintEventArgs	A PaintEventArgs that contains the event data.
bounds	Rectangle	The bounds in which to draw.
link	BarComboBoxLink	The BarComboBoxLink being painted.

DrawComboBoxLinkItem(DrawItemEventArgs, BarComboBoxLink, object)

Draws a BarComboBoxLink item.

void DrawComboBoxLinkItem(DrawItemEventArgs e, BarComboBoxLink link, object item)

Parameter	Type	Description
e	DrawItemEventArgs	A DrawItemEventArgs that contains the event data.
link	BarComboBoxLink	The BarComboBoxLink that owns the item.
item	object	The item to draw.

DrawCommandInCustomizeList(PaintEventArgs, Rectangle, BarManager, BarCommand, UIElementDrawState, bool, SizeF)

Draws a BarCommand for a Customize list.

void DrawCommandInCustomizeList(PaintEventArgs e, Rectangle bounds, BarManager barManager, BarCommand command, UIElementDrawState drawState, bool useCommandName, SizeF scaleFactor)

Parameter	Type	Description
e	PaintEventArgs	A PaintEventArgs that contains the event data.
bounds	Rectangle	The bounds in which to draw.
barManager	BarManager	The BarManager for which the command Customize list is created.
command	BarCommand	The BarCommand being painted.
drawState	UIElementDrawState	A UIElementDrawState specifying draw state.
useCommandName	bool	Whether to draw the bar command using the command name instead of the command text.
scaleFactor	SizeF	The scale factor to be applied when drawing.

DrawCommandLinkInCustomizeList(PaintEventArgs, Rectangle, BarManager, BarCommandLink, UIElementDrawState, bool)

Draws a BarCommandLink for a Customize list.

void DrawCommandLinkInCustomizeList(PaintEventArgs e, Rectangle bounds, BarManager barManager, BarCommandLink commandLink, UIElementDrawState drawState, bool showShortcut)

Parameter	Type	Description
e	PaintEventArgs	A PaintEventArgs that contains the event data.
bounds	Rectangle	The bounds in which to draw.
barManager	BarManager	The BarManager for which the command link Customize list is created.
commandLink	BarCommandLink	The BarCommandLink being painted.
drawState	UIElementDrawState	A UIElementDrawState specifying draw state.
showShortcut	bool	`true` to render shortcut text for supported commands; otherwise `false`

DrawCommandLinkSelectionBorder(PaintEventArgs, Rectangle, BarCommandLink)

Draws the selection border around the specified BarCommandLink if it is currently selected by a BarManager.

void DrawCommandLinkSelectionBorder(PaintEventArgs e, Rectangle bounds, BarCommandLink link)

Parameter	Type	Description
e	PaintEventArgs	A PaintEventArgs that contains the event data.
bounds	Rectangle	The bounds in which to draw.
link	BarCommandLink	The BarCommandLink being painted.

DrawDockAreaBackground(PaintEventArgs, Rectangle, BarDockArea)

Draws the background of a BarDockArea.

void DrawDockAreaBackground(PaintEventArgs e, Rectangle bounds, BarDockArea dockArea)

Parameter	Type	Description
e	PaintEventArgs	A PaintEventArgs that contains the event data.
bounds	Rectangle	The bounds in which to draw.
dockArea	BarDockArea	The BarDockArea being painted.

DrawDockableToolBarBackground(PaintEventArgs, Rectangle, DockableToolBar)

Draws the background of a dockable toolbar.

void DrawDockableToolBarBackground(PaintEventArgs e, Rectangle bounds, DockableToolBar toolBar)

Parameter	Type	Description
e	PaintEventArgs	A PaintEventArgs that contains the event data.
bounds	Rectangle	The bounds in which to draw.
toolBar	DockableToolBar	The DockableToolBar being painted.

DrawDockableToolBarFloatingContainerBackground(PaintEventArgs, Rectangle, DockableToolBar)

Draws the background of a dockable toolbar floating container.

void DrawDockableToolBarFloatingContainerBackground(PaintEventArgs e, Rectangle bounds, DockableToolBar toolBar)

Parameter	Type	Description
e	PaintEventArgs	A PaintEventArgs that contains the event data.
bounds	Rectangle	The bounds in which to draw.
toolBar	DockableToolBar	The DockableToolBar being painted.

DrawDockableToolBarFloatingTitleBar(PaintEventArgs, Rectangle, DockableToolBar)

Draws a floating dockable toolbar title bar.

void DrawDockableToolBarFloatingTitleBar(PaintEventArgs e, Rectangle bounds, DockableToolBar toolBar)

Parameter	Type	Description
e	PaintEventArgs	A PaintEventArgs that contains the event data.
bounds	Rectangle	The bounds in which to draw.
toolBar	DockableToolBar	The DockableToolBar being painted.

DrawDockableToolBarGripper(PaintEventArgs, Rectangle, DockableToolBar)

Draws a dockable toolbar gripper.

void DrawDockableToolBarGripper(PaintEventArgs e, Rectangle bounds, DockableToolBar toolBar)

Parameter	Type	Description
e	PaintEventArgs	A PaintEventArgs that contains the event data.
bounds	Rectangle	The bounds in which to draw.
toolBar	DockableToolBar	The DockableToolBar being painted.

DrawDockableToolBarOptionsButton(PaintEventArgs, Rectangle, DockableToolBar, BarPopupButtonLink)

Draws a dockable toolbar options button.

void DrawDockableToolBarOptionsButton(PaintEventArgs e, Rectangle bounds, DockableToolBar toolBar, BarPopupButtonLink link)

Parameter	Type	Description
e	PaintEventArgs	A PaintEventArgs that contains the event data.
bounds	Rectangle	The bounds in which to draw.
toolBar	DockableToolBar	The DockableToolBar containing the link being painted.
link	BarPopupButtonLink	The BarPopupButtonLink being painted.

DrawExpanderButtonLink(PaintEventArgs, Rectangle, BarExpanderButtonLink)

Draws a BarExpanderButtonLink.

void DrawExpanderButtonLink(PaintEventArgs e, Rectangle bounds, BarExpanderButtonLink link)

Parameter	Type	Description
e	PaintEventArgs	A PaintEventArgs that contains the event data.
bounds	Rectangle	The bounds in which to draw.
link	BarExpanderButtonLink	The BarExpanderButtonLink being painted.

DrawLabelLink(PaintEventArgs, Rectangle, BarLabelLink)

Draws a BarLabelLink.

void DrawLabelLink(PaintEventArgs e, Rectangle bounds, BarLabelLink link)

Parameter	Type	Description
e	PaintEventArgs	A PaintEventArgs that contains the event data.
bounds	Rectangle	The bounds in which to draw.
link	BarLabelLink	The BarLabelLink being painted.

DrawMenuBackground(PaintEventArgs, Rectangle, IBarControl)

Draws the background of a bar menu.

void DrawMenuBackground(PaintEventArgs e, Rectangle bounds, IBarControl menu)

Parameter	Type	Description
e	PaintEventArgs	A PaintEventArgs that contains the event data.
bounds	Rectangle	The bounds in which to draw.
menu	IBarControl	The IBarControl being painted.

DrawMenuGripper(PaintEventArgs, Rectangle, IUIElement)

Draws a menu gripper.

void DrawMenuGripper(PaintEventArgs e, Rectangle bounds, IUIElement gripper)

Parameter	Type	Description
e	PaintEventArgs	A PaintEventArgs that contains the event data.
bounds	Rectangle	The bounds in which to draw.
gripper	IUIElement	The IUIElement being painted.

DrawMenuOverflowButton(PaintEventArgs, Rectangle, IUIElement, bool)

Draws a menu overflow button.

void DrawMenuOverflowButton(PaintEventArgs e, Rectangle bounds, IUIElement button, bool hasDownArrow)

Parameter	Type	Description
e	PaintEventArgs	A PaintEventArgs that contains the event data.
bounds	Rectangle	The bounds in which to draw.
button	IUIElement	The IUIElement being painted.
hasDownArrow	bool	Whether the button has a down arrow; otherwise, an up arrow.

DrawMenuSeparator(PaintEventArgs, Rectangle, BarCommandLink, Orientation)

Draws a menu separator.

void DrawMenuSeparator(PaintEventArgs e, Rectangle bounds, BarCommandLink link, Orientation orientation)

Parameter	Type	Description
e	PaintEventArgs	A PaintEventArgs that contains the event data.
bounds	Rectangle	The bounds in which to draw.
link	BarCommandLink	The BarCommandLink associated with the separator being painted.
orientation	Orientation	The Orientation of the separator.

DrawPopupButtonLink(PaintEventArgs, Rectangle, BarPopupButtonLink)

Draws a BarPopupButtonLink.

void DrawPopupButtonLink(PaintEventArgs e, Rectangle bounds, BarPopupButtonLink link)

Parameter	Type	Description
e	PaintEventArgs	A PaintEventArgs that contains the event data.
bounds	Rectangle	The bounds in which to draw.
link	BarPopupButtonLink	The BarPopupButtonLink being painted.

DrawSplitButtonLink(PaintEventArgs, Rectangle, BarSplitButtonLink)

Draws a BarSplitButtonLink.

void DrawSplitButtonLink(PaintEventArgs e, Rectangle bounds, BarSplitButtonLink link)

Parameter	Type	Description
e	PaintEventArgs	A PaintEventArgs that contains the event data.
bounds	Rectangle	The bounds in which to draw.
link	BarSplitButtonLink	The BarSplitButtonLink being painted.

DrawSystemButtonLink(PaintEventArgs, Rectangle, BarButtonLink)

Draws a system button link.

void DrawSystemButtonLink(PaintEventArgs e, Rectangle bounds, BarButtonLink link)

Parameter	Type	Description
e	PaintEventArgs	A PaintEventArgs that contains the event data.
bounds	Rectangle	The bounds in which to draw.
link	BarButtonLink	The BarButtonLink being painted.

DrawSystemPopupButtonLink(PaintEventArgs, Rectangle, BarPopupButtonLink)

Draws a system popup button link.

void DrawSystemPopupButtonLink(PaintEventArgs e, Rectangle bounds, BarPopupButtonLink link)

Parameter	Type	Description
e	PaintEventArgs	A PaintEventArgs that contains the event data.
bounds	Rectangle	The bounds in which to draw.
link	BarPopupButtonLink	The BarPopupButtonLink being painted.

DrawTextBoxLink(PaintEventArgs, Rectangle, BarTextBoxLink)

Draws a BarTextBoxLink.

void DrawTextBoxLink(PaintEventArgs e, Rectangle bounds, BarTextBoxLink link)

Parameter	Type	Description
e	PaintEventArgs	A PaintEventArgs that contains the event data.
bounds	Rectangle	The bounds in which to draw.
link	BarTextBoxLink	The BarTextBoxLink being painted.

DrawToolBarBackground(PaintEventArgs, Rectangle, ToolBar)

Draws the background of a toolbar.

void DrawToolBarBackground(PaintEventArgs e, Rectangle bounds, ToolBar toolBar)

Parameter	Type	Description
e	PaintEventArgs	A PaintEventArgs that contains the event data.
bounds	Rectangle	The bounds in which to draw.
toolBar	ToolBar	The ToolBar being painted.

DrawToolBarSeparator(PaintEventArgs, Rectangle, BarCommandLink, Orientation)

Draws a toolbar separator.

void DrawToolBarSeparator(PaintEventArgs e, Rectangle bounds, BarCommandLink link, Orientation orientation)

Parameter	Type	Description
e	PaintEventArgs	A PaintEventArgs that contains the event data.
bounds	Rectangle	The bounds in which to draw.
link	BarCommandLink	The BarCommandLink associated with the separator being painted.
orientation	Orientation	The Orientation of the separator.

MeasureCommandLink(Graphics, BarCommandLink)

Measures the specified BarCommandLink.

Size MeasureCommandLink(Graphics g, BarCommandLink link)

Parameter	Type	Description
g	Graphics	The `Graphics` object used to measure.
link	BarCommandLink	The BarCommandLink that is being measured.

Returns

Size

MeasureDockableToolBarFloatingTitleBarHeight(Graphics, DockableToolBar)

Measures the floating title bar height of the specified DockableToolBar.

int MeasureDockableToolBarFloatingTitleBarHeight(Graphics g, DockableToolBar toolBar)

Parameter	Type	Description
g	Graphics	The `Graphics` object used to measure.
toolBar	DockableToolBar	The ToolBar whose floating title bar is being measured.

Returns

int

In This Article

IBarRenderer Interface

Properties

DockableToolBarDockedPadding

Property Value

DockableToolBarFloatingBorderWidth

Property Value

DockableToolBarFloatingPadding

Property Value

DockableToolBarFloatingTitleBarPadding

Property Value

DockableToolBarGripperExtent

Property Value

DockableToolBarOptionsButtonExtent

Property Value

MenuBarPadding

Property Value

MenuDefaultColumnWidth

Property Value

MenuGripperHeight

Property Value

MenuOverflowButtonHeight

Property Value

MenuSeparatorHeight

Property Value

MenuSplitButtonPopupExtent

Property Value

MenuTextMarginHorizontal

Property Value

MenuTextMarginVertical

Property Value

PopupButtonLinkArrowStyle

Property Value

ToolBarAscentMargin

Property Value

ToolBarExtentMargin

Property Value

ToolBarSeparatorExtent

Property Value

ToolBarSplitButtonPopupExtent

Property Value

Methods

ArrangeComboBoxChildControl(PaintEventArgs, Rectangle, BarComboBoxLink)

ArrangeTextBoxChildControl(PaintEventArgs, Rectangle, BarTextBoxLink)

DrawButtonLink(PaintEventArgs, Rectangle, BarButtonLink)

DrawComboBoxLink(PaintEventArgs, Rectangle, BarComboBoxLink)

DrawComboBoxLinkItem(DrawItemEventArgs, BarComboBoxLink, object)

DrawCommandInCustomizeList(PaintEventArgs, Rectangle, BarManager, BarCommand, UIElementDrawState, bool, SizeF)

DrawCommandLinkInCustomizeList(PaintEventArgs, Rectangle, BarManager, BarCommandLink, UIElementDrawState, bool)

DrawCommandLinkSelectionBorder(PaintEventArgs, Rectangle, BarCommandLink)

DrawDockAreaBackground(PaintEventArgs, Rectangle, BarDockArea)

DrawDockableToolBarBackground(PaintEventArgs, Rectangle, DockableToolBar)

DrawDockableToolBarFloatingContainerBackground(PaintEventArgs, Rectangle, DockableToolBar)

DrawDockableToolBarFloatingTitleBar(PaintEventArgs, Rectangle, DockableToolBar)

DrawDockableToolBarGripper(PaintEventArgs, Rectangle, DockableToolBar)

DrawDockableToolBarOptionsButton(PaintEventArgs, Rectangle, DockableToolBar, BarPopupButtonLink)

DrawExpanderButtonLink(PaintEventArgs, Rectangle, BarExpanderButtonLink)

DrawLabelLink(PaintEventArgs, Rectangle, BarLabelLink)

DrawMenuBackground(PaintEventArgs, Rectangle, IBarControl)

DrawMenuGripper(PaintEventArgs, Rectangle, IUIElement)

DrawMenuOverflowButton(PaintEventArgs, Rectangle, IUIElement, bool)

DrawMenuSeparator(PaintEventArgs, Rectangle, BarCommandLink, Orientation)

DrawPopupButtonLink(PaintEventArgs, Rectangle, BarPopupButtonLink)

DrawSplitButtonLink(PaintEventArgs, Rectangle, BarSplitButtonLink)

DrawSystemButtonLink(PaintEventArgs, Rectangle, BarButtonLink)

DrawSystemPopupButtonLink(PaintEventArgs, Rectangle, BarPopupButtonLink)

DrawTextBoxLink(PaintEventArgs, Rectangle, BarTextBoxLink)

DrawToolBarBackground(PaintEventArgs, Rectangle, ToolBar)

DrawToolBarSeparator(PaintEventArgs, Rectangle, BarCommandLink, Orientation)

MeasureCommandLink(Graphics, BarCommandLink)

Returns

MeasureDockableToolBarFloatingTitleBarHeight(Graphics, DockableToolBar)

Returns

Inherited Members

Extension Methods