Search results

CommandButtonOptions API in JavaScript (ES5) Grid API control

Defines options for custom command buttons.

Properties

created

EmitType<Event>

Triggers once the component rendering is completed.

click

EmitType<Event>

Defines handler for the click event.

content

string

Defines the text content of the Button element.

cssClass

string

Defines class/multiple classes separated by a space in the Button element. The Button types, styles, and size can be defined by using this.

disabled

boolean

Specifies a value that indicates whether the Button is disabled or not.

enableHtmlSanitizer

boolean

Specifies whether to enable the rendering of untrusted HTML values in the Button component. If ‘enableHtmlSanitizer’ set to true, the component will sanitize any suspected untrusted strings and scripts before rendering them.

enablePersistence

boolean

Enable or disable persisting component’s state between page reloads.

enableRtl

boolean

Enable or disable rendering component in right to left direction.

iconCss

string

Defines class/multiple classes separated by a space for the Button that is used to include an icon. Buttons can also include font icon and sprite image.

iconPosition

string | IconPosition

Positions the icon before/after the text content in the Button. The possible values are:

  • Left: The icon will be positioned to the left of the text content.
  • Right: The icon will be positioned to the right of the text content.

isPrimary

boolean

Allows the appearance of the Button to be enhanced and visually appealing when set to true.

isToggle

boolean

Makes the Button toggle, when set to true. When you click it, the state changes from normal to active.