GridWeb

Inheritance: java.lang.Object, com.aspose.gridweb.WebControl, com.aspose.gridweb.ExtWebControl, com.aspose.gridweb.MainWeb

public class GridWeb extends MainWeb

The basic class of GridWeb control.

Constructors

Constructor	Description
GridWeb()

Fields

Field	Description
AfterColumnFilter	Occurs after the column filtered.
AjaxCallFinished	Fires when the ajax update of the control finished.
BeforeColumnFilter	Occurs before the column to be filtered.
CellClickOnAjax	Occurs when the cell is clicked,and need to do ajaxcallback for this event.
CellClientUpdate	Occurs when a client cell update happen .
CellCommand	Occurs when a cell’s command hyperlink is clicked.
CellDoubleClick	Occurs when the cell is double-clicked.
CellModifiedOnAjax	Occurs when the cell is modified in ajaxcall.
ColumnDeleted	Occurs when user delete a column from client-side menu.
ColumnDeleting	Occurs when user is trying to delete a column from the client-side menu.
ColumnDoubleClick	Occurs when the column header is double-clicked.
ColumnInserted	Occurs when user insert a column from client-side menu.
CustomCommand	Occurs when user clicks a custom command button.
LoadCustomData	Fires when the control’s SessionMode is set to Custom and needs to load sheet data.
PageIndexChanged	Occurs when the control’s sheet page index changed.
RowDeleted	Occurs when user has deleted a row from client-side menu.
RowDeleting	Occurs when user is trying to delete a row from the client-side menu.
RowDoubleClick	Occurs when the row header is double-clicked.
RowInserted	Occurs when user insert a row from client-side menu.
SaveCommand	Occurs when the “save” button is clicked.
SheetAdded	Occurs when user add a worksheet from toolbar menu.
SheetTabClick	Occurs when the sheet tab is clicked.
SubmitCommand	Occurs when the “submit” button is clicked.
UndoCommand	Occurs when the “undo” button is clicked.

Methods

