ButtonExtensions

Namespace: Wisej.Web.Markup

Assembly: Wisej.Framework (4.1.0.0)

Adds fluent markup extension methods to the ButtonBase, Button and SplitButton classes.

C#

public class ButtonExtensions

VB.NET

Public Class ButtonExtensions

Methods

AllowHtml<TButtonBase>(button, value)

Sets the AllowHtml property of the specified ButtonBase.

Parameter	Type	Description
TButtonBase		The type of the button, must inherit from ButtonBase.
button	TButtonBase	The button for which to set the AllowHtml property.
value	Boolean	A boolean indicating whether HTML is allowed in the button's text.

Returns: TButtonBase. The modified button with the updated AllowHtml property.

This method allows you to enable or disable HTML content in the button's text.

myButton.AllowHtml(true);

AllowMarkdown<TButtonBase>(button, value)

Sets the AllowMarkdown property of the specified ButtonBase.

Parameter	Type	Description
TButtonBase		The type of the button, must inherit from ButtonBase.
button	TButtonBase	The button for which to set the AllowMarkdown property.
value	Boolean	A boolean indicating whether Markdown is allowed in the button's text.

Returns: TButtonBase. The modified button with the updated AllowMarkdown property.

This method allows you to enable or disable Markdown content in the button's text.

myButton.AllowMarkdown(true);

AutoEllipsis<TButtonBase>(button, value)

Sets the AutoEllipsis property of the specified ButtonBase.

Parameter	Type	Description
TButtonBase		The type of the button, must inherit from ButtonBase.
button	TButtonBase	The button for which to set the AutoEllipsis property.
value	Boolean	A boolean indicating whether to automatically show ellipses when text is truncated.

Returns: TButtonBase. The modified button with the updated AutoEllipsis property.

This method allows you to enable or disable the automatic display of ellipses when the button's text is truncated.

myButton.AutoEllipsis(true);

AutoShowLoader<TButtonBase>(button, value)

Sets the AutoShowLoader property of the specified ButtonBase.

Parameter	Type	Description
TButtonBase		The type of the button, must inherit from ButtonBase.
button	TButtonBase	The button for which to set the AutoShowLoader property.
value	Boolean	A boolean indicating whether to automatically show a loader on the button.

Returns: TButtonBase. The modified button with the updated AutoShowLoader property.

This method allows you to enable or disable the automatic display of a loader on the button.

myButton.AutoShowLoader(true);

AutoSizeMode<TButton>(button, mode)

Sets the AutoSizeMode property of the specified Button.

Parameter	Type	Description
TButton		The type of the button, must inherit from Button.
button	TButton	The button for which to set the AutoSizeMode property.
mode	AutoSizeMode	The AutoSizeMode to set for the button.

Returns: TButton. The modified button with the updated AutoSizeMode property.

This method allows you to specify the automatic sizing behavior for the button.

myButton.AutoSizeMode(AutoSizeMode.GrowAndShrink);

AutoToolTip<TButton>(button, value)

Sets the AutoToolTip property of the specified Button.

Parameter	Type	Description
TButton		The type of the button, must inherit from Button and have an AutoToolTip property.
button	TButton	The button for which to set the AutoToolTip property.
value	Boolean	A boolean indicating whether tooltips are automatically shown for the button.

Returns: TButton. The modified button with the updated AutoToolTip property.

This method allows you to enable or disable automatic tooltips for the button.

myButton.AutoToolTip(true);

BorderStyle<TButton>(button, borderStyle)

Sets the BorderStyle property of the specified Button.

Parameter	Type	Description
TButton		The type of the button, must inherit from Button and have a BorderStyle property.
button	TButton	The button for which to set the BorderStyle property.
borderStyle	BorderStyle	The BorderStyle to set for the button.

Returns: TButton. The modified button with the updated BorderStyle property.

This method allows you to specify the border style for the button.

myButton.BorderStyle(BorderStyle.FixedSingle);

CharacterCasing<TButtonBase>(button, casing)

Sets the CharacterCasing property of the specified ButtonBase.

Parameter	Type	Description
TButtonBase		The type of the button, must inherit from ButtonBase.
button	TButtonBase	The button for which to set the CharacterCasing property.
casing	CharacterCasing	The CharacterCasing to set for the button text.

Returns: TButtonBase. The modified button with the updated CharacterCasing property.

This method allows you to specify the character casing for the button's text.

myButton.CharacterCasing(CharacterCasing.Upper);

Display<TButton>(button, display)

Sets the Display property of the specified Button.

Parameter	Type	Description
TButton		The type of the button, must inherit from Button and have a Display property.
button	TButton	The button for which to set the Display property.
display	Display	The Display setting to apply to the button.

Returns: TButton. The modified button with the updated Display property.

This method allows you to specify the display setting for the button.

myButton.Display(Display.Standard);

ImageSpacing<TButton>(button, spacing)

Sets the ImageSpacing property of the specified Button.

Parameter	Type	Description
TButton		The type of the button, must inherit from Button and have an ImageSpacing property.
button	TButton	The button for which to set the ImageSpacing property.
spacing	Nullable<Int32>	The spacing to set between the image and text on the button.

Returns: TButton. The modified button with the updated ImageSpacing property.

This method allows you to specify the spacing between the image and text on the button.

