IWorksheet Interface

Represents a worksheet.

Namespace: GrapeCity.Spreadsheet

Assembly: GrapeCity.Spreadsheet.dll

Syntax

public interface IWorksheet : ISheet

Public Interface IWorksheet
    Inherits ISheet

Properties

Name	Description
ActiveCell	Gets an IRange object that represents the active cell.
AutoFilter	Gets an IAutoFilter object if filtering is on.
AutoFilterMode	Gets a value that indicates whether the AutoFilter drop-down arrows are currently displayed on the sheet.
AutoUpdateFilter	Gets or sets a value indicating whether the filter will update automatically after user input new value.
Behaviors	Gets or sets the behaviors of operations.
Cells	Gets an IRange object which represents the entire worksheet cells (not just the cells that are currently in use).
ChartObjects	Gets an IChartObjects object that represents a collection of all the embedded charts on the sheet.
CircularReference	Gets an IRange object that represents the range containing the first circular reference on the worksheet, or returns `null` if there's no circular reference on the worksheet.
CircularReferences	Gets an IRange object that represent all circular references on the worksheet, or returns `null` if there's no circular reference on the worksheet.
ColumnCount	Gets or sets the number of columns in this IWorksheet.
ColumnFooter	Gets the column footer of a worksheet.
ColumnHeader	Gets the column header of a worksheet.
Columns	Get an IRange object that represents all the columns on the worksheet.
Comments	Gets an IComments collection that represents all the comments for the specified worksheet.
CommentsThreaded	Gets an ICommentsThreaded collection that represents all the top-level/root comments (no replies) for the specified worksheet. Includes legacy and modern comments.
CustomProperties	Gets a ICustomProperties object representing the identifier information associated with a worksheet.
DataManager	Gets the data manager of this worksheet.
DisplayPageBreaks	Gets or sets a value indicating whether the page breaks (both automatic and manual) on this worksheet are displayed.
EnableSelection	Gets or sets what can be selected on the sheet.
Hyperlinks	Gets an IHyperlinks collection that represents the hyperlinks for the worksheet.
Index	Gets an integer value that represents the index number of the worksheet within the collection.
Names	Gets a Names collection that represents all the worksheet-specific names (names defined with the "WorksheetName!" prefix).
Options	Gets the WorksheetOptions object that represents all options of the IWorksheet.
Outline	Gets an IOutline object that represents the outline for the specified worksheet.
Owner	Gets the owner worksheet.
Panes	Gets all panes of the worksheet.
Pictures	Gets a collection of all the IPicture objects on this IWorksheet.
PivotTables	Gets an object that represents a collection of all the IPivotTable objects on a worksheet.
Protection	Gets an IProtection object that represents the protection options of the worksheet.
RowCount	Gets or sets the number of rows in this IWorksheet.
RowHeader	Gets the row header of a worksheet.
Rows	Get an IRange object that represents all the rows on the worksheet.
Selection	Gets the current selected cell(s).
Shapes	Gets a collection of all the IShape objects on this IWorksheet.
Slicers	Gets the ISlicers collection that contains the collection of ISlicer objects in the specified IWorksheet.
Sort	Gets the sort object.
StandardHeight	Gets or sets the standard (default) height of all the rows on the worksheet.
StandardWidth	Gets or sets the standard (default) width of all the columns on the worksheet.
Styles	Gets a IWorksheetStyles collection that represents all the styles in the worksheet.
SubType	Gets the worksheet sub-type.
Tables	Gets the ITables object which manages all tables in this IWorksheet.
UsedRange	Gets an IRange object that represents the used range on the specified worksheet.
View	Gets the worksheet view of this IWorksheet object.

Methods

Name	Description
Calculate()	Calculates this worksheet.
CircleInvalid()	Circles invalid entries on the worksheet.
CircleInvalid(int)	Get a GrapeCity.Spreadsheet.CellReference[] array of invalid entries on the worksheet.
ClearCircles()	Clears circles from invalid entries on the worksheet.
GetPinnedColumns()	Gets an array of column indexes that are pinned.
GetPinnedRows()	Gets an array of row indexes that are pinned.
GetValue(int, int)	Gets raw data from the specified cell on this sheet.
InsertColumns(int, int)	Inserts column(s) to the GrapeCity.Spreadsheet.Worksheet at the specified position.
InsertRows(int, int)	Inserts row(s) to the GrapeCity.Spreadsheet.Worksheet at the specified position.
Paste(IRange, bool)	Pastes the contents of the Clipboard onto the sheet.
Paste(string, bool)	Pastes the contents of the Clipboard onto the sheet.
Protect(WorksheetLocks, string)	Protects a sheet so that it cannot be modified.
Range(params Reference[])	Get an IRange object that represents ranges of reference.
Range(string, string)	Get an IRange object that represents a cell or a range of cells.
RemoveColumns(int, int)	Removes one or more columns starting with the column at the specified position.
RemoveRows(int, int)	Removes one or more rows starting with the row at the specified position.
SetBackgroundPicture(Stream, string)	Sets the background graphic for a worksheet.
SetBackgroundPicture(string, string)	Sets the background graphic for a worksheet.
SetValue(int, int, CalcError)	Sets the CalcError value for the cell of the specified row and column.
SetValue(int, int, ref CellValue)	Sets the CellValue value for the cell of the specified row and column.
SetValue(int, int, bool)	Sets the bool value for the cell of the specified row and column.
SetValue(int, int, byte)	Sets the int value for the cell of the specified row and column.
SetValue(int, int, DateTime)	Sets the DateTime value for the cell of the specified row and column.
SetValue(int, int, decimal)	Sets the int value for the cell of the specified row and column.
SetValue(int, int, double)	Sets the double value for the cell of the specified row and column.
SetValue(int, int, short)	Sets the int value for the cell of the specified row and column.
SetValue(int, int, int)	Sets the int value for the cell of the specified row and column.
SetValue(int, int, int, int, CalcError)	Sets the CalcError value for the cell of the specified cell range.
SetValue(int, int, int, int, bool)	Sets the bool value for the cell of the specified cell range.
SetValue(int, int, int, int, DateTime)	Sets the DateTime value for the cell of the specified cell range.
SetValue(int, int, int, int, double)	Sets the double value for the cell of the specified cell range.
SetValue(int, int, int, int, int)	Sets the int value for the cell of the specified cell range.
SetValue(int, int, int, int, object)	Sets the value for the cell of the specified cell range.
SetValue(int, int, int, int, string)	Sets the string value for the cell of the specified cell range.
SetValue(int, int, long)	Sets the int value for the cell of the specified row and column.
SetValue(int, int, object)	Sets the object value for the cell of the specified row and column.
SetValue(int, int, object[,])	Sets an object array into a specified range of cells.
SetValue(int, int, object[,], bool)	Sets an object array into a specified range of cells.
SetValue(int, int, float)	Sets the int value for the cell of the specified row and column.
SetValue(int, int, string)	Sets the string value for the cell of the specified row and column.
SetValue<T>(int, int, T[,])	Sets an object array into a specified range of cells.
SetValue<T>(int, int, T[,], bool)	Sets an object array into a specified range of cells.
TogglePinnedColumns(params int[])	Pin or unpin columns with specified column index array.
TogglePinnedRows(params int[])	Pin or unpin rows with specified row index array.

Events

Name	Description
BeforeDoubleClick	Occurs before a cell is double-clicked.
CellClick	Occurs when a cell is clicked.
SelectionChange	Occurs when the selection changes in the worksheet.