Method	Description
calculateFormula()	Calculates the result of formulas.
createChildControls()	implment CreateChildControls from WebControl,Internal used only.
equals(Object arg0)
getACWClientPath()	Gets the web path of the script/image files of the control.
getACWLanguageFileUrl()	Gets the web url of the language file of the control.
getActiveCell()	Gets the active cell of the current sheet.
getActiveCellBgColor()	Specifies the background color of the active cell.
getActiveCellColor()	Specifies the color of the active cell.
getActiveHeaderBgColor()	Specifies the background color of the active row/column header.
getActiveHeaderColor()	Specifies the color of the active row/column header.
getActiveSheet()	Gets the active sheet
getActiveSheetIndex()	Gets the active sheet index.
getActiveTabStyle()	Specifies the style of the active tab.
getAutoRefreshChart()	Gets whether the Chart image is updated while updating the cell value.the default is true
getBackColor()	Gets the BackColor in the WebControl
getBorderColor()	Gets the BorderColor in the WebControl
getBorderStyle()	Gets the BorderStyle in the WebControl
getBorderWidth()	Gets the BorderWidth in the WebControl
getBottomTableStyle()	Gets the style of the bottom bar of the control.
getClass()
getCssClass()	Gets the CssClass in the WebControl
getCurrentPageIndex()	Gets the current page index in paging mode.
getCustomCalculationEngine()	Represents user’s custom calculation engine to extend the default calculation engine of Aspose.Cells.
getCustomCommandButtons()	Gets the custom command button collection
getCustomStyleFileName()	Gets the custom style file name.
getDPI()	Gets /Sets the DPI of the machine.
getDefaultFontName()	Gets the control’s default font name.
getDefaultFontSize()	Gets the control’s default font size.
getDefaultGridLineColor()	Gets the default grid line’s color.
getDisplayCellTip()	Gets whether to show tips. the default value is true.
getEditMode()	Gets the control’s edit mode.
getEnableAJAX()	Gets whether to use AJAX call . the default value is true.
getEnableAsync()	Gets whether load cells data in asynchronous way,suggest to apply for one sheet with more than 10000 cells.
getEnableClientColumnOperations()	Gets whether to enable the client side column operations.
getEnableClientFreeze()	Gets whether to enable the client side freezing operations.
getEnableClientMergeOperations()	Gets whether to enable the client side merge operations.
getEnableClientResizeColumnRow()	Gets whether to enable the client side resize column and row.
getEnableClientRowOperations()	Gets whether to enable the client side row operations.
getEnableDoubleClickEvent()	Gets whether to enable customer side double-click event.
getEnableMetalLightEffect()	Gets whether to apply metal light effect.
getEnablePaging()	Gets whether to enable the control’s paging mode.
getEnableStyleDialogbox()	Gets whether to enable the client side style dialogbox.
getEnabled()	Gets the Enabled in the WebControl
getFilteredPaging()	Gets whether to enable the paging after data filtered,will take affect when EnablePaging is true.
getFont()	Gets the Font in the WebControl
getForceValidation()	Gets whether to force customer side validation.
getForeColor()	Gets the ForeColor in the WebControl
getFrameTableStyle()	Gets the frame style of the control.
getGoonDefaultSaveOperation()	Gets whether GridWeb will do the default save operation ,the default value is true.
getHeaderBarHeight()	Gets the height( System.Web.UI.WebControl.Unit ) of the top header bar of the control.
getHeaderBarStyle()	Gets the header bar’s style.
getHeaderBarTableStyle()	Gets the header bar style of the control.
getHeaderBarWidth()	Gets the width( System.Web.UI.WebControl.Unit ) or the left header bar of the control.
getHeight()	Gets the height( System.Web.UI.WebControl.Unit ) of the control.
getIgnoreStyleWithNoData()	Gets whether GridWeb ignores showing rows or columns that do not contain cell values but are still styled.
getLoadOptions()	Represents the loadoptions for GridWeb.
getMaxColumn()	Gets the maximum display column index(zero based) of the web sheet.
getMaxRow()	Gets the maximum display row index(zero based) of the web sheet.
getMessage()	Gets the message for the grid.
getMinColumn()	Gets the minimum display column index(zero based) of the web sheet.
getMinRow()	Gets the minimum display row index(zero based) of the web sheet.
getModifiedCells()	Gets the collection of the cells that modified by the client.
getNeedRenderGroupRows()	Gets whether to show grouprows .
getNoHScroll()	Gets a value indicating whether the horizontal scroll bar is hidden.
getNoScroll()	Gets whether to show scroll bar .
getNoVScroll()	Gets a value indicating whether the vertical scroll bar is hidden.
getOnAjaxCallFinishedClientFunction()	Gets the client side function name to be called when ajaxcall finished.
getOnCellErrorClientFunction()	Gets the client side function name to be called when a cell’s validation is failed.
getOnCellSelectedAjaxCallBackClientFunction()	Gets the client side function to be called when a cell is selected.
getOnCellSelectedClientFunction()	Gets the client side function to be called when a cell is selected.
getOnCellUnselectedClientFunction()	Gets the client side function to be called when a cell is unselected.
getOnCellUpdatedClientFunction()	Gets the client side function name to be called when a cell’s value is updated.
getOnContextMenuShowClientFunction()	Gets the client side function to be called when the context menu will be shown.
getOnDoubleClickCellClientFunction()	Gets the client side function to be called when a cell is double clicked.
getOnDoubleClickRowClientFunction()	Gets the client side function to be called when a row is double clicked.
getOnGridInitClientFunction()	Gets the client side function name to be called when the grid is initialized.
getOnPageChangeClientFunction()	Gets the client side function to be called after page index changing.only take effect when EnablePaging is true.
getOnPageSubmitClientFunction()	Gets the client function to be called before the page is submitted at client side.
getOnShapeSelectedClientFunction()	Gets the client side function to be called when a shape is selected.
getOnSubmitClientFunction()	Gets the client function to be called before the control is submitted at client side.
getOnlyAuto()	Gets whether only fit the rows which height are not customed,the default value is false
getPageSize()	Gets the page size in paging mode.
getPictureCachePath()	Gets the image storage path for the workbook,all the shapes,images will be stored in this directory, the default path is acwcache under current application Base Directory users need to implement a schedule service to clean the files those are out of session time.
getPresetStyle()	Gets the preset style.
getRefreshValidation()	Gets whether to refresh validation value after cell value changes.
getRenderHiddenRow()	Gets whether the hidden row is rendered in GridControl,the default value is false.
getRowHeightForCSV()	Gets the row height value in point for csv file ,default value is 14.5.
getScrollBarArrowColor()	Specifies the color of the scrollbar’s arrow button.
getScrollBarBaseColor()	Specifies the color of the scroll bar of the control.
getSelectCellBgColor()	Specifies the background color of the selected cells in multi-select range.
getSelectCellColor()	Specifies the color of the selected cells in multi-select range.
getSelectCells()	Gets the select cells collection.
getSessionStorePath()	Gets 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
getSettings()	Represents the workbook settings.
getShowAddButton()	Gets whether to show the add worksheet button.
getShowBottomBar()	Specifies whether to show the command bar(includes command bar and tab bar) at the bottom of the control.
getShowCellEditBox()	whether Gridweb shows edit box toolbar as in MS-EXCEL.if enable ,a edit box for current cell will display in Gridweb.
getShowCommandBarAtTop()	Specifies whether to show the command bar(includes command bar and tab bar) at the top of the control.
getShowContextMenu()	Gets whether to show the context menu. the default value is true.
getShowDefaultGridLine()	Gets whether to show the default grid lines of the cells.
getShowHeaderBar()	Gets whether to show header bar
getShowLoading()	Specifies whether to show a loading dialogbox while postbacking to server.
getShowLoadingPosition()	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 .
getShowSaveButton()	Gets whether to show the save button.
getShowSubmitButton()	Gets whether to show the submit button.
getShowTabBar()	Gets whether to show the tab bar.
getShowTabNavigation()	Gets whether the tab navigation button is show,the default value is true.
getShowUndoButton()	Gets whether to show the undo button.
getSpanWrap()	Specifies whether to wrap content in the cell span.the default value is true.
getTabIndex()	Gets the TabIndex in the WebControl
getTabStyle()	Gets the style of the tab bar.
getToolTip()	Gets the ToolTip in the WebControl
getUseClientPageHeight()	Gets whether gridweb use client page height as control height ,suitable for when set Height=“100%",default value is false
getVersion()	Get the release version.
getViewPanelScrollLeft()	Gets the position of the scroll bar of the grid’s view panel.
getViewPanelScrollTop()	Gets the position of the scroll bar of the grid’s view panel.
getViewTableStyle()	Gets the data view panel’s style.
getWidth()	Gets the width( System.Web.UI.WebControl.Unit ) of the control.
getWorkSheets()	Gets the collection of the worksheets.
getXhtmlMode()	Gets whether to use XHTML style,the default value is true.
hashCode()
importExcelFile(InputStream stream)	Imports from an excel file stream, including disk file stream or memory stream.
importExcelFile(InputStream stream, String passwordtoOpen)	Imports from an excel file stream, including disk file stream or memory stream.
importExcelFile(String fileName)	Imports from an excel file.
importExcelFile(String fileName, String passwordtoOpen)	Imports from an excel file.
isCalculateFormula()	Gets whether to calculate formula after cell value changes or after import File.
loadCSVFile(InputStream stream)	Loads data from a CSV file stream.
loadCSVFile(String fileName)	Loads data from a CSV file.
loadHTMLFile(InputStream stream)	Loads data from a HTML file stream.
loadHTMLFile(String fileName)	Loads data from a HTML file.
loadSpreadSheetMLFile(InputStream stream)	Loads data from a SpreadSheetML file stream.
loadSpreadSheetMLFile(String fileName)	Loads data from a SpreadSheetML file.
notify()
notifyAll()
refreshChartShape()	refresh all the chart image for the active worksheet .
saveCSVFile(OutputStream stream)	Saves data to a CSV file stream.
saveCSVFile(String targetFile)	Saves data to a CSV file.
saveCustomStyleFile(String fileName)	Saves current style data of the control to an xml file.
saveHTMLFile(OutputStream stream)	Saves data to a HTML file stream.
saveHTMLFile(String targetFile)	Saves data to a HTML file.
saveSpreadSheetMLFile(OutputStream stream)	Saves data to a SpreadSheetML file stream.
saveSpreadSheetMLFile(String targetFile)	Saves data to a SpreadSheetML file.
saveToExcelFile(OutputStream stream)	Saves the worksheets to an excel file.
saveToExcelFile(OutputStream stream, GridSaveOptions saveOptions)	Saves the worksheets to an excel file.
saveToExcelFile(OutputStream stream, int format)	Saves the worksheets to an excel file.
saveToExcelFile(String targetFile)	Saves the worksheets to an excel file with Excel 2003 format.
saveToExcelFile(String targetFile, GridSaveOptions saveOptions)	Saves the worksheets to an excel file.
saveToExcelFile(String targetFile, int format)	Saves the worksheets to an excel file.
setACWClientPath(String value)	Sets the web path of the script/image files of the control.
setACWLanguageFileUrl(String value)	Sets the web url of the language file of the control.
setActiveCell(GridCell value)	Sets the active cell of the current sheet.
setActiveCellBgColor(Color value)	Specifies the background color of the active cell.
setActiveCellColor(Color value)	Specifies the color of the active cell.
setActiveHeaderBgColor(Color value)	Specifies the background color of the active row/column header.
setActiveHeaderColor(Color value)	Specifies the color of the active row/column header.
setActiveSheetIndex(int value)	Sets the active sheet index.
setActiveTabStyle(GridTableItemStyle value)	Specifies the style of the active tab.
setAutoRefreshChart(boolean value)	Sets whether the Chart image is updated while updating the cell value.the default is true
setBackColor(Color value)	Sets the BackColor in the WebControl
setBorderColor(Color value)	Sets the BorderColor in the WebControl
setBorderStyle(int value)	Sets the BorderStyle in the WebControl
setBorderWidth(Unit value)	Sets the BorderWidth in the WebControl
setBottomTableStyle(GridTableStyle value)	Sets the style of the bottom bar of the control.
setCalculateFormula(boolean value)	Sets whether to calculate formula after cell value changes or after import File.
setCssClass(String value)	Sets the CssClass in the WebControl
setCurrentPageIndex(int value)	Sets the current page index in paging mode.
setCustomCalculationEngine(GridAbstractCalculationEngine value)	Represents user’s custom calculation engine to extend the default calculation engine of Aspose.Cells.
setCustomStyle(InputStream stream)	sets the custom style file from stream including disk file stream or memory stream.
setCustomStyleFileName(String value)	Sets the custom style file name.
setDPI(double value)	Gets /Sets the DPI of the machine.
setDefaultFontName(String value)	Sets the control’s default font name.
setDefaultFontSize(FontUnit value)	Sets the control’s default font size.
setDefaultGridLineColor(Color value)	Sets the default grid line’s color.
setDisplayCellTip(boolean value)	Sets whether to show tips. the default value is true.
setEditMode(boolean value)	Sets the control’s edit mode.
setEnableAJAX(boolean value)	Sets whether to use AJAX call . the default value is true.
setEnableAsync(boolean value)	Sets whether load cells data in asynchronous way,suggest to apply for one sheet with more than 10000 cells.
setEnableClientColumnOperations(boolean value)	Sets whether to enable the client side column operations.
setEnableClientFreeze(boolean value)	Sets whether to enable the client side freezing operations.
setEnableClientMergeOperations(boolean value)	Sets whether to enable the client side merge operations.
setEnableClientResizeColumnRow(boolean value)	Sets whether to enable the client side resize column and row.
setEnableClientRowOperations(boolean value)	Sets whether to enable the client side row operations.
setEnableDoubleClickEvent(boolean value)	Sets whether to enable customer side double-click event.
setEnableMetalLightEffect(boolean value)	Sets whether to apply metal light effect.
setEnablePaging(boolean value)	Sets whether to enable the control’s paging mode.
setEnableStyleDialogbox(boolean value)	Sets whether to enable the client side style dialogbox.
setEnabled(boolean value)	Sets the Enabled in the WebControl
setFilteredPaging(boolean value)	Sets whether to enable the paging after data filtered,will take affect when EnablePaging is true.
setFontFolder(String fontFolder, boolean recursive)	Sets the fonts folder
setFontFolders(String[] fontFolders, boolean recursive)	Sets the fonts folders
setForceValidation(boolean value)	Sets whether to force customer side validation.
setForeColor(Color value)	Sets the ForeColor in the WebControl
setFrameTableStyle(GridTableStyle value)	Sets the frame style of the control.
setGoonDefaultSaveOperation(boolean value)	Sets whether GridWeb will do the default save operation ,the default value is true.
setHeaderBarHeight(Unit value)	Sets the height( System.Web.UI.WebControl.Unit ) of the top header bar of the control.
setHeaderBarStyle(GridTableItemStyle value)	Sets the header bar’s style.
setHeaderBarTableStyle(GridTableStyle value)	Sets the header bar style of the control.
setHeaderBarWidth(Unit value)	Sets the width( System.Web.UI.WebControl.Unit ) or the left header bar of the control.
setHeight(Unit value)	Sets the height( System.Web.UI.WebControl.Unit ) of the control.
setIgnoreStyleWithNoData(boolean value)	Sets whether GridWeb ignores showing rows or columns that do not contain cell values but are still styled.
setLoadOptions(GridLoadOptions value)	Represents the loadoptions for GridWeb.
setMaxColumn(int value)	Sets the maximum display column index(zero based) of the web sheet.
setMaxRow(int value)	Sets the maximum display row index(zero based) of the web sheet.
setMessage(String value)	Sets the message for the grid.
setMinColumn(int value)	Sets the minimum display column index(zero based) of the web sheet.
setMinRow(int value)	Sets the minimum display row index(zero based) of the web sheet.
setNeedRenderGroupRows(boolean value)	Sets whether to show grouprows .
setNoHScroll(boolean value)	Sets a value indicating whether the horizontal scroll bar is hidden.
setNoScroll(boolean value)	Sets whether to show scroll bar .
setNoVScroll(boolean value)	Sets a value indicating whether the vertical scroll bar is hidden.
setOnAjaxCallFinishedClientFunction(String value)	Sets the client side function name to be called when ajaxcall finished.
setOnCellErrorClientFunction(String value)	Sets the client side function name to be called when a cell’s validation is failed.
setOnCellSelectedAjaxCallBackClientFunction(String value)	Sets the client side function to be called when a cell is selected.
setOnCellSelectedClientFunction(String value)	Sets the client side function to be called when a cell is selected.
setOnCellUnselectedClientFunction(String value)	Sets the client side function to be called when a cell is unselected.
setOnCellUpdatedClientFunction(String value)	Sets the client side function name to be called when a cell’s value is updated.
setOnContextMenuShowClientFunction(String value)	Sets the client side function to be called when the context menu will be shown.
setOnDoubleClickCellClientFunction(String value)	Sets the client side function to be called when a cell is double clicked.
setOnDoubleClickRowClientFunction(String value)	Sets the client side function to be called when a row is double clicked.
setOnGridInitClientFunction(String value)	Sets the client side function name to be called when the grid is initialized.
setOnPageChangeClientFunction(String value)	Sets the client side function to be called after page index changing.only take effect when EnablePaging is true.
setOnPageSubmitClientFunction(String value)	Sets the client function to be called before the page is submitted at client side.
setOnShapeSelectedClientFunction(String value)	Sets the client side function to be called when a shape is selected.
setOnSubmitClientFunction(String value)	Sets the client function to be called before the control is submitted at client side.
setOnlyAuto(boolean value)	Sets whether only fit the rows which height are not customed,the default value is false
setPageSize(int value)	Sets the page size in paging mode.
setPictureCachePath(String value)	Sets the image storage path for the workbook,all the shapes,images will be stored in this directory, the default path is acwcache under current application Base Directory users need to implement a schedule service to clean the files those are out of session time.
setPresetStyle(int value)	Sets the preset style.
setRefreshValidation(boolean value)	Sets whether to refresh validation value after cell value changes.
setRenderHiddenRow(boolean value)	Sets whether the hidden row is rendered in GridControl,the default value is false.
setRowHeightForCSV(double value)	Sets the row height value in point for csv file ,default value is 14.5.
setScrollBarArrowColor(Color value)	Specifies the color of the scrollbar’s arrow button.
setScrollBarBaseColor(Color value)	Specifies the color of the scroll bar of the control.
setSelectCellBgColor(Color value)	Specifies the background color of the selected cells in multi-select range.
setSelectCellColor(Color value)	Specifies the color of the selected cells in multi-select range.
setSessionStorePath(String value)	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
setSettings(GridWorkbookSettings value)	Represents the workbook settings.
setShowAddButton(boolean value)	Sets whether to show the add worksheet button.
setShowBottomBar(boolean value)	Specifies whether to show the command bar(includes command bar and tab bar) at the bottom of the control.
setShowCellEditBox(boolean value)	whether Gridweb shows edit box toolbar as in MS-EXCEL.if enable ,a edit box for current cell will display in Gridweb.
setShowCommandBarAtTop(boolean value)	Specifies whether to show the command bar(includes command bar and tab bar) at the top of the control.
setShowContextMenu(boolean value)	Sets whether to show the context menu. the default value is true.
setShowDefaultGridLine(boolean value)	Sets whether to show the default grid lines of the cells.
setShowHeaderBar(boolean value)	Sets whether to show header bar
setShowLoading(boolean value)	Specifies whether to show a loading dialogbox while postbacking to server.
setShowLoadingPosition(String value)	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 .
setShowSaveButton(boolean value)	Sets whether to show the save button.
setShowSubmitButton(boolean value)	Sets whether to show the submit button.
setShowTabBar(boolean value)	Sets whether to show the tab bar.
setShowTabNavigation(boolean value)	Sets whether the tab navigation button is show,the default value is true.
setShowUndoButton(boolean value)	Sets whether to show the undo button.
setSpanWrap(boolean value)	Specifies whether to wrap content in the cell span.the default value is true.
setTabIndex(short value)	Sets the TabIndex in the WebControl
setTabStyle(GridTableItemStyle value)	Sets the style of the tab bar.
setToolTip(String value)	Sets the ToolTip in the WebControl
setUseClientPageHeight(boolean value)	Sets whether gridweb use client page height as control height ,suitable for when set Height=“100%",default value is false
setViewPanelScrollLeft(String value)	Sets the position of the scroll bar of the grid’s view panel.
setViewPanelScrollTop(String value)	Sets the position of the scroll bar of the grid’s view panel.
setViewTableStyle(GridTableStyle value)	Sets the data view panel’s style.
setWidth(Unit value)	Sets the width( System.Web.UI.WebControl.Unit ) of the control.
setXhtmlMode(boolean value)	Sets whether to use XHTML style,the default value is true.
toString()
wait()
wait(long arg0)
wait(long arg0, int arg1)

