Class Spreadsheet

Represents a class for Spreadsheet control.

Inheritance

System.Object

CommonDataBoundControl

Spreadsheet

Implements

System.Web.UI.INamingContainer

System.Web.UI.IPostBackEventHandler

System.Web.UI.IPostBackDataHandler

System.Web.UI.IUrlResolutionService

Inherited Members

CommonDataBoundControl.PerformDataBinding(IEnumerable)

CommonDataBoundControl.RaisePostBackEvent(String)

CommonDataBoundControl.OnLoad(EventArgs)

CommonDataBoundControl.OnPreRender(EventArgs)

CommonDataBoundControl.RenderContents(HtmlTextWriter)

Namespace: Syncfusion.JavaScript.Web

Assembly: Syncfusion.EJ.Web.dll

Syntax

public class Spreadsheet : CommonDataBoundControl, INamingContainer, IPostBackEventHandler, IPostBackDataHandler, IUrlResolutionService

Constructors

Spreadsheet()

Declaration

public Spreadsheet()

Properties

ActivationPanelWidth

Gets or sets a value for Activation Panel width.

Declaration

public int ActivationPanelWidth { get; set; }

Property Value

Type	Description
System.Int32	The activation panel width.

ActiveSheetIndex

Gets or sets a value for Active Sheet Index.

Declaration

public int ActiveSheetIndex { get; set; }

Property Value

Type	Description
System.Int32	The active sheet Index of Spreadsheet.

AllowAutoCellType

Gets or sets a value indicating whether to enable or disable Auto Cell Type.

Declaration

public bool AllowAutoCellType { get; set; }

Property Value

Type	Description
System.Boolean	langword_csharp_True if the auto cell type is enable; otherwise, false.

AllowAutoFill

Gets or sets a value indicating whether to enable or disable AutoFill.

Declaration

public bool AllowAutoFill { get; set; }

Property Value

Type	Description
System.Boolean	langword_csharp_True if the autofill is enable; otherwise, false.

AllowAutoSum

Gets or sets a value indicating whether to enable or disable Autosum.

Declaration

public bool AllowAutoSum { get; set; }

Property Value

Type	Description
System.Boolean	langword_csharp_True if the autosum is enable; otherwise, false.

AllowCellFormatting

Gets or sets a value indicating whether to enable or disable Cell Formatting .

Declaration

public bool AllowCellFormatting { get; set; }

Property Value

Type	Description
System.Boolean	langword_csharp_True if the cell formatting is enable; otherwise, false.

AllowCellType

Gets or sets a value indicating whether to enable or disable Cell Type.

Declaration

public bool AllowCellType { get; set; }

Property Value

Type	Description
System.Boolean	langword_csharp_True if the cell type is enable; otherwise, false.

AllowCharts

Gets or sets a value indicating whether to enable or disable Charts.

Declaration

public bool AllowCharts { get; set; }

Property Value

Type	Description
System.Boolean	langword_csharp_True if the charts is enable; otherwise, false.

AllowClear

Gets or sets a value indicating whether to enable or disble allowClear.

Declaration

public bool AllowClear { get; set; }

Property Value

Type	Description
System.Boolean	langword_csharp_True if the clear is enable; otherwise, false.

AllowClipboard

Gets or sets a value indicating whether to enable or disable Clipboard Operations.

Declaration

public bool AllowClipboard { get; set; }

Property Value

Type	Description
System.Boolean	langword_csharp_True if the clipboard is enable; otherwise, false.

AllowComments

Gets or sets a value indicating whether to enable or disble Comments.

Declaration

public bool AllowComments { get; set; }

Property Value

Type	Description
System.Boolean	langword_csharp_True if the comments is enable; otherwise, false.

AllowConditionalFormats

Gets or sets a value indicating whether to enable or disable Conditional Formatting.

Declaration

public bool AllowConditionalFormats { get; set; }

Property Value

Type	Description
System.Boolean	langword_csharp_True if the conditional formatting is enable; otherwise, false.

AllowDataValidation

Gets or sets a value indicating whether to enable or disable Data Validation.

Declaration

public bool AllowDataValidation { get; set; }

Property Value

Type	Description
System.Boolean	langword_csharp_True if the data validation is enable; otherwise, false.

AllowDelete

Gets or sets a value indicating whether to enable or disable Delete property.

Declaration

public bool AllowDelete { get; set; }

Property Value

