excel package

Classes

Excel.Application

Represents the Excel application that manages the workbook.

[ API set: ExcelApi 1.1 ]

Excel.AutoFilter

Represents the AutoFilter object. AutoFilter turns the values in Excel column into specific filters based on the cell contents.

[ API set: ExcelApi 1.9 ]

Excel.Binding

Represents an Office.js binding that is defined in the workbook.

[ API set: ExcelApi 1.1 ]

Excel.BindingCollection

Represents the collection of all the binding objects that are part of the workbook.

[ API set: ExcelApi 1.1 ]

Excel.CellValueConditionalFormat

Represents a cell value conditional format.

[ API set: ExcelApi 1.6 ]

Excel.Chart

Represents a chart object in a workbook. To learn more about the Chart object model, see Work with charts using the Excel JavaScript API.

[ API set: ExcelApi 1.1 ]

Excel.ChartAreaFormat

Encapsulates the format properties for the overall chart area.

[ API set: ExcelApi 1.1 ]

Excel.ChartAxes

Represents the chart axes.

[ API set: ExcelApi 1.1 ]

Excel.ChartAxis

Represents a single axis in a chart.

[ API set: ExcelApi 1.1 ]

Excel.ChartAxisFormat

Encapsulates the format properties for the chart axis.

[ API set: ExcelApi 1.1 ]

Excel.ChartAxisTitle

Represents the title of a chart axis.

[ API set: ExcelApi 1.1 ]

Excel.ChartAxisTitleFormat

Represents the chart axis title formatting.

[ API set: ExcelApi 1.1 ]

Excel.ChartBinOptions

Encapsulates the bin options for histogram charts and pareto charts.

[ API set: ExcelApi 1.9 ]

Excel.ChartBorder

Represents the border formatting of a chart element.

[ API set: ExcelApi 1.7 ]

Excel.ChartBoxwhiskerOptions

Represents the properties of a box and whisker chart.

[ API set: ExcelApi 1.9 ]

Excel.ChartCollection

A collection of all the chart objects on a worksheet.

[ API set: ExcelApi 1.1 ]

Excel.ChartDataLabel

Represents the data label of a chart point.

[ API set: ExcelApi 1.7 ]

Excel.ChartDataLabelFormat

Encapsulates the format properties for the chart data labels.

[ API set: ExcelApi 1.1 ]

Excel.ChartDataLabels

Represents a collection of all the data labels on a chart point.

[ API set: ExcelApi 1.1 ]

Excel.ChartErrorBars

This object represents the attributes for a chart's error bars.

[ API set: ExcelApi 1.9 ]

Excel.ChartErrorBarsFormat

Encapsulates the format properties for chart error bars.

[ API set: ExcelApi 1.9 ]

Excel.ChartFill

Represents the fill formatting for a chart element.

[ API set: ExcelApi 1.1 ]

Excel.ChartFont

This object represents the font attributes (font name, font size, color, etc.) for a chart object.

[ API set: ExcelApi 1.1 ]

Excel.ChartFormatString

Represents the substring in chart related objects that contains text, like ChartTitle object, ChartAxisTitle object, etc.

[ API set: ExcelApi 1.7 ]

Excel.ChartGridlines

Represents major or minor gridlines on a chart axis.

[ API set: ExcelApi 1.1 ]

Excel.ChartGridlinesFormat

Encapsulates the format properties for chart gridlines.

[ API set: ExcelApi 1.1 ]

Excel.ChartLegend

Represents the legend in a chart.

[ API set: ExcelApi 1.1 ]

Excel.ChartLegendEntry

Represents the legendEntry in legendEntryCollection.

[ API set: ExcelApi 1.7 ]

Excel.ChartLegendEntryCollection

Represents a collection of legendEntries.

[ API set: ExcelApi 1.7 ]

Excel.ChartLegendFormat

Encapsulates the format properties of a chart legend.

[ API set: ExcelApi 1.1 ]

Excel.ChartLineFormat

Encapsulates the formatting options for line elements.

[ API set: ExcelApi 1.1 ]

Excel.ChartMapOptions

Encapsulates the properties for a region map chart.

[ API set: ExcelApi 1.9 ]

Excel.ChartPivotOptions

Encapsulates the options for the pivot chart.

[ API set: ExcelApi 1.9 ]

Excel.ChartPlotArea

This object represents the attributes for a chart plotArea object.

[ API set: ExcelApi 1.8 ]

Excel.ChartPlotAreaFormat

Represents the format properties for chart plotArea.

[ API set: ExcelApi 1.8 ]

Excel.ChartPoint

Represents a point of a series in a chart.

[ API set: ExcelApi 1.1 ]

Excel.ChartPointFormat

Represents formatting object for chart points.

[ API set: ExcelApi 1.1 ]

Excel.ChartPointsCollection

A collection of all the chart points within a series inside a chart.

[ API set: ExcelApi 1.1 ]

Excel.ChartSeries

Represents a series in a chart.

[ API set: ExcelApi 1.1 ]

Excel.ChartSeriesCollection

Represents a collection of chart series.

[ API set: ExcelApi 1.1 ]

Excel.ChartSeriesFormat

Encapsulates the format properties for the chart series

[ API set: ExcelApi 1.1 ]

Excel.ChartTitle

Represents a chart title object of a chart.

[ API set: ExcelApi 1.1 ]

Excel.ChartTitleFormat

Provides access to the office art formatting for chart title.

[ API set: ExcelApi 1.1 ]

Excel.ChartTrendline

This object represents the attributes for a chart trendline object.

[ API set: ExcelApi 1.7 ]

Excel.ChartTrendlineCollection

Represents a collection of Chart Trendlines.

[ API set: ExcelApi 1.7 ]

Excel.ChartTrendlineFormat

Represents the format properties for chart trendline.

[ API set: ExcelApi 1.7 ]

Excel.ChartTrendlineLabel

This object represents the attributes for a chart trendline lable object.

[ API set: ExcelApi 1.8 ]

Excel.ChartTrendlineLabelFormat

Encapsulates the format properties for the chart trendline label.

[ API set: ExcelApi 1.8 ]

Excel.ColorScaleConditionalFormat

Represents an IconSet criteria for conditional formatting.

[ API set: ExcelApi 1.6 ]

Excel.Comment

Represents a comment in the workbook.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

Excel.CommentCollection

Represents a collection of comment objects that are part of the workbook.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

Excel.CommentReply

Represents a comment reply in the workbook.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

Excel.CommentReplyCollection

Represents a collection of comment reply objects that are part of the comment.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

Excel.ConditionalDataBarNegativeFormat

Represents a conditional format DataBar Format for the negative side of the data bar.

[ API set: ExcelApi 1.6 ]

Excel.ConditionalDataBarPositiveFormat

Represents a conditional format DataBar Format for the positive side of the data bar.

[ API set: ExcelApi 1.6 ]

Excel.ConditionalFormat

An object encapsulating a conditional format's range, format, rule, and other properties. To learn more about the conditional formatting object model, read Apply conditional formatting to Excel ranges.

[ API set: ExcelApi 1.6 ]

Excel.ConditionalFormatCollection

Represents a collection of all the conditional formats that are overlap the range.

[ API set: ExcelApi 1.6 ]

Excel.ConditionalFormatRule

Represents a rule, for all traditional rule/format pairings.

[ API set: ExcelApi 1.6 ]

Excel.ConditionalRangeBorder

Represents the border of an object.

[ API set: ExcelApi 1.6 ]

Excel.ConditionalRangeBorderCollection

Represents the border objects that make up range border.

[ API set: ExcelApi 1.6 ]

Excel.ConditionalRangeFill

Represents the background of a conditional range object.

[ API set: ExcelApi 1.6 ]

Excel.ConditionalRangeFont

This object represents the font attributes (font style, color, etc.) for an object.

[ API set: ExcelApi 1.6 ]

Excel.ConditionalRangeFormat

A format object encapsulating the conditional formats range's font, fill, borders, and other properties.

[ API set: ExcelApi 1.6 ]

Excel.CustomConditionalFormat

Represents a custom conditional format type.

[ API set: ExcelApi 1.6 ]

Excel.CustomProperty

Represents a custom property.

[ API set: ExcelApi 1.7 ]

Excel.CustomPropertyCollection

Contains the collection of customProperty objects.

[ API set: ExcelApi 1.7 ]

Excel.CustomXmlPart

Represents a custom XML part object in a workbook.

[ API set: ExcelApi 1.5 ]

Excel.CustomXmlPartCollection

A collection of custom XML parts.

[ API set: ExcelApi 1.5 ]

Excel.CustomXmlPartScopedCollection

A scoped collection of custom XML parts. A scoped collection is the result of some operation, e.g. filtering by namespace. A scoped collection cannot be scoped any further.

[ API set: ExcelApi 1.5 ]

Excel.DataBarConditionalFormat

Represents an Excel Conditional Data Bar Type.

[ API set: ExcelApi 1.6 ]

Excel.DataConnectionCollection

Represents a collection of all the Data Connections that are part of the workbook or worksheet.

[ API set: ExcelApi 1.7 ]

Excel.DataPivotHierarchy

Represents the Excel DataPivotHierarchy.

[ API set: ExcelApi 1.8 ]

Excel.DataPivotHierarchyCollection

Represents a collection of DataPivotHierarchy items associated with the PivotTable.

[ API set: ExcelApi 1.8 ]

Excel.DataValidation

Represents the data validation applied to the current range. To learn more about the data validation object model, read Add data validation to Excel ranges.

[ API set: ExcelApi 1.8 ]

Excel.DocumentProperties

Represents workbook properties.

[ API set: ExcelApi 1.7 ]

Excel.Filter

Manages the filtering of a table's column.

[ API set: ExcelApi 1.2 ]

Excel.FilterPivotHierarchy

Represents the Excel FilterPivotHierarchy.

[ API set: ExcelApi 1.8 ]

Excel.FilterPivotHierarchyCollection

Represents a collection of FilterPivotHierarchy items associated with the PivotTable.

[ API set: ExcelApi 1.8 ]

Excel.FormatProtection

Represents the format protection of a range object.

[ API set: ExcelApi 1.2 ]

Excel.FunctionResult

An object containing the result of a function-evaluation operation

[ API set: ExcelApi 1.2 ]

Excel.Functions

An object for evaluating Excel functions.

[ API set: ExcelApi 1.2 ]

Excel.GeometricShape

Represents a geometric shape inside a worksheet. A geometric shape can be a rectangle, block arrow, equation symbol, flowchart item, star, banner, callout, or any other basic shape in Excel.

[ API set: ExcelApi 1.9 ]

Excel.GroupShapeCollection

Represents the shape collection inside a shape group.

[ API set: ExcelApi 1.9 ]

Excel.HeaderFooter

[ API set: ExcelApi 1.9 ]

Excel.HeaderFooterGroup

[ API set: ExcelApi 1.9 ]

Excel.IconSetConditionalFormat

Represents an IconSet criteria for conditional formatting.

[ API set: ExcelApi 1.6 ]

Excel.Image

Represents an image in the worksheet. To get the corresponding Shape object, use Image.shape.

[ API set: ExcelApi 1.9 ]

Excel.IterativeCalculation

Represents the Iterative Calculation settings.

[ API set: ExcelApi 1.9 ]

Excel.Line

Represents a line inside a worksheet. To get the corresponding Shape object, use Line.shape.

[ API set: ExcelApi 1.9 ]

Excel.NamedItem

Represents a defined name for a range of cells or value. Names can be primitive named objects (as seen in the type below), range object, or a reference to a range. This object can be used to obtain range object associated with names.

[ API set: ExcelApi 1.1 ]

Excel.NamedItemArrayValues

Represents an object containing values and types of a named item.

[ API set: ExcelApi 1.7 ]

Excel.NamedItemCollection

A collection of all the NamedItem objects that are part of the workbook or worksheet, depending on how it was reached.

[ API set: ExcelApi 1.1 ]

Excel.PageBreak

[ API set: ExcelApi 1.9 ]

Excel.PageBreakCollection

[ API set: ExcelApi 1.9 ]

Excel.PageLayout

Represents layout and print settings that are not dependent any printer-specific implementation. These settings include margins, orientation, page numbering, title rows, and print area.

[ API set: ExcelApi 1.9 ]

Excel.PivotField

Represents the Excel PivotField.

[ API set: ExcelApi 1.8 ]

Excel.PivotFieldCollection

Represents a collection of all the PivotFields that are part of a PivotTable's hierarchy.

[ API set: ExcelApi 1.8 ]

Excel.PivotHierarchy

Represents the Excel PivotHierarchy.

[ API set: ExcelApi 1.8 ]

Excel.PivotHierarchyCollection

Represents a collection of all the PivotHierarchies that are part of the PivotTable.

[ API set: ExcelApi 1.8 ]

Excel.PivotItem

Represents the Excel PivotItem.

[ API set: ExcelApi 1.8 ]

Excel.PivotItemCollection

Represents a collection of all the PivotItems related to their parent PivotField.

[ API set: ExcelApi 1.8 ]

Excel.PivotLayout

Represents the visual layout of the PivotTable.

[ API set: ExcelApi 1.8 ]

Excel.PivotTable

Represents an Excel PivotTable. To learn more about the PivotTable object model, read Work with PivotTables using the Excel JavaScript API.

[ API set: ExcelApi 1.3 ]

Excel.PivotTableCollection

Represents a collection of all the PivotTables that are part of the workbook or worksheet.

[ API set: ExcelApi 1.3 ]

Excel.PivotTableStyle

Represents a PivotTable Style, which defines style elements by PivotTable region.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

Excel.PivotTableStyleCollection

Represents a collection of PivotTable styles.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

Excel.PresetCriteriaConditionalFormat

Represents the the preset criteria conditional format such as above average, below average, unique values, contains blank, nonblank, error, and noerror.

[ API set: ExcelApi 1.6 ]

Excel.Range

Range represents a set of one or more contiguous cells such as a cell, a row, a column, block of cells, etc. To learn more about how ranges are used throughout the API, read Work with ranges using the Excel JavaScript API and Work with ranges using the Excel JavaScript API (advanced).

[ API set: ExcelApi 1.1 ]

Excel.RangeAreas

RangeAreas represents a collection of one or more rectangular ranges in the same worksheet. To learn how to use discontinguous ranges, read Work with multiple ranges simultaneously in Excel add-ins.

[ API set: ExcelApi 1.9 ]

Excel.RangeBorder

Represents the border of an object.

[ API set: ExcelApi 1.1 ]

Excel.RangeBorderCollection

Represents the border objects that make up the range border.

[ API set: ExcelApi 1.1 ]

Excel.RangeCollection

[ API set: ExcelApi 1.9 ]

Excel.RangeFill

Represents the background of a range object.

[ API set: ExcelApi 1.1 ]

Excel.RangeFont

This object represents the font attributes (font name, font size, color, etc.) for an object.

[ API set: ExcelApi 1.1 ]

Excel.RangeFormat

A format object encapsulating the range's font, fill, borders, alignment, and other properties.

[ API set: ExcelApi 1.1 ]

Excel.RangeSort

Manages sorting operations on Range objects.

[ API set: ExcelApi 1.2 ]