GridWeb()

public GridWeb()

AfterColumnFilter

public RowColumnEventHandler AfterColumnFilter

Occurs after the column filtered.

AjaxCallFinished

public WorkbookEventHandler AjaxCallFinished

Fires when the ajax update of the control finished.(the EnableAJAX shall be set to true)

BeforeColumnFilter

public RowColumnEventHandler BeforeColumnFilter

Occurs before the column to be filtered.

CellClickOnAjax

public CellEventStringHandler CellClickOnAjax

Occurs when the cell is clicked,and need to do ajaxcallback for this event.

CellClientUpdate

public CellEventHandler CellClientUpdate

Occurs when a client cell update happen . When this event is fired, its parameter e.Argument contains the command’s name.

CellCommand

public CellEventHandler CellCommand

Occurs when a cell’s command hyperlink is clicked. When this event is fired, its parameter e.Argument contains the command’s name.

CellDoubleClick

public CellEventHandler CellDoubleClick

Occurs when the cell is double-clicked.

CellModifiedOnAjax

public CellEventHandler CellModifiedOnAjax

Occurs when the cell is modified in ajaxcall.

ColumnDeleted

public RowColumnEventHandler ColumnDeleted

Occurs when user delete a column from client-side menu.

ColumnDeleting

public RowColumnEventHandler ColumnDeleting

Occurs when user is trying to delete a column from the client-side menu. You may handle this event and set the cancel parameter to True to cancel a deleting operation.

ColumnDoubleClick

public RowColumnEventHandler ColumnDoubleClick

Occurs when the column header is double-clicked.

ColumnInserted

public RowColumnEventHandler ColumnInserted

Occurs when user insert a column from client-side menu.

CustomCommand

public CustomCommandEventHandler CustomCommand

Occurs when user clicks a custom command button.

LoadCustomData

public WorkbookEventHandler LoadCustomData

Fires when the control’s SessionMode is set to Custom and needs to load sheet data. You may handle this event in Custom Session mode to load sheet data from file or database.

PageIndexChanged

public WorkbookEventHandler PageIndexChanged

Occurs when the control’s sheet page index changed.

RowDeleted

public RowColumnEventHandler RowDeleted

Occurs when user has deleted a row from client-side menu.

RowDeleting

public RowColumnEventHandler RowDeleting

Occurs when user is trying to delete a row from the client-side menu. You may handle this event and throw a RejectDeleteException exception to cancel a deleting operation.

RowDoubleClick

public RowColumnEventHandler RowDoubleClick

Occurs when the row header is double-clicked.

RowInserted

public RowColumnEventHandler RowInserted

Occurs when user insert a row from client-side menu.

SaveCommand

public WorkbookEventHandler SaveCommand

Occurs when the “save” button is clicked.

SheetAdded

public SheetEventHandler SheetAdded

Occurs when user add a worksheet from toolbar menu.

SheetTabClick

public WorkbookEventHandler SheetTabClick

Occurs when the sheet tab is clicked.

SubmitCommand

public WorkbookEventHandler SubmitCommand

Occurs when the “submit” button is clicked.

UndoCommand

public WorkbookEventHandler UndoCommand

Occurs when the “undo” button is clicked.

calculateFormula()

public void calculateFormula()

Calculates the result of formulas.

createChildControls()

public void createChildControls()

implment CreateChildControls from WebControl,Internal used only.

equals(Object arg0)

public boolean equals(Object arg0)

Parameters:

Parameter	Type	Description
arg0	java.lang.Object

Returns: boolean

getACWClientPath()

public String getACWClientPath()

Gets 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>

Returns: java.lang.String

getACWLanguageFileUrl()

public String getACWLanguageFileUrl()

Gets 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.

Returns: java.lang.String

getActiveCell()

public GridCell getActiveCell()

Gets the active cell of the current sheet. Changed to be writable since version 1.9.0.1.

Returns: GridCell

getActiveCellBgColor()

public Color getActiveCellBgColor()

Specifies the background color of the active cell.

Returns: Color

getActiveCellColor()

public Color getActiveCellColor()

Specifies the color of the active cell.

Returns: Color

getActiveHeaderBgColor()

public Color getActiveHeaderBgColor()

Specifies the background color of the active row/column header.

Returns: Color

getActiveHeaderColor()

public Color getActiveHeaderColor()

Specifies the color of the active row/column header.

Returns: Color

getActiveSheet()

public GridWorksheet getActiveSheet()

Gets the active sheet

Returns: GridWorksheet

getActiveSheetIndex()

public int getActiveSheetIndex()

Gets the active sheet index. Equal to the WebWorksheets.ActiveSheetIndex.

Returns: int

getActiveTabStyle()

public GridTableItemStyle getActiveTabStyle()

Specifies the style of the active tab.

Returns: GridTableItemStyle

getAutoRefreshChart()

public boolean getAutoRefreshChart()

Gets whether the Chart image is updated while updating the cell value.the default is true

Returns: boolean

getBackColor()

public Color getBackColor()

Gets the BackColor in the WebControl

Returns: Color

getBorderColor()

public Color getBorderColor()

Gets the BorderColor in the WebControl

Returns: Color

getBorderStyle()

public int getBorderStyle()

Gets the BorderStyle in the WebControl

See BorderStyle.

Returns: int

getBorderWidth()

public Unit getBorderWidth()

Gets the BorderWidth in the WebControl

Returns: Unit

getBottomTableStyle()

public GridTableStyle getBottomTableStyle()

Gets the style of the bottom bar of the control.

Returns: GridTableStyle

getClass()

public final native Class<?> getClass()

Returns: java.lang.Class

getCssClass()

public String getCssClass()

Gets the CssClass in the WebControl

Returns: java.lang.String

getCurrentPageIndex()

public int getCurrentPageIndex()

Gets the current page index in paging mode.

Remarks

When in paging mode, the control will display PageSize rows of data once, and display the page select control in the tab bar.

Returns: int

getCustomCalculationEngine()

public GridAbstractCalculationEngine getCustomCalculationEngine()

Represents user’s custom calculation engine to extend the default calculation engine of Aspose.Cells.

Returns: GridAbstractCalculationEngine

getCustomCommandButtons()

public CustomCommandButtonCollection getCustomCommandButtons()

Gets the custom command button collection

Returns: CustomCommandButtonCollection

getCustomStyleFileName()

public String getCustomStyleFileName()

Gets the custom style file name.

Remarks

The custom style file is an XML file. When sets the file name, the file will be loaded immediately. Hear is the content of the “standard preset style” ——————————————————- <Aspose.Cells.GridWeb.ViewerStyleTemplate runat=“server” HeaderBarWidth=“30pt” ScrollBarBaseColor=”” FrameTableStyle-BorderStyle=“Solid” FrameTableStyle-LeftBorderStyle-BorderWidth="" FrameTableStyle-LeftBorderStyle-BorderColor="" FrameTableStyle-RightBorderStyle-BorderWidth="" FrameTableStyle-RightBorderStyle-BorderColor="" FrameTableStyle-BorderWidth=“1px” FrameTableStyle-CellSpacing=“0” FrameTableStyle-BorderColor=“Gray” FrameTableStyle-CellPadding=“0” FrameTableStyle-TopBorderStyle-BorderWidth="" FrameTableStyle-TopBorderStyle-BorderColor="" FrameTableStyle-BottomBorderStyle-BorderWidth="" FrameTableStyle-BottomBorderStyle-BorderColor="" HeaderBarStyle-LeftBorderStyle-BorderStyle=“Solid” HeaderBarStyle-LeftBorderStyle-BorderWidth=“1px” HeaderBarStyle-LeftBorderStyle-BorderColor=“White” HeaderBarStyle-VerticalAlign=“Middle” HeaderBarStyle-RightBorderStyle-BorderStyle=“Solid” HeaderBarStyle-RightBorderStyle-BorderWidth=“1px” HeaderBarStyle-RightBorderStyle-BorderColor=“Gray” HeaderBarStyle-BorderWidth=“1px” HeaderBarStyle-Font-Size=“10pt” HeaderBarStyle-BorderColor=“Gray” HeaderBarStyle-BorderStyle=“Solid” HeaderBarStyle-HorizontalAlign=“Center” HeaderBarStyle-ForeColor=“Black” HeaderBarStyle-TopBorderStyle-BorderStyle=“Solid” HeaderBarStyle-TopBorderStyle-BorderWidth=“1px” HeaderBarStyle-TopBorderStyle-BorderColor=“White” HeaderBarStyle-BackColor="#E0E0E0" HeaderBarStyle-BottomBorderStyle-BorderStyle=“Solid” HeaderBarStyle-BottomBorderStyle-BorderWidth=“1px” HeaderBarStyle-BottomBorderStyle-BorderColor=“Gray” ViewTableStyle-LeftBorderStyle-BorderWidth="" ViewTableStyle-LeftBorderStyle-BorderColor="" ViewTableStyle-LayoutFixed=“Fixed” ViewTableStyle-RightBorderStyle-BorderWidth="" ViewTableStyle-RightBorderStyle-BorderColor="" ViewTableStyle-BorderWidth=“0px” ViewTableStyle-CellSpacing=“0” ViewTableStyle-CellPadding=“0” ViewTableStyle-TopBorderStyle-BorderWidth="" ViewTableStyle-TopBorderStyle-BorderColor="" ViewTableStyle-BottomBorderStyle-BorderWidth="" ViewTableStyle-BottomBorderStyle-BorderColor="" BottomTableStyle-LeftBorderStyle-BorderWidth="" BottomTableStyle-LeftBorderStyle-BorderColor="" BottomTableStyle-LayoutFixed=“Fixed” BottomTableStyle-RightBorderStyle-BorderWidth="" BottomTableStyle-RightBorderStyle-BorderColor="" BottomTableStyle-BorderWidth=“0px” BottomTableStyle-CellSpacing=“0” BottomTableStyle-CellPadding=“1” BottomTableStyle-TopBorderStyle-BorderStyle=“Solid” BottomTableStyle-TopBorderStyle-BorderWidth=“1px” BottomTableStyle-TopBorderStyle-BorderColor=“Gray” BottomTableStyle-BottomBorderStyle-BorderWidth="" BottomTableStyle-BottomBorderStyle-BorderColor="" HeaderBarHeight=“15pt” ActiveTabStyle-LeftBorderStyle-BorderWidth="" ActiveTabStyle-LeftBorderStyle-BorderColor="" ActiveTabStyle-RightBorderStyle-BorderWidth="" ActiveTabStyle-RightBorderStyle-BorderColor="" ActiveTabStyle-Height=“15pt” ActiveTabStyle-BorderWidth=“1px” ActiveTabStyle-Font-Size=“10pt” ActiveTabStyle-BorderColor=“Gray” ActiveTabStyle-ForeColor=“Black” ActiveTabStyle-TopBorderStyle-BorderWidth="" ActiveTabStyle-TopBorderStyle-BorderColor="" ActiveTabStyle-BackColor=“White” ActiveTabStyle-BottomBorderStyle-BorderWidth="" ActiveTabStyle-BottomBorderStyle-BorderColor="" HeaderBarTableStyle-LeftBorderStyle-BorderWidth="" HeaderBarTableStyle-LeftBorderStyle-BorderColor="" HeaderBarTableStyle-LayoutFixed=“Fixed” HeaderBarTableStyle-RightBorderStyle-BorderWidth="" HeaderBarTableStyle-RightBorderStyle-BorderColor="" HeaderBarTableStyle-BorderWidth=“0px” HeaderBarTableStyle-CellSpacing=“0” HeaderBarTableStyle-BorderCollapse=“Separate” HeaderBarTableStyle-CellPadding=“0” HeaderBarTableStyle-TopBorderStyle-BorderWidth="" HeaderBarTableStyle-TopBorderStyle-BorderColor="" HeaderBarTableStyle-BottomBorderStyle-BorderWidth="" HeaderBarTableStyle-BottomBorderStyle-BorderColor="" TabStyle-LeftBorderStyle-BorderWidth="" TabStyle-LeftBorderStyle-BorderColor="" TabStyle-RightBorderStyle-BorderWidth="" TabStyle-RightBorderStyle-BorderColor="" TabStyle-Height=“15pt” TabStyle-BorderWidth=“1px” TabStyle-Font-Size=“10pt” TabStyle-BorderColor=“Gray” TabStyle-ForeColor=“Black” TabStyle-TopBorderStyle-BorderWidth="" TabStyle-TopBorderStyle-BorderColor="" TabStyle-BackColor="#E0E0E0" TabStyle-BottomBorderStyle-BorderWidth="" TabStyle-BottomBorderStyle-BorderColor="" ScrollBarArrowColor=""></Aspose.Cells.GridWeb.ViewerStyleTemplate>

