com.aspose.gridweb

Class WebWorksheet

java.lang.Object

com.aspose.gridweb.Control

com.aspose.gridweb.WebWorksheet

Direct Known Subclasses:

WorksheetDesign

Deprecated.

This class is obsolete; use GridWorksheet instead

public class WebWorksheet
extends Control

Represents a web worksheet.

Remarks

NOTE: This class is now obsolete. please use GridWorksheet Instead. This class will be removed after 6 months since Aug. 2014. Aspose apologizes for any inconvenience you may have experienced.

Example

Constructor Summary

Constructors

Constructor and Description
WebWorksheet() Deprecated. the constructor of the WebWorksheet.
WebWorksheet(MainWeb mw, GridWorksheet gwk) Deprecated. the constructor of the WebWorksheet.

Method Summary

Methods

Modifier and Type	Method and Description
void	autoFitColumn(int columnIndex) Deprecated. Autofits the column width.
void	autoFitColumn(int columnIndex, int startRow, int endRow) Deprecated. Autofits the column width.
int	cancelNewBindRow() Deprecated. Cancels and deletes the new added bind row.
int	commitNewBindRow() Deprecated. Commits the new added bind row and add it to the datasource.
void	copy(WebWorksheet source) Deprecated. Copies from another worksheet object.
void	createAutoGenratedColumns() Deprecated. After setting a datasource for the worksheet, call this method to generate the bind columns automatically.
int	createNewBindRow() Deprecated. Creates a new bind row and bind to the datasource.
void	createSubtotal(int columnNameRowIndex, int dataRows, int groupByColumnIndex, int subtotalFunction, int[] subtotalColumnIndexList, java.lang.String functionLabel, GridTableItemStyle grandCellStyle, GridTableItemStyle subtotalCellStyle, int numberType, java.lang.String customString) Deprecated. Creates subtotal in the sheet.
void	dataBind() Deprecated. Bind the sheet to the DataSource.
int	deleteBindRow(int rowNum) Deprecated. Deletes a bind row.
void	freezePanes(int row, int column, int freezedRows, int freezedColumns) Deprecated. Freezes panes at the specified cell in the worksheet.
java.lang.Iterable	getBindingSource() Deprecated. The actually binding datasource object at run-time.
int	getBindStartColumn() Deprecated. In data-binding mode, BindStartRow and BindStartColumn indicate the position of the grid to bind bo the datasource.
int	getBindStartRow() Deprecated. In data-binding mode, BindStartRow and BindStartColumn indicate the position of the grid to bind bo the datasource.
int	getCurrentBindRows() Deprecated. Gets the binding rows number in data-binding mode.
java.lang.String	getDataMember() Deprecated. Gets the DataMember from the multi-member DataSource.
java.lang.Object	getDataSource() Deprecated. Gets the DataSource.
boolean	getEnableCreateBindColumnHeader() Deprecated. In data-binding mode, indicates whether to create bind column header captions in the sheet.
int	getIndex() Deprecated. Gets the index of itself within the worksheets.
java.lang.String	getName() Deprecated. Gets the name of the sheet.
GridValidationCollection	getValidations() Deprecated. Gets the data validation setting collection in the worksheet.
boolean	getVisible() Deprecated. Indicates whether this sheet's name is shown in the sheet tabs of the control.
void	groupRows(int firstIndex, int lastIndex) Deprecated. Groups rows.
void	groupRows(int firstIndex, int lastIndex, boolean isHidden) Deprecated. Groups rows.
boolean	isProtected() Deprecated. Gets whether the worksheet is protected.
void	setAllCellsEditable() Deprecated. Makes all cells editable.this is extended attribute
void	setAllCellsReadonly() Deprecated. Makes all cells readonly.this is extended attribute notice this attribute can not keep in actual cell,if you want to keep protect please use setProtect
void	setBindStartColumn(int value) Deprecated. In data-binding mode, BindStartRow and BindStartColumn indicate the position of the grid to bind bo the datasource.
void	setBindStartRow(int value) Deprecated. In data-binding mode, BindStartRow and BindStartColumn indicate the position of the grid to bind bo the datasource.
void	setCurrentBindRows(int value) Deprecated. Gets the binding rows number in data-binding mode.
void	setDataMember(java.lang.String value) Deprecated. Sets the DataMember from the multi-member DataSource.
void	setDataSource(java.lang.Object value) Deprecated. Sets the DataSource.
void	setEditableRange(int startRow, int startColumn, int rows, int columns) Deprecated. Makes a range of cells editable.
void	setEnableCreateBindColumnHeader(boolean value) Deprecated. In data-binding mode, indicates whether to create bind column header captions in the sheet.
void	setName(java.lang.String value) Deprecated. Sets the name of the sheet.
void	setProtected(boolean value) Deprecated. Sets whether the worksheet is protected.
void	setReadonlyRange(int startRow, int startColumn, int rows, int columns) Deprecated. Makes a range of cells readonly.
void	setVisible(boolean value) Deprecated. Indicates whether this sheet's name is shown in the sheet tabs of the control.
void	unfreezePanes() Deprecated. Unfreezes panes in the worksheet.
void	ungroupRows(int firstIndex, int lastIndex) Deprecated. Ungroups rows.