Excel.RangeView

RangeView represents a set of visible cells of the parent range.

[ API set: ExcelApi 1.3 ]

Excel.RangeViewCollection

Represents a collection of RangeView objects.

[ API set: ExcelApi 1.3 ]

Excel.RemoveDuplicatesResult

Represents the results from the removeDuplicates method on range

[ API set: ExcelApi 1.9 ]

Excel.RequestContext

The RequestContext object facilitates requests to the Excel application. Since the Office add-in and the Excel application run in two different processes, the request context is required to get access to the Excel object model from the add-in.

Excel.RowColumnPivotHierarchy

Represents the Excel RowColumnPivotHierarchy.

[ API set: ExcelApi 1.8 ]

Excel.RowColumnPivotHierarchyCollection

Represents a collection of RowColumnPivotHierarchy items associated with the PivotTable.

[ API set: ExcelApi 1.8 ]

Excel.Runtime

Represents the Excel Runtime class.

[ API set: ExcelApi 1.5 ]

Excel.Session

Provides connection session for a remote workbook.

Excel.Setting

Setting represents a key-value pair of a setting persisted to the document (per file per add-in). These custom key-value pair can be used to store state or lifecycle information needed by the content or task-pane add-in. Note that settings are persisted in the document and hence it is not a place to store any sensitive or protected information such as user information and password.

[ API set: ExcelApi 1.4 ]

Excel.SettingCollection

Represents a collection of key-value pair setting objects that are part of the workbook. The scope is limited to per file and add-in (task-pane or content) combination.

[ API set: ExcelApi 1.4 ]

Excel.Shape

Represents a generic shape object in the worksheet. A shape could be a geometric shape, a line, a group of shapes, etc. To learn more about the shape object model, read Work with shapes using the Excel JavaScript API.

[ API set: ExcelApi 1.9 ]

Excel.ShapeCollection

Represents a collection of all the shapes in the worksheet.

[ API set: ExcelApi 1.9 ]

Excel.ShapeFill

Represents the fill formatting of a shape object.

[ API set: ExcelApi 1.9 ]

Excel.ShapeFont

Represents the font attributes, such as font name, font size, and color, for a shape's TextRange object.

[ API set: ExcelApi 1.9 ]

Excel.ShapeGroup

Represents a shape group inside a worksheet. To get the corresponding Shape object, use ShapeGroup.shape.

[ API set: ExcelApi 1.9 ]

Excel.ShapeLineFormat

Represents the line formatting for the shape object. For images and geometric shapes, line formatting represents the border of the shape.

[ API set: ExcelApi 1.9 ]

Excel.Slicer

Represents a slicer object in the workbook.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

Excel.SlicerCollection

Represents a collection of all the slicer objects on the workbook or a worksheet.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

Excel.SlicerItem

Represents a slicer item in a slicer.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

Excel.SlicerItemCollection

Represents a collection of all the slicer item objects on the slicer.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

Excel.SlicerStyle

Represents a Slicer Style, which defines style elements by region of the slicer.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

Excel.SlicerStyleCollection

Represents a collection of SlicerStyle objects.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

Excel.Style

An object encapsulating a style's format and other properties.

[ API set: ExcelApi 1.7 ]

Excel.StyleCollection

Represents a collection of all the styles.

[ API set: ExcelApi 1.7 ]

Excel.Table

Represents an Excel table. To learn more about the table object model, read Work with tables using the Excel JavaScript API.

[ API set: ExcelApi 1.1 ]

Excel.TableCollection

Represents a collection of all the tables that are part of the workbook or worksheet, depending on how it was reached.

[ API set: ExcelApi 1.1 ]

Excel.TableColumn

Represents a column in a table.

[ API set: ExcelApi 1.1 ]

Excel.TableColumnCollection

Represents a collection of all the columns that are part of the table.

[ API set: ExcelApi 1.1 ]

Excel.TableRow

Represents a row in a table.

Note that unlike Ranges or Columns, which will adjust if new rows/columns are added before them, a TableRow object represent the physical location of the table row, but not the data. That is, if the data is sorted or if new rows are added, a table row will continue to point at the index for which it was created.

[ API set: ExcelApi 1.1 ]

Excel.TableRowCollection

Represents a collection of all the rows that are part of the table.

Note that unlike Ranges or Columns, which will adjust if new rows/columns are added before them, a TableRow object represent the physical location of the table row, but not the data. That is, if the data is sorted or if new rows are added, a table row will continue to point at the index for which it was created.

[ API set: ExcelApi 1.1 ]

Excel.TableScopedCollection

Represents a scoped collection of tables. For each table its top-left corner is considered its anchor location and the tables are sorted top to bottom and then left to right.

[ API set: ExcelApi 1.9 ]

Excel.TableSort

Manages sorting operations on Table objects.

[ API set: ExcelApi 1.2 ]

Excel.TableStyle

Represents a TableStyle, which defines the style elements by region of the Table.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

Excel.TableStyleCollection

Represents a collection of TableStyles.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

Excel.TextConditionalFormat

Represents a specific text conditional format.

[ API set: ExcelApi 1.6 ]

Excel.TextFrame

Represents the text frame of a shape object.

[ API set: ExcelApi 1.9 ]

Excel.TextRange

Contains the text that is attached to a shape, in addition to properties and methods for manipulating the text.

[ API set: ExcelApi 1.9 ]

Excel.TimelineStyle

Represents a Timeline style, which defines style elements by region in the Timeline.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

Excel.TimelineStyleCollection

Represents a collection of TimelineStyles.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

Excel.TopBottomConditionalFormat

Represents a Top/Bottom conditional format.

[ API set: ExcelApi 1.6 ]

Excel.Workbook

Workbook is the top level object which contains related workbook objects such as worksheets, tables, ranges, etc. To learn more about the workbook object model, read Work with workbooks using the Excel JavaScript API.

[ API set: ExcelApi 1.1 ]

Excel.WorkbookCreated

The WorkbookCreated object is the top level object created by Application.CreateWorkbook. A WorkbookCreated object is a special Workbook object.

[ API set: ExcelApi 1.8 ]

Excel.WorkbookProtection

Represents the protection of a workbook object.

[ API set: ExcelApi 1.7 ]

Excel.Worksheet

An Excel worksheet is a grid of cells. It can contain data, tables, charts, etc. To learn more about the worksheet object model, read Work with worksheets using the Excel JavaScript API.

[ API set: ExcelApi 1.1 ]

Excel.WorksheetCollection

Represents a collection of worksheet objects that are part of the workbook.

[ API set: ExcelApi 1.1 ]

Excel.WorksheetFreezePanes

[ API set: ExcelApi 1.7 ]

Excel.WorksheetProtection

Represents the protection of a sheet object.

[ API set: ExcelApi 1.2 ]

Interfaces

Excel.BasicDataValidation

Represents the Basic Type data validation criteria.

[ API set: ExcelApi 1.8 ]

Excel.BindingDataChangedEventArgs

Provides information about the binding that raised the DataChanged event.

[ API set: ExcelApi 1.2 ]

Excel.BindingSelectionChangedEventArgs

Provides information about the binding that raised the SelectionChanged event.

[ API set: ExcelApi 1.2 ]

Excel.CellBorder

Represents the properties of a single border returned by getCellProperties, getRowProperties, and getColumnProperties or the border property input parameter of setCellProperties, setRowProperties, and setColumnProperties.

[ API set: ExcelApi 1.9 ]

Excel.CellBorderCollection

Represents the format.borders properties of getCellProperties, getRowProperties, and getColumnProperties or the format.borders input parameter of setCellProperties, setRowProperties, and setColumnProperties.

[ API set: ExcelApi 1.9 ]

Excel.CellProperties

Represents the returned properties of getCellProperties.

[ API set: ExcelApi 1.9 ]

Excel.CellPropertiesBorderLoadOptions

Specifies which properties to load on the format.borders object.

[ API set: ExcelApi 1.9 ]

Excel.CellPropertiesFill

Represents the format.fill properties of getCellProperties, getRowProperties, and getColumnProperties or the format.fill input parameter of setCellProperties, setRowProperties, and setColumnProperties.

[ API set: ExcelApi 1.9 ]

Excel.CellPropertiesFillLoadOptions

Specifies which properties to load on the format.fill object.

[ API set: ExcelApi 1.9 ]

Excel.CellPropertiesFont

Represents the format.font properties of getCellProperties, getRowProperties, and getColumnProperties or the format.font input parameter of setCellProperties, setRowProperties, and setColumnProperties.

[ API set: ExcelApi 1.9 ]

Excel.CellPropertiesFontLoadOptions

Specifies which properties to load on the format.font object.

[ API set: ExcelApi 1.9 ]

Excel.CellPropertiesFormat

Represents the returned format properties of getCellProperties or format input parameter of setCellProperties.

[ API set: ExcelApi 1.9 ]

Excel.CellPropertiesFormatLoadOptions

Represents which properties to load on the format object.

[ API set: ExcelApi 1.9 ]

Excel.CellPropertiesLoadOptions

Represents which cell properties to load, when used as part of a "range.getCellProperties" method.

[ API set: ExcelApi 1.9 ]

Excel.CellPropertiesProtection

Represents the format.protection properties of getCellProperties, getRowProperties, and getColumnProperties or the format.protection input parameter of setCellProperties, setRowProperties, and setColumnProperties.

[ API set: ExcelApi 1.9 ]

Excel.ChangedEventDetail

Provide information about the detail of WorksheetChangedEvent/TableChangedEvent

[ API set: ExcelApi 1.9 ]

Excel.ChartActivatedEventArgs

Provides information about the chart that raised the Activated event.

[ API set: ExcelApi 1.8 ]

Excel.ChartAddedEventArgs

Provides information about the chart that raised the Added event.

[ API set: ExcelApi 1.8 ]

Excel.ChartDeactivatedEventArgs

Provides information about the chart that raised the Deactivated event.

[ API set: ExcelApi 1.8 ]

Excel.ChartDeletedEventArgs

Provides information about the chart that raised the Deleted event.

[ API set: ExcelApi 1.8 ]

Excel.ColumnProperties

Represents the returned properties of getColumnProperties.

[ API set: ExcelApi 1.9 ]

Excel.ColumnPropertiesLoadOptions

Represents which column properties to load, when used as part of a "range.getColumnProperties" method.

[ API set: ExcelApi 1.9 ]

Excel.CommentMention

Represents the entity that is mentioned in comments.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

Excel.CommentRichContent

Represents the content contained within a comment or comment reply. Rich content incudes the text string and any other objects contained within the comment body, such as mentions.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

Excel.ConditionalCellValueRule

Represents a cell value conditional format rule.

[ API set: ExcelApi 1.6 ]

Excel.ConditionalColorScaleCriteria

Represents the criteria of the color scale.

[ API set: ExcelApi 1.6 ]

Excel.ConditionalColorScaleCriterion

Represents a Color Scale Criterion which contains a type, value, and a color.

[ API set: ExcelApi 1.6 ]

Excel.ConditionalDataBarRule

Represents a rule-type for a Data Bar.

[ API set: ExcelApi 1.6 ]

Excel.ConditionalIconCriterion

Represents an Icon Criterion which contains a type, value, an Operator, and an optional custom icon, if not using an iconset.

[ API set: ExcelApi 1.6 ]

Excel.ConditionalPresetCriteriaRule

Represents the Preset Criteria Conditional Format Rule

[ API set: ExcelApi 1.6 ]

Excel.ConditionalTextComparisonRule

Represents a Cell Value Conditional Format Rule

[ API set: ExcelApi 1.6 ]

Excel.ConditionalTopBottomRule

Represents the rule of the top/bottom conditional format.

[ API set: ExcelApi 1.6 ]

Excel.CustomDataValidation

Represents the Custom data validation criteria.

[ API set: ExcelApi 1.8 ]

Excel.DataValidationErrorAlert

Represents the error alert properties for the data validation.

[ API set: ExcelApi 1.8 ]

Excel.DataValidationPrompt

Represents the user prompt properties for the data validation.

[ API set: ExcelApi 1.8 ]

Excel.DataValidationRule

Data validation rule contains different types of data validation. You can only use one of them at a time according the Excel.DataValidationType.

[ API set: ExcelApi 1.8 ]

Excel.DateTimeDataValidation

Represents the Date data validation criteria.

[ API set: ExcelApi 1.8 ]

Excel.FilterCriteria

Represents the filtering criteria applied to a column.

[ API set: ExcelApi 1.2 ]

Excel.FilterDatetime

Represents how to filter a date when filtering on values.

[ API set: ExcelApi 1.2 ]

Excel.FiveArrowsGraySet

[ API set: ExcelApi 1.2 ]

Excel.FiveArrowsSet

[ API set: ExcelApi 1.2 ]

Excel.FiveBoxesSet

[ API set: ExcelApi 1.2 ]

Excel.FiveQuartersSet

[ API set: ExcelApi 1.2 ]

Excel.FiveRatingSet

[ API set: ExcelApi 1.2 ]

Excel.FourArrowsGraySet

[ API set: ExcelApi 1.2 ]

Excel.FourArrowsSet

[ API set: ExcelApi 1.2 ]

Excel.FourRatingSet

[ API set: ExcelApi 1.2 ]

Excel.FourRedToBlackSet

[ API set: ExcelApi 1.2 ]

Excel.FourTrafficLightsSet

[ API set: ExcelApi 1.2 ]

Excel.Icon

Represents a cell icon.

[ API set: ExcelApi 1.2 ]

Excel.IconCollections

[ API set: ExcelApi 1.2 ]

Excel.Interfaces.ApplicationData

An interface describing the data returned by calling application.toJSON().

Excel.Interfaces.ApplicationLoadOptions

Represents the Excel application that manages the workbook.

[ API set: ExcelApi 1.1 ]

Excel.Interfaces.ApplicationUpdateData

An interface for updating data on the Application object, for use in application.set({ ... }).

Excel.Interfaces.AutoFilterData

An interface describing the data returned by calling autoFilter.toJSON().

Excel.Interfaces.AutoFilterLoadOptions

Represents the AutoFilter object. AutoFilter turns the values in Excel column into specific filters based on the cell contents.

[ API set: ExcelApi 1.9 ]

Excel.Interfaces.BindingCollectionData

An interface describing the data returned by calling bindingCollection.toJSON().

Excel.Interfaces.BindingCollectionLoadOptions

Represents the collection of all the binding objects that are part of the workbook.

[ API set: ExcelApi 1.1 ]

Excel.Interfaces.BindingCollectionUpdateData

An interface for updating data on the BindingCollection object, for use in bindingCollection.set({ ... }).

Excel.Interfaces.BindingData

An interface describing the data returned by calling binding.toJSON().

Excel.Interfaces.BindingLoadOptions

Represents an Office.js binding that is defined in the workbook.

[ API set: ExcelApi 1.1 ]

Excel.Interfaces.CellValueConditionalFormatData

An interface describing the data returned by calling cellValueConditionalFormat.toJSON().

Excel.Interfaces.CellValueConditionalFormatLoadOptions

Represents a cell value conditional format.

[ API set: ExcelApi 1.6 ]