Example

         		GridWeb1.setCustomStyleFileName("c:\\style\\mystyle.xml");

Returns: java.lang.String

getDPI()

public static double getDPI()

Gets /Sets the DPI of the machine.

Remarks

Returns: double

getDefaultFontName()

public String getDefaultFontName()

Gets the control’s default font name.

Example

         		GridWeb1.setDefaultFontName("Arial");

Returns: java.lang.String

getDefaultFontSize()

public FontUnit getDefaultFontSize()

Gets the control’s default font size.

Example

         		GridWeb1.setDefaultFontSize(new FontUnit("10pt"));

Returns: FontUnit

getDefaultGridLineColor()

public Color getDefaultGridLineColor()

Gets the default grid line’s color.

Example

         		GridWeb1.setDefaultGridLineColor(Color.getRed());

Returns: Color

getDisplayCellTip()

public boolean getDisplayCellTip()

Gets whether to show tips. the default value is true.

Returns: boolean

getEditMode()

public boolean getEditMode()

Gets the control’s edit mode.

Remarks

When sets to true, the control’s cells are editable, and the “save” and the “undo” icon are displayed. When sets to false, the control’s cells are readonly, and the “save” and the “undo” icon are not displayed.

Returns: boolean

getEnableAJAX()

public boolean getEnableAJAX()

Gets whether to use AJAX call . the default value is true.

Returns: boolean

getEnableAsync()

public boolean getEnableAsync()

Gets whether load cells data in asynchronous way,suggest to apply for one sheet with more than 10000 cells.

Returns: boolean

getEnableClientColumnOperations()

public boolean getEnableClientColumnOperations()

Gets whether to enable the client side column operations.

Remarks

When sets to true, the user can use the right-click menu to add/remove columns.

Returns: boolean

getEnableClientFreeze()

public boolean getEnableClientFreeze()

Gets whether to enable the client side freezing operations.

Remarks

When sets to true, the user can use the right-click menu to freeze/unfreeze panes.

Returns: boolean

getEnableClientMergeOperations()

public boolean getEnableClientMergeOperations()

Gets whether to enable the client side merge operations.

Remarks

When sets to true, the user can use the right-click menu to merge/unmerge cells.

Returns: boolean

getEnableClientResizeColumnRow()

public boolean getEnableClientResizeColumnRow()

Gets whether to enable the client side resize column and row.

Remarks

When sets to true, the user can resize the column and row at client side.

Returns: boolean

getEnableClientRowOperations()

public boolean getEnableClientRowOperations()

Gets whether to enable the client side row operations.

Remarks

When sets to true, the user can use the right-click menu to add/remove rows.

Returns: boolean

getEnableDoubleClickEvent()

public boolean getEnableDoubleClickEvent()

Gets whether to enable customer side double-click event.

Remarks

When sets to true, the control will receive customer side double-click events and you may handle these events on the server side. Otherwise the control will ignore any double-click events.

Returns: boolean

getEnableMetalLightEffect()

public boolean getEnableMetalLightEffect()

Gets whether to apply metal light effect.

Returns: boolean

getEnablePaging()

public boolean getEnablePaging()

Gets whether to enable the control’s paging mode.

Remarks

When sets to true, the control will display PageSize rows of data once, and display the page select control in the tab bar.

Returns: boolean

getEnableStyleDialogbox()

public boolean getEnableStyleDialogbox()

Gets whether to enable the client side style dialogbox.

Remarks

When sets to true, the user can use the style dialogbox to set a cell’s style by selecting the “Format Cell…” from the popup menu.

Returns: boolean

getEnabled()

public boolean getEnabled()

Gets the Enabled in the WebControl

Returns: boolean

getFilteredPaging()

public boolean getFilteredPaging()

Gets whether to enable the paging after data filtered,will take affect when EnablePaging is true.

Remarks

When sets to true, the control will paging based on filtered data,the default value is false.

Returns: boolean

getFont()

public FontInfo getFont()

Gets the Font in the WebControl

Returns: FontInfo

getForceValidation()

public boolean getForceValidation()

Gets whether to force customer side validation.

Remarks

When sets to true, data will not post to server until all input fields are valid.

Returns: boolean

getForeColor()

public Color getForeColor()

Gets the ForeColor in the WebControl

Returns: Color

getFrameTableStyle()

public GridTableStyle getFrameTableStyle()

Gets the frame style of the control.

Returns: GridTableStyle

getGoonDefaultSaveOperation()

public boolean getGoonDefaultSaveOperation()

Gets whether GridWeb will do the default save operation ,the default value is true.

Returns: boolean

getHeaderBarHeight()

public Unit getHeaderBarHeight()

Gets the height( System.Web.UI.WebControl.Unit ) of the top header bar of the control.

Example

         		GridWeb1.setHeaderBarWidth(new Unit(32, com.aspose.gridweb.UnitType.Point));
         		GridWeb1.setHeaderBarHeight(new Unit(24, com.aspose.gridweb.UnitType.Point));

Returns: Unit

getHeaderBarStyle()

public GridTableItemStyle getHeaderBarStyle()

Gets the header bar’s style.

Returns: GridTableItemStyle

getHeaderBarTableStyle()

public GridTableStyle getHeaderBarTableStyle()

Gets the header bar style of the control.

Returns: GridTableStyle

getHeaderBarWidth()

public Unit getHeaderBarWidth()

Gets the width( System.Web.UI.WebControl.Unit ) or the left header bar of the control.

Example

         		GridWeb1.setHeaderBarWidth(new Unit(32, com.aspose.gridweb.UnitType.Point));
         		GridWeb1.setHeaderBarHeight(new Unit(24, com.aspose.gridweb.UnitType.Point));

Returns: Unit

getHeight()

public Unit getHeight()

Gets the height( System.Web.UI.WebControl.Unit ) of the control.

Example

         		GridWeb1.setWidth(new Unit(320, com.aspose.gridweb.UnitType.Point));
         		GridWeb1.setHeight(new Unit(240, com.aspose.gridweb.UnitType.Point));

Returns: Unit

getIgnoreStyleWithNoData()

public boolean getIgnoreStyleWithNoData()

Gets 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.

Returns: boolean

getLoadOptions()

public GridLoadOptions getLoadOptions()

Represents the loadoptions for GridWeb.

Returns: GridLoadOptions

getMaxColumn()

public int getMaxColumn()

Gets 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.

Example

         		// Creates a 4x4 "display window".
         		GridWeb1.setMinRow(2);
         		GridWeb1.setMaxRow(5);
         		GridWeb1.setMinColumn(3);
         		GridWeb1.setMaxColumn(6);

Returns: int

getMaxRow()

public int getMaxRow()

Gets 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.

Example

         		// Creates a 4x4 "display window".
         		GridWeb1.setMinRow(2);
         		GridWeb1.setMaxRow(5);
         		GridWeb1.setMinColumn(3);
         		GridWeb1.setMaxColumn(6);

Returns: int

getMessage()

public String getMessage()

Gets the message for the grid.

Returns: java.lang.String

getMinColumn()

public int getMinColumn()

Gets the minimum display column index(zero based) of the web sheet. The control uses the smaller value of MinColumn and sheet data’s min column.

Example

         		// Creates a 4x4 "display window".
         		GridWeb1.setMinRow(2);
         		GridWeb1.setMaxRow(5);
         		GridWeb1.setMinColumn(3);
         		GridWeb1.setMaxColumn(6);

Returns: int

getMinRow()

public int getMinRow()

Gets 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.

Example

         		// Creates a 4x4 "display window".
         		GridWeb1.setMinRow(2);
         		GridWeb1.setMaxRow(5);
         		GridWeb1.setMinColumn(3);
         		GridWeb1.setMaxColumn(6);

Returns: int

getModifiedCells()

public ArrayList getModifiedCells()

Gets the collection of the cells that modified by the client.

Returns: java.util.ArrayList

getNeedRenderGroupRows()

public boolean getNeedRenderGroupRows()

Gets whether to show grouprows .

Returns: boolean

getNoHScroll()

public boolean getNoHScroll()

Gets a value indicating whether the horizontal scroll bar is hidden.

Returns: boolean

getNoScroll()

