Skip to main content
Row

Worksheet Members

A worksheet in a workbook.

Properties

Name Description
ActiveView Provides access to an object that contains options to display and print a worksheet.
ArrayFormulas Obtains a collection of legacy array formulas in a current worksheet.
AutoFilter Provides access to an object that contains options to filter data in a worksheet.
Cells Provides access to the collection of all cells contained in the worksheet.
Charts Provides access to a collection of charts in a worksheet.
CodeName Gets or sets the worksheet’s code name.
Columns Returns the collection of all columns in a worksheet.
Comments Retrieves a collection of simple notes (legacy comments) contained in a worksheet.
Comparers Provides access to default comparers used to sort cell values in ascending and descending order.
ConditionalFormattings Provides access to the collection of all conditional formatting rules on a worksheet.
CustomCellInplaceEditors Provides access to the collection of the custom in-place editors embedded into worksheet cells.
DataBindings Provides access to the collection of WorksheetDataBinding objects.
DataValidations Provides access to a collection of DataValidation objects for the worksheet.
DefaultColumnWidth Gets or sets the default column width in units of measurement used in the workbook.
DefaultColumnWidthInCharacters Gets or sets the default column width in characters of the default font specified by the built-in Normal style.
DefaultColumnWidthInPixels Gets or sets the default column width in pixels.
DefaultRowHeight Gets or sets the default height of worksheet rows.
DefinedNames Gets the collection of defined names whose scope is the current worksheet.
DynamicArrayFormulas Obtains a collection of dynamic array formulas in a current worksheet.
FormControls Obtains a collection of form controls contained in a worksheet.
HasData Checks whether the current worksheet contains data.
HeaderFooterOptions Provides access to header and footer options for a worksheet.
HorizontalPageBreaks Provides access to a collection of row page breaks in the worksheet.
Hyperlinks Provides access to the collection of hyperlinks contained in the worksheet.
Id Returns the sheet’s unique identifier. Inherited from Sheet.
IgnoredErrors Provides access to ranges and error types which are ignored in those ranges.
Index Gets the worksheet index within the workbook’s WorksheetCollection collection.
IsProtected Gets whether the worksheet is protected.
Item[Int32, Int32] Provides access to an individual cell by indexes of a row and column containing this cell.
Item[String] Provides access to a cell range by its reference string.
Name Gets or sets the name of the worksheet .
OutlineOptions Provides access to the group settings that control the summary row and column location.
Pictures Provides access to a collection of pictures in a worksheet.
PivotTables Provides access to the collection of pivot tables in a worksheet.
PrintOptions Provides access to options that control how the worksheet is printed.
ProtectedRanges Provides access to a collection of protected ranges in a current worksheet.
Range Provides access to the range of cells in the worksheet.
Rows Returns the collection of all rows in a worksheet.
SelectedCell Gets or sets an active cell in the worksheet.
SelectedChart Gets or sets the chart selected in a worksheet.
SelectedComment Gets or sets a comment selected in a worksheet.
SelectedPicture Gets or sets a picture selected in the worksheet.
SelectedShape Gets or sets a shape selected in the worksheet.
Selection Gets or sets a cell range selected in the worksheet.
Shapes Provides access to a collection of drawing objects (shapes, pictures, and charts) in a worksheet.
SheetType Returns the type of the sheet. Inherited from Sheet.
SparklineGroups Provides access to a collection of sparkline groups in a worksheet.
SplitLeftPosition Gets the index of the leftmost column in the bottom right pane when panes are frozen.
SplitTopPosition Gets the index of the topmost row in the bottom right pane when panes are frozen.
Tables Provides access to the collection of tables contained in the worksheet.
Tag Gets or sets the data associated with a Worksheet object.
ThreadedComments Obtains a collection of threaded comments.
VerticalPageBreaks Provides access to a collection of column page breaks in the worksheet.
VisibilityType Gets or sets whether the current worksheet is visible, hidden or “very hidden”.
Visible Gets or sets whether the current worksheet is visible or hidden.
Workbook Gets a workbook that contains the current worksheet.

Methods

