C# Class Open.Core.UI.Controls.ToolBarExtensions

Extensions for working with the Toolbar.

Show file Open project: philcockfield/Open.TestHarness.SL

Private Properties

Property	Type	Description

Public Methods

Method	Description
AddButton ( this toolbar, object id = null, IconImage icon = IconImage.SilkAccept, String text = null, Orientation orientation = Orientation.Horizontal, bool showDefaultBackground = false, string toolTip = null, int minWidth, int column = null, int row = null, int columnSpan = 1, int rowSpan = 1 ) : IButtonTool	Adds a button tool to the toolbar.
AddButton ( this toolbar, object id = null, Image icon = null, String text = null, Orientation orientation = Orientation.Horizontal, bool showDefaultBackground = false, string toolTip = null, int minWidth, int column = null, int row = null, int columnSpan = 1, int rowSpan = 1 ) : IButtonTool	Adds a button tool to the toolbar.
AddCustomTool ( this toolbar, IViewFactory viewModel, object id = null, int minWidth, int column = null, int row = null, int columnSpan = 1, int rowSpan = 1 ) : ICustomTool	Adds a custom tool to the toolbar.
AddDivider ( this toolbar, object id = null, int column = null, int row = null, int columnSpan = 1, int rowSpan = 1 ) : IToolDivider	Adds a divider to the toolbar.
AddSpacer ( this toolbar, object id = null, int starAmount = 1, int column = null, int row = null, int columnSpan = 1, int rowSpan = 1 ) : ISpacerTool	Adds a spacer to the toolbar.
AddToolGroup ( this toolbar, object id = null, string title = "Name", double height = 87, int column = null, int row = null, int columnSpan = 1, int rowSpan = 1 ) : IToolBar	Adds a tool-group (a named child-toolbar).

Method Details

AddButton() public static method

Adds a button tool to the toolbar.

public static AddButton ( this toolbar, object id = null, IconImage icon = IconImage.SilkAccept, String text = null, Orientation orientation = Orientation.Horizontal, bool showDefaultBackground = false, string toolTip = null, int minWidth, int column = null, int row = null, int columnSpan = 1, int rowSpan = 1 ) : IButtonTool
toolbar	this	The toolbar to add to.
id	object	The unique identifier of the tool.
icon	IconImage	The icon.
text	String	The text label.
orientation	Orientation	The orientation of the label relative to the icon.
showDefaultBackground	bool	Flag indicating whether the default background is rendered when the mouse is not over the tool.
toolTip	string	The tooltip
minWidth	int	The minimum width of the tool.
column	int	The index of the column the tool is in (0-based, zero by default).
row	int	The index of the row the tool is in (0-based, zero by default).
columnSpan	int	The number of rows the tool spans (1-based, one by default. Must be 1 or greater).
rowSpan	int	The number of columns the tool spans (1-based, one by default. Must be 1 or greater).
return	IButtonTool

AddButton() public static method

Adds a button tool to the toolbar.

public static AddButton ( this toolbar, object id = null, Image icon = null, String text = null, Orientation orientation = Orientation.Horizontal, bool showDefaultBackground = false, string toolTip = null, int minWidth, int column = null, int row = null, int columnSpan = 1, int rowSpan = 1 ) : IButtonTool
toolbar	this	The toolbar to add to.
id	object	The unique identifier of the tool.
icon	Image	The icon.
text	String	The text label.
orientation	Orientation	The orientation of the label relative to the icon.
showDefaultBackground	bool	Flag indicating whether the default background is rendered when the mouse is not over the tool.
toolTip	string	The tooltip
minWidth	int	The minimum width of the tool.
column	int	The index of the column the tool is in (0-based, zero by default).
row	int	The index of the row the tool is in (0-based, zero by default).
columnSpan	int	The number of rows the tool spans (1-based, one by default. Must be 1 or greater).
rowSpan	int	The number of columns the tool spans (1-based, one by default. Must be 1 or greater).
return	IButtonTool

AddCustomTool() public static method

Adds a custom tool to the toolbar.

public static AddCustomTool ( this toolbar, IViewFactory viewModel, object id = null, int minWidth, int column = null, int row = null, int columnSpan = 1, int rowSpan = 1 ) : ICustomTool
toolbar	this	The toolbar to add to.
viewModel	IViewFactory	The view-model for the custom tool UI.
id	object	The unique identifier of the tool.
minWidth	int	The minimum width of the tool.
column	int	The index of the column the tool is in (0-based, zero by default).
row	int	The index of the row the tool is in (0-based, zero by default).
columnSpan	int	The number of rows the tool spans (1-based, one by default. Must be 1 or greater).
rowSpan	int	The number of columns the tool spans (1-based, one by default. Must be 1 or greater).
return	ICustomTool

AddDivider() public static method

Adds a divider to the toolbar.

public static AddDivider ( this toolbar, object id = null, int column = null, int row = null, int columnSpan = 1, int rowSpan = 1 ) : IToolDivider
toolbar	this	The toolbar to add to.
id	object	The unique identifier of the tool.
column	int	The index of the column the tool is in (0-based, zero by default).
row	int	The index of the row the tool is in (0-based, zero by default).
columnSpan	int	The number of rows the tool spans (1-based, one by default. Must be 1 or greater).
rowSpan	int	The number of columns the tool spans (1-based, one by default. Must be 1 or greater).
return	IToolDivider

AddSpacer() public static method

Adds a spacer to the toolbar.

public static AddSpacer ( this toolbar, object id = null, int starAmount = 1, int column = null, int row = null, int columnSpan = 1, int rowSpan = 1 ) : ISpacerTool
toolbar	this	The toolbar to add to.
id	object	The unique identifier of the tool.
starAmount	int	The amount of star multiplications (*) to apply.
column	int	The index of the column the tool is in (0-based, zero by default).
row	int	The index of the row the tool is in (0-based, zero by default).
columnSpan	int	The number of rows the tool spans (1-based, one by default. Must be 1 or greater).
rowSpan	int	The number of columns the tool spans (1-based, one by default. Must be 1 or greater).
return	ISpacerTool

AddToolGroup() public static method

Adds a tool-group (a named child-toolbar).

public static AddToolGroup ( this toolbar, object id = null, string title = "Name", double height = 87, int column = null, int row = null, int columnSpan = 1, int rowSpan = 1 ) : IToolBar
toolbar	this	The toolbar to add to.
id	object	The unique identifier of the tool.
title	string	The display title of the tool-group (displayed under the toolbar).
height	double	The height of the toolgroup (set to NaN for no explicit height).
column	int	The index of the column the tool is in (0-based, zero by default).
row	int	The index of the row the tool is in (0-based, zero by default).
columnSpan	int	The number of rows the tool spans (1-based, one by default. Must be 1 or greater).
rowSpan	int	The number of columns the tool spans (1-based, one by default. Must be 1 or greater).
return	IToolBar