GridWeb

GridWeb class

public class GridWeb : MainWeb

Constructors

Name Description
GridWeb() The default constructor.

Properties

Name Description
ActiveCell { get; set; } Gets or sets the active cell of the current sheet. Changed to be writable since version 1.9.0.1.(Inherited from MainWeb.)
ActiveCellBgColor { get; set; } Specifies the background color of the active cell.(Inherited from MainWeb.)
ActiveCellColor { get; set; } Specifies the color of the active cell.(Inherited from MainWeb.)
ActiveHeaderBgColor { get; set; } Specifies the background color of the active row/column header.(Inherited from MainWeb.)
ActiveHeaderColor { get; set; } Specifies the color of the active row/column header.(Inherited from MainWeb.)
ActiveSheet { get; } Gets the active sheet(Inherited from MainWeb.)
ActiveSheetIndex { get; set; } Gets or sets the active sheet index. Equal to the WebWorksheets.ActiveSheetIndex.(Inherited from MainWeb.)
ActiveTabStyle { get; set; } Specifies the style of the active tab.(Inherited from MainWeb.)
ACWClientPath { get; set; } Gets or sets the web path of the script/image files of the control. For example: “http://localhost/acw_client”. You may also set this value in the web.config file. Add this section to the <configuration> section: <appSettings><add key=“aspose.cells.gridweb.acw_client_path” value="/acw_client/" /></appSettings>(Inherited from MainWeb.)
ACWLanguageFileUrl { get; set; } Gets or sets the web url of the language file of the control. For example: “/acw_client/lang_en.js”. By default, a built-in english file is used.(Inherited from MainWeb.)
AutoRefreshChart { get; set; } Gets or sets whether the Chart image is updated while updating the cell value.the default is true(Inherited from MainWeb.)
BottomTableStyle { get; set; } Gets or sets the style of the bottom bar of the control.(Inherited from MainWeb.)
CurrentPageIndex { get; set; } (Inherited from MainWeb.)
CustomCalculationEngine { get; set; } Represents user’s custom calculation engine to extend the default calculation engine of Aspose.Cells.(Inherited from MainWeb.)
CustomCommandButtons { get; } (Inherited from MainWeb.)
CustomStyleFileName { get; set; } Gets or sets the custom style file name.(Inherited from MainWeb.)
DefaultFontName { get; set; } Gets or sets the control’s default font name.(Inherited from MainWeb.)
DefaultFontSize { get; set; } Gets or sets the control’s default font size.(Inherited from MainWeb.)
DefaultGridLineColor { get; set; } Gets or sets the default grid line’s color.(Inherited from MainWeb.)
DisplayCellTip { get; set; } (Inherited from MainWeb.)
EditMode { get; set; } Gets or sets the control’s edit mode.(Inherited from MainWeb.)
EnableAJAX { get; set; } (Inherited from MainWeb.)
EnableAsync { get; set; } Gets or sets whether load cells data in asynchronous way,suggest to apply for one sheet with more than 10000 cells.(Inherited from MainWeb.)
EnableClientColumnOperations { get; set; } Gets or sets whether to enable the client side column operations.(Inherited from MainWeb.)
EnableClientFreeze { get; set; } Gets or sets whether to enable the client side freezing operations.(Inherited from MainWeb.)
EnableClientMergeOperations { get; set; } Gets or sets whether to enable the client side merge operations.(Inherited from MainWeb.)
EnableClientResizeColumnRow { get; set; } Gets or sets whether to enable the client side resize column and row.(Inherited from MainWeb.)
EnableClientRowOperations { get; set; } Gets or sets whether to enable the client side row operations.(Inherited from MainWeb.)
EnableDoubleClickEvent { get; set; } Gets or sets whether to enable customer side double-click event.(Inherited from MainWeb.)
EnableMetalLightEffect { get; set; } Gets or sets whether to apply metal light effect.(Inherited from MainWeb.)
EnablePaging { get; set; } Gets or sets whether to enable the control’s paging mode.(Inherited from MainWeb.)
EnableStyleDialogbox { get; set; } Gets or sets whether to enable the client side style dialogbox.(Inherited from MainWeb.)
FilteredPaging { get; set; } Gets or sets whether to enable the paging after data filtered,will take affect when EnablePaging is true.(Inherited from MainWeb.)
ForceValidation { get; set; } Gets or sets whether to force customer side validation.(Inherited from MainWeb.)
FrameTableStyle { get; set; } Gets or sets the frame style of the control.(Inherited from MainWeb.)
GoonDefaultSaveOperation { get; set; } Gets or sets whether GridWeb will do the default save operation ,the default value is true.(Inherited from MainWeb.)
HeaderBarHeight { get; set; } Gets or sets the height( System.Web.UI.WebControl.Unit ) of the top header bar of the control.(Inherited from MainWeb.)
HeaderBarStyle { get; set; } Gets or sets the header bar’s style.(Inherited from MainWeb.)
HeaderBarTableStyle { get; set; } Gets or sets the header bar style of the control.(Inherited from MainWeb.)
HeaderBarWidth { get; set; } Gets or sets the width( System.Web.UI.WebControl.Unit ) or the left header bar of the control.(Inherited from MainWeb.)
override Height { get; set; } Gets or sets the height( System.Web.UI.WebControl.Unit ) of the control.(Inherited from MainWeb.)
IgnoreStyleWithNoData { get; set; } Gets or sets whether GridWeb ignores showing rows or columns that do not contain cell values but are still styled. If set to true, the performance will be better. The default value is false, which means that if the last consecutive row/column has no cell values but is styled, we will still display them. This option is only valid when EnableAsync is false. This option has no effect when EnableAsync is true, which means GridWeb will show all rows/columns with style.(Inherited from MainWeb.)
IsCalculateFormula { get; set; } Gets or sets whether to calculate formula after cell value changes or after import File. The default value is true.(Inherited from MainWeb.)
IsPostBack { get; } Gets a value indicating whether gridweb is being loaded in response to a client postback, or if it is being loaded and accessed for the first time.(Inherited from MainWeb.)
LinksTable { get; } (Inherited from MainWeb.)
MaxColumn { get; set; } Gets or sets the maximum display column index(zero based) of the web sheet. The control uses the greater value of MaxColumn and sheet data’s max column.(Inherited from MainWeb.)
MaxRow { get; set; } Gets or sets the maximum display row index(zero based) of the web sheet. The control uses the greater value of MaxRow and sheet data’s max row.(Inherited from MainWeb.)
Message { get; set; } (Inherited from MainWeb.)
MinColumn { get; set; } (Inherited from MainWeb.)
MinRow { get; set; } Gets or sets the minimum display row index(zero based) of the web sheet. The control uses the smaller value of MinRow and sheet data’s min row.(Inherited from MainWeb.)
ModifiedCells { get; } Gets the collection of the cells that modified by the client.(Inherited from MainWeb.)
NeedRenderGroupRows { get; set; } Gets or sets whether to show grouprows .(Inherited from MainWeb.)
NoHScroll { get; set; } Gets or sets a value indicating whether the horizontal scroll bar is hidden.(Inherited from MainWeb.)
NoScroll { get; set; } (Inherited from MainWeb.)
NoVScroll { get; set; } Gets or sets a value indicating whether the vertical scroll bar is hidden.(Inherited from MainWeb.)
OnAjaxCallFinishedClientFunction { get; set; } Gets or sets the client side function name to be called when ajaxcall finished. The client function should be declared like this: function GridAjaxcallFinished() { alert(this.id+" ajaxcall finished “); }Note: You may use the “this” pointer in the client function to point the grid control which fires the event.(Inherited from MainWeb.)
OnCellErrorClientFunction { get; set; } Gets or sets the client side function name to be called when a cell’s validation is failed. The client function should be declared like this: function MyOnCellError(cell) { alert(GridWeb1.getCellValueByCell(cell)); }Note: You may use the “this” pointer in the client function to point the grid control which fires the event.(Inherited from MainWeb.)
OnCellSelectedAjaxCallBackClientFunction { get; set; } Gets or sets the client side function to be called when a cell is selected. The client function should be declared like this: function MyOnSelectCellAjaxCallBack(cell,customerdata) { }Note: You may use the “this” pointer in the client function to point the grid control which fires the event.(Inherited from MainWeb.)
OnCellSelectedClientFunction { get; set; } Gets or sets the client side function to be called when a cell is selected. The client function should be declared like this: function MyOnSelectCell(cell) { GridWeb1.setCellValueByCell(cell, “test”); }Note: You may use the “this” pointer in the client function to point the grid control which fires the event.(Inherited from MainWeb.)
OnCellUnselectedClientFunction { get; set; } Gets or sets the client side function to be called when a cell is unselected. The client function should be declared like this: function MyOnUnselectCell(cell) { GridWeb1.setCellValueByCell(cell, “test”); }Note: You may use the “this” pointer in the client function to point the grid control which fires the event.(Inherited from MainWeb.)
OnCellUpdatedClientFunction { get; set; } Gets or sets the client side function name to be called when a cell’s value is updated. The client function should be declared like this: function MyOnCellUpdated(cell) { alert(this.getCellValueByCell(cell)); }Note: You may use the “this” pointer in the client function to point the grid control which fires the event.(Inherited from MainWeb.)
OnContextMenuShowClientFunction { get; set; } Gets or sets the client side function to be called when the context menu will be shown. The client function should be declared like this: function onContextMenuShow() { var menu = event.srcElement; menu.setItemVisibility(“Delete”, “block”); menu.setItemVisibility(“Update”, “none”); }Note: You may use the “this” pointer in the client function to point the grid control which fires the event.(Inherited from MainWeb.)
OnDoubleClickCellClientFunction { get; set; } Gets or sets the client side function to be called when a cell is double clicked. The client function should be declared like this: function MyOnDoubleClickCell(cell) { GridWeb1.setCellValueByCell(cell, “test”); }Note: You may use the “this” pointer in the client function to point the grid control which fires the event.(Inherited from MainWeb.)
OnDoubleClickRowClientFunction { get; set; } Gets or sets the client side function to be called when a row is double clicked. The client function should be declared like this: function MyOnRowDoubleClick(row) { alert(row); }Note: You may use the “this” pointer in the client function to point the grid control which fires the event.(Inherited from MainWeb.)
OnGridInitClientFunction { get; set; } Gets or sets the client side function name to be called when the grid is initialized. The client function should be declared like this: function MyOnGridInit(grid) { alert(“The grid is initialized: " + grid.id); }Note: You may use the “this” pointer in the client function to point the grid control which fires the event.(Inherited from MainWeb.)
OnlyAuto { get; set; } Gets or sets whether only fit the rows which height are not customed,the default value is false(Inherited from MainWeb.)
OnPageChangeClientFunction { get; set; } Gets or sets the client side function to be called after page index changing.only take effect when EnablePaging is true. The client function should be declared like this: function MyOnPageChange(index) { console.log(“current page is:"+index); }Note: You may use the “this” pointer in the client function to point the grid control which fires the event.(Inherited from MainWeb.)
OnPageSubmitClientFunction { get; set; } Gets or sets the client function to be called before the page is submitted at client side.(Inherited from MainWeb.)
OnShapeSelectedClientFunction { get; set; } Gets or sets the client side function to be called when a shape is selected. The client function should be declared like this: function MyOnSelectShape(shape) { var name=shape.getAttribute(“namevalue”) var text=shape.getAttribute(“textvalue”) var value=shape.getAttribute(“controlvalue”) var type=shape.getAttribute(“msotype”) }Note: You may use the “this” pointer in the client function to point the grid control which fires the event.(Inherited from MainWeb.)
OnSubmitClientFunction { get; set; } Gets or sets the client function to be called before the control is submitted at client side. The client function should be declared like this: function MyOnSubmit(arg, cancelEdit) { return true;} The arg is the submit argument, contains the command to be post to the server. The cancelEdit is boolean value indicates whether the control has discarded the user input before submit. The control will continue submitting if the function returns true. Note: You may use the “this” pointer in the client function to point the grid control which fires the event.(Inherited from MainWeb.)
PageSize { get; set; } Gets or sets the page size in paging mode.(Inherited from MainWeb.)
PicturesTable { get; } (Inherited from MainWeb.)
PresetStyle { get; set; } Gets or sets the preset style.(Inherited from MainWeb.)
RefreshValidation { get; set; } Gets or sets whether to refresh validation value after cell value changes.(Inherited from MainWeb.)
RenderHiddenRow { get; set; } Gets or sets whether the hidden row is rendered in GridControl,the default value is false. if you need to unhide the hidden row latter ,you shall set it as true(Inherited from MainWeb.)
ScrollBarArrowColor { get; set; } Specifies the color of the scrollbar’s arrow button.(Inherited from MainWeb.)
ScrollBarBaseColor { get; set; } Specifies the color of the scroll bar of the control.(Inherited from MainWeb.)
SelectCellBgColor { get; set; } Specifies the background color of the selected cells in multi-select range.(Inherited from MainWeb.)
SelectCellColor { get; set; } Specifies the color of the selected cells in multi-select range.(Inherited from MainWeb.)
SelectCells { get; } Gets the select cells collection.
SessionLoaded { get; set; } (Inherited from MainWeb.)
SessionMode { get; set; } Gets or sets the session mode of the grid. There are 4 type of session mode: 1. Session(default): Use system session to store sheet data. Generally the asp.net uses InProc session state. The grid also supports “StateServer” out process session state and SQLServer session state. 2. ViewState: Use page’s viewstate to store sheet data. 3. Custom: Use LoadCustomData and SheetDataUpdated events to store/recover sheet data. 4. File: store/recover sheet data in SessionStorePath.(Inherited from MainWeb.)
SessionSaved { get; set; } (Inherited from MainWeb.)
SessionStorePath { get; set; } Gets or sets the session cache store path when session mode is File or ViewState, etc: gridweb.SessionStorePath=“c:/mytempdir/session”; then it will store session data in c:/mytempdir/session(Inherited from MainWeb.)
Settings { get; set; } Represents the workbook settings.(Inherited from MainWeb.)
ShapesTable { get; } (Inherited from MainWeb.)
ShowAddButton { get; set; } Gets or sets whether to show the add worksheet button.(Inherited from MainWeb.)
ShowBottomBar { get; set; } (Inherited from MainWeb.)
ShowCellEditBox { get; set; } whether Gridweb shows edit box toolbar as in MS-EXCEL.if enable ,a edit box for current cell will display in Gridweb. if we enable this feature, we need to import jquery js library in your aspx files to support this new feature. all the latest jquery version is ok. etc.(Inherited from MainWeb.)
ShowCommandBarAtTop { get; set; } Specifies whether to show the command bar(includes command bar and tab bar) at the top of the control.(Inherited from MainWeb.)
ShowContextMenu { get; set; } (Inherited from MainWeb.)
ShowDefaultGridLine { get; set; } Gets or sets whether to show the default grid lines of the cells.(Inherited from MainWeb.)
ShowHeaderBar { get; set; } (Inherited from MainWeb.)
ShowLoading { get; set; } Specifies whether to show a loading dialogbox while postbacking to server.(Inherited from MainWeb.)
ShowLoadingPosition { get; set; } Specifies the left,top postion(in px) to show the loading dialogbox while postbacking to server ,etc. 100,200 means the loading dialogbox’s left,top postion is at 100px,200px .(Inherited from MainWeb.)
ShowSaveButton { get; set; } Gets or sets whether to show the save button.(Inherited from MainWeb.)
ShowSubmitButton { get; set; } Gets or sets whether to show the submit button.(Inherited from MainWeb.)
ShowTabBar { get; set; } (Inherited from MainWeb.)
ShowTabNavigation { get; set; } Gets or sets whether the tab navigation button is show,the default value is true.(Inherited from MainWeb.)
ShowUndoButton { get; set; } Gets or sets whether to show the undo button.(Inherited from MainWeb.)
SpanWrap { get; set; } Specifies whether to wrap content in the cell span.the default value is true.(Inherited from MainWeb.)
TabStyle { get; set; } Gets or sets the style of the tab bar.(Inherited from MainWeb.)
UseClientPageHeight { get; set; } Gets or sets whether gridweb use client page height as control height ,suitable for when set Height=“100%",default value is false(Inherited from MainWeb.)
ValidationsTable { get; } (Inherited from MainWeb.)
ViewPanelScrollLeft { get; set; } Gets or sets the position of the scroll bar of the grid’s view panel.(Inherited from MainWeb.)
ViewPanelScrollTop { get; set; } Gets or sets the position of the scroll bar of the grid’s view panel.(Inherited from MainWeb.)
ViewTableStyle { get; set; } Gets or sets the data view panel’s style.(Inherited from MainWeb.)
WebWorksheets { get; } (Inherited from MainWeb.)
override Width { get; set; } Gets or sets the width( System.Web.UI.WebControl.Unit ) of the control.(Inherited from MainWeb.)
WorkSheets { get; } (Inherited from MainWeb.)
XhtmlMode { get; set; } (Inherited from MainWeb.)

Methods

Name Description
CalculateFormula() Calculates the result of formulas.(Inherited from MainWeb.)
override DataBind() Bind the control and all its child contorls to the its datasource.(Inherited from MainWeb.)
override Dispose() (Inherited from MainWeb.)
ImportExcelFile(Stream) Imports from an excel file stream, including disk file stream or memory stream.(Inherited from MainWeb.)
ImportExcelFile(string) Imports from an excel file.(Inherited from MainWeb.)
LoadCSVFile(Stream) Loads data from a CSV file stream.(Inherited from MainWeb.)
LoadCSVFile(string) Loads data from a CSV file.(Inherited from MainWeb.)
LoadHTMLFile(Stream) Loads data from a HTML file stream.(Inherited from MainWeb.)
LoadHTMLFile(string) Loads data from a HTML file.(Inherited from MainWeb.)
LoadSpreadSheetMLFile(Stream) Loads data from a SpreadSheetML file stream.(Inherited from MainWeb.)
LoadSpreadSheetMLFile(string) Loads data from a SpreadSheetML file.(Inherited from MainWeb.)
RefreshChartShape() refresh all the chart image for the active worksheet .(Inherited from MainWeb.)
override RenderBeginTag(HtmlTextWriter) (Inherited from MainWeb.)
SaveCSVFile(Stream) Saves data to a CSV file stream.(Inherited from MainWeb.)
SaveCSVFile(string) Saves data to a CSV file.(Inherited from MainWeb.)
SaveCustomStyleFile(string) Saves current style data of the control to an xml file. Can be used to create your customized style file. (2 methods)
SaveHTMLFile(Stream) Saves data to a HTML file stream.(Inherited from MainWeb.)
SaveHTMLFile(string) Saves data to a HTML file.(Inherited from MainWeb.)
SaveSpreadSheetMLFile(Stream) Saves data to a SpreadSheetML file stream.(Inherited from MainWeb.)
SaveSpreadSheetMLFile(string) Saves data to a SpreadSheetML file.(Inherited from MainWeb.)
SaveToExcelFile(Stream) Saves the worksheets to an excel file.(Inherited from MainWeb.)
SaveToExcelFile(string) Saves the worksheets to an excel file with Excel 2003 format.(Inherited from MainWeb.)
SaveToExcelFile(Stream, GridSaveFormat) Saves the worksheets to an excel file.(Inherited from MainWeb.)
SaveToExcelFile(Stream, GridSaveOptions) Saves the worksheets to an excel file.(Inherited from MainWeb.)
SaveToExcelFile(string, GridSaveFormat) Saves the worksheets to an excel file.(Inherited from MainWeb.)
SaveToExcelFile(string, GridSaveOptions) Saves the worksheets to an excel file.(Inherited from MainWeb.)
SetCustomStyle(Stream) sets the custom style file from stream including disk file stream or memory stream.(Inherited from MainWeb.)
static GetVersion() Get the release version.
static SetFontFolder(string, bool) Sets the fonts folder
static SetFontFolders(string[], bool) Sets the fonts folders

See Also