Excel.Interfaces.CellValueConditionalFormatUpdateData

An interface for updating data on the CellValueConditionalFormat object, for use in cellValueConditionalFormat.set({ ... }).

Excel.Interfaces.ChartAreaFormatData

An interface describing the data returned by calling chartAreaFormat.toJSON().

Excel.Interfaces.ChartAreaFormatLoadOptions

Encapsulates the format properties for the overall chart area.

[ API set: ExcelApi 1.1 ]

Excel.Interfaces.ChartAreaFormatUpdateData

An interface for updating data on the ChartAreaFormat object, for use in chartAreaFormat.set({ ... }).

Excel.Interfaces.ChartAxesData

An interface describing the data returned by calling chartAxes.toJSON().

Excel.Interfaces.ChartAxesLoadOptions

Represents the chart axes.

[ API set: ExcelApi 1.1 ]

Excel.Interfaces.ChartAxesUpdateData

An interface for updating data on the ChartAxes object, for use in chartAxes.set({ ... }).

Excel.Interfaces.ChartAxisData

An interface describing the data returned by calling chartAxis.toJSON().

Excel.Interfaces.ChartAxisFormatData

An interface describing the data returned by calling chartAxisFormat.toJSON().

Excel.Interfaces.ChartAxisFormatLoadOptions

Encapsulates the format properties for the chart axis.

[ API set: ExcelApi 1.1 ]

Excel.Interfaces.ChartAxisFormatUpdateData

An interface for updating data on the ChartAxisFormat object, for use in chartAxisFormat.set({ ... }).

Excel.Interfaces.ChartAxisLoadOptions

Represents a single axis in a chart.

[ API set: ExcelApi 1.1 ]

Excel.Interfaces.ChartAxisTitleData

An interface describing the data returned by calling chartAxisTitle.toJSON().

Excel.Interfaces.ChartAxisTitleFormatData

An interface describing the data returned by calling chartAxisTitleFormat.toJSON().

Excel.Interfaces.ChartAxisTitleFormatLoadOptions

Represents the chart axis title formatting.

[ API set: ExcelApi 1.1 ]

Excel.Interfaces.ChartAxisTitleFormatUpdateData

An interface for updating data on the ChartAxisTitleFormat object, for use in chartAxisTitleFormat.set({ ... }).

Excel.Interfaces.ChartAxisTitleLoadOptions

Represents the title of a chart axis.

[ API set: ExcelApi 1.1 ]

Excel.Interfaces.ChartAxisTitleUpdateData

An interface for updating data on the ChartAxisTitle object, for use in chartAxisTitle.set({ ... }).

Excel.Interfaces.ChartAxisUpdateData

An interface for updating data on the ChartAxis object, for use in chartAxis.set({ ... }).

Excel.Interfaces.ChartBinOptionsData

An interface describing the data returned by calling chartBinOptions.toJSON().

Excel.Interfaces.ChartBinOptionsLoadOptions

Encapsulates the bin options for histogram charts and pareto charts.

[ API set: ExcelApi 1.9 ]

Excel.Interfaces.ChartBinOptionsUpdateData

An interface for updating data on the ChartBinOptions object, for use in chartBinOptions.set({ ... }).

Excel.Interfaces.ChartBorderData

An interface describing the data returned by calling chartBorder.toJSON().

Excel.Interfaces.ChartBorderLoadOptions

Represents the border formatting of a chart element.

[ API set: ExcelApi 1.7 ]

Excel.Interfaces.ChartBorderUpdateData

An interface for updating data on the ChartBorder object, for use in chartBorder.set({ ... }).

Excel.Interfaces.ChartBoxwhiskerOptionsData

An interface describing the data returned by calling chartBoxwhiskerOptions.toJSON().

Excel.Interfaces.ChartBoxwhiskerOptionsLoadOptions

Represents the properties of a box and whisker chart.

[ API set: ExcelApi 1.9 ]

Excel.Interfaces.ChartBoxwhiskerOptionsUpdateData

An interface for updating data on the ChartBoxwhiskerOptions object, for use in chartBoxwhiskerOptions.set({ ... }).

Excel.Interfaces.ChartCollectionData

An interface describing the data returned by calling chartCollection.toJSON().

Excel.Interfaces.ChartCollectionLoadOptions

A collection of all the chart objects on a worksheet.

[ API set: ExcelApi 1.1 ]

Excel.Interfaces.ChartCollectionUpdateData

An interface for updating data on the ChartCollection object, for use in chartCollection.set({ ... }).

Excel.Interfaces.ChartData

An interface describing the data returned by calling chart.toJSON().

Excel.Interfaces.ChartDataLabelData

An interface describing the data returned by calling chartDataLabel.toJSON().

Excel.Interfaces.ChartDataLabelFormatData

An interface describing the data returned by calling chartDataLabelFormat.toJSON().

Excel.Interfaces.ChartDataLabelFormatLoadOptions

Encapsulates the format properties for the chart data labels.

[ API set: ExcelApi 1.1 ]

Excel.Interfaces.ChartDataLabelFormatUpdateData

An interface for updating data on the ChartDataLabelFormat object, for use in chartDataLabelFormat.set({ ... }).

Excel.Interfaces.ChartDataLabelLoadOptions

Represents the data label of a chart point.

[ API set: ExcelApi 1.7 ]

Excel.Interfaces.ChartDataLabelsData

An interface describing the data returned by calling chartDataLabels.toJSON().

Excel.Interfaces.ChartDataLabelsLoadOptions

Represents a collection of all the data labels on a chart point.

[ API set: ExcelApi 1.1 ]

Excel.Interfaces.ChartDataLabelsUpdateData

An interface for updating data on the ChartDataLabels object, for use in chartDataLabels.set({ ... }).

Excel.Interfaces.ChartDataLabelUpdateData

An interface for updating data on the ChartDataLabel object, for use in chartDataLabel.set({ ... }).

Excel.Interfaces.ChartErrorBarsData

An interface describing the data returned by calling chartErrorBars.toJSON().

Excel.Interfaces.ChartErrorBarsFormatData

An interface describing the data returned by calling chartErrorBarsFormat.toJSON().

Excel.Interfaces.ChartErrorBarsFormatLoadOptions

Encapsulates the format properties for chart error bars.

[ API set: ExcelApi 1.9 ]

Excel.Interfaces.ChartErrorBarsFormatUpdateData

An interface for updating data on the ChartErrorBarsFormat object, for use in chartErrorBarsFormat.set({ ... }).

Excel.Interfaces.ChartErrorBarsLoadOptions

This object represents the attributes for a chart's error bars.

[ API set: ExcelApi 1.9 ]

Excel.Interfaces.ChartErrorBarsUpdateData

An interface for updating data on the ChartErrorBars object, for use in chartErrorBars.set({ ... }).

Excel.Interfaces.ChartFontData

An interface describing the data returned by calling chartFont.toJSON().

Excel.Interfaces.ChartFontLoadOptions

This object represents the font attributes (font name, font size, color, etc.) for a chart object.

[ API set: ExcelApi 1.1 ]

Excel.Interfaces.ChartFontUpdateData

An interface for updating data on the ChartFont object, for use in chartFont.set({ ... }).

Excel.Interfaces.ChartFormatStringData

An interface describing the data returned by calling chartFormatString.toJSON().

Excel.Interfaces.ChartFormatStringLoadOptions

Represents the substring in chart related objects that contains text, like ChartTitle object, ChartAxisTitle object, etc.

[ API set: ExcelApi 1.7 ]

Excel.Interfaces.ChartFormatStringUpdateData

An interface for updating data on the ChartFormatString object, for use in chartFormatString.set({ ... }).

Excel.Interfaces.ChartGridlinesData

An interface describing the data returned by calling chartGridlines.toJSON().

Excel.Interfaces.ChartGridlinesFormatData

An interface describing the data returned by calling chartGridlinesFormat.toJSON().

Excel.Interfaces.ChartGridlinesFormatLoadOptions

Encapsulates the format properties for chart gridlines.

[ API set: ExcelApi 1.1 ]

Excel.Interfaces.ChartGridlinesFormatUpdateData

An interface for updating data on the ChartGridlinesFormat object, for use in chartGridlinesFormat.set({ ... }).

Excel.Interfaces.ChartGridlinesLoadOptions

Represents major or minor gridlines on a chart axis.

[ API set: ExcelApi 1.1 ]

Excel.Interfaces.ChartGridlinesUpdateData

An interface for updating data on the ChartGridlines object, for use in chartGridlines.set({ ... }).

Excel.Interfaces.ChartLegendData

An interface describing the data returned by calling chartLegend.toJSON().

Excel.Interfaces.ChartLegendEntryCollectionData

An interface describing the data returned by calling chartLegendEntryCollection.toJSON().

Excel.Interfaces.ChartLegendEntryCollectionLoadOptions

Represents a collection of legendEntries.

[ API set: ExcelApi 1.7 ]

Excel.Interfaces.ChartLegendEntryCollectionUpdateData

An interface for updating data on the ChartLegendEntryCollection object, for use in chartLegendEntryCollection.set({ ... }).

Excel.Interfaces.ChartLegendEntryData

An interface describing the data returned by calling chartLegendEntry.toJSON().

Excel.Interfaces.ChartLegendEntryLoadOptions

Represents the legendEntry in legendEntryCollection.

[ API set: ExcelApi 1.7 ]

Excel.Interfaces.ChartLegendEntryUpdateData

An interface for updating data on the ChartLegendEntry object, for use in chartLegendEntry.set({ ... }).

Excel.Interfaces.ChartLegendFormatData

An interface describing the data returned by calling chartLegendFormat.toJSON().

Excel.Interfaces.ChartLegendFormatLoadOptions

Encapsulates the format properties of a chart legend.

[ API set: ExcelApi 1.1 ]

Excel.Interfaces.ChartLegendFormatUpdateData

An interface for updating data on the ChartLegendFormat object, for use in chartLegendFormat.set({ ... }).

Excel.Interfaces.ChartLegendLoadOptions

Represents the legend in a chart.

[ API set: ExcelApi 1.1 ]

Excel.Interfaces.ChartLegendUpdateData

An interface for updating data on the ChartLegend object, for use in chartLegend.set({ ... }).

Excel.Interfaces.ChartLineFormatData

An interface describing the data returned by calling chartLineFormat.toJSON().

Excel.Interfaces.ChartLineFormatLoadOptions

Encapsulates the formatting options for line elements.

[ API set: ExcelApi 1.1 ]

Excel.Interfaces.ChartLineFormatUpdateData

An interface for updating data on the ChartLineFormat object, for use in chartLineFormat.set({ ... }).

Excel.Interfaces.ChartLoadOptions

Represents a chart object in a workbook. To learn more about the Chart object model, see Work with charts using the Excel JavaScript API.

[ API set: ExcelApi 1.1 ]

Excel.Interfaces.ChartMapOptionsData

An interface describing the data returned by calling chartMapOptions.toJSON().

Excel.Interfaces.ChartMapOptionsLoadOptions

Encapsulates the properties for a region map chart.

[ API set: ExcelApi 1.9 ]

Excel.Interfaces.ChartMapOptionsUpdateData

An interface for updating data on the ChartMapOptions object, for use in chartMapOptions.set({ ... }).

Excel.Interfaces.ChartPivotOptionsData

An interface describing the data returned by calling chartPivotOptions.toJSON().

Excel.Interfaces.ChartPivotOptionsLoadOptions

Encapsulates the options for the pivot chart.

[ API set: ExcelApi 1.9 ]

Excel.Interfaces.ChartPivotOptionsUpdateData

An interface for updating data on the ChartPivotOptions object, for use in chartPivotOptions.set({ ... }).

Excel.Interfaces.ChartPlotAreaData

An interface describing the data returned by calling chartPlotArea.toJSON().

Excel.Interfaces.ChartPlotAreaFormatData

An interface describing the data returned by calling chartPlotAreaFormat.toJSON().

Excel.Interfaces.ChartPlotAreaFormatLoadOptions

Represents the format properties for chart plotArea.

[ API set: ExcelApi 1.8 ]

Excel.Interfaces.ChartPlotAreaFormatUpdateData

An interface for updating data on the ChartPlotAreaFormat object, for use in chartPlotAreaFormat.set({ ... }).

Excel.Interfaces.ChartPlotAreaLoadOptions

This object represents the attributes for a chart plotArea object.

[ API set: ExcelApi 1.8 ]

Excel.Interfaces.ChartPlotAreaUpdateData

An interface for updating data on the ChartPlotArea object, for use in chartPlotArea.set({ ... }).

Excel.Interfaces.ChartPointData

An interface describing the data returned by calling chartPoint.toJSON().

Excel.Interfaces.ChartPointFormatData

An interface describing the data returned by calling chartPointFormat.toJSON().

Excel.Interfaces.ChartPointFormatLoadOptions

Represents formatting object for chart points.

[ API set: ExcelApi 1.1 ]

Excel.Interfaces.ChartPointFormatUpdateData

An interface for updating data on the ChartPointFormat object, for use in chartPointFormat.set({ ... }).

Excel.Interfaces.ChartPointLoadOptions

Represents a point of a series in a chart.

[ API set: ExcelApi 1.1 ]

Excel.Interfaces.ChartPointsCollectionData

An interface describing the data returned by calling chartPointsCollection.toJSON().

Excel.Interfaces.ChartPointsCollectionLoadOptions

A collection of all the chart points within a series inside a chart.

[ API set: ExcelApi 1.1 ]

Excel.Interfaces.ChartPointsCollectionUpdateData

An interface for updating data on the ChartPointsCollection object, for use in chartPointsCollection.set({ ... }).

Excel.Interfaces.ChartPointUpdateData

An interface for updating data on the ChartPoint object, for use in chartPoint.set({ ... }).

Excel.Interfaces.ChartSeriesCollectionData

An interface describing the data returned by calling chartSeriesCollection.toJSON().

Excel.Interfaces.ChartSeriesCollectionLoadOptions

Represents a collection of chart series.

[ API set: ExcelApi 1.1 ]

Excel.Interfaces.ChartSeriesCollectionUpdateData

An interface for updating data on the ChartSeriesCollection object, for use in chartSeriesCollection.set({ ... }).

Excel.Interfaces.ChartSeriesData

An interface describing the data returned by calling chartSeries.toJSON().

Excel.Interfaces.ChartSeriesFormatData

An interface describing the data returned by calling chartSeriesFormat.toJSON().

Excel.Interfaces.ChartSeriesFormatLoadOptions

Encapsulates the format properties for the chart series

[ API set: ExcelApi 1.1 ]

Excel.Interfaces.ChartSeriesFormatUpdateData

An interface for updating data on the ChartSeriesFormat object, for use in chartSeriesFormat.set({ ... }).

Excel.Interfaces.ChartSeriesLoadOptions

Represents a series in a chart.

[ API set: ExcelApi 1.1 ]

Excel.Interfaces.ChartSeriesUpdateData

An interface for updating data on the ChartSeries object, for use in chartSeries.set({ ... }).

Excel.Interfaces.ChartTitleData

An interface describing the data returned by calling chartTitle.toJSON().

Excel.Interfaces.ChartTitleFormatData

