SpreadsheetGear 2023
SpreadsheetGear Namespace (SpreadsheetGear2023)
Inheritance Hierarchy

The SpreadsheetGear namespace consists primarily of interfaces along with a few classes and enumerations which provide access to the SpreadsheetGear spreadsheet model.

Classes
 ClassDescription
ClassRepresents a year, month, day, hour, minute or second to show in an autofiltered worksheet.
ClassColorIndex provides special constants which specify that a color should be Automatic or None (transparent).
ClassContains a set of predefined colors.
ClassContains a set of default system colors.
ClassProvides data for an EndCalculate event.
ClassThe Factory class provides static methods for creating instances of IWorkbookSet and IWorkbook.
ClassProvides commonly used values for the SpreadsheetGear.IRange.Orientation property.
ClassSpecifies sort key information.
ClassContains a set of predefined system colors.
Interfaces
 InterfaceDescription
InterfaceRepresents a conditional format for above or below average values.
InterfaceRepresents a collection of ranges, each of which represent a single contiguous range of one or more cells.
InterfaceRepresents the autofilter options of a worksheet.
InterfaceRepresents the color, style, and weight of a border.
InterfaceRepresents the border color, border style, and border weight of a cell or range of cells.
InterfaceRepresents a collection of built-in document properties associated with a workbook.
InterfaceRepresents the font and text of a range of characters in a text cell or shape.
InterfaceRepresents a chart sheet.
InterfaceRepresents a collection of chartSheets in a workbook.
InterfaceRepresents chart sheet specific window information.
InterfaceRepresents a collection of IChartSheetWindowInfo instances in a chart sheet.
InterfaceRepresents the color palette of a workbook.
InterfaceRepresents a conditional format which uses color scales.
InterfaceRepresents the collection of criteria for a conditional format which uses color scales.
InterfaceRepresents an individual criterion for a conditional format which uses color scales.
InterfaceRepresents an individual color stop for a gradient fill.
InterfaceRepresents the collection of color stops for a gradient fill.
InterfaceRepresents a cell comment.
InterfaceRepresents the collection of cell comments for a worksheet.
InterfaceRepresents the minimum or maximum condition value of a conditional format.
InterfaceRepresents a conditional format which uses data bars.
InterfaceRepresents the border of a data bar conditional format.
InterfaceRepresents a dialog sheet in a workbook.
InterfaceRepresents a collection of built-in or custom document properties associated with a workbook.
InterfaceRepresents a built-in or custom document property associated with a workbook.
InterfaceRepresents a factory which created a workbook set and all of the objects contained by the workbook set.
InterfaceRepresents an object which was directly or indirectly created by a SpreadsheetGear.IFactory.
InterfaceRepresents an individual filter associated with a set of autofilters.
InterfaceRepresents the collection of filters associated with the autofilter of a worksheet.
InterfaceRepresents the font of a cell, range or object. Setting the properties of an instance of IFont modifies the font properties of the represented cell, range or object.
InterfaceRepresents the colors used by color scale and data bar conditional formats.
InterfaceRepresents a conditional format.
InterfaceRepresents the conditional formats associated with a range.
InterfaceRepresents the ILinearGradient or IRectangularGradient returned by the IRange.Interior.Gradient property.
InterfaceRepresents a horizontal page break (a row page break) in a worksheet.
InterfaceRepresents the collection of horizontal page breaks (row page breaks) in a worksheet.
InterfaceRepresents a hyperlink.
InterfaceRepresents a hyperlink collection.
InterfaceRepresents an individual icon in an icon set.
InterfaceRepresents the collection of criteria for a conditional format which uses a set of icons.
InterfaceRepresents an individual criterion for a conditional format which uses a set of icons.
InterfaceRepresents an icon set.
InterfaceRepresents a conditional format which uses a set of icons.
InterfaceRepresents a collection of icon sets.
InterfaceRepresents the interior of a cell, range or object.
InterfaceRepresents a linear gradient returned by the IInterior.Gradient property.
InterfaceRepresents a module.
InterfaceRepresents a defined name.
InterfaceRepresents the collection of defined names in a workbook or worksheet.
InterfaceRepresents the negative bar format of a data bar conditional format.
InterfaceRepresents the outlining options of a worksheet.
InterfaceRepresents the page setup properties of a worksheet.
InterfaceRepresents a worksheet window pane.
InterfaceRepresents the collection of window panes associated with a worksheet.
InterfaceMarks a class or interface as being printable.
InterfaceRepresents the fine-grained protection attributes of a worksheet.
InterfaceRepresents one or more cells, rows, columns, or ranges of cells.
InterfaceRepresents a rectangular gradient returned by the IInterior.Gradient property.
InterfaceThe base interface of all sheets in a workbook, including worksheets, chart sheets, dialog sheets, macro sheets and VBA modules.
InterfaceRepresents all of the sheets in a workbook, including worksheets, chart sheets, dialog sheets, macro sheets and VBA modules.
InterfaceRepresents an individual named cell style associated with a workbook.
InterfaceRepresents the named cell styles associated with a workbook.
InterfaceRepresents a sheet tab.
InterfaceRepresents a conditional format for top or bottom ranking values.
InterfaceRepresents a conditional format for duplicate or unique values.
InterfaceRepresents the data validation associated with a range of cells.
InterfaceRepresents a vertical page break (a column page break) in a worksheet.
InterfaceRepresents the collection of vertical page breaks (column page breaks) in a worksheet.
InterfaceRepresents a workbook.
InterfaceRepresents all of the workbooks in a workbook set.
InterfaceManages a set of workbooks which may refer to each other by external cell references or external defined name references.
InterfaceRepresents workbook specific window information.
InterfaceRepresents a collection of IWorkbookWindowInfo instances in a workbook.
InterfaceRepresents a worksheet.
InterfaceRepresents a collection of worksheets in a workbook.
InterfaceRepresents worksheet specific window information.
InterfaceRepresents a collection of IWorksheetWindowInfo instances in a worksheet.
Structures
 StructureDescription