Methods inherited from class com.aspose.gridweb.Control

getUniqueID

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WebWorksheet

public WebWorksheet(MainWeb mw,
            GridWorksheet gwk)

Deprecated.

the constructor of the WebWorksheet.

Parameters:

mw -

gwk -

WebWorksheet

public WebWorksheet()

Deprecated.

the constructor of the WebWorksheet.

Method Detail

getIndex

public int getIndex()

Deprecated.

Gets the index of itself within the worksheets.

getDataSource

public java.lang.Object getDataSource()

Deprecated.

Gets the DataSource. Generally it's a DataSet object.

setDataSource

public void setDataSource(java.lang.Object value)

Deprecated.

Sets the DataSource. Generally it's a DataSet object.

getDataMember

public java.lang.String getDataMember()

Deprecated.

Gets the DataMember from the multi-member DataSource. Generally it represents a DataTable object of a DataSet.

setDataMember

public void setDataMember(java.lang.String value)

Deprecated.

Sets the DataMember from the multi-member DataSource. Generally it represents a DataTable object of a DataSet.

createAutoGenratedColumns

public void createAutoGenratedColumns()

Deprecated.

After setting a datasource for the worksheet, call this method to generate the bind columns automatically.

getBindingSource

public java.lang.Iterable getBindingSource()

Deprecated.

The actually binding datasource object at run-time. It is a DataView object when the DataSource property is a DataSet, DataTable or DataView object.

commitNewBindRow

public int commitNewBindRow()

Deprecated.

Commits the new added bind row and add it to the datasource.

Returns:

The row index of the new row. If no row is created, returns -1.

cancelNewBindRow

public int cancelNewBindRow()

Deprecated.

Cancels and deletes the new added bind row.

Returns:

The row index. If there is no new created bind row, returns -1.

getEnableCreateBindColumnHeader

public boolean getEnableCreateBindColumnHeader()

Deprecated.

In data-binding mode, indicates whether to create bind column header captions in the sheet.

setEnableCreateBindColumnHeader

public void setEnableCreateBindColumnHeader(boolean value)

Deprecated.

In data-binding mode, indicates whether to create bind column header captions in the sheet.

getBindStartRow

public int getBindStartRow()

Deprecated.

In data-binding mode, BindStartRow and BindStartColumn indicate the position of the grid to bind bo the datasource.

setBindStartRow

public void setBindStartRow(int value)

Deprecated.

In data-binding mode, BindStartRow and BindStartColumn indicate the position of the grid to bind bo the datasource.

getBindStartColumn

public int getBindStartColumn()

Deprecated.

In data-binding mode, BindStartRow and BindStartColumn indicate the position of the grid to bind bo the datasource.

setBindStartColumn

public void setBindStartColumn(int value)

Deprecated.

In data-binding mode, BindStartRow and BindStartColumn indicate the position of the grid to bind bo the datasource.

freezePanes

public void freezePanes(int row,
               int column,
               int freezedRows,
               int freezedColumns)

Deprecated.

Freezes panes at the specified cell in the worksheet.

Remarks

Row index and column index cannot all be zero. Number of rows and number of columns also cannot all be zero.

The first two parameters specify the freezed position and the last two parameters specify the area freezed on the left top pane.

Parameters:

row - Row index.

column - Column index.

freezedRows - Number of visible rows in top pane, no more than row index.

freezedColumns - Number of visible columns in left pane, no more than column index.

unfreezePanes

public void unfreezePanes()

Deprecated.

Unfreezes panes in the worksheet.

setAllCellsReadonly

public void setAllCellsReadonly()

Deprecated.

Makes all cells readonly.this is extended attribute notice this attribute can not keep in actual cell,if you want to keep protect please use setProtect

setAllCellsEditable

public void setAllCellsEditable()

Deprecated.

Makes all cells editable.this is extended attribute

setEditableRange

public void setEditableRange(int startRow,
                    int startColumn,
                    int rows,
                    int columns)

Deprecated.

Makes a range of cells editable. http://docs.aspose.com:8082/docs/display/cellsnet/Protecting+Cells Make all cells read only by calling the SetAllCellsReadonly method. then call this method to Specify the range of cells that to be editable

Parameters:

startRow - The start row of the range.

startColumn - The start column of the range.