An interface describing the data returned by calling chartTitleFormat.toJSON().

Excel.Interfaces.ChartTitleFormatLoadOptions

Provides access to the office art formatting for chart title.

[ API set: ExcelApi 1.1 ]

Excel.Interfaces.ChartTitleFormatUpdateData

An interface for updating data on the ChartTitleFormat object, for use in chartTitleFormat.set({ ... }).

Excel.Interfaces.ChartTitleLoadOptions

Represents a chart title object of a chart.

[ API set: ExcelApi 1.1 ]

Excel.Interfaces.ChartTitleUpdateData

An interface for updating data on the ChartTitle object, for use in chartTitle.set({ ... }).

Excel.Interfaces.ChartTrendlineCollectionData

An interface describing the data returned by calling chartTrendlineCollection.toJSON().

Excel.Interfaces.ChartTrendlineCollectionLoadOptions

Represents a collection of Chart Trendlines.

[ API set: ExcelApi 1.7 ]

Excel.Interfaces.ChartTrendlineCollectionUpdateData

An interface for updating data on the ChartTrendlineCollection object, for use in chartTrendlineCollection.set({ ... }).

Excel.Interfaces.ChartTrendlineData

An interface describing the data returned by calling chartTrendline.toJSON().

Excel.Interfaces.ChartTrendlineFormatData

An interface describing the data returned by calling chartTrendlineFormat.toJSON().

Excel.Interfaces.ChartTrendlineFormatLoadOptions

Represents the format properties for chart trendline.

[ API set: ExcelApi 1.7 ]

Excel.Interfaces.ChartTrendlineFormatUpdateData

An interface for updating data on the ChartTrendlineFormat object, for use in chartTrendlineFormat.set({ ... }).

Excel.Interfaces.ChartTrendlineLabelData

An interface describing the data returned by calling chartTrendlineLabel.toJSON().

Excel.Interfaces.ChartTrendlineLabelFormatData

An interface describing the data returned by calling chartTrendlineLabelFormat.toJSON().

Excel.Interfaces.ChartTrendlineLabelFormatLoadOptions

Encapsulates the format properties for the chart trendline label.

[ API set: ExcelApi 1.8 ]

Excel.Interfaces.ChartTrendlineLabelFormatUpdateData

An interface for updating data on the ChartTrendlineLabelFormat object, for use in chartTrendlineLabelFormat.set({ ... }).

Excel.Interfaces.ChartTrendlineLabelLoadOptions

This object represents the attributes for a chart trendline lable object.

[ API set: ExcelApi 1.8 ]

Excel.Interfaces.ChartTrendlineLabelUpdateData

An interface for updating data on the ChartTrendlineLabel object, for use in chartTrendlineLabel.set({ ... }).

Excel.Interfaces.ChartTrendlineLoadOptions

This object represents the attributes for a chart trendline object.

[ API set: ExcelApi 1.7 ]

Excel.Interfaces.ChartTrendlineUpdateData

An interface for updating data on the ChartTrendline object, for use in chartTrendline.set({ ... }).

Excel.Interfaces.ChartUpdateData

An interface for updating data on the Chart object, for use in chart.set({ ... }).

Excel.Interfaces.CollectionLoadOptions

Provides ways to load properties of only a subset of members of a collection.

Excel.Interfaces.ColorScaleConditionalFormatData

An interface describing the data returned by calling colorScaleConditionalFormat.toJSON().

Excel.Interfaces.ColorScaleConditionalFormatLoadOptions

Represents an IconSet criteria for conditional formatting.

[ API set: ExcelApi 1.6 ]

Excel.Interfaces.ColorScaleConditionalFormatUpdateData

An interface for updating data on the ColorScaleConditionalFormat object, for use in colorScaleConditionalFormat.set({ ... }).

Excel.Interfaces.CommentCollectionData

An interface describing the data returned by calling commentCollection.toJSON().

Excel.Interfaces.CommentCollectionLoadOptions

Represents a collection of comment objects that are part of the workbook.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

Excel.Interfaces.CommentCollectionUpdateData

An interface for updating data on the CommentCollection object, for use in commentCollection.set({ ... }).

Excel.Interfaces.CommentData

An interface describing the data returned by calling comment.toJSON().

Excel.Interfaces.CommentLoadOptions

Represents a comment in the workbook.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

Excel.Interfaces.CommentReplyCollectionData

An interface describing the data returned by calling commentReplyCollection.toJSON().

Excel.Interfaces.CommentReplyCollectionLoadOptions

Represents a collection of comment reply objects that are part of the comment.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

Excel.Interfaces.CommentReplyCollectionUpdateData

An interface for updating data on the CommentReplyCollection object, for use in commentReplyCollection.set({ ... }).

Excel.Interfaces.CommentReplyData

An interface describing the data returned by calling commentReply.toJSON().

Excel.Interfaces.CommentReplyLoadOptions

Represents a comment reply in the workbook.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

Excel.Interfaces.CommentReplyUpdateData

An interface for updating data on the CommentReply object, for use in commentReply.set({ ... }).

Excel.Interfaces.CommentUpdateData

An interface for updating data on the Comment object, for use in comment.set({ ... }).

Excel.Interfaces.ConditionalDataBarNegativeFormatData

An interface describing the data returned by calling conditionalDataBarNegativeFormat.toJSON().

Excel.Interfaces.ConditionalDataBarNegativeFormatLoadOptions

Represents a conditional format DataBar Format for the negative side of the data bar.

[ API set: ExcelApi 1.6 ]

Excel.Interfaces.ConditionalDataBarNegativeFormatUpdateData

An interface for updating data on the ConditionalDataBarNegativeFormat object, for use in conditionalDataBarNegativeFormat.set({ ... }).

Excel.Interfaces.ConditionalDataBarPositiveFormatData

An interface describing the data returned by calling conditionalDataBarPositiveFormat.toJSON().

Excel.Interfaces.ConditionalDataBarPositiveFormatLoadOptions

Represents a conditional format DataBar Format for the positive side of the data bar.

[ API set: ExcelApi 1.6 ]

Excel.Interfaces.ConditionalDataBarPositiveFormatUpdateData

An interface for updating data on the ConditionalDataBarPositiveFormat object, for use in conditionalDataBarPositiveFormat.set({ ... }).

Excel.Interfaces.ConditionalFormatCollectionData

An interface describing the data returned by calling conditionalFormatCollection.toJSON().

Excel.Interfaces.ConditionalFormatCollectionLoadOptions

Represents a collection of all the conditional formats that are overlap the range.

[ API set: ExcelApi 1.6 ]

Excel.Interfaces.ConditionalFormatCollectionUpdateData

An interface for updating data on the ConditionalFormatCollection object, for use in conditionalFormatCollection.set({ ... }).

Excel.Interfaces.ConditionalFormatData

An interface describing the data returned by calling conditionalFormat.toJSON().

Excel.Interfaces.ConditionalFormatLoadOptions

An object encapsulating a conditional format's range, format, rule, and other properties. To learn more about the conditional formatting object model, read Apply conditional formatting to Excel ranges.

[ API set: ExcelApi 1.6 ]

Excel.Interfaces.ConditionalFormatRuleData

An interface describing the data returned by calling conditionalFormatRule.toJSON().

Excel.Interfaces.ConditionalFormatRuleLoadOptions

Represents a rule, for all traditional rule/format pairings.

[ API set: ExcelApi 1.6 ]

Excel.Interfaces.ConditionalFormatRuleUpdateData

An interface for updating data on the ConditionalFormatRule object, for use in conditionalFormatRule.set({ ... }).

Excel.Interfaces.ConditionalFormatUpdateData

An interface for updating data on the ConditionalFormat object, for use in conditionalFormat.set({ ... }).

Excel.Interfaces.ConditionalRangeBorderCollectionData

An interface describing the data returned by calling conditionalRangeBorderCollection.toJSON().

Excel.Interfaces.ConditionalRangeBorderCollectionLoadOptions

Represents the border objects that make up range border.

[ API set: ExcelApi 1.6 ]

Excel.Interfaces.ConditionalRangeBorderCollectionUpdateData

An interface for updating data on the ConditionalRangeBorderCollection object, for use in conditionalRangeBorderCollection.set({ ... }).

Excel.Interfaces.ConditionalRangeBorderData

An interface describing the data returned by calling conditionalRangeBorder.toJSON().

Excel.Interfaces.ConditionalRangeBorderLoadOptions

Represents the border of an object.

[ API set: ExcelApi 1.6 ]

Excel.Interfaces.ConditionalRangeBorderUpdateData

An interface for updating data on the ConditionalRangeBorder object, for use in conditionalRangeBorder.set({ ... }).

Excel.Interfaces.ConditionalRangeFillData

An interface describing the data returned by calling conditionalRangeFill.toJSON().

Excel.Interfaces.ConditionalRangeFillLoadOptions

Represents the background of a conditional range object.

[ API set: ExcelApi 1.6 ]

Excel.Interfaces.ConditionalRangeFillUpdateData

An interface for updating data on the ConditionalRangeFill object, for use in conditionalRangeFill.set({ ... }).

Excel.Interfaces.ConditionalRangeFontData

An interface describing the data returned by calling conditionalRangeFont.toJSON().

Excel.Interfaces.ConditionalRangeFontLoadOptions

This object represents the font attributes (font style, color, etc.) for an object.

[ API set: ExcelApi 1.6 ]

Excel.Interfaces.ConditionalRangeFontUpdateData

An interface for updating data on the ConditionalRangeFont object, for use in conditionalRangeFont.set({ ... }).

Excel.Interfaces.ConditionalRangeFormatData

An interface describing the data returned by calling conditionalRangeFormat.toJSON().

Excel.Interfaces.ConditionalRangeFormatLoadOptions

A format object encapsulating the conditional formats range's font, fill, borders, and other properties.

[ API set: ExcelApi 1.6 ]

Excel.Interfaces.ConditionalRangeFormatUpdateData

An interface for updating data on the ConditionalRangeFormat object, for use in conditionalRangeFormat.set({ ... }).

Excel.Interfaces.CustomConditionalFormatData

An interface describing the data returned by calling customConditionalFormat.toJSON().

Excel.Interfaces.CustomConditionalFormatLoadOptions

Represents a custom conditional format type.

[ API set: ExcelApi 1.6 ]

Excel.Interfaces.CustomConditionalFormatUpdateData

An interface for updating data on the CustomConditionalFormat object, for use in customConditionalFormat.set({ ... }).

Excel.Interfaces.CustomPropertyCollectionData

An interface describing the data returned by calling customPropertyCollection.toJSON().

Excel.Interfaces.CustomPropertyCollectionLoadOptions

Contains the collection of customProperty objects.

[ API set: ExcelApi 1.7 ]

Excel.Interfaces.CustomPropertyCollectionUpdateData

An interface for updating data on the CustomPropertyCollection object, for use in customPropertyCollection.set({ ... }).

Excel.Interfaces.CustomPropertyData

An interface describing the data returned by calling customProperty.toJSON().

Excel.Interfaces.CustomPropertyLoadOptions

Represents a custom property.

[ API set: ExcelApi 1.7 ]

Excel.Interfaces.CustomPropertyUpdateData

An interface for updating data on the CustomProperty object, for use in customProperty.set({ ... }).

Excel.Interfaces.CustomXmlPartCollectionData

An interface describing the data returned by calling customXmlPartCollection.toJSON().

Excel.Interfaces.CustomXmlPartCollectionLoadOptions

A collection of custom XML parts.

[ API set: ExcelApi 1.5 ]

Excel.Interfaces.CustomXmlPartCollectionUpdateData

An interface for updating data on the CustomXmlPartCollection object, for use in customXmlPartCollection.set({ ... }).

Excel.Interfaces.CustomXmlPartData

An interface describing the data returned by calling customXmlPart.toJSON().

Excel.Interfaces.CustomXmlPartLoadOptions

Represents a custom XML part object in a workbook.

[ API set: ExcelApi 1.5 ]

Excel.Interfaces.CustomXmlPartScopedCollectionData

An interface describing the data returned by calling customXmlPartScopedCollection.toJSON().

Excel.Interfaces.CustomXmlPartScopedCollectionLoadOptions

A scoped collection of custom XML parts. A scoped collection is the result of some operation, e.g. filtering by namespace. A scoped collection cannot be scoped any further.

[ API set: ExcelApi 1.5 ]

Excel.Interfaces.CustomXmlPartScopedCollectionUpdateData

An interface for updating data on the CustomXmlPartScopedCollection object, for use in customXmlPartScopedCollection.set({ ... }).

Excel.Interfaces.DataBarConditionalFormatData

An interface describing the data returned by calling dataBarConditionalFormat.toJSON().

Excel.Interfaces.DataBarConditionalFormatLoadOptions

Represents an Excel Conditional Data Bar Type.

[ API set: ExcelApi 1.6 ]

Excel.Interfaces.DataBarConditionalFormatUpdateData

An interface for updating data on the DataBarConditionalFormat object, for use in dataBarConditionalFormat.set({ ... }).

Excel.Interfaces.DataPivotHierarchyCollectionData

An interface describing the data returned by calling dataPivotHierarchyCollection.toJSON().

Excel.Interfaces.DataPivotHierarchyCollectionLoadOptions

Represents a collection of DataPivotHierarchy items associated with the PivotTable.

[ API set: ExcelApi 1.8 ]

Excel.Interfaces.DataPivotHierarchyCollectionUpdateData

An interface for updating data on the DataPivotHierarchyCollection object, for use in dataPivotHierarchyCollection.set({ ... }).

Excel.Interfaces.DataPivotHierarchyData

An interface describing the data returned by calling dataPivotHierarchy.toJSON().

Excel.Interfaces.DataPivotHierarchyLoadOptions

Represents the Excel DataPivotHierarchy.

[ API set: ExcelApi 1.8 ]

Excel.Interfaces.DataPivotHierarchyUpdateData

An interface for updating data on the DataPivotHierarchy object, for use in dataPivotHierarchy.set({ ... }).

Excel.Interfaces.DataValidationData

An interface describing the data returned by calling dataValidation.toJSON().

Excel.Interfaces.DataValidationLoadOptions

Represents the data validation applied to the current range. To learn more about the data validation object model, read Add data validation to Excel ranges.

[ API set: ExcelApi 1.8 ]

Excel.Interfaces.DataValidationUpdateData

An interface for updating data on the DataValidation object, for use in dataValidation.set({ ... }).

Excel.Interfaces.DocumentPropertiesData

An interface describing the data returned by calling documentProperties.toJSON().

Excel.Interfaces.DocumentPropertiesLoadOptions

Represents workbook properties.

[ API set: ExcelApi 1.7 ]

Excel.Interfaces.DocumentPropertiesUpdateData

An interface for updating data on the DocumentProperties object, for use in documentProperties.set({ ... }).

Excel.Interfaces.FilterData

An interface describing the data returned by calling filter.toJSON().

Excel.Interfaces.FilterLoadOptions

Manages the filtering of a table's column.

[ API set: ExcelApi 1.2 ]

Excel.Interfaces.FilterPivotHierarchyCollectionData

An interface describing the data returned by calling filterPivotHierarchyCollection.toJSON().

