Class GroupButton

The Essential ASP.NET Group Button widget helps to display multiple buttons which are stacked together in a single line and used as a navigation component.

Inheritance

System.Object

CommonDataBoundControl

GroupButton

Implements

System.Web.UI.INamingContainer

System.Web.UI.IPostBackEventHandler

System.Web.UI.IPostBackDataHandler

System.Web.UI.IUrlResolutionService

Inherited Members

CommonDataBoundControl.PerformDataBinding(IEnumerable)

CommonDataBoundControl.RaisePostBackEvent(String)

CommonDataBoundControl.OnLoad(EventArgs)

CommonDataBoundControl.OnPreRender(EventArgs)

CommonDataBoundControl.RenderContents(HtmlTextWriter)

Namespace: Syncfusion.JavaScript.Web

Assembly: Syncfusion.EJ.Web.dll

Syntax

public class GroupButton : CommonDataBoundControl, INamingContainer, IPostBackEventHandler, IPostBackDataHandler, IUrlResolutionService

Constructors

GroupButton()

Declaration

public GroupButton()

Properties

ClientSideOnBeforeSelect

Gets or sets a value indicating this event gets fired before any button element in the group button gets selected.

Declaration

public string ClientSideOnBeforeSelect { get; set; }

Property Value

Type	Description
System.String

ClientSideOnCreate

Gets or sets a value indicating this event gets fired when group button is created.

Declaration

public string ClientSideOnCreate { get; set; }

Property Value

Type	Description
System.String

ClientSideOnDestroy

Gets or sets a value indicating this event gets fired when the group button is destroyed successfully.

Declaration

public string ClientSideOnDestroy { get; set; }

Property Value

Type	Description
System.String

ClientSideOnKeyPress

Gets or sets a value indicating this event gets fired once the key is pressed, when the control is in focused state.

Declaration

public string ClientSideOnKeyPress { get; set; }

Property Value

Type	Description
System.String

ClientSideOnSelect

Gets or sets a value indicating this event gets fired when the button element gets selected.

Declaration

public string ClientSideOnSelect { get; set; }

Property Value

Type	Description
System.String

CssClass

Gets or sets the root CSS class to group button for theme customization.

Declaration

public string CssClass { get; set; }

Property Value

Type	Description
System.String

DataContentTypeField

Gets or sets the content type of the button. Button can have image only, text only, imagetextimage, textandimage, or imageboth as content type.

Declaration

public string DataContentTypeField { get; set; }

Property Value

Type	Description
System.String

DataHtmlAttributeField

Gets or sets the value to map the field of HTML attributes.

Declaration

public string DataHtmlAttributeField { get; set; }

Property Value

Type	Description
System.String

DataIDField

Gets or sets the text in the button.

Declaration

public string DataIDField { get; set; }

Property Value

Type	Description
System.String

DataImagePositionField

Gets or sets the image position in the button. This property is applicable for the content type 'textandimage' only.

Declaration

public string DataImagePositionField { get; set; }

Property Value

Type	Description
System.String

DataLinkAttributeField

Gets or sets the link attribute to the button element.

Declaration

public string DataLinkAttributeField { get; set; }

Property Value

Type	Description
System.String

DataPrefixIconField

Gets or sets the primary icon for button. This icon will be displayed from the left margin of the button

Declaration

public string DataPrefixIconField { get; set; }

Property Value

Type	Description
System.String

DataSelectedField

Gets or sets the value indicating the button in selected state.

Declaration

public string DataSelectedField { get; set; }

Property Value

Type	Description
System.String

DataSource

Gets or sets value indicating the data source. Data source can be a string array or json array.

Declaration

[JsonConverter(typeof(DataManagerConverter))]
public object DataSource { get; set; }

Property Value

Type	Description
System.Object

DataSourceCachingMode

Gets or sets the value for datasource caching mode.

Declaration

public DataSourceCachingMode DataSourceCachingMode { get; set; }

Property Value

Type	Description
DataSourceCachingMode

DataSuffixIconField

Gets or sets the secondary icon for button. This icon will be displayed from the right margin of the button.

Declaration

public string DataSuffixIconField { get; set; }

Property Value

Type	Description
System.String

DataTextField

Gets or sets the text in the button.

Declaration

public string DataTextField { get; set; }

Property Value

Type	Description
System.String

DataUrlField

Gets or sets the URL of the button for navigation.

Declaration

public string DataUrlField { get; set; }

Property Value

Type	Description
System.String

Enabled

Gets or sets a value indicating whether the control can respond to user interaction.

Declaration

public bool Enabled { get; set; }

Property Value

Type	Description
System.Boolean

EnableRTL

Gets or sets a value to align the group button in right to left direction.

Declaration

