The SpreadsheetGear namespace consists primarily of interfaces and enumerations which provide access to the SpreadsheetGear for .NET spreadsheet model.
Classes
| Class | Description |
|---|---|
| ColorIndex | ColorIndex provides special constants which specify that a color should be Automatic or None (transparent). |
| Factory | The Factory class provides static methods for creating instances of IWorkbookSet and IWorkbook. |
| Orientation | Provides commonly used values for the SpreadsheetGear.IRange.Orientation property. |
| SortKey | Specifies sort key information. |
Interfaces
| Interface | Description |
|---|---|
| IAreas | Represents a collection of ranges, each of which represent a single contiguous range of one or more cells. |
| IBorder | Represents the color, style, and weight of a border. |
| IBorders | Represents the border color, border style, and border weight of a cell or range of cells. |
| ICharacters | Represents the font and text of a range of characters in a text cell or shape. |
| IChart | Represents a chart sheet. |
| IColors | Represents the color palette of a workbook. |
| IComment | Represents a cell comment. |
| IDialogSheet | Represents a dialog sheet in a workbook. |
| IFont | Represents 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. |
| IFormatCondition | Represents a conditional format. |
| IFormatConditions | Represents the conditional formats associated with a range. |
| IHPageBreak | Represents a horizontal page break (a row page break) in a worksheet. |
| IHPageBreaks | Represents the collection of horizontal page breaks (row page breaks) in a worksheet. |
| IHyperlink | Represents a hyperlink. |
| IHyperlinks | Represents a hyperlink collection. |
| IInterior | Represents the interior of a cell, range or object. |
| IModule | Represents a module. |
| IName | Represents a defined name. |
| INames | Represents the collection of defined names in a workbook or worksheet. |
| IOutline | Represents the outlining options of a worksheet. |
| IPageSetup | Represents the page setup properties of a worksheet. |
| IPane | Represents a worksheet window pane. |
| IPanes | Represents the collection of window panes associated with a worksheet. |
| IRange | Represents one or more cells, rows, columns, or ranges of cells. |
| ISheet | The base interface of all sheets in a workbook, including worksheets, chart sheets, dialog sheets, macro sheets and VBA modules. |
| ISheets | Represents all of the sheets in a workbook, including worksheets, chart sheets, dialog sheets, macro sheets and VBA modules. |
| ITab | Represents a sheet tab. |
| IValidation | Represents the data validation associated with a range of cells. |
| IVPageBreak | Represents a vertical page break (a column page break) in a worksheet. |
| IVPageBreaks | Represents the collection of vertical page breaks (column page breaks) in a worksheet. |
| IWorkbook | Represents a workbook. |
| IWorkbooks | Represents all of the workbooks in a workbook set. |
| IWorkbookSet | Manages a set of workbooks which may refer to each other by external cell references or external defined name references. |
| IWorkbookWindowInfo | Represents workbook specific window information. |
| IWorksheet | Represents a worksheet. |
| IWorksheets | Represents a collection of worksheets in a workbook. |
| IWorksheetWindowInfo | Represents worksheet specific window information. |
Enumerations
| Enumeration | Description |
|---|---|
| BordersIndex | Used as an index to IBorders to specify a border for a cell or range. |
| BorderWeight | Specifies the weight (thickness) of a border. |
| Calculation | Specifies whether a workbook set is calculated automatically. |
| DeleteShiftDirection | Specifies whether to shift cells left or up to replace deleted cells. |
| DisplayDrawingObjects | Specifies whether drawing objects are displayed on worksheets. |
| FileFormat | Specifies the file format with which to save a file. |
| FindLookIn | Specifies whether to search formulas or values. |
| FormatConditionOperator | Specifies the operator to be used by a conditional format. |
| FormatConditionType | Specifies whether a conditional format compares the values of cells of contains a formula. |
| HAlign | Specifies the horizontal alignment of a cell or object. |
| InsertShiftDirection | Specifies whether to shift existing cells right or down when inserting cells. |
| LineStyle | Specifies a line style for an object. |
| LookAt | Specifies whether to accept a partial match or require a complete match. |
| NumberFormatType | Specifies the type of a number format. |
| Order | Specifies the order for printing. |
| PageBreak | Specifies whether a page break is automatic, manual or non-existent. |
| PageBreakExtent | Specifies the extent of a page break. |
| PageOrientation | Specifies whether to print in portrait or landscape mode. |
| PaperSize | Specifies the size of the paper to print on. |
| PasteOperation | Specifies how values are combined by IRange.Copy. |
| PasteType | Specifies what is copied by IRange.Copy. |
| Pattern | Specifies the pattern of the interior of a cell or object. |
| PrintLocation | Specifies whether and where to print cell comments. |
| ReferenceStyle | Specifies whether to use A1 style or R1C1 style for cell references. |
| SearchDirection | Specifies whether to search forward (Next) or backward (Previous). |
| SearchOrder | Specifies whether to search by rows or by columns. |
| SheetType | Specifies the type of a sheet in a workbook. |
| SheetVisibility | Specifies the visibility of a worksheet. |
| SortDataOption | Specifies whether or not to sort text as numbers. |
| SortOrder | Specifies whether to sort in ascending order or descending order. |
| SortOrientation | Specifies whether to sort rows or columns. |
| SummaryColumn | Specifies whether summary columns are left of or to the right of detail columns. |
| SummaryRow | Specifies whether summary rows are above or below detail rows. |
| UnderlineStyle | Specifies the underline style of text. |
| ValidationAlertStyle | Represents the alert style to be used when data validation fails and displays an alert. |
| ValidationOperator | Represents the operator to be used with data validation types which require an operator. |
| ValidationType | Represents the type of data validation associated with a range of cells. |
| VAlign | Specifies the vertical alignment of text. |
| ValueError | Specifies the possible formula error conditions. |
| ValueType | Specifies the type of a cell value. |
| WindowView | Specifies 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 for .NET, 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.