myButton.ImageSpacing(10);

MenuItems<TButton>(button, items)

Adds the specified menu items to the MenuItems collection of the specified Button.

Parameter	Type	Description
TButton		The type of the button, must inherit from Button and have a MenuItems property.
button	TButton	The button to which the menu items should be added.
items	MenuItem[]	An array of MenuItem to add to the button.

Returns: TButton. The modified button with the added menu items.

This method allows you to add multiple menu items to the button in one call.

myButton.MenuItems(new MenuItem("Item1"), new MenuItem("Item2"));

OnItemClicked<TButton>(button, action)

Attaches an event handler for the ItemClicked event of the specified Button.

Parameter	Type	Description
TButton		The type of the button, must inherit from Button and have an ItemClicked event.
button	TButton	The button to attach the event handler to.
action	Action<TButton, MenuButtonItemClickedEventArgs>	An action to execute when an item is clicked.

Returns: TButton. The modified button with the attached ItemClicked event handler.

This method allows you to execute a custom action whenever an item within the button's menu is clicked.

myButton.OnItemClicked((btn, args) =>
{
AlertBox.Show("Item clicked!");
});

OnMenuCollapse<TButton>(button, action)

Attaches an event handler for the MenuCollapse event of the specified Button.

Parameter	Type	Description
TButton		The type of the button, must inherit from Button and have a MenuCollapse event.
button	TButton	The button to attach the event handler to.
action	Action<TButton>	An action to execute when the menu collapses.

Returns: TButton. The modified button with the attached MenuCollapse event handler.

This method allows you to execute a custom action whenever the button's menu collapses.

myButton.OnMenuCollapse(btn =>
{
AlertBox.Show("Menu collapsed!");
});

OnMenuPopup<TButton>(button, action)

Attaches an event handler for the MenuPopup event of the specified Button.

Parameter	Type	Description
TButton		The type of the button, must inherit from Button and have a MenuPopup event.
button	TButton	The button to attach the event handler to.
action	Action<TButton>	An action to execute when the menu pops up.

Returns: TButton. The modified button with the attached MenuPopup event handler.

This method allows you to execute a custom action whenever the button's menu pops up.

myButton.OnMenuPopup(btn =>
{
AlertBox.Show("Menu popped up!");
});

Orientation<TSplitButton>(button, orientation)

Sets the Orientation property of the specified SplitButton.

Parameter	Type	Description
TSplitButton		The type of the button, must inherit from SplitButton.
button	TSplitButton	The split button for which to set the Orientation property.
orientation	Orientation	The Orientation to set for the button.

Returns: TSplitButton. The modified button with the updated Orientation property.

This method allows you to specify the orientation of the split button, such as horizontal or vertical.

mySplitButton.Orientation(Orientation.Horizontal);

Repeat<TButton>(button, value)

Sets the Repeat property of the specified Button.

Parameter	Type	Description
TButton		The type of the button, must inherit from Button and have a Repeat property.
button	TButton	The button for which to set the Repeat property.
value	Boolean	A boolean indicating whether the button repeats its action when held down.

Returns: TButton. The modified button with the updated Repeat property.

This method allows you to enable or disable repeating actions for the button when it is held down.

myButton.Repeat(true);

Shortcut<TButton>(button, shortcut)

Sets the Shortcut property of the specified Button.

Parameter	Type	Description
TButton		The type of the button, must inherit from Button and have a Shortcut property.
button	TButton	The button for which to set the Shortcut property.
shortcut	Shortcut	The Shortcut to set for the button.

Returns: TButton. The modified button with the updated Shortcut property.

This method allows you to specify a keyboard shortcut for the button.

myButton.Shortcut(Shortcut.CtrlS);

TextAlign<TButtonBase>(button, alignment)

Sets the TextAlign property of the specified ButtonBase.

Parameter	Type	Description
TButtonBase		The type of the button, must inherit from ButtonBase.
button	TButtonBase	The button for which to set the TextAlign property.
alignment	ContentAlignment	The ContentAlignment to set for the button text.

Returns: TButtonBase. The modified button with the updated TextAlign property.

This method allows you to specify the alignment of the text on the button.

myButton.TextAlign(ContentAlignment.MiddleCenter);

TextImageRelation<TButtonBase>(button, textImageRelation)

Sets the TextImageRelation property of the specified ButtonBase.

Parameter	Type	Description
TButtonBase		The type of the button, must inherit from ButtonBase.
button	TButtonBase	The button for which to set the TextImageRelation property.
textImageRelation	TextImageRelation	The TextImageRelation to set for the button.

Returns: TButtonBase. The modified button with the updated TextImageRelation property.

This method allows you to specify the relationship between the button's text and image.

myButton.TextImageRelation(TextImageRelation.ImageBeforeText);

UseMnemonic<TButtonBase>(button, value)

Sets the UseMnemonic property of the specified ButtonBase.

Parameter	Type	Description
TButtonBase		The type of the button, must inherit from ButtonBase.
button	TButtonBase	The button for which to set the UseMnemonic property.
value	Boolean	A boolean indicating whether mnemonic characters are used.

Returns: TButtonBase. The modified button with the updated UseMnemonic property.

This method allows you to enable or disable the use of mnemonic characters in the button's text.

myButton.UseMnemonic(true);