Class ButtonPropertiesBuilder

Instance of control properties class

Inheritance

System.Object

ButtonPropertiesBuilder

Implements

IPropertiesBuilder

System.Web.IHtmlString

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Syncfusion.JavaScript

Assembly: Syncfusion.EJ.dll

Syntax

public class ButtonPropertiesBuilder : IPropertiesBuilder, IHtmlString

Constructors

ButtonPropertiesBuilder()

Initializes a new instance of the ButtonPropertiesBuilder class.

Declaration

public ButtonPropertiesBuilder()

ButtonPropertiesBuilder(Button)

Initializes a new instance of the ButtonPropertiesBuilder class by the specified button object.

Declaration

public ButtonPropertiesBuilder(Button button)

Parameters

Type	Name	Description
Button	button

Fields

button

Specifies the instance of the Button class.

Declaration

public Button button

Field Value

Type	Description
Button

Methods

ClientSideEvents(Action<ButtonClientSideEventsBuilder>)

Specifies to trigger the button client side events.

Declaration

public ButtonPropertiesBuilder ClientSideEvents(Action<ButtonClientSideEventsBuilder> clientSideEvents)

Parameters

Type	Name	Description
System.Action<ButtonClientSideEventsBuilder>	clientSideEvents

Returns

Type	Description
ButtonPropertiesBuilder

ContentType(ContentType)

Specifies the content type of the button with specified argument. Content type can be image only, text only, image text image, text and image or image both.

Declaration

public ButtonPropertiesBuilder ContentType(ContentType contentType)

Parameters

Type	Name	Description
ContentType	contentType	contentType

Returns

Type	Description
ButtonPropertiesBuilder	This method returns enum value

CssClass(String)

Specifies the root CSS class to button for theme customization with specified string argument.

Declaration

public ButtonPropertiesBuilder CssClass(string cssClass)

Parameters

Type	Name	Description
System.String	cssClass	cssClass

Returns

Type	Description
ButtonPropertiesBuilder	This method returns string value

Enabled()

Allows the button control to respond for user interaction.

Declaration

public ButtonPropertiesBuilder Enabled()

Returns

Type	Description
ButtonPropertiesBuilder

Enabled(Boolean)

Allows the button control to respond for user interaction with specified boolean argument.

Declaration

public ButtonPropertiesBuilder Enabled(bool enabled)

Parameters

Type	Name	Description
System.Boolean	enabled	enabled

Returns

Type	Description
ButtonPropertiesBuilder	This method returns boolean value

EnableRTL()

Specifies to align the button control in right to left direction.

Declaration

public ButtonPropertiesBuilder EnableRTL()

Returns

Type	Description
ButtonPropertiesBuilder

EnableRTL(Boolean)

Specifies to align the button control in right to left direction with specified boolean argument.

Declaration

public ButtonPropertiesBuilder EnableRTL(bool enableRTL)

Parameters

Type	Name	Description
System.Boolean	enableRTL	enableRTL

Returns

Type	Description
ButtonPropertiesBuilder	This method returns boolean value

Height(String)

Specifies the height of the button with specified string argument.

Declaration

public ButtonPropertiesBuilder Height(string height)

Parameters

Type	Name	Description
System.String	height	height

Returns

Type	Description
ButtonPropertiesBuilder	This method returns string value

HtmlAttributes(IDictionary<String, Object>)

Specifies to map the field of HTML attributes.

Declaration

public ButtonPropertiesBuilder HtmlAttributes(IDictionary<string, object> itemHtmlAttributes)

Parameters

Type	Name	Description
System.Collections.Generic.IDictionary<System.String, System.Object>	itemHtmlAttributes	HTML Attributes

Returns

Type	Description
ButtonPropertiesBuilder	This method returns object value

ImagePosition(ImagePosition)

Specifies the image position of the button with specified argument. Image position can be left or right and is applicable if content type is text and image.

Declaration

public ButtonPropertiesBuilder ImagePosition(ImagePosition imagePosition)