Excel.Interfaces.FilterPivotHierarchyCollectionLoadOptions

Represents a collection of FilterPivotHierarchy items associated with the PivotTable.

[ API set: ExcelApi 1.8 ]

Excel.Interfaces.FilterPivotHierarchyCollectionUpdateData

An interface for updating data on the FilterPivotHierarchyCollection object, for use in filterPivotHierarchyCollection.set({ ... }).

Excel.Interfaces.FilterPivotHierarchyData

An interface describing the data returned by calling filterPivotHierarchy.toJSON().

Excel.Interfaces.FilterPivotHierarchyLoadOptions

Represents the Excel FilterPivotHierarchy.

[ API set: ExcelApi 1.8 ]

Excel.Interfaces.FilterPivotHierarchyUpdateData

An interface for updating data on the FilterPivotHierarchy object, for use in filterPivotHierarchy.set({ ... }).

Excel.Interfaces.FormatProtectionData

An interface describing the data returned by calling formatProtection.toJSON().

Excel.Interfaces.FormatProtectionLoadOptions

Represents the format protection of a range object.

[ API set: ExcelApi 1.2 ]

Excel.Interfaces.FormatProtectionUpdateData

An interface for updating data on the FormatProtection object, for use in formatProtection.set({ ... }).

Excel.Interfaces.FunctionResultData

An interface describing the data returned by calling functionResult.toJSON().

Excel.Interfaces.FunctionResultLoadOptions

An object containing the result of a function-evaluation operation

[ API set: ExcelApi 1.2 ]

Excel.Interfaces.GeometricShapeData

An interface describing the data returned by calling geometricShape.toJSON().

Excel.Interfaces.GeometricShapeLoadOptions

Represents a geometric shape inside a worksheet. A geometric shape can be a rectangle, block arrow, equation symbol, flowchart item, star, banner, callout, or any other basic shape in Excel.

[ API set: ExcelApi 1.9 ]

Excel.Interfaces.GroupShapeCollectionData

An interface describing the data returned by calling groupShapeCollection.toJSON().

Excel.Interfaces.GroupShapeCollectionLoadOptions

Represents the shape collection inside a shape group.

[ API set: ExcelApi 1.9 ]

Excel.Interfaces.GroupShapeCollectionUpdateData

An interface for updating data on the GroupShapeCollection object, for use in groupShapeCollection.set({ ... }).

Excel.Interfaces.HeaderFooterData

An interface describing the data returned by calling headerFooter.toJSON().

Excel.Interfaces.HeaderFooterGroupData

An interface describing the data returned by calling headerFooterGroup.toJSON().

Excel.Interfaces.HeaderFooterGroupLoadOptions

[ API set: ExcelApi 1.9 ]

Excel.Interfaces.HeaderFooterGroupUpdateData

An interface for updating data on the HeaderFooterGroup object, for use in headerFooterGroup.set({ ... }).

Excel.Interfaces.HeaderFooterLoadOptions

[ API set: ExcelApi 1.9 ]

Excel.Interfaces.HeaderFooterUpdateData

An interface for updating data on the HeaderFooter object, for use in headerFooter.set({ ... }).

Excel.Interfaces.IconSetConditionalFormatData

An interface describing the data returned by calling iconSetConditionalFormat.toJSON().

Excel.Interfaces.IconSetConditionalFormatLoadOptions

Represents an IconSet criteria for conditional formatting.

[ API set: ExcelApi 1.6 ]

Excel.Interfaces.IconSetConditionalFormatUpdateData

An interface for updating data on the IconSetConditionalFormat object, for use in iconSetConditionalFormat.set({ ... }).

Excel.Interfaces.ImageData

An interface describing the data returned by calling image.toJSON().

Excel.Interfaces.ImageLoadOptions

Represents an image in the worksheet. To get the corresponding Shape object, use Image.shape.

[ API set: ExcelApi 1.9 ]

Excel.Interfaces.IterativeCalculationData

An interface describing the data returned by calling iterativeCalculation.toJSON().

Excel.Interfaces.IterativeCalculationLoadOptions

Represents the Iterative Calculation settings.

[ API set: ExcelApi 1.9 ]

Excel.Interfaces.IterativeCalculationUpdateData

An interface for updating data on the IterativeCalculation object, for use in iterativeCalculation.set({ ... }).

Excel.Interfaces.LineData

An interface describing the data returned by calling line.toJSON().

Excel.Interfaces.LineLoadOptions

Represents a line inside a worksheet. To get the corresponding Shape object, use Line.shape.

[ API set: ExcelApi 1.9 ]

Excel.Interfaces.LineUpdateData

An interface for updating data on the Line object, for use in line.set({ ... }).

Excel.Interfaces.NamedItemArrayValuesData

An interface describing the data returned by calling namedItemArrayValues.toJSON().

Excel.Interfaces.NamedItemArrayValuesLoadOptions

Represents an object containing values and types of a named item.

[ API set: ExcelApi 1.7 ]

Excel.Interfaces.NamedItemCollectionData

An interface describing the data returned by calling namedItemCollection.toJSON().

Excel.Interfaces.NamedItemCollectionLoadOptions

A collection of all the NamedItem objects that are part of the workbook or worksheet, depending on how it was reached.

[ API set: ExcelApi 1.1 ]

Excel.Interfaces.NamedItemCollectionUpdateData

An interface for updating data on the NamedItemCollection object, for use in namedItemCollection.set({ ... }).

Excel.Interfaces.NamedItemData

An interface describing the data returned by calling namedItem.toJSON().

Excel.Interfaces.NamedItemLoadOptions

Represents a defined name for a range of cells or value. Names can be primitive named objects (as seen in the type below), range object, or a reference to a range. This object can be used to obtain range object associated with names.

[ API set: ExcelApi 1.1 ]

Excel.Interfaces.NamedItemUpdateData

An interface for updating data on the NamedItem object, for use in namedItem.set({ ... }).

Excel.Interfaces.PageBreakCollectionData

An interface describing the data returned by calling pageBreakCollection.toJSON().

Excel.Interfaces.PageBreakCollectionLoadOptions

[ API set: ExcelApi 1.9 ]

Excel.Interfaces.PageBreakCollectionUpdateData

An interface for updating data on the PageBreakCollection object, for use in pageBreakCollection.set({ ... }).

Excel.Interfaces.PageBreakData

An interface describing the data returned by calling pageBreak.toJSON().

Excel.Interfaces.PageBreakLoadOptions

[ API set: ExcelApi 1.9 ]

Excel.Interfaces.PageLayoutData

An interface describing the data returned by calling pageLayout.toJSON().

Excel.Interfaces.PageLayoutLoadOptions

Represents layout and print settings that are not dependent any printer-specific implementation. These settings include margins, orientation, page numbering, title rows, and print area.

[ API set: ExcelApi 1.9 ]

Excel.Interfaces.PageLayoutUpdateData

An interface for updating data on the PageLayout object, for use in pageLayout.set({ ... }).

Excel.Interfaces.PivotFieldCollectionData

An interface describing the data returned by calling pivotFieldCollection.toJSON().

Excel.Interfaces.PivotFieldCollectionLoadOptions

Represents a collection of all the PivotFields that are part of a PivotTable's hierarchy.

[ API set: ExcelApi 1.8 ]

Excel.Interfaces.PivotFieldCollectionUpdateData

An interface for updating data on the PivotFieldCollection object, for use in pivotFieldCollection.set({ ... }).

Excel.Interfaces.PivotFieldData

An interface describing the data returned by calling pivotField.toJSON().

Excel.Interfaces.PivotFieldLoadOptions

Represents the Excel PivotField.

[ API set: ExcelApi 1.8 ]

Excel.Interfaces.PivotFieldUpdateData

An interface for updating data on the PivotField object, for use in pivotField.set({ ... }).

Excel.Interfaces.PivotHierarchyCollectionData

An interface describing the data returned by calling pivotHierarchyCollection.toJSON().

Excel.Interfaces.PivotHierarchyCollectionLoadOptions

Represents a collection of all the PivotHierarchies that are part of the PivotTable.

[ API set: ExcelApi 1.8 ]

Excel.Interfaces.PivotHierarchyCollectionUpdateData

An interface for updating data on the PivotHierarchyCollection object, for use in pivotHierarchyCollection.set({ ... }).

Excel.Interfaces.PivotHierarchyData

An interface describing the data returned by calling pivotHierarchy.toJSON().

Excel.Interfaces.PivotHierarchyLoadOptions

Represents the Excel PivotHierarchy.

[ API set: ExcelApi 1.8 ]

Excel.Interfaces.PivotHierarchyUpdateData

An interface for updating data on the PivotHierarchy object, for use in pivotHierarchy.set({ ... }).

Excel.Interfaces.PivotItemCollectionData

An interface describing the data returned by calling pivotItemCollection.toJSON().

Excel.Interfaces.PivotItemCollectionLoadOptions

Represents a collection of all the PivotItems related to their parent PivotField.

[ API set: ExcelApi 1.8 ]

Excel.Interfaces.PivotItemCollectionUpdateData

An interface for updating data on the PivotItemCollection object, for use in pivotItemCollection.set({ ... }).

Excel.Interfaces.PivotItemData

An interface describing the data returned by calling pivotItem.toJSON().

Excel.Interfaces.PivotItemLoadOptions

Represents the Excel PivotItem.

[ API set: ExcelApi 1.8 ]

Excel.Interfaces.PivotItemUpdateData

An interface for updating data on the PivotItem object, for use in pivotItem.set({ ... }).

Excel.Interfaces.PivotLayoutData

An interface describing the data returned by calling pivotLayout.toJSON().

Excel.Interfaces.PivotLayoutLoadOptions

Represents the visual layout of the PivotTable.

[ API set: ExcelApi 1.8 ]

Excel.Interfaces.PivotLayoutUpdateData

An interface for updating data on the PivotLayout object, for use in pivotLayout.set({ ... }).

Excel.Interfaces.PivotTableCollectionData

An interface describing the data returned by calling pivotTableCollection.toJSON().

Excel.Interfaces.PivotTableCollectionLoadOptions

Represents a collection of all the PivotTables that are part of the workbook or worksheet.

[ API set: ExcelApi 1.3 ]

Excel.Interfaces.PivotTableCollectionUpdateData

An interface for updating data on the PivotTableCollection object, for use in pivotTableCollection.set({ ... }).

Excel.Interfaces.PivotTableData

An interface describing the data returned by calling pivotTable.toJSON().

Excel.Interfaces.PivotTableLoadOptions

Represents an Excel PivotTable. To learn more about the PivotTable object model, read Work with PivotTables using the Excel JavaScript API.

[ API set: ExcelApi 1.3 ]

Excel.Interfaces.PivotTableStyleCollectionData

An interface describing the data returned by calling pivotTableStyleCollection.toJSON().

Excel.Interfaces.PivotTableStyleCollectionLoadOptions

Represents a collection of PivotTable styles.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

Excel.Interfaces.PivotTableStyleCollectionUpdateData

An interface for updating data on the PivotTableStyleCollection object, for use in pivotTableStyleCollection.set({ ... }).

Excel.Interfaces.PivotTableStyleData

An interface describing the data returned by calling pivotTableStyle.toJSON().

Excel.Interfaces.PivotTableStyleLoadOptions

Represents a PivotTable Style, which defines style elements by PivotTable region.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

Excel.Interfaces.PivotTableStyleUpdateData

An interface for updating data on the PivotTableStyle object, for use in pivotTableStyle.set({ ... }).

Excel.Interfaces.PivotTableUpdateData

An interface for updating data on the PivotTable object, for use in pivotTable.set({ ... }).

Excel.Interfaces.PresetCriteriaConditionalFormatData

An interface describing the data returned by calling presetCriteriaConditionalFormat.toJSON().

Excel.Interfaces.PresetCriteriaConditionalFormatLoadOptions

Represents the the preset criteria conditional format such as above average, below average, unique values, contains blank, nonblank, error, and noerror.

[ API set: ExcelApi 1.6 ]

Excel.Interfaces.PresetCriteriaConditionalFormatUpdateData

An interface for updating data on the PresetCriteriaConditionalFormat object, for use in presetCriteriaConditionalFormat.set({ ... }).

Excel.Interfaces.RangeAreasData

An interface describing the data returned by calling rangeAreas.toJSON().

Excel.Interfaces.RangeAreasLoadOptions

RangeAreas represents a collection of one or more rectangular ranges in the same worksheet. To learn how to use discontinguous ranges, read Work with multiple ranges simultaneously in Excel add-ins.

[ API set: ExcelApi 1.9 ]

Excel.Interfaces.RangeAreasUpdateData

An interface for updating data on the RangeAreas object, for use in rangeAreas.set({ ... }).

Excel.Interfaces.RangeBorderCollectionData

An interface describing the data returned by calling rangeBorderCollection.toJSON().

Excel.Interfaces.RangeBorderCollectionLoadOptions

Represents the border objects that make up the range border.

[ API set: ExcelApi 1.1 ]

Excel.Interfaces.RangeBorderCollectionUpdateData

An interface for updating data on the RangeBorderCollection object, for use in rangeBorderCollection.set({ ... }).

Excel.Interfaces.RangeBorderData

An interface describing the data returned by calling rangeBorder.toJSON().

Excel.Interfaces.RangeBorderLoadOptions

Represents the border of an object.

[ API set: ExcelApi 1.1 ]

Excel.Interfaces.RangeBorderUpdateData

An interface for updating data on the RangeBorder object, for use in rangeBorder.set({ ... }).

Excel.Interfaces.RangeCollectionData

An interface describing the data returned by calling rangeCollection.toJSON().

Excel.Interfaces.RangeCollectionLoadOptions

[ API set: ExcelApi 1.9 ]

Excel.Interfaces.RangeCollectionUpdateData

An interface for updating data on the RangeCollection object, for use in rangeCollection.set({ ... }).

Excel.Interfaces.RangeData

An interface describing the data returned by calling range.toJSON().

Excel.Interfaces.RangeFillData

An interface describing the data returned by calling rangeFill.toJSON().

Excel.Interfaces.RangeFillLoadOptions

Represents the background of a range object.

[ API set: ExcelApi 1.1 ]

Excel.Interfaces.RangeFillUpdateData

An interface for updating data on the RangeFill object, for use in rangeFill.set({ ... }).

Excel.Interfaces.RangeFontData

An interface describing the data returned by calling rangeFont.toJSON().

Excel.Interfaces.RangeFontLoadOptions

This object represents the font attributes (font name, font size, color, etc.) for an object.

[ API set: ExcelApi 1.1 ]

Excel.Interfaces.RangeFontUpdateData

An interface for updating data on the RangeFont object, for use in rangeFont.set({ ... }).

Excel.Interfaces.RangeFormatData

An interface describing the data returned by calling rangeFormat.toJSON().

Excel.Interfaces.RangeFormatLoadOptions

A format object encapsulating the range's font, fill, borders, alignment, and other properties.

[ API set: ExcelApi 1.1 ]

Excel.Interfaces.RangeFormatUpdateData

An interface for updating data on the RangeFormat object, for use in rangeFormat.set({ ... }).