Type	Description
System.Boolean	langword_csharp_True if the delete option is enable; otherwise, false.

AllowDragAndDrop

Gets or sets a value indicating whether to enable or disable Drag and Drop.

Declaration

public bool AllowDragAndDrop { get; set; }

Property Value

Type	Description
System.Boolean	langword_csharp_True if the drag and drop is enable; otherwise, false.

AllowEditing

Gets or sets a value indicating whether to enable or disable Editing.

Declaration

public bool AllowEditing { get; set; }

Property Value

Type	Description
System.Boolean	langword_csharp_True if the editing is enable; otherwise, false.

AllowFiltering

Gets or sets a value indicating whether to enable or disable Filtering.

Declaration

public bool AllowFiltering { get; set; }

Property Value

Type	Description
System.Boolean	langword_csharp_True if the filtering is enable; otherwise, false.

AllowFormatAsTable

Gets or sets a value indicating whether to enable or disable Table.

Declaration

public bool AllowFormatAsTable { get; set; }

Property Value

Type	Description
System.Boolean	langword_csharp_True if the format table is enable; otherwise, false.

AllowFormatPainter

Gets or sets a value indicating whether to enable or disable Format Painter.

Declaration

public bool AllowFormatPainter { get; set; }

Property Value

Type	Description
System.Boolean	langword_csharp_True if the format painter is enable; otherwise, false.

AllowFormulaBar

Gets or sets a value indicating whether to enable or disable Formula Bar.

Declaration

public bool AllowFormulaBar { get; set; }

Property Value

Type	Description
System.Boolean	langword_csharp_True if the formula bar is enable; otherwise, false.

AllowFreezing

Gets or sets a value indicating whether to enable or disable Freeze Panes.

Declaration

public bool AllowFreezing { get; set; }

Property Value

Type	Description
System.Boolean	langword_csharp_True if the freezing is enable; otherwise, false.

AllowHyperlink

Gets or sets a value indicating whether to enable or disable Hyperlink.

Declaration

public bool AllowHyperlink { get; set; }

Property Value

Type	Description
System.Boolean	langword_csharp_True if the hyperlink is enable; otherwise, false.

AllowImport

Gets or sets a value indicating whether to enable or disable Import.

Declaration

public bool AllowImport { get; set; }

Property Value

Type	Description
System.Boolean	langword_csharp_True if the import is enable; otherwise, false.

AllowInsert

Gets or sets a value indicating whether to enable or disable Insert.

Declaration

public bool AllowInsert { get; set; }

Property Value

Type	Description
System.Boolean	langword_csharp_True if the insert option is enable; otherwise, false.

AllowKeyboardNavigation

Gets or sets a value indicating whether to enable or disable Keyboard Navigation.

Declaration

public bool AllowKeyboardNavigation { get; set; }

Property Value

Type	Description
System.Boolean	langword_csharp_True if the keyboard navigation is enable; otherwise, false.

AllowLockCell

Gets or sets a value indicating whether to enable or disable Lock Cells.

Declaration

public bool AllowLockCell { get; set; }

Property Value

Type	Description
System.Boolean	langword_csharp_True if the lock cell is enable; otherwise, false.

AllowMerging

Gets or sets a value indicating whether to enable or disable Merging.

Declaration

public bool AllowMerging { get; set; }

Property Value

Type	Description
System.Boolean	langword_csharp_True if the merging is enable; otherwise, false.

AllowOverflow

Gets or sets a value indicating whether Overflow is enable or not.

Declaration

public bool AllowOverflow { get; set; }

Property Value

Type	Description
System.Boolean	langword_csharp_True if the text is overflow ; otherwise not overflow, false.

AllowResizing

Gets or sets a value indicating whether to enable or disable Resizing.

Declaration

public bool AllowResizing { get; set; }

Property Value

Type	Description
System.Boolean	langword_csharp_True if the resizing is enable; otherwise, false.

AllowSearching

Gets or sets a value indicating whether to enable or disable Searching.

Declaration

public bool AllowSearching { get; set; }

Property Value

Type	Description
System.Boolean	langword_csharp_True if the searching is enable; otherwise, false.

AllowSelection

Gets or sets a value indicating whether to enable or disable Selection.

Declaration

public bool AllowSelection { get; set; }

Property Value

Type	Description
System.Boolean	langword_csharp_True if the selection is enable; otherwise, false.