public boolean getNoScroll()

Gets whether to show scroll bar .

Returns: boolean

getNoVScroll()

public boolean getNoVScroll()

Gets a value indicating whether the vertical scroll bar is hidden.

Returns: boolean

getOnAjaxCallFinishedClientFunction()

public String getOnAjaxCallFinishedClientFunction()

Gets 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.

Returns: java.lang.String

getOnCellErrorClientFunction()

public String getOnCellErrorClientFunction()

Gets 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(this.getCellValueByCell(cell)); }

Note: You may use the “this” pointer in the client function to point the grid control which fires the event.

Returns: java.lang.String

getOnCellSelectedAjaxCallBackClientFunction()

public String getOnCellSelectedAjaxCallBackClientFunction()

Gets 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.

Returns: java.lang.String

getOnCellSelectedClientFunction()

public String getOnCellSelectedClientFunction()

Gets 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.

Returns: java.lang.String

getOnCellUnselectedClientFunction()

public String getOnCellUnselectedClientFunction()

Gets the client side function to be called when a cell is unselected. The client function should be declared like this: function MyOnUnselectCell(cell) { this.setCellValueByCell(cell, “test”); }

Note: You may use the “this” pointer in the client function to point the grid control which fires the event.

Returns: java.lang.String

getOnCellUpdatedClientFunction()

public String getOnCellUpdatedClientFunction()

Gets 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.

Returns: java.lang.String

getOnContextMenuShowClientFunction()

public String getOnContextMenuShowClientFunction()

Gets 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.

Returns: java.lang.String

getOnDoubleClickCellClientFunction()

public String getOnDoubleClickCellClientFunction()

Gets the client side function to be called when a cell is double clicked. The client function should be declared like this: function MyOnDoubleClickCell(cell) { this.setCellValueByCell(cell, “test”); }

Note: You may use the “this” pointer in the client function to point the grid control which fires the event.

Returns: java.lang.String

getOnDoubleClickRowClientFunction()

public String getOnDoubleClickRowClientFunction()

Gets 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.

Returns: java.lang.String

getOnGridInitClientFunction()

public String getOnGridInitClientFunction()

Gets 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.

Returns: java.lang.String

getOnPageChangeClientFunction()

public String getOnPageChangeClientFunction()

Gets 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.

Returns: java.lang.String

getOnPageSubmitClientFunction()

public String getOnPageSubmitClientFunction()

Gets the client function to be called before the page is submitted at client side.

Returns: java.lang.String

getOnShapeSelectedClientFunction()

public String getOnShapeSelectedClientFunction()

Gets 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.

Returns: java.lang.String

getOnSubmitClientFunction()

public String getOnSubmitClientFunction()

Gets 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.

Returns: java.lang.String

getOnlyAuto()

public boolean getOnlyAuto()

Gets whether only fit the rows which height are not customed,the default value is false

Returns: boolean

getPageSize()

public int getPageSize()

Gets the page size in paging mode.

Remarks

When in paging mode, the control will display PageSize rows of data once, and display the page select control in the tab bar.

Returns: int

getPictureCachePath()

public static String getPictureCachePath()

Gets the image storage path for the workbook,all the shapes,images will be stored in this directory, the default path is acwcache under current application Base Directory users need to implement a schedule service to clean the files those are out of session time.

Returns: java.lang.String

getPresetStyle()

public int getPresetStyle()

Gets the preset style.

See PresetStyle.

Example

         		GridWeb1.setPresetStyle(PresetStyle.TRADITIONAL_1);

Returns: int

getRefreshValidation()

public boolean getRefreshValidation()

Gets whether to refresh validation value after cell value changes.

Returns: boolean

getRenderHiddenRow()

public boolean getRenderHiddenRow()

Gets 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

Returns: boolean

getRowHeightForCSV()

public double getRowHeightForCSV()

Gets the row height value in point for csv file ,default value is 14.5.

Returns: double

getScrollBarArrowColor()

public Color getScrollBarArrowColor()

Specifies the color of the scrollbar’s arrow button.

Returns: Color

getScrollBarBaseColor()

public Color getScrollBarBaseColor()

Specifies the color of the scroll bar of the control.

Returns: Color

getSelectCellBgColor()

public Color getSelectCellBgColor()

Specifies the background color of the selected cells in multi-select range.

Returns: Color

getSelectCellColor()

public Color getSelectCellColor()

Specifies the color of the selected cells in multi-select range.

Returns: Color

getSelectCells()

public ArrayList getSelectCells()

Gets the select cells collection.

Returns: java.util.ArrayList

getSessionStorePath()

public String getSessionStorePath()

Gets 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

Returns: java.lang.String

getSettings()

public GridWorkbookSettings getSettings()

Represents the workbook settings.

Returns: GridWorkbookSettings

getShowAddButton()

public boolean getShowAddButton()

Gets whether to show the add worksheet button.

Returns: boolean

getShowBottomBar()

public boolean getShowBottomBar()

Specifies whether to show the command bar(includes command bar and tab bar) at the bottom of the control.

Returns: boolean

getShowCellEditBox()

public boolean getShowCellEditBox()

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.

Returns: boolean

getShowCommandBarAtTop()

public boolean getShowCommandBarAtTop()

Specifies whether to show the command bar(includes command bar and tab bar) at the top of the control.

Returns: boolean

getShowContextMenu()

public boolean getShowContextMenu()

Gets whether to show the context menu. the default value is true.

Returns: boolean

getShowDefaultGridLine()

public boolean getShowDefaultGridLine()

Gets whether to show the default grid lines of the cells.

Returns: boolean

getShowHeaderBar()

public boolean getShowHeaderBar()

Gets whether to show header bar

Returns: boolean

getShowLoading()

public boolean getShowLoading()

Specifies whether to show a loading dialogbox while postbacking to server.

Returns: boolean

getShowLoadingPosition()

public String getShowLoadingPosition()

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 .

Returns: java.lang.String

getShowSaveButton()

public boolean getShowSaveButton()

Gets whether to show the save button.

Returns: boolean

getShowSubmitButton()

public boolean getShowSubmitButton()

Gets whether to show the submit button.

Returns: boolean

getShowTabBar()

public boolean getShowTabBar()

Gets whether to show the tab bar.

Returns: boolean

getShowTabNavigation()

public boolean getShowTabNavigation()

Gets whether the tab navigation button is show,the default value is true.

Returns: boolean

getShowUndoButton()

public boolean getShowUndoButton()

Gets whether to show the undo button.

Returns: boolean

getSpanWrap()

public boolean getSpanWrap()

Specifies whether to wrap content in the cell span.the default value is true.

Returns: boolean

getTabIndex()

public short getTabIndex()

Gets the TabIndex in the WebControl

Returns: short

getTabStyle()

public GridTableItemStyle getTabStyle()

Gets the style of the tab bar.

Returns: GridTableItemStyle

getToolTip()

public String getToolTip()

Gets the ToolTip in the WebControl

Returns: java.lang.String

getUseClientPageHeight()

public boolean getUseClientPageHeight()

Gets whether gridweb use client page height as control height ,suitable for when set Height=“100%",default value is false

Returns: boolean

getVersion()

public static String getVersion()

Get the release version.

Returns: java.lang.String - The release version.

getViewPanelScrollLeft()

public String getViewPanelScrollLeft()

Gets the position of the scroll bar of the grid’s view panel.

Returns: java.lang.String

getViewPanelScrollTop()

public String getViewPanelScrollTop()

Gets the position of the scroll bar of the grid’s view panel.

Returns: java.lang.String

getViewTableStyle()

public GridTableStyle getViewTableStyle()

Gets the data view panel’s style.

Returns: GridTableStyle

getWidth()

public Unit getWidth()

Gets the width( System.Web.UI.WebControl.Unit ) of the control.

Example

         		GridWeb1.setWidth(new Unit(320, com.aspose.gridweb.UnitType.Point));
         		GridWeb1.setHeight(new Unit(240, com.aspose.gridweb.UnitType.Point));

Returns: Unit

getWorkSheets()

public GridWorksheetCollection getWorkSheets()

Gets the collection of the worksheets.

Returns: GridWorksheetCollection

getXhtmlMode()

public boolean getXhtmlMode()

Gets whether to use XHTML style,the default value is true.

Returns: boolean

hashCode()

public native int hashCode()

Returns: int

importExcelFile(InputStream stream)

public void importExcelFile(InputStream stream)

Imports from an excel file stream, including disk file stream or memory stream.

Parameters:

Parameter	Type	Description
stream	java.io.InputStream	The excel file’s stream, including disk file stream or memory stream.

importExcelFile(InputStream stream, String passwordtoOpen)

public void importExcelFile(InputStream stream, String passwordtoOpen)

Imports from an excel file stream, including disk file stream or memory stream.

Parameters:

Parameter	Type	Description
stream	java.io.InputStream	The excel file’s stream, including disk file stream or memory stream.
passwordtoOpen	java.lang.String	the open password for the file which is encrypted .

importExcelFile(String fileName)

public void importExcelFile(String fileName)

Imports from an excel file.

Parameters:

Parameter	Type	Description
fileName	java.lang.String	The excel file’s name.

importExcelFile(String fileName, String passwordtoOpen)

public void importExcelFile(String fileName, String passwordtoOpen)

Imports from an excel file.

Parameters:

Parameter	Type	Description
fileName	java.lang.String	The excel file’s name.
passwordtoOpen	java.lang.String	the open password for the file which is encrypted .

isCalculateFormula()

public boolean isCalculateFormula()

Gets whether to calculate formula after cell value changes or after import File. The default value is true.

Returns: boolean

loadCSVFile(InputStream stream)

public void loadCSVFile(InputStream stream)

Loads data from a CSV file stream.

Parameters:

Parameter	Type	Description
stream	java.io.InputStream	The file stream.

loadCSVFile(String fileName)

public void loadCSVFile(String fileName)

Loads data from a CSV file.

Parameters:

Parameter	Type	Description
fileName	java.lang.String	The file’s name.

loadHTMLFile(InputStream stream)

public void loadHTMLFile(InputStream stream)

Loads data from a HTML file stream.

Parameters:

Parameter	Type	Description
stream	java.io.InputStream	The file stream.

loadHTMLFile(String fileName)

public void loadHTMLFile(String fileName)

Loads data from a HTML file.

Parameters:

Parameter	Type	Description
fileName	java.lang.String	The file’s name.

loadSpreadSheetMLFile(InputStream stream)

public void loadSpreadSheetMLFile(InputStream stream)

Loads data from a SpreadSheetML file stream.

Parameters:

Parameter	Type	Description
stream	java.io.InputStream	The file’s stream.

loadSpreadSheetMLFile(String fileName)

public void loadSpreadSheetMLFile(String fileName)

Loads data from a SpreadSheetML file.

Parameters:

Parameter	Type	Description
fileName	java.lang.String	The file’s name.

notify()

public final native void notify()

notifyAll()

public final native void notifyAll()

refreshChartShape()

public void refreshChartShape()

