ToolBarButtonExtensions

Wisej.Web.Markup.ToolBarButtonExtensions

Namespace: Wisej.Web.Markup

Assembly: Wisej.Framework (4.0.0.0)

Adds fluent markup extension methods to the ToolBarButton class.

C#

public class ToolBarButtonExtensions

VB.NET

Public Class ToolBarButtonExtensions

Methods

AllowHtml<TToolBarButton>(toolbarButton, allow)

Sets whether HTML is allowed in the text of the ToolBarButton.

Parameter	Type	Description
TToolBarButton		The type of the toolbar button.
toolbarButton	TToolBarButton	The toolbar button to extend.
allow	Boolean	A value indicating whether HTML is allowed.

Returns: TToolBarButton. The modified toolbar button.

AppearanceKey<TToolBarButton>(toolbarButton, appearanceKey)

Sets the appearance key of the ToolBarButton.

Parameter	Type	Description
TToolBarButton		The type of the toolbar button.
toolbarButton	TToolBarButton	The toolbar button to extend.
appearanceKey	String	The appearance key to set.

Returns: TToolBarButton. The modified toolbar button.

AutoShowLoader<TToolBarButton>(toolbarButton, autoShowLoader)

Sets whether the loader is automatically shown for the ToolBarButton.

Parameter	Type	Description
TToolBarButton		The type of the toolbar button.
toolbarButton	TToolBarButton	The toolbar button to extend.
autoShowLoader	Boolean	A value indicating whether the loader is automatically shown.

Returns: TToolBarButton. The modified toolbar button.

DropDownMenu<TToolBarButton>(toolbarButton, dropDownMenu)

Sets the DropDownMenu of the ToolBarButton.

Parameter	Type	Description
TToolBarButton		The type of the toolbar button.
toolbarButton	TToolBarButton	The toolbar button to extend.
dropDownMenu	ContextMenu	The drop-down menu to associate.

Returns: TToolBarButton. The modified toolbar button.

Enabled<TToolBarButton>(toolbarButton, enabled)

Sets the enabled state of the ToolBarButton.

Parameter	Type	Description
TToolBarButton		The type of the toolbar button.
toolbarButton	TToolBarButton	The toolbar button to extend.
enabled	Boolean	A value indicating whether the button is enabled.

Returns: TToolBarButton. The modified toolbar button.

ForeColor<TToolBarButton>(toolbarButton, color)

Sets the foreground color of the ToolBarButton.

Parameter	Type	Description
TToolBarButton		The type of the toolbar button.
toolbarButton	TToolBarButton	The toolbar button to extend.
color	Color	The color to set.

Returns: TToolBarButton. The modified toolbar button.

Image<TToolBarButton>(toolbarButton, image)

Sets the image of the ToolBarButton.

Parameter	Type	Description
TToolBarButton		The type of the toolbar button.
toolbarButton	TToolBarButton	The toolbar button to extend.
image	Image	The image to set.

Returns: TToolBarButton. The modified toolbar button.

ImageIndex<TToolBarButton>(toolbarButton, imageIndex)

Sets the image index of the ToolBarButton.

Parameter	Type	Description
TToolBarButton		The type of the toolbar button.
toolbarButton	TToolBarButton	The toolbar button to extend.
imageIndex	Int32	The zero-based index of the image to set.

Returns: TToolBarButton. The modified toolbar button.

ImageKey<TToolBarButton>(toolbarButton, imageKey)

Sets the image key of the ToolBarButton.

Parameter	Type	Description
TToolBarButton		The type of the toolbar button.
toolbarButton	TToolBarButton	The toolbar button to extend.
imageKey	String	The image key to set.

Returns: TToolBarButton. The modified toolbar button.

ImageSource<TToolBarButton>(toolbarButton, imageSource)

Sets the image source of the ToolBarButton.

Parameter	Type	Description
TToolBarButton		The type of the toolbar button.
toolbarButton	TToolBarButton	The toolbar button to extend.
imageSource	String	The image source URL or path to set.

Returns: TToolBarButton. The modified toolbar button.

Margin<TToolBarButton>(toolbarButton, margin)

Sets the margin of the ToolBarButton.

Parameter	Type	Description
TToolBarButton		The type of the toolbar button.
toolbarButton	TToolBarButton	The toolbar button to extend.
margin	Padding	The margin to set.

Returns: TToolBarButton. The modified toolbar button.

Margin<TToolBarButton>(toolbarButton, left, top, right, bottom)

Sets the margin of the ToolBarButton using individual values.

