BarRenderer Class

[ToolboxBitmap(typeof(BarRenderer))]
[TypeConverter(typeof(GenericExpandableNullableObjectConverter))]
public abstract class BarRenderer : UIRenderer, IDisposable, IBarRenderer, IUIRenderer

public BarRenderer()

protected BarRenderer(IWindowsColorScheme colorScheme)

Parameter	Type	Description
colorScheme	IWindowsColorScheme	The IWindowsColorScheme to use as a base for the colors.

public Padding DockableToolBarDockedPadding { get; set; }

Property Value

Padding

public int DockableToolBarFloatingBorderWidth { get; set; }

Property Value

int

public Padding DockableToolBarFloatingPadding { get; set; }

Property Value

Padding

public Padding DockableToolBarFloatingTitleBarPadding { get; set; }

Property Value

Padding

public int DockableToolBarGripperExtent { get; set; }

Property Value

int

public int DockableToolBarOptionsButtonExtent { get; set; }

Property Value

int

public Padding MenuBarPadding { get; set; }

Property Value

Padding

public int MenuDefaultColumnWidth { get; set; }

Property Value

int

public int MenuGripperHeight { get; set; }

Property Value

int

public int MenuOverflowButtonHeight { get; set; }

Property Value

int

public int MenuSeparatorHeight { get; set; }

Property Value

int

public int MenuSplitButtonPopupExtent { get; set; }

Property Value

int

public int MenuTextMarginHorizontal { get; set; }

Property Value

int

public int MenuTextMarginVertical { get; set; }

Property Value

int

public BarPopupButtonLinkArrowStyle PopupButtonLinkArrowStyle { get; set; }

Property Value

BarPopupButtonLinkArrowStyle

public bool ResetAllPropertiesOnSystemColorChange { get; set; }

Property Value

bool:

true if all properties should be reset; otherwise, false.

public int ToolBarAscentMargin { get; set; }

Property Value

int

public int ToolBarExtentMargin { get; set; }

Property Value

int

public int ToolBarSeparatorExtent { get; set; }

Property Value

int

public int ToolBarSplitButtonPopupExtent { get; set; }

Property Value

int

protected void ApplyColorSchemeToBarCustomControlLink(BarCustomControlLink link)

Parameter	Type	Description
link	BarCustomControlLink	The custom control link to examine.

public abstract 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.

public abstract 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.

public abstract 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.

public abstract 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.

public virtual 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.

public abstract 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.

public abstract 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

public virtual 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.

public abstract 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.

public abstract 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.

public abstract 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.

public abstract 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.

public abstract 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.

public abstract 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.

public abstract 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.

public abstract 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.

public abstract 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.

public static void DrawMenuBarMdiIcon(PaintEventArgs e, Rectangle bounds, BarManager barManager)

Parameter	Type	Description
e	PaintEventArgs	A PaintEventArgs that contains the event data.
bounds	Rectangle	The bounds in which to draw.
barManager	BarManager	The BarManager whose MDI child form's icon is being painted.

public abstract 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.

public abstract 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.

public abstract 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.

public abstract 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.

public abstract 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.

public abstract 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.

public abstract 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.

public abstract 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.

public abstract 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.

public abstract 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.

public abstract 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

public abstract 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

protected override void OnSystemUserPreferenceColorChanged()

Remarks

This method will only be invoked if IsSystemUserPreferenceColorChangeMonitored returns true.

protected virtual void ResetAll(bool force)

Parameter	Type	Description
force	bool	Whether to force resetting.

public virtual void ResetDockableToolBarDockedPadding()

public virtual void ResetDockableToolBarFloatingBorderWidth()

public virtual void ResetDockableToolBarFloatingPadding()

public virtual void ResetDockableToolBarFloatingTitleBarPadding()

public virtual void ResetDockableToolBarGripperExtent()

public virtual void ResetDockableToolBarOptionsButtonExtent()

