Class Spreadsheet
Inherited Members
Namespace: Syncfusion.EJ2.Spreadsheet
Assembly: Syncfusion.EJ2.dll
Syntax
public class Spreadsheet : EJTagHelper
Constructors
Spreadsheet()
Declaration
public Spreadsheet()
Properties
ActionBegin
Triggers when the Spreadsheet actions (such as editing, formatting, sorting etc..) are starts.
Declaration
[HtmlAttributeName("actionBegin")]
public string ActionBegin { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
ActionComplete
Triggers when the spreadsheet actions (such as editing, formatting, sorting etc..) gets completed.
Declaration
[HtmlAttributeName("actionComplete")]
public string ActionComplete { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
ActiveSheetIndex
Specifies the active sheet index in the workbook.
Declaration
[HtmlAttributeName("activeSheetIndex")]
public int ActiveSheetIndex { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 | The default value is 0 |
AfterHyperlinkClick
Triggers when the Hyperlink function gets completed.
Declaration
[HtmlAttributeName("afterHyperlinkClick")]
public string AfterHyperlinkClick { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
AfterHyperlinkCreate
Triggers after the hyperlink inserted.
Declaration
[HtmlAttributeName("afterHyperlinkCreate")]
public string AfterHyperlinkCreate { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
AllowAutoFill
It allows to enable/disable AutoFill functionalities.
Declaration
[HtmlAttributeName("allowAutoFill")]
public bool AllowAutoFill { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is true |
AllowCellFormatting
It allows you to apply styles (font size, font weight, font family, fill color, and more) to the spreadsheet cells.
Declaration
[HtmlAttributeName("allowCellFormatting")]
public bool AllowCellFormatting { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is true |
AllowChart
It allows you to insert the chart in a spreadsheet.
Declaration
[HtmlAttributeName("allowChart")]
public bool AllowChart { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is true |
AllowConditionalFormat
It allows you to apply conditional formatting to the sheet.
Declaration
[HtmlAttributeName("allowConditionalFormat")]
public bool AllowConditionalFormat { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is true |
AllowDataValidation
It allows you to apply data validation to the spreadsheet cells.
Declaration
[HtmlAttributeName("allowDataValidation")]
public bool AllowDataValidation { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is true |
AllowDelete
It allows you to delete rows, columns, and sheets from a spreadsheet.
Declaration
[HtmlAttributeName("allowDelete")]
public bool AllowDelete { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is true |
AllowEditing
It allows you to add new data or update existing cell data. If it is false, it will act as read only mode.
Declaration
[HtmlAttributeName("allowEditing")]
public bool AllowEditing { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is true |
AllowFiltering
It allows to enable/disable filter and its functionalities.
Declaration
[HtmlAttributeName("allowFiltering")]
public bool AllowFiltering { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is true |
AllowFindAndReplace
It allows to enable/disable find and replace with its functionalities.
Declaration
[HtmlAttributeName("allowFindAndReplace")]
public bool AllowFindAndReplace { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is true |
AllowFreezePane
It allows to enable/disable freeze pane functionality in spreadsheet.
Declaration
[HtmlAttributeName("allowFreezePane")]
public bool AllowFreezePane { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is true |
AllowHyperlink
It allows to enable/disable Hyperlink and its functionalities.
Declaration
[HtmlAttributeName("allowHyperlink")]
public bool AllowHyperlink { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is true |
AllowImage
It allows you to insert the image in a spreadsheet.
Declaration
[HtmlAttributeName("allowImage")]
public bool AllowImage { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is true |
AllowInsert
It allows you to insert rows, columns, and sheets into the spreadsheet.
Declaration
[HtmlAttributeName("allowInsert")]
public bool AllowInsert { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is true |
AllowMerge
It allows you to merge the range of cells.
Declaration
[HtmlAttributeName("allowMerge")]
public bool AllowMerge { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is true |
AllowNumberFormatting
It allows formatting a raw number into different types of formats (number, currency, accounting, percentage, short date, long date, time, fraction, scientific, and text) with built-in format codes.
Declaration
[HtmlAttributeName("allowNumberFormatting")]
public bool AllowNumberFormatting { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is true |
AllowOpen
It allows you to open an Excel file (.xlsx, .xls, and .csv) in Spreadsheet.
Declaration
[HtmlAttributeName("allowOpen")]
public bool AllowOpen { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is true |
AllowResizing
If allowResizing
is set to true, spreadsheet columns and rows can be resized.
Declaration
[HtmlAttributeName("allowResizing")]
public bool AllowResizing { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is true |
AllowSave
It allows you to save Spreadsheet with all data as Excel file (.xlsx, .xls, and .csv).
Declaration
[HtmlAttributeName("allowSave")]
public bool AllowSave { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is true |
AllowScrolling
It specifies whether the Spreadsheet should be rendered with scrolling or not.
To customize the Spreadsheet scrolling behavior, use the scrollSettings
property.
Declaration
[HtmlAttributeName("allowScrolling")]
public bool AllowScrolling { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is true |
AllowSorting
It allows to enable/disable sort and its functionalities.
Declaration
[HtmlAttributeName("allowSorting")]
public bool AllowSorting { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is true |
AllowUndoRedo
It allows to enable/disable undo and redo functionalities.
Declaration
[HtmlAttributeName("allowUndoRedo")]
public bool AllowUndoRedo { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is true |
AllowWrap
It allows to enable/disable wrap text feature. By using this feature the wrapping applied cell text can wrap to the next line, if the text width exceeds the column width.
Declaration
[HtmlAttributeName("allowWrap")]
public bool AllowWrap { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is true |
AutoFillSettings
Configures the auto fill settings.
Declaration
[HtmlAttributeName("autoFillSettings")]
public object AutoFillSettings { get; set; }
Property Value
Type | Description |
---|---|
System.Object | The default value is null |
BeforeCellFormat
Triggers before the cell format applied to the cell.
Declaration
[HtmlAttributeName("beforeCellFormat")]
public string BeforeCellFormat { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
BeforeCellRender
Triggers before the cell appended to the DOM.
Declaration
[HtmlAttributeName("beforeCellRender")]
public string BeforeCellRender { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
BeforeCellSave
Triggers when before the cell is saved.
Declaration
[HtmlAttributeName("beforeCellSave")]
public string BeforeCellSave { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
BeforeCellUpdate
Triggers before changing any cell properties.
Declaration
[HtmlAttributeName("beforeCellUpdate")]
public string BeforeCellUpdate { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
BeforeConditionalFormat
Triggers before apply or remove the conditional format from a cell in a range.
Declaration
[HtmlAttributeName("beforeConditionalFormat")]
public string BeforeConditionalFormat { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
BeforeDataBound
Triggers before the data is populated to the worksheet.
Declaration
[HtmlAttributeName("beforeDataBound")]
public string BeforeDataBound { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
BeforeHyperlinkClick
Triggers when the Hyperlink is clicked.
Declaration
[HtmlAttributeName("beforeHyperlinkClick")]
public string BeforeHyperlinkClick { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
BeforeHyperlinkCreate
Triggers before insert a hyperlink.
Declaration
[HtmlAttributeName("beforeHyperlinkCreate")]
public string BeforeHyperlinkCreate { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
BeforeOpen
Triggers before opening an Excel file.
Declaration
[HtmlAttributeName("beforeOpen")]
public string BeforeOpen { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
BeforeSave
Triggers before saving the Spreadsheet as Excel file.
Declaration
[HtmlAttributeName("beforeSave")]
public string BeforeSave { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
BeforeSelect
Triggers before the cell or range of cells being selected.
Declaration
[HtmlAttributeName("beforeSelect")]
public string BeforeSelect { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
BeforeSort
Triggers before sorting the specified range.
Declaration
[HtmlAttributeName("beforeSort")]
public string BeforeSort { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
CellEdit
Triggers when the cell is being edited.
Declaration
[HtmlAttributeName("cellEdit")]
public string CellEdit { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
CellEditing
Triggers every time a request is made to access cell information. This will be triggered when editing a cell.
Declaration
[HtmlAttributeName("cellEditing")]
public string CellEditing { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
CellSave
Triggers when the edited cell is saved.
Declaration
[HtmlAttributeName("cellSave")]
public string CellSave { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
CellStyle
Specifies the cell style options.
Declaration
[HtmlAttributeName("cellStyle")]
public SpreadsheetCommonCellStyle CellStyle { get; set; }
Property Value
Type | Description |
---|---|
SpreadsheetCommonCellStyle | The default value is null |
ContextMenuBeforeClose
Triggers before closing the context menu.
Declaration
[HtmlAttributeName("contextMenuBeforeClose")]
public string ContextMenuBeforeClose { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
ContextMenuBeforeOpen
Triggers before opening the context menu and it allows customizing the menu items.
Declaration
[HtmlAttributeName("contextMenuBeforeOpen")]
public string ContextMenuBeforeOpen { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
ContextMenuItemSelect
Triggers when the context menu item is selected.
Declaration
[HtmlAttributeName("contextMenuItemSelect")]
public string ContextMenuItemSelect { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
Created
Triggers when the component is created.
Declaration
[HtmlAttributeName("created")]
public string Created { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
CssClass
To specify a CSS class or multiple CSS class separated by a space, add it in the Spreadsheet root element. This allows you to customize the appearance of component.
Declaration
[HtmlAttributeName("cssClass")]
public string CssClass { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is "" |
DataBound
Triggers when the data is populated in the worksheet.
Declaration
[HtmlAttributeName("dataBound")]
public string DataBound { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
DataSourceChanged
Triggers during data changes when the data is provided as dataSource
in the Spreadsheet.
Declaration
[HtmlAttributeName("dataSourceChanged")]
public string DataSourceChanged { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
DefinedNames
Specifies the name of a range and uses it in a formula for calculation.
Declaration
[HtmlAttributeName("definedNames")]
public List<DefinedName> DefinedNames { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<DefinedName> | The default value is null |
DialogBeforeOpen
Triggers before opening the dialog box.
Declaration
[HtmlAttributeName("dialogBeforeOpen")]
public string DialogBeforeOpen { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
EnableClipboard
It enables or disables the clipboard operations (cut, copy, and paste) of the Spreadsheet.
Declaration
[HtmlAttributeName("enableClipboard")]
public bool EnableClipboard { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is true |
EnableContextMenu
It enables or disables the context menu option of spreadsheet. By default, context menu will opens for row header, column header, sheet tabs, and cell.
Declaration
[HtmlAttributeName("enableContextMenu")]
public bool EnableContextMenu { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is true |
EnableKeyboardNavigation
It allows you to interact with cell, sheet tabs, formula bar, and ribbon through the keyboard device.
Declaration
[HtmlAttributeName("enableKeyboardNavigation")]
public bool EnableKeyboardNavigation { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is true |
EnableKeyboardShortcut
It enables shortcut keys to perform Spreadsheet operations like open, save, copy, paste, and more.
Declaration
[HtmlAttributeName("enableKeyboardShortcut")]
public bool EnableKeyboardShortcut { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is true |
EnablePersistence
Enable or disable persisting component's state between page reloads.
Declaration
[HtmlAttributeName("enablePersistence")]
public bool EnablePersistence { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is false |
EnableRtl
Enable or disable rendering component in right to left direction.
Declaration
[HtmlAttributeName("enableRtl")]
public bool EnableRtl { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is false |
FileMenuBeforeClose
Triggers before closing the file menu.
Declaration
[HtmlAttributeName("fileMenuBeforeClose")]
public string FileMenuBeforeClose { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
FileMenuBeforeOpen
Triggers before opening the file menu.
Declaration
[HtmlAttributeName("fileMenuBeforeOpen")]
public string FileMenuBeforeOpen { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
FileMenuItemSelect
Triggers when the file menu item is selected.
Declaration
[HtmlAttributeName("fileMenuItemSelect")]
public string FileMenuItemSelect { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
filterCollection
Specifies Filter Type.
Declaration
[HtmlAttributeName("filterCollection")]
public List<FilterCollectionModel> filterCollection { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<FilterCollectionModel> |
Height
Defines the height of the Spreadsheet. It accepts height as pixels, number, and percentage.
Declaration
[HtmlAttributeName("height")]
public string Height { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is "100%" |
HtmlAttributes
Allows additional HTML attributes such as title, name, etc., and accepts n number of attributes in a key-value pair format.
Declaration
[HtmlAttributeName("htmlAttributes")]
public object HtmlAttributes { get; set; }
Property Value
Type | Description |
---|---|
System.Object |
IsProtected
Specifies to protect the workbook.
Declaration
[HtmlAttributeName("isProtected")]
public bool IsProtected { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is false |
Locale
Overrides the global culture and localization value for this component. Default global culture is 'en-US'.
Declaration
[HtmlAttributeName("locale")]
public string Locale { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is "" |
OpenComplete
Triggers when the spreadsheet importing gets completed.
Declaration
[HtmlAttributeName("openComplete")]
public string OpenComplete { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
OpenFailure
Triggers when the opened Excel file fails to load.
Declaration
[HtmlAttributeName("openFailure")]
public string OpenFailure { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
OpenUrl
Specifies the service URL to open excel file in spreadsheet.
Declaration
[HtmlAttributeName("openUrl")]
public string OpenUrl { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is "" |
Password
Specifies the password.
Declaration
[HtmlAttributeName("password")]
public string Password { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is "" |
QueryCellInfo
Triggered every time a request is made to access cell information.
Declaration
[HtmlAttributeName("queryCellInfo")]
public string QueryCellInfo { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
SaveComplete
Triggers after saving the Spreadsheet as Excel file.
Declaration
[HtmlAttributeName("saveComplete")]
public string SaveComplete { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
SaveUrl
Specifies the service URL to save spreadsheet as Excel file.
Declaration
[HtmlAttributeName("saveUrl")]
public string SaveUrl { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is "" |
ScrollSettings
Configures the scroll settings.
Declaration
[HtmlAttributeName("scrollSettings")]
public SpreadsheetScrollSettings ScrollSettings { get; set; }
Property Value
Type | Description |
---|---|
SpreadsheetScrollSettings | The default value is null |
Select
Triggers after the cell or range of cells is selected.
Declaration
[HtmlAttributeName("select")]
public string Select { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
SelectionSettings
Configures the selection settings.
Declaration
[HtmlAttributeName("selectionSettings")]
public SpreadsheetSelectionSettings SelectionSettings { get; set; }
Property Value
Type | Description |
---|---|
SpreadsheetSelectionSettings | The default value is null |
Sheets
Configures sheets and its options.
Declaration
[HtmlAttributeName("sheets")]
public List<Sheet> Sheets { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<Sheet> | The default value is null |
ShowAggregate
If showAggregate
is set to true, spreadsheet will show the AVERAGE, SUM, COUNT, MIN and MAX values based on the selected cells.
Declaration
[HtmlAttributeName("showAggregate")]
public bool ShowAggregate { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is true |
ShowFormulaBar
It shows or hides the formula bar and its features.
Declaration
[HtmlAttributeName("showFormulaBar")]
public bool ShowFormulaBar { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is true |
ShowRibbon
It shows or hides the ribbon in spreadsheet.
Declaration
[HtmlAttributeName("showRibbon")]
public bool ShowRibbon { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is true |
ShowSheetTabs
It shows or hides the sheets tabs, this is used to navigate among the sheets and create or delete sheets by UI interaction.
Declaration
[HtmlAttributeName("showSheetTabs")]
public bool ShowSheetTabs { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is true |
sortCollection
Specifies sort Type.
Declaration
[HtmlAttributeName("sortCollection")]
public List<SortCollectionModel> sortCollection { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<SortCollectionModel> |
SortComplete
Triggers after sorting action is completed.
Declaration
[HtmlAttributeName("sortComplete")]
public string SortComplete { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
Width
Defines the width of the Spreadsheet. It accepts width as pixels, number, and percentage.
Declaration
[HtmlAttributeName("width")]
public string Width { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is "100%" |