Parameter	Type	Description
TToolBarButton		The type of the toolbar button.
toolbarButton	TToolBarButton	The toolbar button to extend.
left	Int32	The left margin.
top	Int32	The top margin.
right	Int32	The right margin.
bottom	Int32	The bottom margin.

Returns: TToolBarButton. The modified toolbar button.

Name<TToolBarButton>(toolbarButton, name)

Sets the name of the ToolBarButton.

Parameter	Type	Description
TToolBarButton		The type of the toolbar button.
toolbarButton	TToolBarButton	The toolbar button to extend.
name	String	The name to set.

Returns: TToolBarButton. The modified toolbar button.

OnClick<TToolBarButton>(toolbarButton, action)

Attaches an action to the Click event of the ToolBarButton.

Parameter	Type	Description
TToolBarButton		The type of the toolbar button.
toolbarButton	TToolBarButton	The toolbar button to extend.
action	Action<TToolBarButton>	The action to perform when the button is clicked.

Returns: TToolBarButton. The modified toolbar button.

OnPushedChanged<TToolBarButton>(toolbarButton, action)

Attaches an action to the PushedChanged event of the ToolBarButton.

Parameter	Type	Description
TToolBarButton		The type of the toolbar button.
toolbarButton	TToolBarButton	The toolbar button to extend.
action	Action<TToolBarButton>	The action to perform when the pushed state changes.

Returns: TToolBarButton. The modified toolbar button.

Padding<TToolBarButton>(toolbarButton, padding)

Sets the padding of the ToolBarButton.

Parameter	Type	Description
TToolBarButton		The type of the toolbar button.
toolbarButton	TToolBarButton	The toolbar button to extend.
padding	Padding	The padding to set.

Returns: TToolBarButton. The modified toolbar button.

Padding<TToolBarButton>(toolbarButton, left, top, right, bottom)

Sets the padding of the ToolBarButton with specified left, top, right, and bottom values.

Parameter	Type	Description
TToolBarButton		The type of the toolbar button.
toolbarButton	TToolBarButton	The toolbar button to extend.
left	Int32	The left padding.
top	Int32	The top padding.
right	Int32	The right padding.
bottom	Int32	The bottom padding.

Returns: TToolBarButton. The modified toolbar button.

Pushed<TToolBarButton>(toolbarButton, pushed)

Sets the pushed state of the ToolBarButton.

Parameter	Type	Description
TToolBarButton		The type of the toolbar button.
toolbarButton	TToolBarButton	The toolbar button to extend.
pushed	Boolean	A value indicating whether the button is pushed.

Returns: TToolBarButton. The modified toolbar button.

SizeMode<TToolBarButton>(toolbarButton, sizeMode)

Sets the size mode of the ToolBarButton.

Parameter	Type	Description
TToolBarButton		The type of the toolbar button.
toolbarButton	TToolBarButton	The toolbar button to extend.
sizeMode	ToolBarButtonSizeMode	The size mode to set.

Returns: TToolBarButton. The modified toolbar button.

Style<TToolBarButton>(toolbarButton, style)

Sets the style of the ToolBarButton.

Parameter	Type	Description
TToolBarButton		The type of the toolbar button.
toolbarButton	TToolBarButton	The toolbar button to extend.
style	ToolBarButtonStyle	The style to set.

Returns: TToolBarButton. The modified toolbar button.

Tag<TToolBarButton>(toolbarButton, obj)

Sets the tag object of the ToolBarButton.

Parameter	Type	Description
TToolBarButton		The type of the toolbar button.
toolbarButton	TToolBarButton	The toolbar button to extend.
obj	Object	The object to set as the tag.

Returns: TToolBarButton. The modified toolbar button.

Text<TToolBarButton>(toolbarButton, text)

Sets the text of the ToolBarButton.

Parameter	Type	Description
TToolBarButton		The type of the toolbar button.
toolbarButton	TToolBarButton	The toolbar button to extend.
text	String	The text to set.

Returns: TToolBarButton. The modified toolbar button.

Text<TToolBarButton>(toolbarButton, visible)

Sets the visibility of the ToolBarButton.

Parameter	Type	Description
TToolBarButton		The type of the toolbar button.
toolbarButton	TToolBarButton	The toolbar button to extend.
visible	Boolean	A value indicating whether the button is visible.

Returns: TToolBarButton. The modified toolbar button.

ToolTipText<TToolBarButton>(toolbarButton, toolTipText)

Sets the tooltip text of the ToolBarButton.

Parameter	Type	Description
TToolBarButton		The type of the toolbar button.
toolbarButton	TToolBarButton	The toolbar button to extend.
toolTipText	String	The tooltip text to set.

Returns: TToolBarButton. The modified toolbar button.