rows - The number of the rows.

columns - The number of the columns.

ungroupRows

public void ungroupRows(int firstIndex,
               int lastIndex)

Deprecated.

Ungroups rows.

Remarks

Only removes outter group info.

Parameters:

firstIndex - The first row index to be ungrouped.

lastIndex - The last row index to be ungrouped.

groupRows

public void groupRows(int firstIndex,
             int lastIndex)

Deprecated.

Groups rows.

Parameters:

firstIndex - The first row index to be grouped.

lastIndex - The last row index to be grouped.

groupRows

public void groupRows(int firstIndex,
             int lastIndex,
             boolean isHidden)

Deprecated.

Groups rows.

Parameters:

firstIndex - The first row index to be grouped.

lastIndex - The last row index to be grouped.

isHidden - Specifies if the grouped rows are hidden.

createSubtotal

public void createSubtotal(int columnNameRowIndex,
                  int dataRows,
                  int groupByColumnIndex,
                  int subtotalFunction,
                  int[] subtotalColumnIndexList,
                  java.lang.String functionLabel,
                  GridTableItemStyle grandCellStyle,
                  GridTableItemStyle subtotalCellStyle,
                  int numberType,
                  java.lang.String customString)

Deprecated.

Creates subtotal in the sheet.

Parameters:

columnNameRowIndex - The row index of the column name row.

dataRows - The number of the data rows.

groupByColumnIndex - The column index of the column to be grouped.

subtotalFunction - SubtotalFunction. The subtotal function type.

subtotalColumnIndexList - The column indexes to be subtotaled.

functionLabel - The label of subtotal function.

grandCellStyle - The style of the grand total line.

subtotalCellStyle - The style of the subtotal line.

numberType - NumberType. The number type of the subtotal result cells.

customString - The custome format string of the subtotal result cells. Can be null.

dataBind

public void dataBind()

Deprecated.

Bind the sheet to the DataSource.

createNewBindRow

public int createNewBindRow()

Deprecated.

Creates a new bind row and bind to the datasource.

Returns:

The row index of the new row. If no row is created, returns -1.

deleteBindRow

public int deleteBindRow(int rowNum)

Deprecated.

Deletes a bind row.

Parameters:

rowNum - The row index.

Returns:

The deleted row index. If no bind row is deleted, returns -1.

getName

public java.lang.String getName()

Deprecated.

Gets the name of the sheet.

setName

public void setName(java.lang.String value)

Deprecated.

Sets the name of the sheet.

getValidations

public GridValidationCollection getValidations()

Deprecated.

Gets the data validation setting collection in the worksheet.

getVisible

public boolean getVisible()

Deprecated.

Indicates whether this sheet's name is shown in the sheet tabs of the control.

Overrides:

getVisible in class Control

setVisible

public void setVisible(boolean value)

Deprecated.

Indicates whether this sheet's name is shown in the sheet tabs of the control.

Overrides:

setVisible in class Control

copy

public void copy(WebWorksheet source)

Deprecated.

Copies from another worksheet object.

Parameters:

source - The other sheet.

getCurrentBindRows

public int getCurrentBindRows()

Deprecated.

Gets the binding rows number in data-binding mode.

setCurrentBindRows

public void setCurrentBindRows(int value)

Deprecated.

Gets the binding rows number in data-binding mode.

setReadonlyRange

public void setReadonlyRange(int startRow,
                    int startColumn,
                    int rows,
                    int columns)

Deprecated.

Makes a range of cells readonly. http://docs.aspose.com:8082/docs/display/cellsnet/Protecting+Cells First make all cells editable by calling the SetAllCellsEditable method. then call this method to Specify the range of cells that to be readonly

Parameters:

startRow - The start row of the range.

startColumn - The start column of the range.

rows - The number of the rows.

columns - The number of the columns.

isProtected

public boolean isProtected()

Deprecated.

Gets whether the worksheet is protected. When a worksheet is protected, all the cells can not be edit except the cell whose IsLocked property is false.

setProtected

public void setProtected(boolean value)

Deprecated.

Sets whether the worksheet is protected. When a worksheet is protected, all the cells can not be edit except the cell whose IsLocked property is false.

autoFitColumn

public void autoFitColumn(int columnIndex,
                 int startRow,
                 int endRow)

Deprecated.

Autofits the column width. This method autofits a column based on content in a range of cells within the column from startRow to endRow. AutoFitColumn is an imprecise function.

Parameters:

columnIndex - column index, zero based

startRow - start row index, zero based

endRow - end row index, zero based

autoFitColumn

public void autoFitColumn(int columnIndex)

Deprecated.

Autofits the column width.

Remarks

AutoFitColumn is an imprecise function.

Parameters:

columnIndex - Column index.