AllowSorting

Gets or sets a value indicating whether to enable or disable Sorting.

Declaration

public bool AllowSorting { get; set; }

Property Value

Type	Description
System.Boolean	langword_csharp_True if the sorting is enable; otherwise, false.

AllowSparkline

Gets or sets a value indicating whether to enable or disable Sparkline Chart.

Declaration

public bool AllowSparkline { get; set; }

Property Value

Type	Description
System.Boolean	langword_csharp_True if the Sparkline Chart is enable; otherwise, false.

AllowUndoRedo

Gets or sets a value indicating whether to enable or disable Undo Redo.

Declaration

public bool AllowUndoRedo { get; set; }

Property Value

Type	Description
System.Boolean	langword_csharp_True if the undo and redo is enable; otherwise, false.

AllowWrap

Gets or sets a value indicating whether to enable or disable Wrap.

Declaration

public bool AllowWrap { get; set; }

Property Value

Type	Description
System.Boolean	langword_csharp_True if the wrap is enable; otherwise, false.

ApWidth

Gets or sets a value for Activation Panel width.

Declaration

public int ApWidth { get; set; }

Property Value

Type	Description
System.Int32	The activation panel width.

AutoFillSettings

Gets or sets a value for AutoFill settings.

Declaration

public SpreadsheetAutoFillSettings AutoFillSettings { get; set; }

Property Value

Type	Description
SpreadsheetAutoFillSettings	The autofill settings.

ChartSettings

Gets or sets a value for Chart settings.

Declaration

public SpreadsheetChartSettings ChartSettings { get; set; }

Property Value

Type	Description
SpreadsheetChartSettings	The chart settings.

ClientSideEvents

Spreadsheet Client Side Events

Declaration

public SpreadsheetClientSideEvents ClientSideEvents { get; set; }

Property Value

Type	Description
SpreadsheetClientSideEvents

ColumnCount

Gets or sets a value for Column Count.

Declaration

public int ColumnCount { get; set; }

Property Value

Type	Description
System.Int32	The column count value.

ColumnWidth

Gets or sets a value for Column Width.

Declaration

public int ColumnWidth { get; set; }

Property Value

Type	Description
System.Int32	The column width value.

CssClass

Gets or sets the Cascading Style Sheet (CSS) class rendered by the Web Server control on the client.

Declaration

public override string CssClass { get; set; }

Property Value

Type	Description
System.String	The CSS class rendered by the Web server control on the client. The default is System.String.Empty.

CustomFormula

Gets or sets the Custom Formula.

Declaration

public List<CustomFormula> CustomFormula { get; }

Property Value

Type	Description
System.Collections.Generic.List<CustomFormula>	The custom formula collection.

DataSourceCachingMode

Gets or sets a value for Datasource Caching Mode.

Declaration

public DataSourceCachingMode DataSourceCachingMode { get; set; }

Property Value

Type	Description
DataSourceCachingMode	The type of caching mode.

EnableContextMenu

Gets or sets a value indicating whether to enable or disable Context Menu.

Declaration

public bool EnableContextMenu { get; set; }

Property Value

Type	Description
System.Boolean	langword_csharp_True if the context menu is enable; otherwise, false.

EnablePersistence

Gets or sets a value indicating whether to enable or disable Persistence.

Declaration

public bool EnablePersistence { get; set; }

Property Value

Type	Description
System.Boolean	langword_csharp_True if the persistence is enable; otherwise, false.

EnablePivotTable

Gets or sets a value indicating whether to enable or disable Pivot Table.

Declaration

public bool EnablePivotTable { get; set; }

Property Value

Type	Description
System.Boolean	langword_csharp_True if the pivot table is enable; otherwise, false.

EnableTouch

Gets or sets a value indicating whether to enable or disable Touch.

Declaration

public bool EnableTouch { get; set; }

Property Value

Type	Description
System.Boolean	langword_csharp_True if the touch is enable; otherwise, false.

ExportSettings

Gets or sets a value for Spreadsheet Export settings.

Declaration

public SpreadsheetExportSettings ExportSettings { get; set; }

Property Value

Type	Description
SpreadsheetExportSettings	The export settings

FormatSettings

Gets or sets a value for Spreadsheet Format settings.

Declaration

public SpreadsheetFormatSettings FormatSettings { get; set; }

Property Value

Type	Description
SpreadsheetFormatSettings	The format settings

Height

