Spire.XLS API

Spire.Xls Namespace

Classes

	Class	Description
	BookmarkHyperlink	Represents a hyperlink that can be used to bookmark a specific location within a document.
	CellBorder	Represents a cell border.
	CellRange	Represents a range of cells in a grid or spreadsheet.
	CellStyle	Represents the style of the cell range. Examples The following code illustrates how to the style of the specified range: Copy <para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Set text</para><para>worksheet["C2"].Text = "Sample";</para><para>//Add and set style</para><para>CellStyle style = workbook.Styles.Add("BorderStyle");</para><para>style.Color = Color.Red;</para><para>worksheet["C2"].Style = style;</para><para>//Save to file</para><para>workbook.SaveToFile("Style.xlsx");</para>
	CellStyleFlag	Represents a set of flags that define the style of a cell in a spreadsheet.
	CellStyleObject	RepresentsCellStyleObject
	Chart	Represents a chart shape in a spreadsheet.
	ChartShadow	Represents Chart`s Shadow
	ChartSheet	Represents a ChartSheet
	ColorScale	The color scale condition in the conditional format
	ConditionalFormat	Contains a condition and the formatting for cells.
	ConditionalFormats	Contains a condition and the formatting for cells.
	ConditionalFormatWrapper	Summary description for ConditionalFormatWrapper.
	ConditionValue	Represents single condition value for iconset, databar, colorscale conditions.
	ConverterSetting	Convert Setting
	CustomFontData	Represents custom font data.
	DataBar	Represents a data bar conditional formating rule.
	DBConnection	Represents a database connection that extends the functionality of an external connection.
	DocumentProperty	Represents a property of a document.
	ExcelAddInFunction	Represents a single add-in, either installed or not installed.
	ExcelComment	Represents a comment in an Excel worksheet.
	ExcelCommentObject	Represents an Excel comment object.
	ExcelFont	Represents a font in an Excel worksheet.
	ExcelGradient	Represents a gradient fill in an Excel spreadsheet.
	ExcelInterior	Represents the interior object for extended format . This class provides methods and properties to set the fill color, pattern, and other styling options for cell interiors.
	ExcelPicture	Represents an Excel picture shape within a spreadsheet.
	ExportTableOptions	Options class for exporting to a DataTable, used to configure export behavior.
	ExternalConnection	Represents an abstract class for external database connections.
	ExternalLink	Represents an external link in a spreadsheet, inheriting from Spire.Xls.Core.Spreadsheet.XlsObject.
	Format3D	Represents a 3D format object in a spreadsheet.
	GoalSeek	Goal seek.
	GoalSeekResult	Goal seek calculate result.
	HPageBreak	Represents a horizontal page break in a spreadsheet.
	HyperLink	Represents a hyperlink in a spreadsheet.
	IconSet	Conditional formatting icon set condition.
	ImportObjectOptions	Represents options for importing objects.
	MarkerDesigner	WorkbookDesignerused for template markers to the workbook and worksheet.
	OColor	This object used to store, convert colors.
	OdsPageBackground	Represents the background settings for an ODS (OpenDocument Spreadsheet) page.
	PageImagePaintedEventArgs	Represents the event arguments for the PageImagePainted event.
	PageSetup	Represents the page setup description. The PageSetup object contains all page setup attributes (left margin, bottom margin, paper size, and so on) as properties.
	PivotCache	Represents a cache of data used by a PivotTable in Excel. The PivotCache stores the data source and any filters or transformations applied to the data, which can then be used to quickly refresh the PivotTable without re-querying the original data source.
	PivotField	Represents a field in a pivot table, which can be used to define the rows, columns, values, or filters in the pivot table.
	PivotTable	Represents a pivot table that summarizes and organizes data in a tabular format, allowing for dynamic analysis and reporting.
	PivotTableFields	Represents a collection of fields in a pivot table, which are used to categorize, summarize, and filter data.
	QueryTableXls	Represents QueryTable information.
	ReferRangeArea	Represents a reference range area.
	RichText	Represents a rich text object in a Spire.Xls worksheet.
	RichTextObject	Represents a rich text object in a spreadsheet.
	SaveShapeTypeOption	Specifies the shape type that needs to be converted to a picture, and defaults to all types
	ShapeGlow	Represents a shape that can glow.
	ShapeReflection	Represents a class for shape reflection operations.
	Sparkline	A sparkline represents a tiny chart or graphic in a worksheet cell that provides a visual representation of data.
	SparklineCollection	Represents the SparklineCollection.
	SparklineGroup	Represents a SparklineGroup.The SparklineGroup object is a member of the SparklineGroups collection.The SparklineGroups collection contains all the SparklineGroup objects in a workheet.
	SparklineGroupCollection	The SparklineGroupCollection represents the collection of SparklineGroup objects.
	TextSaveOptions	Represents options for saving text data.
	Validation	Represents a class for handling validation.
	VPageBreak	Represents a vertical page break.
	WebQueryConnection	Represents a connection to a web-based query service.
	Workbook	Represents a workbook.
	Worksheet	Represents a worksheet. The Worksheet object is a member of the Worksheets collection. The Worksheets collection contains all the Worksheet objects in a workbook.
	XlsConditionValue	Represents implementation of single condition value for iconset, databar, colorscale conditions.
	XlsDocumentProperty	Summary description for DocumentProperty.
	XlsSlicer	Represents a slicer in an Excel worksheet. A slicer is a visual filter that allows users to interactively filter data in a pivot table or table.
	XlsSlicerCache	Represents a slicer cache in an Excel worksheet. A slicer cache contains the state of a slicer, including its filters and items.
	XlsSlicerCacheItem	Represents a single item within a slicer cache in an Excel worksheet. This class provides properties to access and modify the state of a slicer item.
	XlsSlicerCacheItemCollection	Represents a collection of slicer cache items within an Excel worksheet. This class provides functionalities to access and manage individual slicer cache items.
	XlsSlicerCollection	Represents a collection of slicers within an Excel worksheet. This class provides functionalities to add, remove, access, and manage slicers.

Structures

	Structure	Description
	PageColRow	Represents a range of columns and rows on a page, defined by starting and ending column and row indices.

Interfaces

	Interface	Description
	IConditionValue	Represents single condition value for iconset, databar, colorscale conditions.
	IPropertyData

Delegates

	Delegate	Description
	PageImagePaintedHandler	Represents a method that will handle the PageImagePainted event.

Enumerations

	Enumeration	Description
	AlertStyleType	Possible error style values:
	AutoFormatOptions	Represents auto format options.
	AutoFormatType	Represents auto format values.
	AverageType	Average type.
	AxisLineIdentifierType	Axis line indentifier type.
	AxisTextDirectionType	Represents axis text direction.
	AxisType	Primary axis types for Charts..
	AxisTypes	Axis types.
	BaseFormatType	Base format options.
	BordersLineType	Specifies border and diagonal line types in Excel.
	BubbleSizeType	Bubble size.
	BuiltInPropertyType	SummaryInformation property type.
	BuiltInStyles	Specifies existing built-in styles for Excel 2007.
	CategoryType	Represents category type.
	CellDataType	Cell data types:
	CellFormatType	Cell format types.
	ChartBackgroundMode	Chart background mode.
	ChartBaseUnitType	Represents chart base unit.
	ChartDisplayUnitType	Represents excel chart uint to display.
	ChartExPositionAlignment	It represent side position alignment of a chart element
	ChartExSidePosition	It specifies an enumeration of side positions
	ChartLinePatternType	Chart line patterns.
	ChartLineWeightType	Chart line weight values type.
	ChartMarkerType	Chart marker types.
	ChartParagraphType	MS Chart Font Type
	ChartPieType	Chart pile type.
	ChartPlotEmptyType	Chart plot empty type.
	ChartStyleElements	Contains the list of style elements
	CheckState	Specifies check state of the check box.
	ColorModel	Contains the list of color models
	ColorType	Color types.
	CommentHAlignType	Comment horizontally align.
	CommentVAlignType	Comment vertically align
	ComparisonOperatorType	The Comparison operator for conditional formatting in Excel.
	CompoundLineType	Represents style of drawing lines.
	ConditionalFormatScope	Reperesents the scope of conditional formatting applied in the PivotTable
	ConditionalFormatType	Conditional formatting type.
	ConditionalTopNType	This simple type defines the values for the Top N conditional formatting evaluation for the PivotTable
	ConditionValuePosition	Specifies condition value position.
	ConditionValueType	Specifies the types of condition values that can be used.
	ConnectionDataSourceType
	CopyRangeOptions	Enumeration to specify the options to update formulas and merged ranges during copy range operation.
	DataLabelPositionType	Represents Data label placement.
	DataSourceType	Data source type.
	DeleteOption	Represents the options available for deleting Range.
	DropLineStyleType	Drop line style type.
	EndLineCap	This simple type enumeration specifies how to cap the ends of lines.
	ErrorBarIncludeType	Represents error bar include values.
	ErrorBarType	Error-bar type.
	Excel2007DataLabelPos	Represents the data label positioning.
	Excel2016Charttype
	ExcelCalculationMode	Enum that defines different types of the formula calculations.
	ExcelChartType	Chart types.
	ExcelClearOptions	Enumeration of possible directions to clear the Cell formats, content, comments or clear all of them.
	ExcelColors	Predefined colors in excel.
	ExcelComboType	Represents possible combo box type values.
	ExcelFindOptions	Possible type of finding options
	ExcelHorizontalAlignment	Represents different horizontal alignments
	ExcelPatternType	Patterns style.
	ExcelQuartileCalculation	It represents Quartile calculation used for Box and Whisker Chart series
	ExcelSaveType	Enumeration of the Save types in Excel.
	ExcelShapeType	Excel shapes.
	ExcelSheetType	Sheet types.
	ExcelTotalsCalculation	Specifies the type of calculation in the Totals row of a list column.
	ExcelTreeMapLabelOption	It represents the Label position in Tree Map chart
	ExcelVersion	Represents possible excel versions.
	ExcelVerticalAlignment	Represents different vertical alignments
	ExpandCollapseFlags	Flags for expand/collapse settings.
	FileFormat	Represents possible excel versions.
	FilterConditionType	Filter conditions.
	FilterDataType	Data type for filters.
	FindType	Possible types of param, specified as string, number in FindFirst, FindAll methods.
	FontCollectionIndex	Enumeration represents one of the fonts associated with the style.
	FontUnderlineType	Font underline types.
	FontVertialAlignmentType	Defines the possible settings for vertical alignment of a run of text. This is used to get superscript or subscript text without altering the font size properties of the rest of the text run.
	GradientColorType	Represents gradient color type.
	GradientPatternType	Represents excel gradient pattern.
	GradientPresetType	Represents preset gradient type.
	GradientStyleType	Represents excel shape shading style.
	GradientTextureType	Represents gradient texture.
	GradientVariantsType	Represents shape shading variants.
	GroupByType	Enumeration of Group types in Excel.
	HorizontalAlignType	Horizontal alignment type.
	HttpContentType	HttpContent type.
	HyperLinkType	Hyper link type.
	IconSetType	Icon set type for conditional formatting. The threshold values for triggering the different icons within a set are configurable, and the icon order is reversible.
	IgnoreErrorType	Represents flags of excel ignore error indicator.
	ImageFormatType	Image formats.
	ImageType	Possible image types for image conversion.
	InsertMoveOption	Represents the options available for insert Range.
	InsertOptionsType	Enumeration of the insert options in Excel.
	LegendPositionType	Legend placement for charts.
	LegendSpacingType	Legend spacing for charts.
	LineShapeType	Represents different types of line shapes.
	LineStyleType	Border line styles.
	MeasureUnits	Represents the MeasureUnits types.
	MsoPathType
	OdsPageBackgroundImagePositionType
	OdsPageBackgroundImageType
	OdsPageBackgroundType
	OLEDBCommandType
	OleLinkType	Defines types of the ole object field.
	OleObjectType	defines the types of OLE object
	OrderBy	Represents the sort order.
	OrderType	Page order for sheet in Excel.
	PageBreakExtentType	Page break extent types in Excel.
	PageBreakType	Page break types in Excel.
	PageOrientationType	Page orientation types in Excel.
	PagesOrderType	Page order type
	PaperSizeType	Paper size type.
	PathFillMode
	PivotAutoFomatTypes	Represents PivotTable auto format type.
	PivotBuiltInStyles	Excel 2007 pivot table built in styles.
	PivotDataType
	PivotFieldFormatType
	PivotFieldSortType	sort orders that can be applied to fields in a PivotTable.
	PivotGroupByTypes	The groupby types of pivot field.
	PivotItemType
	PivotLabelFilterType
	PivotPageAreaFieldsOrderType	Repersents the Page field area order when there are multiple page fields in the page area
	PivotTableElement	// Represents PivotStyleMedium28 style. //
	PivotTableLayoutType	Specifies the pivot table layout
	PivotValueFilterType
	PresetTextEffect
	PrintCommentType	Print comments types.
	PrintErrorsType	Print error values.
	PrintingPageType	Indicates which pages will not be printed.
	PropertyType	Enumeration with all supported property types.
	PrstGeomShapeType	Represents the predefined geometric shapes available for use in presentations.
	ReadingOrderType	Reading order types.
	RectangleShapeType
	RectangleStyleType	Excel rectangle style.
	RenameStrategy	Renaming strategy enumeration, used to handle duplicate column names when exporting to a DataTable.
	ResizeBehaveType	Represents The ResizeBehave mode.
	SelectionType	The selection type of list box.
	ShapeArrowLengthType	Represents arrow head length.
	ShapeArrowStyleType	Represents shape arrow style type.
	ShapeArrowWidthType	Represents arrow head width.
	ShapeDashLineStyleType	Represents shape dash line style.
	ShapeFillType	Represents shape XlsFill type.
	ShapeLayerChangeType	Change target type of shape.
	ShapeLineStyleType	Represents shape line style.
	SheetProtectionType	Represents sheet protection flags enums.
	SlicerCacheCrossFilterType	Specifies the type of cross filtering applied to a slicer cache and how it is visually displayed. Cross filtering determines how slicers that are connected to the same data source interact with each other when filtering.
	SortComparsionType	Represents the sort by in the range.
	SortedWayType	Represents the algorithm to sort.
	SortOrientationType	Represents the sort orientation.
	SparklineEmptyCells	Defines the Display of the Empty Cells within the Sparkline Range.
	SparklineType	Defined types of Sparkline chart types.
	SpartlineVerticalAxisType	Defines the Sparkline vertical axis type.
	SplitType	Split type.
	StyleEntryModifierEnum	Contains the style entry modifier enumerations
	SubtotalTypes	Represents theSubtotal types.
	TableBuiltInStyles	Excel 2007 table built in styles.
	TextDirection	Represents different text direction.
	TextRotationType	Text Rotation types.
	TextVerticalValue
	ThemeColorType	theme color type
	TickLabelPositionType	Represents enum of chart tick label position values.
	TickMarkType	Represents enum of chart tick mark values.
	TopBottomType	TopBottom type.
	TopFormatType	Top format type.
	TrendLineType	Represents trend line values.
	UnknownVariableAction	Defines action that must be taken when meeting unknown variable during template markers processing.
	ValidationComparisonOperator	The Comparison operator for conditional formatting.
	VariableTypeAction	Defines value type and numberformat in the template marker variable.
	VerticalAlignType	Vertical alignment type.
	ViewMode	Defines the view setting of the sheet.
	WorksheetCopyType	Enumeration to specify options when copying worksheets.
	WorksheetVisibility	Visibility of worksheet type.
	XLSXBorderJoinType	shape border join type
	XLSXChartBevelType	This enumeration value indicates the bevel properties for both Top nad Bottom Bevel
	XLSXChartLightingType	This enumeration value indicates the Lighting properties for the Chart
	XLSXChartMaterialType	Indicates the Material property values fro the chart
	XLSXChartPrespectiveType	Indicates the Perspective shadow Values
	XLSXChartShadowInnerType	Indicates the Inner Shadow Values
	XLSXChartShadowOuterType	Indicates the Outer Shadow values
	XLSXPivotItemType	This simple type defines the Open Xml Pivot type for a pivotItem.
	XmlOpenType	Supported Xml open types.