ExcelCommandDirective

Represents the export-to-Excel command of the Grid. You can apply this directive to any button element inside a ToolbarTemplate. When the user clicks a button associated with the directive, the excelExport event fires (see example).

html

<kendo-grid>
     <ng-template kendoGridToolbarTemplate>
         <button kendoGridExcelCommand>Export to Excel</button>
     </ng-template>
     <kendo-grid-excel fileName="Grid.xlsx">
     </kendo-grid-excel>
</kendo-grid>

Selector

[kendoGridExcelCommand]

Inputs

Name	Type	Default	Description
disabled	boolean	false	When true, disables the Button and prevents user interaction.
fillMode	ButtonFillMode	'solid'	Sets the background and border styles of the Button. See Button Appearance.
icon	string		Sets the name of an existing font icon in the Kendo UI theme.
iconClass	string		Defines a CSS class, or multiple classes separated by spaces applied to a span element inside the Button. Use the iconClass to add custom icons.
imageUrl	string		Specifies a URL for an img element inside the Button. The URL can be relative or absolute. If relative, it is evaluated with relation to the web page URL.
rounded	ButtonRounded	'medium'	Sets the border radius of the Button. See Button Appearance.
selected	boolean	false	Sets the selected state of the Button. Use with the toggleable property.
size	ButtonSize	'medium'	Sets the padding of the Button. See Button Appearance.
svgIcon	SVGIcon		Sets an SVG icon to display inside the Button.
themeColor	ButtonThemeColor	'base'	Sets a predefined theme color for the Button. The theme color applies as a background and border color and adjusts the text color. See Button Appearance.
toggleable	boolean	false	Adds visual styling to indicate when the Button is active.

Events

Name	Type	Description
click	EventEmitter<any>	Fires when the user clicks the Button.
selectedChange	EventEmitter<any>	Fires when the selected state of a toggleable button changes. The event argument is the new selected state (boolean).

Methods

blur
Removes focus from the Button component.

focus
Focuses the Button component.