Parameters

Type	Name	Description
ImagePosition	imagePosition	imagePosition

Returns

Type	Description
ButtonPropertiesBuilder	This method returns enum value

PrefixIcon(String)

Specifies the primary icon for button with specified string argument. This property applicable to all content types except 'text only'.

Declaration

public ButtonPropertiesBuilder PrefixIcon(string prefixIcon)

Parameters

Type	Name	Description
System.String	prefixIcon	prefixIcon

Returns

Type	Description
ButtonPropertiesBuilder	This method returns string value

Render()

Renders the button instance.

Declaration

public void Render()

RepeatButton()

Represents the repeat button. Repeat button raises its ‘click’ event repeatedly from the time it is pressed until it is released.

Declaration

public ButtonPropertiesBuilder RepeatButton()

Returns

Type	Description
ButtonPropertiesBuilder

RepeatButton(Boolean)

Represents the repeat button with specified boolean argument. Repeat button raises its ‘click’ event repeatedly from the time it is pressed until it is released.

Declaration

public ButtonPropertiesBuilder RepeatButton(bool repeatButton)

Parameters

Type	Name	Description
System.Boolean	repeatButton	repeatButton

Returns

Type	Description
ButtonPropertiesBuilder	This method returns boolean value

ShowRoundedCorner()

Displays the button with rounded corners.

Declaration

public ButtonPropertiesBuilder ShowRoundedCorner()

Returns

Type	Description
ButtonPropertiesBuilder

ShowRoundedCorner(Boolean)

Displays the button with rounded corners by the specified boolean argument.

Declaration

public ButtonPropertiesBuilder ShowRoundedCorner(bool showRoundedCorner)

Parameters

Type	Name	Description
System.Boolean	showRoundedCorner	showRoundedCorner

Returns

Type	Description
ButtonPropertiesBuilder	This method returns boolean value

Size(ButtonSize)

Specifies the size of the button with specified argument. Size can be normal, mini, small, medium or large.

Declaration

public ButtonPropertiesBuilder Size(ButtonSize size)

Parameters

Type	Name	Description
ButtonSize	size	buttonSize

Returns

Type	Description
ButtonPropertiesBuilder	This method returns enum value

SuffixIcon(String)

Specifies the secondary icon for button with specified string argument. This property applicable for the content types 'image text image' and 'image both'.

Declaration

public ButtonPropertiesBuilder SuffixIcon(string suffixIcon)

Parameters

Type	Name	Description
System.String	suffixIcon	suffixIcon

Returns

Type	Description
ButtonPropertiesBuilder	This method returns string value

Text(String)

Specifies the text content for button with specified string argument.

Declaration

public ButtonPropertiesBuilder Text(string text)

Parameters

Type	Name	Description
System.String	text	text

Returns

Type	Description
ButtonPropertiesBuilder	This method returns string value

TimeInterval(String)

Specifies the time interval between two consecutive ‘click’ event on the button with specified string argument.

Declaration

public ButtonPropertiesBuilder TimeInterval(string timeInterval)

Parameters

Type	Name	Description
System.String	timeInterval	timeInterval

Returns

Type	Description
ButtonPropertiesBuilder	This method returns string value

ToHtmlString()

Represents an HTML-encoded string.

Declaration

public string ToHtmlString()

Returns

Type	Description
System.String

Type(ButtonType)

Specifies the type of the Button with specified argument. Type can be submit, reset or button.

Declaration

public ButtonPropertiesBuilder Type(ButtonType type)

Parameters

Type	Name	Description
ButtonType	type	type

Returns

Type	Description
ButtonPropertiesBuilder	This method returns enum value

Width(String)

Specifies the width of the button with specified string argument.

Declaration

public ButtonPropertiesBuilder Width(string width)

Parameters

Type	Name	Description
System.String	width	width

Returns

Type	Description
ButtonPropertiesBuilder	This method returns string value

Implements

IPropertiesBuilder

System.Web.IHtmlString