Class Spreadsheet
Inheritance
System.Object
Spreadsheet
Assembly: Syncfusion.EJ2.dll
Syntax
public class Spreadsheet : EJTagHelper
Constructors
Spreadsheet()
Declaration
Properties
ActionBegin
Triggers when the Spreadsheet actions (such as editing, formatting, sorting etc..) are starts.
Declaration
public string ActionBegin { get; set; }
Property Value
Type |
Description |
System.String |
|
ActionComplete
Triggers when the spreadsheet actions (such as editing, formatting, sorting etc..) gets completed.
Declaration
public string ActionComplete { get; set; }
Property Value
Type |
Description |
System.String |
|
ActiveSheetIndex
Specifies active sheet index in workbook.
Declaration
public int ActiveSheetIndex { get; set; }
Property Value
Type |
Description |
System.Int32 |
|
AfterHyperlinkClick
Triggers when the Hyperlink function gets completed.
Declaration
public string AfterHyperlinkClick { get; set; }
Property Value
Type |
Description |
System.String |
|
AfterHyperlinkCreate
Triggers after the hyperlink inserted.
Declaration
public string AfterHyperlinkCreate { get; set; }
Property Value
Type |
Description |
System.String |
|
AllowAutoFill
Declaration
public bool AllowAutoFill { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
It allows you to apply styles (font size, font weight, font family, fill color, and more) to the spreadsheet cells.
Declaration
public bool AllowCellFormatting { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
AllowChart
Declaration
public bool AllowChart { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
It allows you to apply conditional formatting to the sheet.
Declaration
public bool AllowConditionalFormat { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
AllowDataValidation
It allows you to apply validation to the spreadsheet cells.
Declaration
public bool AllowDataValidation { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
AllowDelete
It allows you to delete rows, columns and sheets from spreadsheet.
Declaration
public bool AllowDelete { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
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
public bool AllowEditing { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
AllowFiltering
It allows to enable/disable filter and its functionalities.
Declaration
public bool AllowFiltering { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
AllowFindAndReplace
Declaration
public bool AllowFindAndReplace { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
AllowFreezePane
Declaration
public bool AllowFreezePane { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
AllowHyperlink
It allows to enable/disable Hyperlink and its functionalities.
Declaration
public bool AllowHyperlink { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
AllowImage
Declaration
public bool AllowImage { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
AllowInsert
It allows you to insert rows, columns and sheets in to the spreadsheet.
Declaration
public bool AllowInsert { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
AllowMerge
It allows you to merge the range of cells.
Declaration
public bool AllowMerge { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
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
public bool AllowNumberFormatting { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
AllowOpen
It allows you to open an Excel file (.xlsx, .xls, and .csv) in Spreadsheet.
Declaration
public bool AllowOpen { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
AllowResizing
If allowResizing
is set to true, spreadsheet columns and rows can be resized.
Declaration
public bool AllowResizing { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
AllowSave
It allows you to save Spreadsheet with all data as Excel file (.xlsx, .xls, and .csv).
Declaration
public bool AllowSave { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
Declaration
public bool AllowScrolling { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
AllowSorting
It allows to enable/disable sort and its functionalities.
Declaration
public bool AllowSorting { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
AllowUndoRedo
It allows to enable/disable undo and redo functionalities.
Declaration
public bool AllowUndoRedo { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
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
public bool AllowWrap { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
AutoFillSettings
Declaration
public object AutoFillSettings { get; set; }
Property Value
Type |
Description |
System.Object |
|
Triggers before the cell format applied to the cell.
Declaration
public string BeforeCellFormat { get; set; }
Property Value
Type |
Description |
System.String |
|
BeforeCellRender
Triggers before the cell appended to the DOM.
Declaration
public string BeforeCellRender { get; set; }
Property Value
Type |
Description |
System.String |
|
BeforeCellSave
Triggers when before the cell is saved.
Declaration
public string BeforeCellSave { get; set; }
Property Value
Type |
Description |
System.String |
|
BeforeCellUpdate
Declaration
public string BeforeCellUpdate { get; set; }
Property Value
Type |
Description |
System.String |
|
Declaration
public string BeforeConditionalFormat { get; set; }
Property Value
Type |
Description |
System.String |
|
BeforeDataBound
Triggers before the data is populated to the worksheet.
Declaration
public string BeforeDataBound { get; set; }
Property Value
Type |
Description |
System.String |
|
BeforeHyperlinkClick
Triggers when the Hyperlink is clicked.
Declaration
public string BeforeHyperlinkClick { get; set; }
Property Value
Type |
Description |
System.String |
|
BeforeHyperlinkCreate
Triggers before insert a hyperlink.
Declaration
public string BeforeHyperlinkCreate { get; set; }
Property Value
Type |
Description |
System.String |
|
BeforeOpen
Triggers before opening an Excel file.
Declaration
public string BeforeOpen { get; set; }
Property Value
Type |
Description |
System.String |
|
BeforeSave
Triggers before saving the Spreadsheet as Excel file.
Declaration
public string BeforeSave { get; set; }
Property Value
Type |
Description |
System.String |
|
BeforeSelect
Triggers before the cell or range of cells being selected.
Declaration
public string BeforeSelect { get; set; }
Property Value
Type |
Description |
System.String |
|
BeforeSort
Triggers before sorting the specified range.
Declaration
public string BeforeSort { get; set; }
Property Value
Type |
Description |
System.String |
|
CellEdit
Triggers when the cell is being edited.
Declaration
public string CellEdit { get; set; }
Property Value
Type |
Description |
System.String |
|
CellEditing
Triggers every time a request is made to access cell information.
This will be triggered when editing a cell.
Declaration
public string CellEditing { get; set; }
Property Value
Type |
Description |
System.String |
|
CellSave
Triggers when the edited cell is saved.
Declaration
public string CellSave { get; set; }
Property Value
Type |
Description |
System.String |
|
CellStyle
Specifies the cell style options.
Declaration
public SpreadsheetCommonCellStyle CellStyle { get; set; }
Property Value
ClassName
Declaration
protected override string ClassName { get; }
Property Value
Type |
Description |
System.String |
|
Overrides
Triggers before closing the context menu.
Declaration
public string ContextMenuBeforeClose { get; set; }
Property Value
Type |
Description |
System.String |
|
Triggers before opening the context menu and it allows customizing the menu items.
Declaration
public string ContextMenuBeforeOpen { get; set; }
Property Value
Type |
Description |
System.String |
|
Triggers when the context menu item is selected.
Declaration
public string ContextMenuItemSelect { get; set; }
Property Value
Type |
Description |
System.String |
|
Created
Triggers when the component is created.
Declaration
public string Created { get; set; }
Property Value
Type |
Description |
System.String |
|
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
public string CssClass { get; set; }
Property Value
Type |
Description |
System.String |
|
DataBound
Triggers when the data is populated in the worksheet.
Declaration
public string DataBound { get; set; }
Property Value
Type |
Description |
System.String |
|
DataSourceChanged
Declaration
public string DataSourceChanged { get; set; }
Property Value
Type |
Description |
System.String |
|
DefinedNames
Specifies the name for a range and uses it in formula for calculation.
Declaration
public List<DefinedName> DefinedNames { get; set; }
Property Value
Type |
Description |
System.Collections.Generic.List<DefinedName> |
|
DialogBeforeOpen
Triggers before opening the dialog box.
Declaration
public string DialogBeforeOpen { get; set; }
Property Value
Type |
Description |
System.String |
|
EnableClipboard
It enables or disables the clipboard operations (cut, copy, and paste) of the Spreadsheet.
Declaration
public bool EnableClipboard { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
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
public bool EnableContextMenu { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
EnableKeyboardNavigation
It allows you to interact with cell, pager, formula bar, and ribbon through the keyboard device.
Declaration
public bool EnableKeyboardNavigation { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
EnableKeyboardShortcut
It enables shortcut keys to perform Spreadsheet operations like open, save, copy, paste, and more.
Declaration
public bool EnableKeyboardShortcut { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
EnablePersistence
Enable or disable persisting component's state between page reloads.
Declaration
public bool EnablePersistence { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
EnableRtl
Enable or disable rendering component in right to left direction.
Declaration
public bool EnableRtl { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
Triggers before closing the file menu.
Declaration
public string FileMenuBeforeClose { get; set; }
Property Value
Type |
Description |
System.String |
|
Triggers before opening the file menu.
Declaration
public string FileMenuBeforeOpen { get; set; }
Property Value
Type |
Description |
System.String |
|
Triggers when the file menu item is selected.
Declaration
public string FileMenuItemSelect { get; set; }
Property Value
Type |
Description |
System.String |
|
filterCollection
Declaration
public List<FilterCollectionModel> filterCollection { get; set; }
Property Value
Height
Defines the height of the Spreadsheet. It accepts height as pixels, number, and percentage.
Declaration
public string Height { get; set; }
Property Value
Type |
Description |
System.String |
|
HtmlAttributes
Allows additional HTML attributes such as title, name, etc., and
accepts n number of attributes in a key-value pair format.
Declaration
public object HtmlAttributes { get; set; }
Property Value
Type |
Description |
System.Object |
|
IsFor
Declaration
protected override bool IsFor { get; }
Property Value
Type |
Description |
System.Boolean |
|
Overrides
IsProtected
Declaration
public bool IsProtected { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
Locale
Overrides the global culture and localization value for this component. Default global culture is 'en-US'.
Declaration
public string Locale { get; set; }
Property Value
Type |
Description |
System.String |
|
NameSpace
Declaration
protected override string NameSpace { get; }
Property Value
Type |
Description |
System.String |
|
Overrides
OpenComplete
Triggers when the spreadsheet importing gets completed.
Declaration
public string OpenComplete { get; set; }
Property Value
Type |
Description |
System.String |
|
OpenFailure
Triggers when the opened Excel file fails to load.
Declaration
public string OpenFailure { get; set; }
Property Value
Type |
Description |
System.String |
|
OpenUrl
Specifies the service URL to open excel file in spreadsheet.
Declaration
public string OpenUrl { get; set; }
Property Value
Type |
Description |
System.String |
|
Password
Declaration
public string Password { get; set; }
Property Value
Type |
Description |
System.String |
|
QueryCellInfo
Triggered every time a request is made to access cell information.
Declaration
public string QueryCellInfo { get; set; }
Property Value
Type |
Description |
System.String |
|
SaveComplete
Triggers after saving the Spreadsheet as Excel file.
Declaration
public string SaveComplete { get; set; }
Property Value
Type |
Description |
System.String |
|
SaveUrl
Specifies the service URL to save spreadsheet as Excel file.
Declaration
public string SaveUrl { get; set; }
Property Value
Type |
Description |
System.String |
|
Configures the scroll settings.
The allowScrolling
property should be true
.
Declaration
public SpreadsheetScrollSettings ScrollSettings { get; set; }
Property Value
Select
Triggers after the cell or range of cells is selected.
Declaration
public string Select { get; set; }
Property Value
Type |
Description |
System.String |
|
SelectionSettings
Configures the selection settings.
typescript
new Spreadsheet({
selectionSettings: {
mode: 'None'
}
...
}, '#Spreadsheet');
Declaration
public SpreadsheetSelectionSettings SelectionSettings { get; set; }
Property Value
Sheets
Configures sheets and its options.
Declaration
public List<Sheet> Sheets { get; set; }
Property Value
Type |
Description |
System.Collections.Generic.List<Sheet> |
|
ShowAggregate
Declaration
public bool ShowAggregate { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
It shows or hides the formula bar and its features.
Declaration
public bool ShowFormulaBar { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
ShowRibbon
It shows or hides the ribbon in spreadsheet.
Declaration
public bool ShowRibbon { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
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
public bool ShowSheetTabs { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
sortCollection
Declaration
public List<SortCollectionModel> sortCollection { get; set; }
Property Value
SortComplete
Triggers after sorting action is completed.
Declaration
public string SortComplete { get; set; }
Property Value
Type |
Description |
System.String |
|
TagName
Declaration
protected override string TagName { get; }
Property Value
Type |
Description |
System.String |
|
Overrides
Width
Defines the width of the Spreadsheet. It accepts width as pixels, number, and percentage.
Declaration
public string Width { get; set; }
Property Value
Type |
Description |
System.String |
|