Gets or sets a value to define the height of the Spreadsheet.

Declaration

public override Unit Height { get; set; }

Property Value

Type	Description
System.Web.UI.WebControls.Unit

ImportSettings

Gets or sets a value for Spreadsheet Import settings.

Declaration

public SpreadsheetImportSettings ImportSettings { get; set; }

Property Value

Type	Description
SpreadsheetImportSettings	The import settings.

IsReadOnly

Gets or sets a value indicating is readOnly mode in spreadsheet content.

Declaration

public bool IsReadOnly { get; set; }

Property Value

Type	Description
System.Boolean	langword_csharp_True if the isReadonly is enable; otherwise, false.

Locale

Gets or sets the locale.

Declaration

public string Locale { get; set; }

Property Value

Type	Description
System.String	The locale value.

Model

Represents a Spreadsheet model.

Declaration

public WorkbookProperties Model { get; set; }

Property Value

Type	Description
WorkbookProperties	The Spreadsheet model.

NameManagers

Gets or sets the Name Manager.

Declaration

public List<NameManager> NameManagers { get; }

Property Value

Type	Description
System.Collections.Generic.List<NameManager>	The name managers collection.

PageSettings

Gets or sets a value for Spreadsheet Page settings.

Declaration

public SpreadsheetPageSettings PageSettings { get; set; }

Property Value

Type	Description
SpreadsheetPageSettings	The page settings value.

PageSize

Gets or sets a value for page size.

Declaration

public SpreadsheetPageSize PageSize { get; set; }

Property Value

Type	Description
SpreadsheetPageSize	The Page size value.

PictureSettings

Gets or sets a value for Picture settings.

Declaration

public SpreadsheetPictureSettings PictureSettings { get; set; }

Property Value

Type	Description
SpreadsheetPictureSettings	The picture settings.

PrintSettings

Gets or sets a value for Print settings.

Declaration

public SpreadsheetPrintSettings PrintSettings { get; set; }

Property Value

Type	Description
SpreadsheetPrintSettings	The print settings.

RibbonSettings

Gets or sets a value for Spreadsheet ribbon settings.

Declaration

public SpreadsheetRibbonSettings RibbonSettings { get; set; }

Property Value

Type	Description
SpreadsheetRibbonSettings	The export settings

RowCount

Gets or sets a value for Row Count.

Declaration

public int RowCount { get; set; }

Property Value

Type	Description
System.Int32	The row count value.

RowHeight

Gets or sets a value for Row Height.

Declaration

public int RowHeight { get; set; }

Property Value

Type	Description
System.Int32	The Row height value.

ScrollSettings

Gets or sets a value for Scroll settings.

Declaration

public SpreadsheetScrollSettings ScrollSettings { get; set; }

Property Value

Type	Description
SpreadsheetScrollSettings	The scroll settings value.

SelectionSettings

Gets or sets a value for Selection settings.

Declaration

public SpreadsheetSelectionSettings SelectionSettings { get; set; }

Property Value

Type	Description
SpreadsheetSelectionSettings	The Selection settings.

SheetCount

Gets or sets a value for Sheet Count.

Declaration

public int SheetCount { get; set; }

Property Value

Type	Description
System.Int32	The sheet count value.

Sheets

Gets or sets a value for Sheet settings.

Declaration

public List<Sheet> Sheets { get; }

Property Value

Type	Description
System.Collections.Generic.List<Sheet>	The sheet settings.

ShowPager

Gets or sets a value indicating whether to enable or disable Pager.

Declaration

public bool ShowPager { get; set; }

Property Value

Type	Description
System.Boolean	langword_csharp_True if the pager is enable; otherwise, false.

ShowRibbon

Gets or sets a value indicating whether to enable or disable ribbon.

Declaration

public bool ShowRibbon { get; set; }

Property Value

Type	Description
System.Boolean	langword_csharp_True if the ribbon is enable; otherwise, false.

UndoredoStep

Gets or sets the Undo Redo Step value.

Declaration

public int UndoredoStep { get; set; }

Property Value

Type	Description
System.Int32	The undo redo step value.

UserName

Gets or sets Username.

Declaration

public string UserName { get; set; }

Property Value

Type	Description
System.String	The Username value.

Width

Gets or sets a value to define the width of the Spreadsheet.

Declaration

public override Unit Width { get; set; }

Property Value

Type	Description
System.Web.UI.WebControls.Unit