Excel.Interfaces.RangeLoadOptions

Range represents a set of one or more contiguous cells such as a cell, a row, a column, block of cells, etc. To learn more about how ranges are used throughout the API, read Work with ranges using the Excel JavaScript API and Work with ranges using the Excel JavaScript API (advanced).

[ API set: ExcelApi 1.1 ]

Excel.Interfaces.RangeUpdateData

An interface for updating data on the Range object, for use in range.set({ ... }).

Excel.Interfaces.RangeViewCollectionData

An interface describing the data returned by calling rangeViewCollection.toJSON().

Excel.Interfaces.RangeViewCollectionLoadOptions

Represents a collection of RangeView objects.

[ API set: ExcelApi 1.3 ]

Excel.Interfaces.RangeViewCollectionUpdateData

An interface for updating data on the RangeViewCollection object, for use in rangeViewCollection.set({ ... }).

Excel.Interfaces.RangeViewData

An interface describing the data returned by calling rangeView.toJSON().

Excel.Interfaces.RangeViewLoadOptions

RangeView represents a set of visible cells of the parent range.

[ API set: ExcelApi 1.3 ]

Excel.Interfaces.RangeViewUpdateData

An interface for updating data on the RangeView object, for use in rangeView.set({ ... }).

Excel.Interfaces.RemoveDuplicatesResultData

An interface describing the data returned by calling removeDuplicatesResult.toJSON().

Excel.Interfaces.RemoveDuplicatesResultLoadOptions

Represents the results from the removeDuplicates method on range

[ API set: ExcelApi 1.9 ]

Excel.Interfaces.RowColumnPivotHierarchyCollectionData

An interface describing the data returned by calling rowColumnPivotHierarchyCollection.toJSON().

Excel.Interfaces.RowColumnPivotHierarchyCollectionLoadOptions

Represents a collection of RowColumnPivotHierarchy items associated with the PivotTable.

[ API set: ExcelApi 1.8 ]

Excel.Interfaces.RowColumnPivotHierarchyCollectionUpdateData

An interface for updating data on the RowColumnPivotHierarchyCollection object, for use in rowColumnPivotHierarchyCollection.set({ ... }).

Excel.Interfaces.RowColumnPivotHierarchyData

An interface describing the data returned by calling rowColumnPivotHierarchy.toJSON().

Excel.Interfaces.RowColumnPivotHierarchyLoadOptions

Represents the Excel RowColumnPivotHierarchy.

[ API set: ExcelApi 1.8 ]

Excel.Interfaces.RowColumnPivotHierarchyUpdateData

An interface for updating data on the RowColumnPivotHierarchy object, for use in rowColumnPivotHierarchy.set({ ... }).

Excel.Interfaces.RuntimeData

An interface describing the data returned by calling runtime.toJSON().

Excel.Interfaces.RuntimeLoadOptions

Represents the Excel Runtime class.

[ API set: ExcelApi 1.5 ]

Excel.Interfaces.RuntimeUpdateData

An interface for updating data on the Runtime object, for use in runtime.set({ ... }).

Excel.Interfaces.SettingCollectionData

An interface describing the data returned by calling settingCollection.toJSON().

Excel.Interfaces.SettingCollectionLoadOptions

Represents a collection of key-value pair setting objects that are part of the workbook. The scope is limited to per file and add-in (task-pane or content) combination.

[ API set: ExcelApi 1.4 ]

Excel.Interfaces.SettingCollectionUpdateData

An interface for updating data on the SettingCollection object, for use in settingCollection.set({ ... }).

Excel.Interfaces.SettingData

An interface describing the data returned by calling setting.toJSON().

Excel.Interfaces.SettingLoadOptions

Setting represents a key-value pair of a setting persisted to the document (per file per add-in). These custom key-value pair can be used to store state or lifecycle information needed by the content or task-pane add-in. Note that settings are persisted in the document and hence it is not a place to store any sensitive or protected information such as user information and password.

[ API set: ExcelApi 1.4 ]

Excel.Interfaces.SettingUpdateData

An interface for updating data on the Setting object, for use in setting.set({ ... }).

Excel.Interfaces.ShapeCollectionData

An interface describing the data returned by calling shapeCollection.toJSON().

Excel.Interfaces.ShapeCollectionLoadOptions

Represents a collection of all the shapes in the worksheet.

[ API set: ExcelApi 1.9 ]

Excel.Interfaces.ShapeCollectionUpdateData

An interface for updating data on the ShapeCollection object, for use in shapeCollection.set({ ... }).

Excel.Interfaces.ShapeData

An interface describing the data returned by calling shape.toJSON().

Excel.Interfaces.ShapeFillData

An interface describing the data returned by calling shapeFill.toJSON().

Excel.Interfaces.ShapeFillLoadOptions

Represents the fill formatting of a shape object.

[ API set: ExcelApi 1.9 ]

Excel.Interfaces.ShapeFillUpdateData

An interface for updating data on the ShapeFill object, for use in shapeFill.set({ ... }).

Excel.Interfaces.ShapeFontData

An interface describing the data returned by calling shapeFont.toJSON().

Excel.Interfaces.ShapeFontLoadOptions

Represents the font attributes, such as font name, font size, and color, for a shape's TextRange object.

[ API set: ExcelApi 1.9 ]

Excel.Interfaces.ShapeFontUpdateData

An interface for updating data on the ShapeFont object, for use in shapeFont.set({ ... }).

Excel.Interfaces.ShapeGroupData

An interface describing the data returned by calling shapeGroup.toJSON().

Excel.Interfaces.ShapeGroupLoadOptions

Represents a shape group inside a worksheet. To get the corresponding Shape object, use ShapeGroup.shape.

[ API set: ExcelApi 1.9 ]

Excel.Interfaces.ShapeLineFormatData

An interface describing the data returned by calling shapeLineFormat.toJSON().

Excel.Interfaces.ShapeLineFormatLoadOptions

Represents the line formatting for the shape object. For images and geometric shapes, line formatting represents the border of the shape.

[ API set: ExcelApi 1.9 ]

Excel.Interfaces.ShapeLineFormatUpdateData

An interface for updating data on the ShapeLineFormat object, for use in shapeLineFormat.set({ ... }).

Excel.Interfaces.ShapeLoadOptions

Represents a generic shape object in the worksheet. A shape could be a geometric shape, a line, a group of shapes, etc. To learn more about the shape object model, read Work with shapes using the Excel JavaScript API.

[ API set: ExcelApi 1.9 ]

Excel.Interfaces.ShapeUpdateData

An interface for updating data on the Shape object, for use in shape.set({ ... }).

Excel.Interfaces.SlicerCollectionData

An interface describing the data returned by calling slicerCollection.toJSON().

Excel.Interfaces.SlicerCollectionLoadOptions

Represents a collection of all the slicer objects on the workbook or a worksheet.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

Excel.Interfaces.SlicerCollectionUpdateData

An interface for updating data on the SlicerCollection object, for use in slicerCollection.set({ ... }).

Excel.Interfaces.SlicerData

An interface describing the data returned by calling slicer.toJSON().

Excel.Interfaces.SlicerItemCollectionData

An interface describing the data returned by calling slicerItemCollection.toJSON().

Excel.Interfaces.SlicerItemCollectionLoadOptions

Represents a collection of all the slicer item objects on the slicer.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

Excel.Interfaces.SlicerItemCollectionUpdateData

An interface for updating data on the SlicerItemCollection object, for use in slicerItemCollection.set({ ... }).

Excel.Interfaces.SlicerItemData

An interface describing the data returned by calling slicerItem.toJSON().

Excel.Interfaces.SlicerItemLoadOptions

Represents a slicer item in a slicer.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

Excel.Interfaces.SlicerItemUpdateData

An interface for updating data on the SlicerItem object, for use in slicerItem.set({ ... }).

Excel.Interfaces.SlicerLoadOptions

Represents a slicer object in the workbook.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

Excel.Interfaces.SlicerStyleCollectionData

An interface describing the data returned by calling slicerStyleCollection.toJSON().

Excel.Interfaces.SlicerStyleCollectionLoadOptions

Represents a collection of SlicerStyle objects.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

Excel.Interfaces.SlicerStyleCollectionUpdateData

An interface for updating data on the SlicerStyleCollection object, for use in slicerStyleCollection.set({ ... }).

Excel.Interfaces.SlicerStyleData

An interface describing the data returned by calling slicerStyle.toJSON().

Excel.Interfaces.SlicerStyleLoadOptions

Represents a Slicer Style, which defines style elements by region of the slicer.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

Excel.Interfaces.SlicerStyleUpdateData

An interface for updating data on the SlicerStyle object, for use in slicerStyle.set({ ... }).

Excel.Interfaces.SlicerUpdateData

An interface for updating data on the Slicer object, for use in slicer.set({ ... }).

Excel.Interfaces.StyleCollectionData

An interface describing the data returned by calling styleCollection.toJSON().

Excel.Interfaces.StyleCollectionLoadOptions

Represents a collection of all the styles.

[ API set: ExcelApi 1.7 ]

Excel.Interfaces.StyleCollectionUpdateData

An interface for updating data on the StyleCollection object, for use in styleCollection.set({ ... }).

Excel.Interfaces.StyleData

An interface describing the data returned by calling style.toJSON().

Excel.Interfaces.StyleLoadOptions

An object encapsulating a style's format and other properties.

[ API set: ExcelApi 1.7 ]

Excel.Interfaces.StyleUpdateData

An interface for updating data on the Style object, for use in style.set({ ... }).

Excel.Interfaces.TableCollectionData

An interface describing the data returned by calling tableCollection.toJSON().

Excel.Interfaces.TableCollectionLoadOptions

Represents a collection of all the tables that are part of the workbook or worksheet, depending on how it was reached.

[ API set: ExcelApi 1.1 ]

Excel.Interfaces.TableCollectionUpdateData

An interface for updating data on the TableCollection object, for use in tableCollection.set({ ... }).

Excel.Interfaces.TableColumnCollectionData

An interface describing the data returned by calling tableColumnCollection.toJSON().

Excel.Interfaces.TableColumnCollectionLoadOptions

Represents a collection of all the columns that are part of the table.

[ API set: ExcelApi 1.1 ]

Excel.Interfaces.TableColumnCollectionUpdateData

An interface for updating data on the TableColumnCollection object, for use in tableColumnCollection.set({ ... }).

Excel.Interfaces.TableColumnData

An interface describing the data returned by calling tableColumn.toJSON().

Excel.Interfaces.TableColumnLoadOptions

Represents a column in a table.

[ API set: ExcelApi 1.1 ]

Excel.Interfaces.TableColumnUpdateData

An interface for updating data on the TableColumn object, for use in tableColumn.set({ ... }).

Excel.Interfaces.TableData

An interface describing the data returned by calling table.toJSON().

Excel.Interfaces.TableLoadOptions

Represents an Excel table. To learn more about the table object model, read Work with tables using the Excel JavaScript API.

[ API set: ExcelApi 1.1 ]

Excel.Interfaces.TableRowCollectionData

An interface describing the data returned by calling tableRowCollection.toJSON().

Excel.Interfaces.TableRowCollectionLoadOptions

Represents a collection of all the rows that are part of the table.

Note that unlike Ranges or Columns, which will adjust if new rows/columns are added before them, a TableRow object represent the physical location of the table row, but not the data. That is, if the data is sorted or if new rows are added, a table row will continue to point at the index for which it was created.

[ API set: ExcelApi 1.1 ]

Excel.Interfaces.TableRowCollectionUpdateData

An interface for updating data on the TableRowCollection object, for use in tableRowCollection.set({ ... }).

Excel.Interfaces.TableRowData

An interface describing the data returned by calling tableRow.toJSON().

Excel.Interfaces.TableRowLoadOptions

Represents a row in a table.

Note that unlike Ranges or Columns, which will adjust if new rows/columns are added before them, a TableRow object represent the physical location of the table row, but not the data. That is, if the data is sorted or if new rows are added, a table row will continue to point at the index for which it was created.

[ API set: ExcelApi 1.1 ]

Excel.Interfaces.TableRowUpdateData

An interface for updating data on the TableRow object, for use in tableRow.set({ ... }).

Excel.Interfaces.TableScopedCollectionData

An interface describing the data returned by calling tableScopedCollection.toJSON().

Excel.Interfaces.TableScopedCollectionLoadOptions

Represents a scoped collection of tables. For each table its top-left corner is considered its anchor location and the tables are sorted top to bottom and then left to right.

[ API set: ExcelApi 1.9 ]

Excel.Interfaces.TableScopedCollectionUpdateData

An interface for updating data on the TableScopedCollection object, for use in tableScopedCollection.set({ ... }).

Excel.Interfaces.TableSortData

An interface describing the data returned by calling tableSort.toJSON().

Excel.Interfaces.TableSortLoadOptions

Manages sorting operations on Table objects.

[ API set: ExcelApi 1.2 ]

Excel.Interfaces.TableStyleCollectionData

An interface describing the data returned by calling tableStyleCollection.toJSON().

Excel.Interfaces.TableStyleCollectionLoadOptions

Represents a collection of TableStyles.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

Excel.Interfaces.TableStyleCollectionUpdateData

An interface for updating data on the TableStyleCollection object, for use in tableStyleCollection.set({ ... }).

Excel.Interfaces.TableStyleData

An interface describing the data returned by calling tableStyle.toJSON().

Excel.Interfaces.TableStyleLoadOptions

Represents a TableStyle, which defines the style elements by region of the Table.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

Excel.Interfaces.TableStyleUpdateData

An interface for updating data on the TableStyle object, for use in tableStyle.set({ ... }).

Excel.Interfaces.TableUpdateData

An interface for updating data on the Table object, for use in table.set({ ... }).

Excel.Interfaces.TextConditionalFormatData

An interface describing the data returned by calling textConditionalFormat.toJSON().

Excel.Interfaces.TextConditionalFormatLoadOptions

Represents a specific text conditional format.

[ API set: ExcelApi 1.6 ]

Excel.Interfaces.TextConditionalFormatUpdateData

An interface for updating data on the TextConditionalFormat object, for use in textConditionalFormat.set({ ... }).

Excel.Interfaces.TextFrameData

An interface describing the data returned by calling textFrame.toJSON().

Excel.Interfaces.TextFrameLoadOptions

Represents the text frame of a shape object.

[ API set: ExcelApi 1.9 ]

Excel.Interfaces.TextFrameUpdateData

An interface for updating data on the TextFrame object, for use in textFrame.set({ ... }).

Excel.Interfaces.TextRangeData

An interface describing the data returned by calling textRange.toJSON().

Excel.Interfaces.TextRangeLoadOptions

Contains the text that is attached to a shape, in addition to properties and methods for manipulating the text.

[ API set: ExcelApi 1.9 ]

Excel.Interfaces.TextRangeUpdateData

An interface for updating data on the TextRange object, for use in textRange.set({ ... }).

Excel.Interfaces.TimelineStyleCollectionData

An interface describing the data returned by calling timelineStyleCollection.toJSON().

Excel.Interfaces.TimelineStyleCollectionLoadOptions

Represents a collection of TimelineStyles.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

Excel.Interfaces.TimelineStyleCollectionUpdateData