StructureRepresents a Color in the SpreadsheetGear API.
Delegates
 DelegateDescription
DelegateRepresents the method which handles an EndCalculate event.
Enumerations
 EnumerationDescription
Enumeration 
EnumerationSpecifies the type of fill to perform.
EnumerationSpecifies whether autofilter date / time grouping filters should be grouped by year, month, day, hour, minute or second.
EnumerationSpecifies the type of filter to apply to an autofilter column.
EnumerationUsed as an index to IBorders to specify a border for a cell or range.
EnumerationSpecifies the weight (thickness) of a border.
EnumerationSpecifies whether a workbook set is calculated automatically.
Enumeration 
Enumeration 
Enumeration 
Enumeration 
Enumeration 
Enumeration 
EnumerationSpecifies the type of date operation to be performed by the IRange.DataSeries method when DataSeriesType.Chronological is used.
EnumerationSpecifies the type of operation to be performed by the IRange.DataSeries method.
EnumerationSpecifies whether to shift cells left or up to replace deleted cells.
EnumerationSpecifies whether drawing objects are displayed on worksheets.
Enumeration 
EnumerationSpecifies the type of to apply to an auto column.
EnumerationSpecifies worksheet selection restrictions when a worksheet is protected.
EnumerationSpecifies the file format with which to save a file.
EnumerationSpecifies whether to search formulas or values.
EnumerationSpecifies the operator to be used by a conditional format.
EnumerationSpecifies the type of conditional format.
EnumerationSpecifies the horizontal alignment of a cell or object.
Enumeration 
Enumeration 
EnumerationSpecifies whether to shift existing cells right or down when inserting cells.
EnumerationSpecifies a line style for an object.
EnumerationSpecifies whether to accept a partial match or require a complete match.
EnumerationSpecifies the type of a number format.
EnumerationSpecifies the order for printing.
EnumerationSpecifies whether a page break is automatic, manual or non-existent.
EnumerationSpecifies the extent of a page break.
EnumerationSpecifies whether to print in portrait or landscape mode.
EnumerationSpecifies the size of the paper to print on.
EnumerationSpecifies how values are combined by IRange.Copy.
EnumerationSpecifies what is copied by IRange.Copy.
EnumerationSpecifies the pattern of the interior of a cell or object.
EnumerationSpecifies whether and how to print cell errors.
EnumerationSpecifies whether and where to print cell comments.
EnumerationSpecifies whether to use A1 style or R1C1 style for cell references.
EnumerationSpecifies whether to search forward (Next) or backward (Previous).
EnumerationSpecifies whether to search by rows or by columns.
EnumerationSpecifies the type of a sheet in a workbook.
EnumerationSpecifies the visibility of a worksheet.
EnumerationSpecifies whether or not to sort text as numbers.
EnumerationSpecifies whether to sort in ascending order or descending order.
EnumerationSpecifies whether to sort rows or columns.
EnumerationSpecifies whether summary columns are left of or to the right of detail columns.
EnumerationSpecifies whether summary rows are above or below detail rows.
Enumeration 
Enumeration 
EnumerationSpecifies the underline style of text.
EnumerationSpecifies how Excel updates links when a workbook is loaded.
EnumerationRepresents the alert style to be used when data validation fails and displays an alert.
EnumerationRepresents the operator to be used with data validation types which require an operator.
EnumerationRepresents the type of data validation associated with a range of cells.
EnumerationSpecifies the vertical alignment of text.
EnumerationSpecifies the possible formula error conditions.
EnumerationSpecifies the type of a cell value.
EnumerationSpecifies whether a worksheet is viewed normally or in page break preview mode.
Remarks

The Factory class provides static methods for creating workbook sets and workbooks.

The IWorkbookSet interface is central to SpreadsheetGear, containing a set of workbooks and options which control the set of workbooks, including calculation options and methods. Related workbooks must be in the same workbook set if external formula references are to be updated during calculation.

The IWorkbookSet.Workbooks property returns an implementation of IWorkbooks which represents a collection of workbooks. Use this collection to add and open workbooks. Retrieve instances of IWorkbook from IWorkbooks by indexing with a zero based index number (workbooks[0]) or a workbook name (workbooks["Finance.xls"]).

IWorkbook provides properties and methods which affect a workbook, including methods to save and close workbooks.

The IWorkbook.Worksheets property returns an implementation of IWorksheets which represents a collection of worksheets. Retrieve instances of IWorksheet from IWorksheets by indexing with a zero based index number (worksheets[0]) or a worksheet name (worksheets["Sheet1"]) .

The IWorksheet.Cells property returns an implementation of IRange which represents all of the cells on a worksheet. Retrieve IRange objects which represent single cells or ranges of cells by indexing IWorksheet.Cells with a zero based row and column number (Cells[0, 0]), a string representing a cell (cells["A1"]), zero based starting and ending row numbers (Cells[row1, column1, row2, column2]) or a string representing a range (cells["B3:C5"]) or defined name (cells["JanuarySales"]).

The IRange interface provides properties to get and set cell attributes including values, formulas, number formats, fonts, borders, patterns and colors as well as methods to copy, insert, delete, copy from or to DataTables and more.

See Also

Reference

SpreadsheetGear2023 Assembly