refresh all the chart image for the active worksheet .

saveCSVFile(OutputStream stream)

public void saveCSVFile(OutputStream stream)

Saves data to a CSV file stream.

Parameters:

Parameter	Type	Description
stream	java.io.OutputStream	The file stream.

saveCSVFile(String targetFile)

public void saveCSVFile(String targetFile)

Saves data to a CSV file.

Parameters:

Parameter	Type	Description
targetFile	java.lang.String	The file’s name.

saveCustomStyleFile(String fileName)

public void saveCustomStyleFile(String fileName)

Saves current style data of the control to an xml file. Can be used to create your customized style file.

Parameters:

Parameter	Type	Description
fileName	java.lang.String	The style file’s name.

saveHTMLFile(OutputStream stream)

public void saveHTMLFile(OutputStream stream)

Saves data to a HTML file stream.

Parameters:

Parameter	Type	Description
stream	java.io.OutputStream	The file stream.

saveHTMLFile(String targetFile)

public void saveHTMLFile(String targetFile)

Saves data to a HTML file.

Parameters:

Parameter	Type	Description
targetFile	java.lang.String	The file’s name.

saveSpreadSheetMLFile(OutputStream stream)

public void saveSpreadSheetMLFile(OutputStream stream)

Saves data to a SpreadSheetML file stream.

Parameters:

Parameter	Type	Description
stream	java.io.OutputStream	The file stream.

saveSpreadSheetMLFile(String targetFile)

public void saveSpreadSheetMLFile(String targetFile)

Saves data to a SpreadSheetML file.

Parameters:

Parameter	Type	Description
targetFile	java.lang.String	The file’s name.

saveToExcelFile(OutputStream stream)

public void saveToExcelFile(OutputStream stream)

Saves the worksheets to an excel file.

Parameters:

Parameter	Type	Description
stream	java.io.OutputStream	The stream to write to.

saveToExcelFile(OutputStream stream, GridSaveOptions saveOptions)

public void saveToExcelFile(OutputStream stream, GridSaveOptions saveOptions)

Saves the worksheets to an excel file.

Parameters:

Parameter	Type	Description
stream	java.io.OutputStream	The stream to write to.
saveOptions	GridSaveOptions	The save options.

saveToExcelFile(OutputStream stream, int format)

public void saveToExcelFile(OutputStream stream, int format)

Saves the worksheets to an excel file.

Parameters:

Parameter	Type	Description
stream	java.io.OutputStream	The stream to write to.
format	int	GridSaveFormat. The file format(Excel2003, Excel2007, CSV, SpreadsheetML)

saveToExcelFile(String targetFile)

public void saveToExcelFile(String targetFile)

Saves the worksheets to an excel file with Excel 2003 format.

Parameters:

Parameter	Type	Description
targetFile	java.lang.String	The name of the target file to write to.

saveToExcelFile(String targetFile, GridSaveOptions saveOptions)

public void saveToExcelFile(String targetFile, GridSaveOptions saveOptions)

Saves the worksheets to an excel file.

Parameters:

Parameter	Type	Description
targetFile	java.lang.String	The name of the target file to write to.
saveOptions	GridSaveOptions	The save options.

saveToExcelFile(String targetFile, int format)

public void saveToExcelFile(String targetFile, int format)

Saves the worksheets to an excel file.

Parameters:

Parameter	Type	Description
targetFile	java.lang.String	The name of the target file to write to.
format	int	GridSaveFormat. The file format(Excel2003, Excel2007, CSV, SpreadsheetML)

setACWClientPath(String value)

public void setACWClientPath(String value)

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>

Parameters:

Parameter	Type	Description
value	java.lang.String

setACWLanguageFileUrl(String value)

public void setACWLanguageFileUrl(String value)

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.

Parameters:

Parameter	Type	Description
value	java.lang.String

setActiveCell(GridCell value)

public void setActiveCell(GridCell value)

Sets the active cell of the current sheet. Changed to be writable since version 1.9.0.1.

Parameters:

Parameter	Type	Description
value	GridCell

setActiveCellBgColor(Color value)

public void setActiveCellBgColor(Color value)

Specifies the background color of the active cell.

Parameters:

Parameter	Type	Description
value	Color

setActiveCellColor(Color value)

public void setActiveCellColor(Color value)

Specifies the color of the active cell.

Parameters:

Parameter	Type	Description
value	Color

setActiveHeaderBgColor(Color value)

public void setActiveHeaderBgColor(Color value)

Specifies the background color of the active row/column header.

Parameters:

Parameter	Type	Description
value	Color

setActiveHeaderColor(Color value)

public void setActiveHeaderColor(Color value)

Specifies the color of the active row/column header.

Parameters:

Parameter	Type	Description
value	Color

setActiveSheetIndex(int value)

public void setActiveSheetIndex(int value)

Sets the active sheet index. Equal to the WebWorksheets.ActiveSheetIndex.

Parameters:

Parameter	Type	Description
value	int

setActiveTabStyle(GridTableItemStyle value)

public void setActiveTabStyle(GridTableItemStyle value)

Specifies the style of the active tab.

Parameters:

Parameter	Type	Description
value	GridTableItemStyle

setAutoRefreshChart(boolean value)

public void setAutoRefreshChart(boolean value)

Sets whether the Chart image is updated while updating the cell value.the default is true

Parameters:

Parameter	Type	Description
value	boolean

setBackColor(Color value)

public void setBackColor(Color value)

Sets the BackColor in the WebControl

Parameters:

Parameter	Type	Description
value	Color

setBorderColor(Color value)

public void setBorderColor(Color value)

Sets the BorderColor in the WebControl

Parameters:

Parameter	Type	Description
value	Color

setBorderStyle(int value)

public void setBorderStyle(int value)

Sets the BorderStyle in the WebControl

See BorderStyle.

Parameters:

Parameter	Type	Description
value	int

setBorderWidth(Unit value)

public void setBorderWidth(Unit value)

Sets the BorderWidth in the WebControl

Parameters:

Parameter	Type	Description
value	Unit

setBottomTableStyle(GridTableStyle value)

public void setBottomTableStyle(GridTableStyle value)

Sets the style of the bottom bar of the control.

Parameters:

Parameter	Type	Description
value	GridTableStyle

setCalculateFormula(boolean value)

public void setCalculateFormula(boolean value)

Sets whether to calculate formula after cell value changes or after import File. The default value is true.

Parameters:

Parameter	Type	Description
value	boolean

setCssClass(String value)

public void setCssClass(String value)

Sets the CssClass in the WebControl

Parameters:

Parameter	Type	Description
value	java.lang.String

setCurrentPageIndex(int value)

public void setCurrentPageIndex(int value)

Sets the current page index in paging mode.

Remarks

When in paging mode, the control will display PageSize rows of data once, and display the page select control in the tab bar.

Parameters:

Parameter	Type	Description
value	int

setCustomCalculationEngine(GridAbstractCalculationEngine value)

public void setCustomCalculationEngine(GridAbstractCalculationEngine value)

Represents user’s custom calculation engine to extend the default calculation engine of Aspose.Cells.

Parameters:

Parameter	Type	Description
value	GridAbstractCalculationEngine

setCustomStyle(InputStream stream)

public void setCustomStyle(InputStream stream)

sets the custom style file from stream including disk file stream or memory stream.

Parameters:

Parameter	Type	Description
stream	java.io.InputStream	The file’s stream, including disk file stream or memory stream.

setCustomStyleFileName(String value)

public void setCustomStyleFileName(String value)

Sets the custom style file name.

Remarks

The custom style file is an XML file. When sets the file name, the file will be loaded immediately. Hear is the content of the “standard preset style” ——————————————————- <Aspose.Cells.GridWeb.ViewerStyleTemplate runat=“server” HeaderBarWidth=“30pt” ScrollBarBaseColor=”” FrameTableStyle-BorderStyle=“Solid” FrameTableStyle-LeftBorderStyle-BorderWidth=”” FrameTableStyle-LeftBorderStyle-BorderColor="" FrameTableStyle-RightBorderStyle-BorderWidth="" FrameTableStyle-RightBorderStyle-BorderColor="" FrameTableStyle-BorderWidth=“1px” FrameTableStyle-CellSpacing=“0” FrameTableStyle-BorderColor=“Gray” FrameTableStyle-CellPadding=“0” FrameTableStyle-TopBorderStyle-BorderWidth="" FrameTableStyle-TopBorderStyle-BorderColor="" FrameTableStyle-BottomBorderStyle-BorderWidth="" FrameTableStyle-BottomBorderStyle-BorderColor="" HeaderBarStyle-LeftBorderStyle-BorderStyle=“Solid” HeaderBarStyle-LeftBorderStyle-BorderWidth=“1px” HeaderBarStyle-LeftBorderStyle-BorderColor=“White” HeaderBarStyle-VerticalAlign=“Middle” HeaderBarStyle-RightBorderStyle-BorderStyle=“Solid” HeaderBarStyle-RightBorderStyle-BorderWidth=“1px” HeaderBarStyle-RightBorderStyle-BorderColor=“Gray” HeaderBarStyle-BorderWidth=“1px” HeaderBarStyle-Font-Size=“10pt” HeaderBarStyle-BorderColor=“Gray” HeaderBarStyle-BorderStyle=“Solid” HeaderBarStyle-HorizontalAlign=“Center” HeaderBarStyle-ForeColor=“Black” HeaderBarStyle-TopBorderStyle-BorderStyle=“Solid” HeaderBarStyle-TopBorderStyle-BorderWidth=“1px” HeaderBarStyle-TopBorderStyle-BorderColor=“White” HeaderBarStyle-BackColor="#E0E0E0" HeaderBarStyle-BottomBorderStyle-BorderStyle=“Solid” HeaderBarStyle-BottomBorderStyle-BorderWidth=“1px” HeaderBarStyle-BottomBorderStyle-BorderColor=“Gray” ViewTableStyle-LeftBorderStyle-BorderWidth="" ViewTableStyle-LeftBorderStyle-BorderColor="" ViewTableStyle-LayoutFixed=“Fixed” ViewTableStyle-RightBorderStyle-BorderWidth="" ViewTableStyle-RightBorderStyle-BorderColor="" ViewTableStyle-BorderWidth=“0px” ViewTableStyle-CellSpacing=“0” ViewTableStyle-CellPadding=“0” ViewTableStyle-TopBorderStyle-BorderWidth="" ViewTableStyle-TopBorderStyle-BorderColor="" ViewTableStyle-BottomBorderStyle-BorderWidth="" ViewTableStyle-BottomBorderStyle-BorderColor="" BottomTableStyle-LeftBorderStyle-BorderWidth="" BottomTableStyle-LeftBorderStyle-BorderColor="" BottomTableStyle-LayoutFixed=“Fixed” BottomTableStyle-RightBorderStyle-BorderWidth="" BottomTableStyle-RightBorderStyle-BorderColor="" BottomTableStyle-BorderWidth=“0px” BottomTableStyle-CellSpacing=“0” BottomTableStyle-CellPadding=“1” BottomTableStyle-TopBorderStyle-BorderStyle=“Solid” BottomTableStyle-TopBorderStyle-BorderWidth=“1px” BottomTableStyle-TopBorderStyle-BorderColor=“Gray” BottomTableStyle-BottomBorderStyle-BorderWidth="" BottomTableStyle-BottomBorderStyle-BorderColor="" HeaderBarHeight=“15pt” ActiveTabStyle-LeftBorderStyle-BorderWidth="" ActiveTabStyle-LeftBorderStyle-BorderColor="" ActiveTabStyle-RightBorderStyle-BorderWidth="" ActiveTabStyle-RightBorderStyle-BorderColor="" ActiveTabStyle-Height=“15pt” ActiveTabStyle-BorderWidth=“1px” ActiveTabStyle-Font-Size=“10pt” ActiveTabStyle-BorderColor=“Gray” ActiveTabStyle-ForeColor=“Black” ActiveTabStyle-TopBorderStyle-BorderWidth="" ActiveTabStyle-TopBorderStyle-BorderColor="" ActiveTabStyle-BackColor=“White” ActiveTabStyle-BottomBorderStyle-BorderWidth="" ActiveTabStyle-BottomBorderStyle-BorderColor="" HeaderBarTableStyle-LeftBorderStyle-BorderWidth="" HeaderBarTableStyle-LeftBorderStyle-BorderColor="" HeaderBarTableStyle-LayoutFixed=“Fixed” HeaderBarTableStyle-RightBorderStyle-BorderWidth="" HeaderBarTableStyle-RightBorderStyle-BorderColor="" HeaderBarTableStyle-BorderWidth=“0px” HeaderBarTableStyle-CellSpacing=“0” HeaderBarTableStyle-BorderCollapse=“Separate” HeaderBarTableStyle-CellPadding=“0” HeaderBarTableStyle-TopBorderStyle-BorderWidth="" HeaderBarTableStyle-TopBorderStyle-BorderColor="" HeaderBarTableStyle-BottomBorderStyle-BorderWidth="" HeaderBarTableStyle-BottomBorderStyle-BorderColor="" TabStyle-LeftBorderStyle-BorderWidth="" TabStyle-LeftBorderStyle-BorderColor="" TabStyle-RightBorderStyle-BorderWidth="" TabStyle-RightBorderStyle-BorderColor="" TabStyle-Height=“15pt” TabStyle-BorderWidth=“1px” TabStyle-Font-Size=“10pt” TabStyle-BorderColor=“Gray” TabStyle-ForeColor=“Black” TabStyle-TopBorderStyle-BorderWidth="" TabStyle-TopBorderStyle-BorderColor="" TabStyle-BackColor="#E0E0E0" TabStyle-BottomBorderStyle-BorderWidth="" TabStyle-BottomBorderStyle-BorderColor="" ScrollBarArrowColor=""></Aspose.Cells.GridWeb.ViewerStyleTemplate>