An interface for updating data on the TimelineStyleCollection object, for use in timelineStyleCollection.set({ ... }).

Excel.Interfaces.TimelineStyleData

An interface describing the data returned by calling timelineStyle.toJSON().

Excel.Interfaces.TimelineStyleLoadOptions

Represents a Timeline style, which defines style elements by region in the Timeline.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

Excel.Interfaces.TimelineStyleUpdateData

An interface for updating data on the TimelineStyle object, for use in timelineStyle.set({ ... }).

Excel.Interfaces.TopBottomConditionalFormatData

An interface describing the data returned by calling topBottomConditionalFormat.toJSON().

Excel.Interfaces.TopBottomConditionalFormatLoadOptions

Represents a Top/Bottom conditional format.

[ API set: ExcelApi 1.6 ]

Excel.Interfaces.TopBottomConditionalFormatUpdateData

An interface for updating data on the TopBottomConditionalFormat object, for use in topBottomConditionalFormat.set({ ... }).

Excel.Interfaces.WorkbookCreatedData

An interface describing the data returned by calling workbookCreated.toJSON().

Excel.Interfaces.WorkbookData

An interface describing the data returned by calling workbook.toJSON().

Excel.Interfaces.WorkbookLoadOptions

Workbook is the top level object which contains related workbook objects such as worksheets, tables, ranges, etc. To learn more about the workbook object model, read Work with workbooks using the Excel JavaScript API.

[ API set: ExcelApi 1.1 ]

Excel.Interfaces.WorkbookProtectionData

An interface describing the data returned by calling workbookProtection.toJSON().

Excel.Interfaces.WorkbookProtectionLoadOptions

Represents the protection of a workbook object.

[ API set: ExcelApi 1.7 ]

Excel.Interfaces.WorkbookUpdateData

An interface for updating data on the Workbook object, for use in workbook.set({ ... }).

Excel.Interfaces.WorksheetCollectionData

An interface describing the data returned by calling worksheetCollection.toJSON().

Excel.Interfaces.WorksheetCollectionLoadOptions

Represents a collection of worksheet objects that are part of the workbook.

[ API set: ExcelApi 1.1 ]

Excel.Interfaces.WorksheetCollectionUpdateData

An interface for updating data on the WorksheetCollection object, for use in worksheetCollection.set({ ... }).

Excel.Interfaces.WorksheetData

An interface describing the data returned by calling worksheet.toJSON().

Excel.Interfaces.WorksheetLoadOptions

An Excel worksheet is a grid of cells. It can contain data, tables, charts, etc. To learn more about the worksheet object model, read Work with worksheets using the Excel JavaScript API.

[ API set: ExcelApi 1.1 ]

Excel.Interfaces.WorksheetProtectionData

An interface describing the data returned by calling worksheetProtection.toJSON().

Excel.Interfaces.WorksheetProtectionLoadOptions

Represents the protection of a sheet object.

[ API set: ExcelApi 1.2 ]

Excel.Interfaces.WorksheetUpdateData

An interface for updating data on the Worksheet object, for use in worksheet.set({ ... }).

Excel.ListDataValidation

Represents the List data validation criteria.

[ API set: ExcelApi 1.8 ]

Excel.PageLayoutMarginOptions

Represents the options in page layout margins.

[ API set: ExcelApi 1.9 ]

Excel.PageLayoutZoomOptions

Represents page zoom properties.

[ API set: ExcelApi 1.9 ]

Excel.RangeHyperlink

Represents the necessary strings to get/set a hyperlink (XHL) object.

[ API set: ExcelApi 1.7 ]

Excel.RangeReference

Represents a string reference of the form SheetName!A1:B5, or a global or local named range.

[ API set: ExcelApi 1.2 ]

Excel.ReplaceCriteria

Represents the replace criteria to be used.

[ API set: ExcelApi 1.9 ]

Excel.RowProperties

Represents the returned properties of getRowProperties.

[ API set: ExcelApi 1.9 ]

Excel.RowPropertiesLoadOptions

Represents which row properties to load, when used as part of a "range.getRowProperties" method.

[ API set: ExcelApi 1.9 ]

Excel.RunOptions

Represents the Basic Type data validation criteria.

[ API set: ExcelApi 1.8 ]

Excel.SearchCriteria

Represents the search criteria to be used.

[ API set: ExcelApi 1.9 ]

Excel.SelectionChangedEventArgs

Provides information about the document that raised the SelectionChanged event.

[ API set: ExcelApi 1.2 ]

Excel.SettableCellProperties

Represents the input parameter of setCellProperties.

[ API set: ExcelApi 1.9 ]

Excel.SettableColumnProperties

Represents the input parameter of setColumnProperties.

[ API set: ExcelApi 1.9 ]

Excel.SettableRowProperties

Represents the input parameter of setRowProperties.

[ API set: ExcelApi 1.9 ]

Excel.SettingsChangedEventArgs

Provides information about the setting that raised the SettingsChanged event

[ API set: ExcelApi 1.4 ]

Excel.ShapeActivatedEventArgs

Provides information about the shape that raised the Activated event.

[ API set: ExcelApi 1.9 ]

Excel.ShapeDeactivatedEventArgs

Provides information about the shape that raised the Deactivated event.

[ API set: ExcelApi 1.9 ]

Excel.ShowAsRule

[ API set: ExcelApi 1.8 ]

Excel.SortField

Represents a condition in a sorting operation.

[ API set: ExcelApi 1.2 ]

Excel.Subtotals

Subtotals for the Pivot Field.

[ API set: ExcelApi 1.8 ]

Excel.TableAddedEventArgs

Provides information about the table that raised the OnAdded event.

[ API set: ExcelApi 1.9 ]

Excel.TableChangedEventArgs

Provides information about the table that raised the Changed event.

[ API set: ExcelApi 1.7 ]

Excel.TableDeletedEventArgs

Provides information about the table that raised the OnDeleted event.

[ API set: ExcelApi 1.9 ]

Excel.TableFilteredEventArgs

Provides information about the table that raised the filter applied event.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

Excel.TableSelectionChangedEventArgs

Provides information about the table that raised the SelectionChanged event.

[ API set: ExcelApi 1.7 ]

Excel.ThreeArrowsGraySet

[ API set: ExcelApi 1.2 ]

Excel.ThreeArrowsSet

[ API set: ExcelApi 1.2 ]

Excel.ThreeFlagsSet

[ API set: ExcelApi 1.2 ]

Excel.ThreeSignsSet

[ API set: ExcelApi 1.2 ]

Excel.ThreeStarsSet

[ API set: ExcelApi 1.2 ]

Excel.ThreeSymbols2Set

[ API set: ExcelApi 1.2 ]

Excel.ThreeSymbolsSet

[ API set: ExcelApi 1.2 ]

Excel.ThreeTrafficLights1Set

[ API set: ExcelApi 1.2 ]

Excel.ThreeTrafficLights2Set

[ API set: ExcelApi 1.2 ]

Excel.ThreeTrianglesSet

[ API set: ExcelApi 1.2 ]

Excel.WorkbookAutoSaveSettingChangedEventArgs

Provides information about the workbook's onAutoSaveSettingChanged event.

[ API set: ExcelApi 1.9 ]

Excel.WorksheetActivatedEventArgs

Provides information about the worksheet that raised the Activated event.

[ API set: ExcelApi 1.7 ]

Excel.WorksheetAddedEventArgs

Provides information about the worksheet that raised the Added event.

[ API set: ExcelApi 1.7 ]

Excel.WorksheetCalculatedEventArgs

Provides information about the worksheet that raised the Calculated event.

[ API set: ExcelApi 1.8 ]

Excel.WorksheetChangedEventArgs

Provides information about the worksheet that raised the Changed event.

[ API set: ExcelApi 1.7 ]

Excel.WorksheetColumnSortedEventArgs

Provides information about the column-sorted event and its related worksheet.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

Excel.WorksheetDeactivatedEventArgs

Provides information about the worksheet that raised the Deactivated event.

[ API set: ExcelApi 1.7 ]

Excel.WorksheetDeletedEventArgs

Provides information about the worksheet that raised the Deleted event.

[ API set: ExcelApi 1.7 ]

Excel.WorksheetFilteredEventArgs

Provides information about the worksheet that raised the filter applied event.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

Excel.WorksheetFormatChangedEventArgs

Provides information about the worksheet format change event.

[ API set: ExcelApi 1.9 ]

Excel.WorksheetProtectionOptions

Represents the options in sheet protection.

[ API set: ExcelApi 1.2 ]

Excel.WorksheetRowHiddenChangedEventArgs

Provides information about the worksheet's row hidden change event.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

Excel.WorksheetRowSortedEventArgs

Provides information about the row-sorted event and its related worksheet.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

Excel.WorksheetSearchCriteria

Represents the worksheet search criteria to be used.

[ API set: ExcelApi 1.9 ]

Excel.WorksheetSelectionChangedEventArgs

Provides information about the worksheet that raised the SelectionChanged event.

[ API set: ExcelApi 1.7 ]

Excel.WorksheetSingleClickedEventArgs

Provides information about the left-clicked/tapped event and its related worksheet.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

Enums

Excel.AggregationFunction

Aggregation Function for the Data Pivot Field.

[ API set: ExcelApi 1.8 ]

Excel.ArrowheadLength

[ API set: ExcelApi 1.9 ]

Excel.ArrowheadStyle

[ API set: ExcelApi 1.9 ]

Excel.ArrowheadWidth

[ API set: ExcelApi 1.9 ]

Excel.AutoFillType

[ API set: ExcelApi 1.9 ]

Excel.BindingType

[ API set: ExcelApi 1.1 ]

Excel.BorderIndex

[ API set: ExcelApi 1.1 ]

Excel.BorderLineStyle

[ API set: ExcelApi 1.1 ]

Excel.BorderWeight

[ API set: ExcelApi 1.1 ]

Excel.BuiltInStyle

[ API set: ExcelApi 1.7 ]

Excel.CalculationMode

[ API set: ExcelApi 1.1 ]

Excel.CalculationState

Represents the state of calculation across the entire Excel application.

[ API set: ExcelApi 1.9 ]

Excel.CalculationType

[ API set: ExcelApi 1.1 ]

Excel.ChartAxisCategoryType

Specifies the type of the category axis.

[ API set: ExcelApi 1.7 ]

Excel.ChartAxisDisplayUnit

[ API set: ExcelApi 1.7 ]

Excel.ChartAxisGroup

[ API set: ExcelApi 1.7 ]

Excel.ChartAxisPosition

[ API set: ExcelApi 1.7 ]

Excel.ChartAxisScaleType

[ API set: ExcelApi 1.7 ]

Excel.ChartAxisTickLabelPosition

[ API set: ExcelApi 1.7 ]

Excel.ChartAxisTickMark

[ API set: ExcelApi 1.7 ]

Excel.ChartAxisTimeUnit

Specifies the unit of time for chart axes and data series.

[ API set: ExcelApi 1.7 ]

Excel.ChartAxisType

[ API set: ExcelApi 1.7 ]

Excel.ChartBinType

Specifies the bin's type of a histogram chart or pareto chart series.

[ API set: ExcelApi 1.9 ]

Excel.ChartBoxQuartileCalculation

Represents the quartile calculation type of chart series layout. Only applies to a box and whisker chart.

[ API set: ExcelApi 1.9 ]

Excel.ChartColorScheme

[ API set: ExcelApi 1.8 ]

Excel.ChartDataLabelPosition

[ API set: ExcelApi 1.1 ]

Excel.ChartDisplayBlanksAs

[ API set: ExcelApi 1.8 ]

Excel.ChartErrorBarsInclude

Represents which parts of the error bar to include.

[ API set: ExcelApi 1.9 ]

Excel.ChartErrorBarsType

Represents the range type for error bars.

[ API set: ExcelApi 1.9 ]

Excel.ChartGradientStyle

Represents the gradient style of a chart series. This is only applicable for region map charts.

[ API set: ExcelApi 1.9 ]

Excel.ChartGradientStyleType

Represents the gradient style type of a chart series. This is only applicable for region map charts.

[ API set: ExcelApi 1.9 ]

Excel.ChartLegendPosition

[ API set: ExcelApi 1.1 ]

Excel.ChartLineStyle

[ API set: ExcelApi 1.7 ]

Excel.ChartMapAreaLevel

Represents the mapping level of a chart series. This only applies to region map charts.

[ API set: ExcelApi 1.9 ]

Excel.ChartMapLabelStrategy

Represents the region level of a chart series layout. This only applies to region map charts.

[ API set: ExcelApi 1.9 ]

Excel.ChartMapProjectionType

Represents the region projection type of a chart series layout. This only applies to region map charts.

[ API set: ExcelApi 1.9 ]

Excel.ChartMarkerStyle

[ API set: ExcelApi 1.7 ]

Excel.ChartParentLabelStrategy

Represents the parent label strategy of the chart series layout. This only applies to treemap charts

[ API set: ExcelApi 1.9 ]

Excel.ChartPlotAreaPosition

[ API set: ExcelApi 1.8 ]

Excel.ChartPlotBy

[ API set: ExcelApi 1.8 ]

Excel.ChartSeriesBy

Specifies whether the series are by rows or by columns. On Desktop, the "auto" option will inspect the source data shape to automatically guess whether the data is by rows or columns; in Excel on the web, "auto" will simply default to "columns".

[ API set: ExcelApi 1.1 ]

Excel.ChartSplitType

[ API set: ExcelApi 1.8 ]

Excel.ChartTextHorizontalAlignment

Represents the horizontal alignment for the specified object.

[ API set: ExcelApi 1.7 ]

Excel.ChartTextVerticalAlignment

Represents the vertical alignment for the specified object.

[ API set: ExcelApi 1.7 ]

Excel.ChartTickLabelAlignment

[ API set: ExcelApi 1.8 ]

Excel.ChartTitlePosition

Represents the position of chart title.

[ API set: ExcelApi 1.7 ]

Excel.ChartTrendlineType

[ API set: ExcelApi 1.7 ]

Excel.ChartType

[ API set: ExcelApi 1.1 ]

Excel.ChartUnderlineStyle

[ API set: ExcelApi 1.1 ]

Excel.ClearApplyTo

[ API set: ExcelApi 1.1 for All/Formats/Contents, 1.7 for Hyperlinks & HyperlinksAndFormats. ]

Excel.CloseBehavior

Specifies the close behavior for Workbook.close API.

[ API set: ExcelApi 1.9 ]

Excel.ConditionalCellValueOperator

Represents the operator of the text conditional format type.

[ API set: ExcelApi 1.6 ]

Excel.ConditionalDataBarAxisFormat

Represents the format options for a Data Bar Axis.

[ API set: ExcelApi 1.6 ]

Excel.ConditionalDataBarDirection

Represents the Data Bar direction within a cell.

[ API set: ExcelApi 1.6 ]

Excel.ConditionalFormatColorCriterionType

Represents the types of conditional format values.

[ API set: ExcelApi 1.6 ]

Excel.ConditionalFormatDirection

Represents the direction for a selection.

[ API set: ExcelApi 1.6 ]

Excel.ConditionalFormatIconRuleType