Methods

DependentScripts()

To get the dependant scripts.

Declaration

public List<string> DependentScripts()

Returns

Type	Description
System.Collections.Generic.List<System.String>	The collection of scripts.

FetchData(IEnumerable)

Gets or sets the data to render the Spreadsheet with sheet datasource.

Declaration

public override void FetchData(IEnumerable data)

Parameters

Type	Name	Description
System.Collections.IEnumerable	data	It accepts the IEnumerable data to update sheet datasource

Overrides

CommonDataBoundControl.FetchData(IEnumerable)

GetCollection<T>(Object)

Declaration

protected List<T> GetCollection<T>(object collection)

Parameters

Type	Name	Description
System.Object	collection

Returns

Type	Description
System.Collections.Generic.List<T>

Type Parameters

Name	Description
T

GetDependentFiles()

To get the Dependent files.

Declaration

public override List<string> GetDependentFiles()

Returns

Type	Description
System.Collections.Generic.List<System.String>	The collection of files.

Overrides

CommonDataBoundControl.GetDependentFiles()

LoadViewState(Object)

Restores view-state information from a previous page request that was saved by the System.Web.UI.WebControls.DataBoundControl.SaveViewState method.

Declaration

protected override void LoadViewState(object state)

Parameters

Type	Name	Description
System.Object	state

Overrides

CommonDataBoundControl.LoadViewState(Object)

PostBackEventHandler(String, Dictionary<String, Object>)

Declaration

public override void PostBackEventHandler(string EventName, Dictionary<string, object> args)

Parameters

Type	Name	Description
System.String	EventName
System.Collections.Generic.Dictionary<System.String, System.Object>	args

Overrides

CommonDataBoundControl.PostBackEventHandler(String, Dictionary<String, Object>)

Render()

To render the Spreadsheet

Declaration

public string Render()

Returns

Type	Description
System.String	HTML string for Spreadsheet

Render(HtmlTextWriter)

Declaration

protected override void Render(HtmlTextWriter writer)

Parameters

Type	Name	Description
System.Web.UI.HtmlTextWriter	writer

Overrides

CommonDataBoundControl.Render(HtmlTextWriter)

SaveViewState()

Saves any view-state changes that have occurred since the time the page was posted back to the server.

Declaration

protected override object SaveViewState()

Returns

Type	Description
System.Object	The control's current view state. If there is no view state associated with the control, this method returns null.

UpdateServerModel(Dictionary<String, Object>)

To Update Server Model with client model.

Declaration

public override void UpdateServerModel(Dictionary<string, object> ClientModel)

Parameters

Type	Name	Description
System.Collections.Generic.Dictionary<System.String, System.Object>	ClientModel	Client model to update a server model.

Overrides

CommonDataBoundControl.UpdateServerModel(Dictionary<String, Object>)

Events

ServerCellSave

The OnServerCellSave event is triggered upon saving the edited cell to the Spreadsheet. The details of the edited cell can be obtained from server-side.

Declaration

public event Spreadsheet.SpreadsheetEventHandler ServerCellSave

Event Type

Type	Description
Spreadsheet.SpreadsheetEventHandler

ServerCsvExporting

The OnServerCsvExporting event is triggered when a request is made to Export the Spreadsheet to CSV file. The Spreadsheet model details can be obtained from server-side.

Declaration

public event Spreadsheet.SpreadsheetEventHandler ServerCsvExporting

Event Type

Type	Description
Spreadsheet.SpreadsheetEventHandler

ServerExcelExporting

The OnServerExcelExporting event is triggered when a request is made to Export the Spreadsheet to excel file. The Spreadsheet model details can be obtained from server-side.

Declaration

public event Spreadsheet.SpreadsheetEventHandler ServerExcelExporting

Event Type

Type	Description
Spreadsheet.SpreadsheetEventHandler

ServerPdfExporting

The OnServerPdfExporting event is triggered when a request is made to Export the Spreadsheet to PDF file. The Spreadsheet model details can be obtained from server-side.

Declaration

public event Spreadsheet.SpreadsheetEventHandler ServerPdfExporting

Event Type

Type	Description
Spreadsheet.SpreadsheetEventHandler

Implements

System.Web.UI.INamingContainer

System.Web.UI.IPostBackEventHandler

System.Web.UI.IPostBackDataHandler

System.Web.UI.IUrlResolutionService