SpreadsheetGear Namespace (SpreadsheetGear2023)

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

Classes

	Class	Description
	AutoFilterDateTimeGroupItem	Represents a year, month, day, hour, minute or second to show in an autofiltered worksheet.
	ColorIndex	ColorIndex provides special constants which specify that a color should be Automatic or None (transparent).
	Colors	Contains a set of predefined colors.
	DefaultSystemColors	Contains a set of default system colors.
	EndCalculateEventArgs	Provides data for an EndCalculate event.
	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.
	SystemColors	Contains a set of predefined system colors.

Interfaces

	Interface	Description
	IAboveAverage	Represents a conditional format for above or below average values.
	IAreas	Represents a collection of ranges, each of which represent a single contiguous range of one or more cells.
	IAutoFilter	Represents the autofilter options of a worksheet.
	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.
	IBuiltinDocumentProperties	Represents a collection of built-in document properties associated with a workbook.
	ICharacters	Represents the font and text of a range of characters in a text cell or shape.
	IChartSheet	Represents a chart sheet.
	IChartSheets	Represents a collection of chartSheets in a workbook.
	IChartSheetWindowInfo	Represents chart sheet specific window information.
	IChartSheetWindowInfos	Represents a collection of IChartSheetWindowInfo instances in a chart sheet.
	IColors	Represents the color palette of a workbook.
	IColorScale	Represents a conditional format which uses color scales.
	IColorScaleCriteria	Represents the collection of criteria for a conditional format which uses color scales.
	IColorScaleCriterion	Represents an individual criterion for a conditional format which uses color scales.
	IColorStop	Represents an individual color stop for a gradient fill.
	IColorStops	Represents the collection of color stops for a gradient fill.
	IComment	Represents a cell comment.
	IComments	Represents the collection of cell comments for a worksheet.
	IConditionValue	Represents the minimum or maximum condition value of a conditional format.
	IDatabar	Represents a conditional format which uses data bars.
	IDataBarBorder	Represents the border of a data bar conditional format.
	IDialogSheet	Represents a dialog sheet in a workbook.
	IDocumentProperties	Represents a collection of built-in or custom document properties associated with a workbook.
	IDocumentProperty	Represents a built-in or custom document property associated with a workbook.
	IFactory	Represents a factory which created a workbook set and all of the objects contained by the workbook set.
	IFactoryChild	Represents an object which was directly or indirectly created by a `SpreadsheetGear.IFactory`.
	IFilter	Represents an individual filter associated with a set of autofilters.
	IFilters	Represents the collection of filters associated with the autofilter of a worksheet.
	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.
	IFormatColor	Represents the colors used by color scale and data bar conditional formats.
	IFormatCondition	Represents a conditional format.
	IFormatConditions	Represents the conditional formats associated with a range.
	IGradient	Represents the ILinearGradient or IRectangularGradient returned by the IRange.Interior.Gradient property.
	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.
	IIcon	Represents an individual icon in an icon set.
	IIconCriteria	Represents the collection of criteria for a conditional format which uses a set of icons.
	IIconCriterion	Represents an individual criterion for a conditional format which uses a set of icons.
	IIconSet	Represents an icon set.
	IIconSetCondition	Represents a conditional format which uses a set of icons.
	IIconSets	Represents a collection of icon sets.
	IInterior	Represents the interior of a cell, range or object.
	ILinearGradient	Represents a linear gradient returned by the IInterior.Gradient property.
	IModule	Represents a module.
	IName	Represents a defined name.
	INames	Represents the collection of defined names in a workbook or worksheet.
	INegativeBarFormat	Represents the negative bar format of a data bar conditional format.
	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.
	IPrintable	Marks a class or interface as being printable.
	IProtection	Represents the fine-grained protection attributes of a worksheet.
	IRange	Represents one or more cells, rows, columns, or ranges of cells.
	IRectangularGradient	Represents a rectangular gradient returned by the IInterior.Gradient property.
	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.
	IStyle	Represents an individual named cell style associated with a workbook.
	IStyles	Represents the named cell styles associated with a workbook.
	ITab	Represents a sheet tab.
	ITop10	Represents a conditional format for top or bottom ranking values.
	IUniqueValues	Represents a conditional format for duplicate or unique values.
	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.
	IWorkbookWindowInfos	Represents a collection of IWorkbookWindowInfo instances in a workbook.
	IWorksheet	Represents a worksheet.
	IWorksheets	Represents a collection of worksheets in a workbook.
	IWorksheetWindowInfo	Represents worksheet specific window information.
	IWorksheetWindowInfos	Represents a collection of IWorksheetWindowInfo instances in a worksheet.

Structures

	Structure	Description
	Color	Represents a Color in the SpreadsheetGear API.

Delegates

	Delegate	Description
	EndCalculateEventHandler	Represents the method which handles an EndCalculate event.

Enumerations

	Enumeration	Description
	AboveBelow
	AutoFillType	Specifies the type of fill to perform.
	AutoFilterDateTimeGrouping	Specifies whether autofilter date / time grouping filters should be grouped by year, month, day, hour, minute or second.
	AutoFilterOperator	Specifies the type of filter to apply to an autofilter column.
	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.
	ConditionValueTypes
	ContainsOperator
	DataBarAxisPosition
	DataBarBorderType
	DataBarFillType
	DataBarNegativeColorType
	DataSeriesDate	Specifies the type of date operation to be performed by the IRange.DataSeries method when DataSeriesType.Chronological is used.
	DataSeriesType	Specifies the type of operation to be performed by the IRange.DataSeries method.
	DeleteShiftDirection	Specifies whether to shift cells left or up to replace deleted cells.
	DisplayDrawingObjects	Specifies whether drawing objects are displayed on worksheets.
	DupeUnique
	DynamicFilterCriteria	Specifies the type of to apply to an auto column.
	EnableSelection	Specifies worksheet selection restrictions when a worksheet is protected.
	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 the type of conditional format.
	HAlign	Specifies the horizontal alignment of a cell or object.
	Icon
	IconSet
	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.
	PrintErrors	Specifies whether and how to print cell errors.
	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.
	TimePeriods
	TopBottom
	UnderlineStyle	Specifies the underline style of text.
	UpdateLinks	Specifies how Excel updates links when a workbook is loaded.
	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, 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.

Reference

SpreadsheetGear2023 Assembly