Parameters:

Parameter	Type	Description
value	java.lang.String

setDPI(double value)

public static void setDPI(double value)

Gets /Sets the DPI of the machine.

Remarks

Parameters:

Parameter	Type	Description
value	double

setDefaultFontName(String value)

public void setDefaultFontName(String value)

Sets the control’s default font name.

Parameters:

Parameter	Type	Description
value	java.lang.String

setDefaultFontSize(FontUnit value)

public void setDefaultFontSize(FontUnit value)

Sets the control’s default font size.

Parameters:

Parameter	Type	Description
value	FontUnit

setDefaultGridLineColor(Color value)

public void setDefaultGridLineColor(Color value)

Sets the default grid line’s color.

Parameters:

Parameter	Type	Description
value	Color

setDisplayCellTip(boolean value)

public void setDisplayCellTip(boolean value)

Sets whether to show tips. the default value is true.

Parameters:

Parameter	Type	Description
value	boolean

setEditMode(boolean value)

public void setEditMode(boolean value)

Sets the control’s edit mode.

Remarks

Parameters:

Parameter	Type	Description
value	boolean

setEnableAJAX(boolean value)

public void setEnableAJAX(boolean value)

Sets whether to use AJAX call . the default value is true.

Parameters:

Parameter	Type	Description
value	boolean

setEnableAsync(boolean value)

public void setEnableAsync(boolean value)

Sets whether load cells data in asynchronous way,suggest to apply for one sheet with more than 10000 cells.

Parameters:

Parameter	Type	Description
value	boolean

setEnableClientColumnOperations(boolean value)

public void setEnableClientColumnOperations(boolean value)

Sets whether to enable the client side column operations.

Remarks

When sets to true, the user can use the right-click menu to add/remove columns.

Parameters:

Parameter	Type	Description
value	boolean

setEnableClientFreeze(boolean value)

public void setEnableClientFreeze(boolean value)

Sets whether to enable the client side freezing operations.

Remarks

When sets to true, the user can use the right-click menu to freeze/unfreeze panes.

Parameters:

Parameter	Type	Description
value	boolean

setEnableClientMergeOperations(boolean value)

public void setEnableClientMergeOperations(boolean value)

Sets whether to enable the client side merge operations.

Remarks

When sets to true, the user can use the right-click menu to merge/unmerge cells.

Parameters:

Parameter	Type	Description
value	boolean

setEnableClientResizeColumnRow(boolean value)

public void setEnableClientResizeColumnRow(boolean value)

Sets whether to enable the client side resize column and row.

Remarks

When sets to true, the user can resize the column and row at client side.

Parameters:

Parameter	Type	Description
value	boolean

setEnableClientRowOperations(boolean value)

public void setEnableClientRowOperations(boolean value)

Sets whether to enable the client side row operations.

Remarks

When sets to true, the user can use the right-click menu to add/remove rows.

Parameters:

Parameter	Type	Description
value	boolean

setEnableDoubleClickEvent(boolean value)

public void setEnableDoubleClickEvent(boolean value)

Sets whether to enable customer side double-click event.

Remarks

When sets to true, the control will receive customer side double-click events and you may handle these events on the server side. Otherwise the control will ignore any double-click events.

Parameters:

Parameter	Type	Description
value	boolean

setEnableMetalLightEffect(boolean value)

public void setEnableMetalLightEffect(boolean value)

Sets whether to apply metal light effect.

Parameters:

Parameter	Type	Description
value	boolean

setEnablePaging(boolean value)

public void setEnablePaging(boolean value)

Sets whether to enable the control’s paging mode.

Remarks

When sets to true, the control will display PageSize rows of data once, and display the page select control in the tab bar.

Parameters:

Parameter	Type	Description
value	boolean

setEnableStyleDialogbox(boolean value)

public void setEnableStyleDialogbox(boolean value)

Sets whether to enable the client side style dialogbox.

Remarks

When sets to true, the user can use the style dialogbox to set a cell’s style by selecting the “Format Cell…” from the popup menu.

Parameters:

Parameter	Type	Description
value	boolean

setEnabled(boolean value)

public void setEnabled(boolean value)

Sets the Enabled in the WebControl

Parameters:

Parameter	Type	Description
value	boolean

setFilteredPaging(boolean value)

public void setFilteredPaging(boolean value)

Sets whether to enable the paging after data filtered,will take affect when EnablePaging is true.

Remarks

When sets to true, the control will paging based on filtered data,the default value is false.

Parameters:

Parameter	Type	Description
value	boolean

setFontFolder(String fontFolder, boolean recursive)

public static void setFontFolder(String fontFolder, boolean recursive)

Sets the fonts folder

Parameters:

Parameter	Type	Description
fontFolder	java.lang.String	The folder that contains TrueType fonts.
recursive	boolean	Determines whether or not to scan subfolders.

setFontFolders(String[] fontFolders, boolean recursive)

public static void setFontFolders(String[] fontFolders, boolean recursive)

Sets the fonts folders

Parameters:

Parameter	Type	Description
fontFolders	java.lang.String[]	The folders that contains TrueType fonts.
recursive	boolean	Determines whether or not to scan subfolders.

setForceValidation(boolean value)

public void setForceValidation(boolean value)

Sets whether to force customer side validation.

Remarks

When sets to true, data will not post to server until all input fields are valid.

Parameters:

Parameter	Type	Description
value	boolean

setForeColor(Color value)

public void setForeColor(Color value)

Sets the ForeColor in the WebControl

Parameters:

Parameter	Type	Description
value	Color

setFrameTableStyle(GridTableStyle value)

public void setFrameTableStyle(GridTableStyle value)

Sets the frame style of the control.

Parameters:

Parameter	Type	Description
value	GridTableStyle

setGoonDefaultSaveOperation(boolean value)

public void setGoonDefaultSaveOperation(boolean value)

Sets whether GridWeb will do the default save operation ,the default value is true.

Parameters:

Parameter	Type	Description
value	boolean

setHeaderBarHeight(Unit value)

public void setHeaderBarHeight(Unit value)

Sets the height( System.Web.UI.WebControl.Unit ) of the top header bar of the control.

Parameters:

Parameter	Type	Description
value	Unit

setHeaderBarStyle(GridTableItemStyle value)

public void setHeaderBarStyle(GridTableItemStyle value)

Sets the header bar’s style.

Parameters:

Parameter	Type	Description
value	GridTableItemStyle

setHeaderBarTableStyle(GridTableStyle value)

public void setHeaderBarTableStyle(GridTableStyle value)

Sets the header bar style of the control.

Parameters:

Parameter	Type	Description
value	GridTableStyle

setHeaderBarWidth(Unit value)

public void setHeaderBarWidth(Unit value)

Sets the width( System.Web.UI.WebControl.Unit ) or the left header bar of the control.

Parameters:

Parameter	Type	Description
value	Unit

setHeight(Unit value)

public void setHeight(Unit value)

Sets the height( System.Web.UI.WebControl.Unit ) of the control.

Parameters:

Parameter	Type	Description
value	Unit

setIgnoreStyleWithNoData(boolean value)

public void setIgnoreStyleWithNoData(boolean value)

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.

Parameters:

Parameter	Type	Description
value	boolean

setLoadOptions(GridLoadOptions value)

public void setLoadOptions(GridLoadOptions value)

Represents the loadoptions for GridWeb.

Parameters:

Parameter	Type	Description
value	GridLoadOptions

setMaxColumn(int value)

public void setMaxColumn(int value)

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.

Parameters:

Parameter	Type	Description
value	int

setMaxRow(int value)

public void setMaxRow(int value)

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.

Parameters:

Parameter	Type	Description
value	int

setMessage(String value)

public void setMessage(String value)

Sets the message for the grid.

Parameters:

Parameter	Type	Description
value	java.lang.String

setMinColumn(int value)

public void setMinColumn(int value)

Sets the minimum display column index(zero based) of the web sheet. The control uses the smaller value of MinColumn and sheet data’s min column.

Parameters:

Parameter	Type	Description
value	int

setMinRow(int value)

public void setMinRow(int value)

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.

Parameters:

Parameter	Type	Description
value	int