public bool EnableRTL { get; set; }

Property Value

Type	Description
System.Boolean

GroupButtonFields

Gets or sets a value indicating the field members which make databind easier.

Declaration

public GroupButtonFields GroupButtonFields { get; }

Property Value

Type	Description
GroupButtonFields

GroupButtonMode

Gets or sets a value indicating the mode (checkbox mode/radio button mode) of the group button.

Declaration

public GroupButtonMode GroupButtonMode { get; set; }

Property Value

Type	Description
GroupButtonMode

Height

Gets or sets the height of the group button.

Declaration

public override Unit Height { get; set; }

Property Value

Type	Description
System.Web.UI.WebControls.Unit

Items

Gets or sets a value indicating the list of group button items.

Declaration

public List<GroupButtonItem> Items { get; }

Property Value

Type	Description
System.Collections.Generic.List<GroupButtonItem>

Model

Gets or sets the group button model object of the group button properties.

Declaration

public GroupButtonProperties Model { get; set; }

Property Value

Type	Description
GroupButtonProperties

Orientation

Gets or sets the orientation of the group button.

Declaration

public Orientation Orientation { get; set; }

Property Value

Type	Description
Orientation

Query

Gets or sets the query to retrieve the data from the online server.

Declaration

[JsonConverter(typeof(QueryConverter))]
public string Query { get; set; }

Property Value

Type	Description
System.String

SelectedItemIndex

Gets or sets the list of button items to be selected. This property is applicable when 'GroupButtonMode' is 'checkbox' mode.

Declaration

public List<int> SelectedItemIndex { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<System.Int32>

ShowRoundedCorner

Gets or sets the value indicating the group button with rounded corners or not.

Declaration

public bool ShowRoundedCorner { get; set; }

Property Value

Type	Description
System.Boolean

Size

Gets or sets the size of the group button..

Declaration

public ButtonSize Size { get; set; }

Property Value

Type	Description
ButtonSize

Width

Gets or sets the width of the group button.

Declaration

public override Unit Width { get; set; }

Property Value

Type	Description
System.Web.UI.WebControls.Unit

Methods

DependentScripts()

Specifies the dependent scripts.

Declaration

public List<string> DependentScripts()

Returns

Type	Description
System.Collections.Generic.List<System.String>

FetchData(IEnumerable)

Specifies to fetch the datasource values.

Declaration

public override void FetchData(IEnumerable data)

Parameters

Type	Name	Description
System.Collections.IEnumerable	data

Overrides

CommonDataBoundControl.FetchData(IEnumerable)

GetDependentFiles()

Specifies the the dependent files.

Declaration

public override List<string> GetDependentFiles()

Returns

Type	Description
System.Collections.Generic.List<System.String>

Overrides

CommonDataBoundControl.GetDependentFiles()

LoadViewState(Object)

Restores view-state information from a previous page request.

Declaration

protected override void LoadViewState(object state)

Parameters

Type	Name	Description
System.Object	state

Overrides

CommonDataBoundControl.LoadViewState(Object)

PostBackEventHandler(String, Dictionary<String, Object>)

Specifies the handler for server side events.

Declaration

public override void PostBackEventHandler(string EventName, Dictionary<string, object> args)

Parameters

Type	Name	Description
System.String	EventName
System.Collections.Generic.Dictionary<System.String, System.Object>	args

Overrides

CommonDataBoundControl.PostBackEventHandler(String, Dictionary<String, Object>)

Render()

Renders the group button instance.

Declaration

public string Render()

Returns

Type	Description
System.String

Render(HtmlTextWriter)

Declaration

protected override void Render(HtmlTextWriter writer)

Parameters

Type	Name	Description
System.Web.UI.HtmlTextWriter	writer

Overrides

CommonDataBoundControl.Render(HtmlTextWriter)

SaveViewState()

Saves any server control view-state changes that have occurred since the time the page was posted back to the server.

Declaration

protected override object SaveViewState()

Returns

Type	Description
System.Object

UpdateServerModel(Dictionary<String, Object>)

Updates the server model with client model.

Declaration

public override void UpdateServerModel(Dictionary<string, object> ClientModel)

Parameters

Type	Name	Description
System.Collections.Generic.Dictionary<System.String, System.Object>	ClientModel

Overrides

CommonDataBoundControl.UpdateServerModel(Dictionary<String, Object>)

Events

ItemSelect

Represents the select event handler of the group button.

Declaration

public event GroupButton.GroupButtonEventHandler ItemSelect

Event Type

Type	Description
GroupButton.GroupButtonEventHandler

Implements

System.Web.UI.INamingContainer

System.Web.UI.IPostBackEventHandler

System.Web.UI.IPostBackDataHandler

System.Web.UI.IUrlResolutionService