Represents the types of conditional format values.

[ API set: ExcelApi 1.6 ]

Excel.ConditionalFormatPresetCriterion

Represents the criteria for the Preset Criteria conditional format type.

[ API set: ExcelApi 1.6 ]

Excel.ConditionalFormatRuleType

Represents the types of conditional format values.

[ API set: ExcelApi 1.6 ]

Excel.ConditionalFormatType

[ API set: ExcelApi 1.6 ]

Excel.ConditionalIconCriterionOperator

Represents the operator for each icon criteria.

[ API set: ExcelApi 1.6 ]

Excel.ConditionalRangeBorderIndex

[ API set: ExcelApi 1.6 ]

Excel.ConditionalRangeBorderLineStyle

[ API set: ExcelApi 1.6 ]

Excel.ConditionalRangeFontUnderlineStyle

[ API set: ExcelApi 1.6 ]

Excel.ConditionalTextOperator

Represents the operator of the text conditional format type.

[ API set: ExcelApi 1.6 ]

Excel.ConditionalTopBottomCriterionType

Represents the criteria for the above/below average conditional format type.

[ API set: ExcelApi 1.6 ]

Excel.ConnectorType

[ API set: ExcelApi 1.9 ]

Excel.ContentType

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

Excel.CustomFunctionMetadataFormat

[ API set: CustomFunctions 1.1 ]

Excel.CustomFunctionType

[ API set: CustomFunctions 1.1 ]

Excel.DataChangeType

[ API set: ExcelApi 1.7 ]

Excel.DataValidationAlertStyle

Represents Data validation error alert style. The default is "Stop".

[ API set: ExcelApi 1.8 ]

Excel.DataValidationOperator

Represents Data validation operator enum.

[ API set: ExcelApi 1.8 ]

Excel.DataValidationType

Represents Data validation type enum.

[ API set: ExcelApi 1.8 ]

Excel.DeleteShiftDirection

[ API set: ExcelApi 1.1 ]

Excel.DocumentPropertyItem

[ API set: ExcelApi 1.7 ]

Excel.DocumentPropertyType

[ API set: ExcelApi 1.7 ]

Excel.DynamicFilterCriteria

[ API set: ExcelApi 1.2 ]

Excel.ErrorCodes

Aggregation Function for the Data Pivot Field.

[ API set: ExcelApi 1.8 ]

Excel.EventSource

[ API set: ExcelApi 1.7 ]

Excel.EventType

[ API set: ExcelApi 1.7 ]

Excel.FillPattern

[ API set: ExcelApi 1.9 ]

Excel.FilterDatetimeSpecificity

[ API set: ExcelApi 1.2 ]

Excel.FilterOn

[ API set: ExcelApi 1.2 ]

Excel.FilterOperator

[ API set: ExcelApi 1.2 ]

Excel.GeometricShapeType

Specifies the shape type for a GeometricShape object.

[ API set: ExcelApi 1.9 ]

Excel.GroupOption

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

Excel.HeaderFooterState

[ API set: ExcelApi 1.9 ]

Excel.HorizontalAlignment

[ API set: ExcelApi 1.1 ]

Excel.IconSet

[ API set: ExcelApi 1.2 ]

Excel.ImageFittingMode

[ API set: ExcelApi 1.2 ]

Excel.InsertShiftDirection

[ API set: ExcelApi 1.1 ]

Excel.LinkedDataTypeState

[ API set: ExcelApi 1.9 ]

Excel.NamedItemScope

[ API set: ExcelApi 1.4 ]

Excel.NamedItemType

[ API set: ExcelApi 1.1 for String,Integer,Double,Boolean,Range,Error; 1.7 for Array ]

Excel.PageOrientation

[ API set: ExcelApi 1.7 ]

Excel.PaperType

[ API set: ExcelApi 1.9 ]

Excel.PictureFormat

The format of the image.

[ API set: ExcelApi 1.9 ]

Excel.PivotAxis

The ShowAs Calculation function for the Data Pivot Field.

[ API set: ExcelApi 1.9 ]

Excel.PivotFilterTopBottomCriterion

Represents the criteria for the top/bottom values filter.

[ API set: ExcelApi 1.9 ]

Excel.PivotLayoutType

[ API set: ExcelApi 1.8 ]

Excel.Placement

Specifies the way that an object is attached to its underlying cells.

[ API set: ExcelApi 1.9 ]

Excel.PrintComments

[ API set: ExcelApi 1.9 ]

Excel.PrintErrorType

[ API set: ExcelApi 1.9 ]

Excel.PrintMarginUnit

[ API set: ExcelApi 1.9 ]

Excel.PrintOrder

[ API set: ExcelApi 1.9 ]

Excel.ProtectionSelectionMode

[ API set: ExcelApi 1.7 ]

Excel.RangeCopyType

[ API set: ExcelApi 1.9 ]

Excel.RangeUnderlineStyle

[ API set: ExcelApi 1.1 ]

Excel.RangeValueType

[ API set: ExcelApi 1.1 for Unknown, Empty, String, Integer, Double, Boolean, Error. 1.7 for RichValue ]

Excel.ReadingOrder

[ API set: ExcelApi 1.7 ]

Excel.RibbonTab

[ API set: ExcelApi 1.9 ]

Excel.RowHiddenChangeType

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

Excel.SaveBehavior

Specifies the save behavior for Workbook.save API.

[ API set: ExcelApi 1.9 ]

Excel.SearchDirection

Specifies the search direction.

[ API set: ExcelApi 1.9 ]

Excel.ShapeAutoSize

Determines the type of automatic sizing allowed.

[ API set: ExcelApi 1.9 ]

Excel.ShapeFillType

Specifies a shape's fill type.

[ API set: ExcelApi 1.9 ]

Excel.ShapeFontUnderlineStyle

The type of underline applied to a font.

[ API set: ExcelApi 1.9 ]

Excel.ShapeLineDashStyle

The dash style for a line.

[ API set: ExcelApi 1.9 ]

Excel.ShapeLineStyle

The style for a line.

[ API set: ExcelApi 1.9 ]

Excel.ShapeScaleFrom

Specifies which part of the shape retains its position when the shape is scaled.

[ API set: ExcelApi 1.9 ]

Excel.ShapeScaleType

Specifies whether the shape is scaled relative to its original or current size.

[ API set: ExcelApi 1.9 ]

Excel.ShapeTextHorizontalAlignment

Specifies the horizontal alignment for the text frame in a shape.

[ API set: ExcelApi 1.9 ]

Excel.ShapeTextHorizontalOverflow

Specifies the horizontal overflow for the text frame in a shape.

[ API set: ExcelApi 1.9 ]

Excel.ShapeTextOrientation

Specifies the orientation for the text frame in a shape.

[ API set: ExcelApi 1.9 ]

Excel.ShapeTextReadingOrder

Specifies the reading order for the text frame in a shape.

[ API set: ExcelApi 1.9 ]

Excel.ShapeTextVerticalAlignment

Specifies the vertical alignment for the text frame in a shape.

[ API set: ExcelApi 1.9 ]

Excel.ShapeTextVerticalOverflow

Specifies the vertical overflow for the text frame in a shape.

[ API set: ExcelApi 1.9 ]

Excel.ShapeType

Specifies the type of a shape.

[ API set: ExcelApi 1.9 ]

Excel.ShapeZOrder

Specifies where in the z-order a shape should be moved relative to other shapes.

[ API set: ExcelApi 1.9 ]

Excel.SheetVisibility

[ API set: ExcelApi 1.1 ]

Excel.ShowAsCalculation

The ShowAs Calculation function for the Data Pivot Field.

[ API set: ExcelApi 1.8 ]

Excel.SlicerSortType

Specifies the slicer sort behavior for Slicer.sortBy API.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

Excel.SortBy

Represents the sort direction.

[ API set: ExcelApi 1.8 ]

Excel.SortDataOption

[ API set: ExcelApi 1.2 ]

Excel.SortMethod

[ API set: ExcelApi 1.2 ]

Excel.SortOn

[ API set: ExcelApi 1.2 ]

Excel.SortOrientation

[ API set: ExcelApi 1.2 ]

Excel.SpecialCellType

[ API set: ExcelApi 1.9 ]

Excel.SpecialCellValueType

[ API set: ExcelApi 1.9 ]

Excel.SubtotalLocationType

[ API set: ExcelApi 1.8 ]

Excel.VerticalAlignment

[ API set: ExcelApi 1.1 ]

Excel.WorksheetPositionType

[ API set: ExcelApi 1.7 ]

Functions

Excel.createWorkbook(base64)

Creates and opens a new workbook. Optionally, the workbook can be pre-populated with a base64-encoded .xlsx file.

[ API set: ExcelApi 1.8 ]

Excel.getDataCommonPostprocess(response, callArgs)
Excel.postprocessBindingDescriptor(response)
Excel.run(batch)

Executes a batch script that performs actions on the Excel object model, using a new RequestContext. When the promise is resolved, any tracked objects that were automatically allocated during execution will be released.

Excel.run(object, batch)

Executes a batch script that performs actions on the Excel object model, using the RequestContext of a previously-created API object. When the promise is resolved, any tracked objects that were automatically allocated during execution will be released.

Excel.run(objects, batch)

Executes a batch script that performs actions on the Excel object model, using the RequestContext of previously-created API objects.

Excel.run(options, batch)

Executes a batch script that performs actions on the Excel object model, using the RequestContext of a previously-created API object. When the promise is resolved, any tracked objects that were automatically allocated during execution will be released.

Excel.run(context, batch)

Executes a batch script that performs actions on the Excel object model, using the RequestContext of a previously-created object. When the promise is resolved, any tracked objects that were automatically allocated during execution will be released.

Function Details

Excel.createWorkbook(base64)

Creates and opens a new workbook. Optionally, the workbook can be pre-populated with a base64-encoded .xlsx file.

[ API set: ExcelApi 1.8 ]

export function createWorkbook(base64?: string): Promise<void>;

Parameters

base64
string

Returns

Promise<void>

Examples

var myFile = document.getElementById("file");
var reader = new FileReader();

reader.onload = function (event) {
    // strip off the metadata before the base64-encoded string
    var startIndex = event.target.result.indexOf("base64,");
    var copyBase64 = event.target.result.substr(startIndex + 7);

    Excel.createWorkbook(copyBase64);        
};

// read in the file as a data URL so we can parse the base64-encoded string
reader.readAsDataURL(myFile.files[0]);

Excel.getDataCommonPostprocess(response, callArgs)

export function getDataCommonPostprocess(response: any, callArgs: any): any;

Parameters

response
any
callArgs
any

Returns

any

Excel.postprocessBindingDescriptor(response)

export function postprocessBindingDescriptor(response: any): any;

Parameters

response
any

Returns

any

Excel.run(batch)

Executes a batch script that performs actions on the Excel object model, using a new RequestContext. When the promise is resolved, any tracked objects that were automatically allocated during execution will be released.

export function run<T>(batch: (context: Excel.RequestContext) => Promise<T>): Promise<T>;

Parameters

batch
(context: Excel.RequestContext) => Promise<T>

A function that takes in a RequestContext and returns a promise (typically, just the result of "context.sync()"). The context parameter facilitates requests to the Excel application. Since the Office add-in and the Excel application run in two different processes, the RequestContext is required to get access to the Excel object model from the add-in.

Returns

Promise<T>

Excel.run(object, batch)

Executes a batch script that performs actions on the Excel object model, using the RequestContext of a previously-created API object. When the promise is resolved, any tracked objects that were automatically allocated during execution will be released.

export function run<T>(object: OfficeExtension.ClientObject, batch: (context: Excel.RequestContext) => Promise<T>): Promise<T>;

Parameters

object
OfficeExtension.ClientObject

A previously-created API object. The batch will use the same RequestContext as the passed-in object, which means that any changes applied to the object will be picked up by "context.sync()".

batch
(context: Excel.RequestContext) => Promise<T>

A function that takes in a RequestContext and returns a promise (typically, just the result of "context.sync()"). The context parameter facilitates requests to the Excel application. Since the Office add-in and the Excel application run in two different processes, the RequestContext is required to get access to the Excel object model from the add-in.

Returns

Promise<T>

Excel.run(objects, batch)

Executes a batch script that performs actions on the Excel object model, using the RequestContext of previously-created API objects.

export function run<T>(objects: OfficeExtension.ClientObject[], batch: (context: Excel.RequestContext) => Promise<T>): Promise<T>;

Parameters

objects
OfficeExtension.ClientObject[]

An array of previously-created API objects. The array will be validated to make sure that all of the objects share the same context. The batch will use this shared RequestContext, which means that any changes applied to these objects will be picked up by "context.sync()".

batch
(context: Excel.RequestContext) => Promise<T>

A function that takes in a RequestContext and returns a promise (typically, just the result of "context.sync()"). The context parameter facilitates requests to the Excel application. Since the Office add-in and the Excel application run in two different processes, the RequestContext is required to get access to the Excel object model from the add-in.

Returns

Promise<T>

Excel.run(options, batch)

Executes a batch script that performs actions on the Excel object model, using the RequestContext of a previously-created API object. When the promise is resolved, any tracked objects that were automatically allocated during execution will be released.

export function run<T>(options: Excel.RunOptions, batch: (context: Excel.RequestContext) => Promise<T>): Promise<T>;

Parameters

options
Excel.RunOptions

The additional options for this Excel.run which specify previous objects, whether to delay the request for cell edit, session info, etc.

batch
(context: Excel.RequestContext) => Promise<T>

A function that takes in a RequestContext and returns a promise (typically, just the result of "context.sync()"). The context parameter facilitates requests to the Excel application. Since the Office add-in and the Excel application run in two different processes, the RequestContext is required to get access to the Excel object model from the add-in.

Returns

Promise<T>

Excel.run(context, batch)

Executes a batch script that performs actions on the Excel object model, using the RequestContext of a previously-created object. When the promise is resolved, any tracked objects that were automatically allocated during execution will be released.

export function run<T>(context: OfficeExtension.ClientRequestContext, batch: (context: Excel.RequestContext) => Promise<T>): Promise<T>;

Parameters

context
OfficeExtension.ClientRequestContext

A previously-created object. The batch will use the same RequestContext as the passed-in object, which means that any changes applied to the object will be picked up by "context.sync()".

batch
(context: Excel.RequestContext) => Promise<T>

A function that takes in a RequestContext and returns a promise (typically, just the result of "context.sync()"). The context parameter facilitates requests to the Excel application. Since the Office add-in and the Excel application run in two different processes, the RequestContext is required to get access to the Excel object model from the add-in.

Returns

Promise<T>

Remarks

In addition to this signature, the method also has the following signatures:

run<T>(object: OfficeExtension.ClientObject, batch: (context: Excel.RequestContext) => Promise<T>): Promise<T>;

run<T>(objects: OfficeExtension.ClientObject[], batch: (context: Excel.RequestContext) => Promise<T>): Promise<T>;

run<T>(options: Excel.RunOptions, batch: (context: Excel.RequestContext) => Promise<T>): Promise<T>;

run<T>(batch: (context: Excel.RequestContext) => Promise<T>): Promise<T>;