setNeedRenderGroupRows(boolean value)

public void setNeedRenderGroupRows(boolean value)

Sets whether to show grouprows .

Parameters:

Parameter	Type	Description
value	boolean

setNoHScroll(boolean value)

public void setNoHScroll(boolean value)

Sets a value indicating whether the horizontal scroll bar is hidden.

Parameters:

Parameter	Type	Description
value	boolean

setNoScroll(boolean value)

public void setNoScroll(boolean value)

Sets whether to show scroll bar .

Parameters:

Parameter	Type	Description
value	boolean

setNoVScroll(boolean value)

public void setNoVScroll(boolean value)

Sets a value indicating whether the vertical scroll bar is hidden.

Parameters:

Parameter	Type	Description
value	boolean

setOnAjaxCallFinishedClientFunction(String value)

public void setOnAjaxCallFinishedClientFunction(String value)

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.

Parameters:

Parameter	Type	Description
value	java.lang.String

setOnCellErrorClientFunction(String value)

public void setOnCellErrorClientFunction(String value)

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(this.getCellValueByCell(cell)); }

Note: You may use the “this” pointer in the client function to point the grid control which fires the event.

Parameters:

Parameter	Type	Description
value	java.lang.String

setOnCellSelectedAjaxCallBackClientFunction(String value)

public void setOnCellSelectedAjaxCallBackClientFunction(String value)

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.

Parameters:

Parameter	Type	Description
value	java.lang.String

setOnCellSelectedClientFunction(String value)

public void setOnCellSelectedClientFunction(String value)

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.

Parameters:

Parameter	Type	Description
value	java.lang.String

setOnCellUnselectedClientFunction(String value)

public void setOnCellUnselectedClientFunction(String value)

Sets the client side function to be called when a cell is unselected. The client function should be declared like this: function MyOnUnselectCell(cell) { this.setCellValueByCell(cell, “test”); }

Note: You may use the “this” pointer in the client function to point the grid control which fires the event.

Parameters:

Parameter	Type	Description
value	java.lang.String

setOnCellUpdatedClientFunction(String value)

public void setOnCellUpdatedClientFunction(String value)

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.

Parameters:

Parameter	Type	Description
value	java.lang.String

setOnContextMenuShowClientFunction(String value)

public void setOnContextMenuShowClientFunction(String value)

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.

Parameters:

Parameter	Type	Description
value	java.lang.String

setOnDoubleClickCellClientFunction(String value)

public void setOnDoubleClickCellClientFunction(String value)

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) { this.setCellValueByCell(cell, “test”); }

Note: You may use the “this” pointer in the client function to point the grid control which fires the event.

Parameters:

Parameter	Type	Description
value	java.lang.String

setOnDoubleClickRowClientFunction(String value)

public void setOnDoubleClickRowClientFunction(String value)

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.

Parameters:

Parameter	Type	Description
value	java.lang.String

setOnGridInitClientFunction(String value)

public void setOnGridInitClientFunction(String value)

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.

Parameters:

Parameter	Type	Description
value	java.lang.String

setOnPageChangeClientFunction(String value)

public void setOnPageChangeClientFunction(String value)

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.

Parameters:

Parameter	Type	Description
value	java.lang.String

setOnPageSubmitClientFunction(String value)

public void setOnPageSubmitClientFunction(String value)

Sets the client function to be called before the page is submitted at client side.

Parameters:

Parameter	Type	Description
value	java.lang.String

setOnShapeSelectedClientFunction(String value)

public void setOnShapeSelectedClientFunction(String value)

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.

Parameters:

Parameter	Type	Description
value	java.lang.String

setOnSubmitClientFunction(String value)

public void setOnSubmitClientFunction(String value)

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.

Parameters:

Parameter	Type	Description
value	java.lang.String

setOnlyAuto(boolean value)

public void setOnlyAuto(boolean value)

Sets whether only fit the rows which height are not customed,the default value is false

Parameters:

Parameter	Type	Description
value	boolean

setPageSize(int value)

public void setPageSize(int value)

Sets the page size in paging mode.

Remarks

When in paging mode, the control will display PageSize rows of data once, and display the page select control in the tab bar.

Parameters:

Parameter	Type	Description
value	int

setPictureCachePath(String value)

public static void setPictureCachePath(String value)

Sets the image storage path for the workbook,all the shapes,images will be stored in this directory, the default path is acwcache under current application Base Directory users need to implement a schedule service to clean the files those are out of session time.

Parameters:

Parameter	Type	Description
value	java.lang.String

setPresetStyle(int value)

public void setPresetStyle(int value)

Sets the preset style.

See PresetStyle.

Parameters:

Parameter	Type	Description
value	int

setRefreshValidation(boolean value)

public void setRefreshValidation(boolean value)

Sets whether to refresh validation value after cell value changes.

Parameters:

Parameter	Type	Description
value	boolean

setRenderHiddenRow(boolean value)

public void setRenderHiddenRow(boolean value)

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

Parameters:

Parameter	Type	Description
value	boolean

setRowHeightForCSV(double value)

public void setRowHeightForCSV(double value)

Sets the row height value in point for csv file ,default value is 14.5.

Parameters:

Parameter	Type	Description
value	double

setScrollBarArrowColor(Color value)

public void setScrollBarArrowColor(Color value)

Specifies the color of the scrollbar’s arrow button.

Parameters:

Parameter	Type	Description
value	Color

setScrollBarBaseColor(Color value)

public void setScrollBarBaseColor(Color value)

Specifies the color of the scroll bar of the control.

Parameters:

Parameter	Type	Description
value	Color

setSelectCellBgColor(Color value)

public void setSelectCellBgColor(Color value)

Specifies the background color of the selected cells in multi-select range.

Parameters:

Parameter	Type	Description
value	Color

setSelectCellColor(Color value)

public void setSelectCellColor(Color value)

Specifies the color of the selected cells in multi-select range.

Parameters:

Parameter	Type	Description
value	Color

setSessionStorePath(String value)

public void setSessionStorePath(String value)

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

Parameters:

Parameter	Type	Description
value	java.lang.String

setSettings(GridWorkbookSettings value)

public void setSettings(GridWorkbookSettings value)

Represents the workbook settings.

Parameters:

Parameter	Type	Description
value	GridWorkbookSettings

setShowAddButton(boolean value)

public void setShowAddButton(boolean value)

Sets whether to show the add worksheet button.

Parameters:

Parameter	Type	Description
value	boolean

setShowBottomBar(boolean value)

public void setShowBottomBar(boolean value)

Specifies whether to show the command bar(includes command bar and tab bar) at the bottom of the control.

Parameters:

Parameter	Type	Description
value	boolean

setShowCellEditBox(boolean value)

public void setShowCellEditBox(boolean value)

Parameters:

Parameter	Type	Description
value	boolean

setShowCommandBarAtTop(boolean value)

public void setShowCommandBarAtTop(boolean value)

Specifies whether to show the command bar(includes command bar and tab bar) at the top of the control.

Parameters:

Parameter	Type	Description
value	boolean

setShowContextMenu(boolean value)

public void setShowContextMenu(boolean value)

Sets whether to show the context menu. the default value is true.

Parameters:

Parameter	Type	Description
value	boolean

setShowDefaultGridLine(boolean value)

public void setShowDefaultGridLine(boolean value)

Sets whether to show the default grid lines of the cells.

Parameters:

Parameter	Type	Description
value	boolean

setShowHeaderBar(boolean value)

public void setShowHeaderBar(boolean value)

Sets whether to show header bar

Parameters:

Parameter	Type	Description
value	boolean

setShowLoading(boolean value)

public void setShowLoading(boolean value)

Specifies whether to show a loading dialogbox while postbacking to server.

Parameters:

Parameter	Type	Description
value	boolean

setShowLoadingPosition(String value)

public void setShowLoadingPosition(String value)

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 .

Parameters:

Parameter	Type	Description
value	java.lang.String

setShowSaveButton(boolean value)

public void setShowSaveButton(boolean value)

Sets whether to show the save button.

Parameters:

Parameter	Type	Description
value	boolean

setShowSubmitButton(boolean value)

public void setShowSubmitButton(boolean value)

Sets whether to show the submit button.

Parameters:

Parameter	Type	Description
value	boolean

setShowTabBar(boolean value)

public void setShowTabBar(boolean value)

Sets whether to show the tab bar.

Parameters:

Parameter	Type	Description
value	boolean

setShowTabNavigation(boolean value)

public void setShowTabNavigation(boolean value)

Sets whether the tab navigation button is show,the default value is true.

Parameters:

Parameter	Type	Description
value	boolean

setShowUndoButton(boolean value)

public void setShowUndoButton(boolean value)

Sets whether to show the undo button.

Parameters:

Parameter	Type	Description
value	boolean

setSpanWrap(boolean value)

public void setSpanWrap(boolean value)

Specifies whether to wrap content in the cell span.the default value is true.

Parameters:

Parameter	Type	Description
value	boolean

setTabIndex(short value)

public void setTabIndex(short value)

Sets the TabIndex in the WebControl

Parameters:

Parameter	Type	Description
value	short

setTabStyle(GridTableItemStyle value)

public void setTabStyle(GridTableItemStyle value)

Sets the style of the tab bar.

Parameters:

Parameter	Type	Description
value	GridTableItemStyle

setToolTip(String value)

public void setToolTip(String value)

Sets the ToolTip in the WebControl

Parameters:

Parameter	Type	Description
value	java.lang.String

setUseClientPageHeight(boolean value)

public void setUseClientPageHeight(boolean value)

Sets whether gridweb use client page height as control height ,suitable for when set Height=“100%",default value is false

Parameters:

Parameter	Type	Description
value	boolean

setViewPanelScrollLeft(String value)

public void setViewPanelScrollLeft(String value)

Sets the position of the scroll bar of the grid’s view panel.

Parameters:

Parameter	Type	Description
value	java.lang.String

setViewPanelScrollTop(String value)

public void setViewPanelScrollTop(String value)

Sets the position of the scroll bar of the grid’s view panel.

Parameters:

Parameter	Type	Description
value	java.lang.String

setViewTableStyle(GridTableStyle value)

public void setViewTableStyle(GridTableStyle value)

Sets the data view panel’s style.

Parameters:

Parameter	Type	Description
value	GridTableStyle

setWidth(Unit value)

public void setWidth(Unit value)

Sets the width( System.Web.UI.WebControl.Unit ) of the control.

Parameters:

Parameter	Type	Description
value	Unit

setXhtmlMode(boolean value)

public void setXhtmlMode(boolean value)

Sets whether to use XHTML style,the default value is true.

Parameters:

Parameter	Type	Description
value	boolean

toString()

public String toString()

Returns: java.lang.String

wait()

public final void wait()

wait(long arg0)

public final native void wait(long arg0)

Parameters:

Parameter	Type	Description
arg0	long

wait(long arg0, int arg1)

public final void wait(long arg0, int arg1)

Parameters:

Parameter	Type	Description
arg0	long
arg1	int