Name Description
AddPrintRange(CellRange) Extends print range by merging with the specified range.
AutoOutline() Automatically creates an outline for the specified worksheet.
Calculate() Forces recalculation of the current worksheet and does not look for circular references.
Clear(CellRange) Removes cell content, formatting, hyperlinks and comments.
ClearComments(CellRange) Removes cell comments and simple notes.
ClearContents(CellRange) Removes cell content.
ClearFormats(CellRange) Removes cell formatting.
ClearHyperlinks(CellRange) Removes cell hyperlinks.
ClearOutline() Clears the outline for the specified worksheet.
ClearPrintRange() Clears the print area in the current worksheet.
CopyFrom(Worksheet, WorksheetCopyOptions) Copies data from the specified worksheet to the current worksheet and allows you to specify copy options.
CopyFrom(Worksheet) Copies the specified worksheet into the current instance.
CreateThreadedCommentAuthor(String, String, String) Creates a new object that contains information about the comment author.
DeleteCells(CellRange, DeleteMode) Deletes cells from the worksheet.
DeleteCells(CellRange) Deletes cells from a worksheet, shifting other cells in the same row to the left.
FreezeColumns(Int32, CellRange) Freezes the specified number of columns to the right of the specified cell, including the column that contains this cell.
FreezeColumns(Int32) Freezes the specified number of columns on the left side of the worksheet.
FreezePanes(Int32, Int32, CellRange) Freezes the specified number of rows and columns below and to the right of the specified cell, including the row and column containing this cell.
FreezePanes(Int32, Int32) Freezes the specified number of rows and columns at the top and on the left side of the worksheet.
FreezeRows(Int32, CellRange) Freezes the specified number of rows below the specified cell, including the row that contains this cell.
FreezeRows(Int32) Freezes the specified number of rows at the top of the worksheet.
GetCellValue(Int32, Int32) Obtains the cell value for the specified cell. Inherited from ExternalWorksheet.
GetDataRange() Gets the worksheet range that encompasses all cells containing data and formulas.
GetExistingCells() Gets the existing cells in the worksheet.
GetPrintableRange() Returns a worksheet range that can be printed.
GetPrintableRange(Boolean) Calculates a worksheet range that can be printed with respect to the specified print area.
GetProtectionPermissions() Returns the permission set for a protected worksheet.
GetSelectedRanges() Returns cell ranges currently selected in the worksheet.
GetSelectedShapes() Returns shapes currently selected in the worksheet.
GetUsedRange() Returns the used range on the specified worksheet.
InsertCells(CellRange, InsertCellsMode) Inserts new cells in the worksheet.
InsertCells(CellRange) Inserts new cells in a worksheet, shifting other cells in the same column down.
MergeCells(CellRange, MergeCellsMode) Merges cells in the specified mode.
MergeCells(CellRange) Merges the specified cells.
Move(Int32) Moves the worksheet to another location within the workbook’s collection of worksheets.
MoveAfter(String) Moves the current sheet after the specified sheet in a workbook. Inherited from Sheet.
MoveBefore(String) Moves the current sheet before the specified sheet in a workbook. Inherited from Sheet.
MoveToBeginning() Moves the current sheet to the first position in a workbook. Inherited from Sheet.
MoveToEnd() Moves the current sheet to the last position in a workbook. Inherited from Sheet.
Print() Prints the current sheet using the default printer settings. Inherited from Sheet.
Print(DXPrinterSettings) Prints the current sheet using the specified printer settings. Use this method overload in non-Windows environments. Inherited from Sheet.
Print(PrinterSettings) Prints the current sheet using the specified printer settings. Inherited from Sheet.
Protect(String, WorksheetProtectionPermissions) Protects worksheet elements to prevent them from being changed by the user.
RemoveSubtotal(CellRange) Removes subtotals for the specified cell range.
ScrollTo(CellRange) Scrolls the worksheet to the top-left cell of the specified range.
ScrollTo(Int32, Int32) Scrolls the worksheet to the specified column and row.
ScrollToColumn(Int32) Scrolls the worksheet to the specified column.
ScrollToColumn(String) Scrolls the worksheet to the specified column.
ScrollToRow(Int32) Scrolls the worksheet to the specified row.
ScrollToRow(String) Scrolls the worksheet to the specified row.
Search(String, SearchOptions) Performs a search in the worksheet using specified options.
Search(String) Performs a search in the worksheet using the default parameters.
SetPrintRange(CellRange) Defines the print range.
SetSelectedRanges(IList<CellRange>, Boolean) Selects cell ranges in the worksheet and specifies whether the selection expands to fit merged cells.
SetSelectedRanges(IList<CellRange>) Sets cell ranges selected in the worksheet.
SetSelectedShapes(IList<Shape>) Sets shapes selected in the worksheet.
Sort(CellRange, Fill, Boolean) Sorts the specified range by the specified color in the specified order.
Sort(CellRange, Fill) Sorts the specified range by the specified color in ascending order.
Sort(CellRange, Boolean) Sorts the specified range by the first column.
Sort(CellRange, IEnumerable<SortFieldBase>) Sorts the specified range by multiple columns.
Sort(CellRange, Color, Boolean) Sorts the specified range by the font color in a specific order.
Sort(CellRange, Color) Sorts the specified range by the specified font color in ascending order.
Sort(CellRange, Int32, Fill, Boolean) Sorts the specified range by the fill color in a specific order. Allows you to specify column offset.
Sort(CellRange, Int32, Fill) Sorts the specified range by the fill color. Allows you to specify column offset.
Sort(CellRange, Int32, Boolean) Sorts the specified range by the specified column.
Sort(CellRange, Int32, IComparer<CellValue>) Sorts the specified range by the specified column using the specified comparer.
Sort(CellRange, Int32, Color, Boolean) Sorts the specified range by the font color in a specific order. Allows you to specify column offset.
Sort(CellRange, Int32, Color) Sorts the specified range by the background color. Allows you to specify column offset.
Sort(CellRange, Int32) Sorts the specified range by the specified column in ascending order.
Sort(CellRange) Sorts the specified range by the first column in ascending order.
Subtotal(CellRange, Int32, List<Int32>, Int32, String) Creates subtotals for the specified range of cells.
UnfreezePanes() Unfreezes rows and columns on the worksheet.
UnMergeCells(CellRange) Unmerges the specified cells that have been merged.
Unprotect(String) Removes protection from a worksheet.
See Also