SpreadsheetTagHelper

Example

Razor
<kendo-spreadsheet>
    <default-cell-style />
    <excel />
    <pdf></pdf>
    <sheets></sheets>
    <toolbar></toolbar>
</kendo-spreadsheet>

ChildTags

Attributes

AttributeTypeDescription
nameStringSets the name of the component.
has-client-componentBoolean
deferredBooleanSuppress initialization script rendering. Note that this options should be used in conjunction with DeferredScripts method.
is-in-client-templateBooleanWhen placing a Tag Helper within a Kendo Template, set the type to text/html and add the is-in-client-template="true" attribute.
active-sheetStringThe name of the currently active sheet. Must exactly match one of the (sheet names)[#configuration-sheets.name].
as-moduleBoolean
columnsDoubleThe number of columns in the document.
column-widthDoubleThe default column width in pixels.
header-heightDoubleThe height of the header row in pixels.
header-widthDoubleThe width of the header column in pixels.
imagesObjectAn object containing any images used in the Spreadsheet. The keys should be image ID-s (they are referenced by this ID in (sheets.drawings)[#configuration-sheets.drawings]) and the values should be image URLs.The image URLs can be eitherdata URLs, in which case the images are fully contained by the JSON, or can be external URLs.Note that when external URLs are used, they should reside on the same domain, or the server must be configured with the properCORS headers, for the Spreadsheet to be able to fetch binary image data using a XMLHttpRequest. If it cannot fetch the image, export to Excel or PDF might not work.
on-changeStringTriggered when the range format is changed from the UI. Introduced in the 2017 Q1 release.
on-change-formatStringTriggered when the range format is changed from the UI. Introduced in the 2017 Q1 release.
on-changingStringTriggered when a value or validation in the Spreadsheet is about to be changed upon user interaction.
on-copyStringFired when a range of a sheet is about to be copied.
on-cutStringFired when a range of a sheet is about to be cut.
on-data-bindingStringFired when the data retrieved from a DataSource is about to be bound to a sheet. Available only if DataSource has been defined for at least one sheet.
on-data-boundStringFired when the data from a DataSource is already populated in a sheet. Available only if DataSource has been defined for at least one sheet.
on-delete-columnStringTriggered when a column will be deleted. Introduced in the 2017 Q1 release.
on-delete-rowStringTriggered when a row will be deleted. Introduced in the 2017 Q1 release.
on-excel-exportStringFires when the user clicks the Export to Excel toolbar button.
on-excel-importStringFired when the user clicks the Open toolbar button.
on-hide-columnStringTriggered when a column will be hidden. Introduced in the 2017 Q1 release.
on-hide-rowStringTriggered when a row will be hidden. Introduced in the 2017 Q1 release.
on-insert-columnStringTriggered when a column will be inserted. Introduced in the 2017 Q1 release.
on-insert-rowStringTriggered when a row will be inserted. Introduced in the 2017 Q1 release.
on-insert-sheetStringTriggered when a sheet is inserted. Introduced in the 2017 Q1 release.
on-pasteStringFired when a data is about to be pasted in a sheet.
on-pdf-exportStringFired when the user initiates the export to PDF.
on-remove-sheetStringTriggered when a sheet will be removed. Introduced in the 2017 Q1 release.
on-rename-sheetStringTriggered when a sheet will be renamed. Introduced in the 2017 Q1 release.
on-renderStringTriggered after the widget has completed rendering. The event will also fire when a cell is selected or when the Spreadsheet's tools (bold, italic) are used, as the target element is re-generated with new styles (e.g background-color, box-shadow, font-weight, etc.).
on-selectStringTriggered when a sheet will be activated. Introduced in the 2017 Q1 release.
on-select-sheetStringTriggered when a sheet will be activated. Introduced in the 2017 Q1 release.
on-unhide-columnStringTriggered when a column will be shown. Introduced in the 2017 Q1 release.
on-unhide-rowStringTriggered when a row will be shown. Introduced in the 2017 Q1 release.
row-heightDoubleThe default row height in pixels.
rowsDoubleThe number of rows in the document.
sanitize-idBoolean
script-attributesIDictionary<String,Object>
sheetsbarBooleanA Boolean value which indicates if the sheets-bar will be displayed.
use-culture-decimalsBooleanIf set to true, the Spreadsheet formula parser will obey the decimal separator of the current culture. If set to false (default), the decimal separator in formulas will always be the dot.This flag has implications on how formulas are entered. When it is set to true, in cultures where the decimal separator is the comma (,), similar to Excel, the following additional changes upon entering a formula will occur: The semicolon will become a function argument separator. For example, =SUM(A1;A2) instead of =SUM(A1,A2). or The backslash will become an element separator in an array formula. For example, ={1\2;3\4} instead of ={1,2;3,4}.. This flag only affects the presentation - the way formulas are entered by the end user or displayed on screen. Serialization to JSON or XLSX as well as the public API functions will continue to use the dot as decimal separator and the comma as an argument separator (canonical form). For example, to apply a formula by using the API, even if useCultureDecimals is in effect, you still need to use the canonical form.To make the API functions obey useCultureDecimals, wrap your code in a call to sheet.withCultureDecimals. Assuming a culture where the comma is used for decimals, compare the previous example with the following one.
In this article
ExampleChildTagsAttributes
Not finding the help you need?
Contact Support