public virtual void ResetMenuBarPadding()

public virtual void ResetMenuDefaultColumnWidth()

public virtual void ResetMenuGripperHeight()

public virtual void ResetMenuOverflowButtonHeight()

public virtual void ResetMenuSeparatorHeight()

public virtual void ResetMenuSplitButtonPopupExtent()

public virtual void ResetMenuTextMarginHorizontal()

public virtual void ResetMenuTextMarginVertical()

public virtual void ResetPopupButtonLinkArrowStyle()

public virtual void ResetResetAllPropertiesOnSystemColorChange()

public virtual void ResetToolBarAscentMargin()

public virtual void ResetToolBarExtentMargin()

public virtual void ResetToolBarSeparatorExtent()

public virtual void ResetToolBarSplitButtonPopupExtent()

protected bool ShouldDisplayDropDownArrow(BarCommandLink link)

Parameter	Type	Description
link	BarCommandLink	The BarCommandLink to examine.

Returns

bool:

true if the specified BarCommandLink should display a drop-down arrow; otherwise, false.

public virtual bool ShouldSerializeDockableToolBarDockedPadding()

Returns

bool:

true if the property value has changed from its default; otherwise, false.

public virtual bool ShouldSerializeDockableToolBarFloatingBorderWidth()

Returns

bool:

true if the property value has changed from its default; otherwise, false.

public virtual bool ShouldSerializeDockableToolBarFloatingPadding()

Returns

bool:

true if the property value has changed from its default; otherwise, false.

public virtual bool ShouldSerializeDockableToolBarFloatingTitleBarPadding()

Returns

bool:

true if the property value has changed from its default; otherwise, false.

public virtual bool ShouldSerializeDockableToolBarGripperExtent()

Returns

bool:

true if the property value has changed from its default; otherwise, false.

public virtual bool ShouldSerializeDockableToolBarOptionsButtonExtent()

Returns

bool:

true if the property value has changed from its default; otherwise, false.

public virtual bool ShouldSerializeMenuBarPadding()

Returns

bool:

true if the property value has changed from its default; otherwise, false.

public virtual bool ShouldSerializeMenuDefaultColumnWidth()

Returns

bool:

true if the property value has changed from its default; otherwise, false.

public virtual bool ShouldSerializeMenuGripperHeight()

Returns

bool:

true if the property value has changed from its default; otherwise, false.

public virtual bool ShouldSerializeMenuOverflowButtonHeight()

Returns

bool:

true if the property value has changed from its default; otherwise, false.

public virtual bool ShouldSerializeMenuSeparatorHeight()

Returns

bool:

true if the property value has changed from its default; otherwise, false.

public virtual bool ShouldSerializeMenuSplitButtonPopupExtent()

Returns

bool:

true if the property value has changed from its default; otherwise, false.

public virtual bool ShouldSerializeMenuTextMarginHorizontal()

Returns

bool:

true if the property value has changed from its default; otherwise, false.

public virtual bool ShouldSerializeMenuTextMarginVertical()

Returns

bool:

true if the property value has changed from its default; otherwise, false.

public virtual bool ShouldSerializePopupButtonLinkArrowStyle()

Returns

bool:

true if the property value has changed from its default; otherwise, false.

public virtual bool ShouldSerializeResetAllPropertiesOnSystemColorChange()

Returns

bool:

true if the property value has changed from its default; otherwise, false.

public virtual bool ShouldSerializeToolBarAscentMargin()

Returns

bool:

true if the property value has changed from its default; otherwise, false.

public virtual bool ShouldSerializeToolBarExtentMargin()

Returns

bool:

true if the property value has changed from its default; otherwise, false.

public virtual bool ShouldSerializeToolBarSeparatorExtent()

Returns

bool:

true if the property value has changed from its default; otherwise, false.

public virtual bool ShouldSerializeToolBarSplitButtonPopupExtent()

Returns

bool:

true if the property value has changed from its default; otherwise, false.