Skip to end of metadata
Go to start of metadata
  • AnchorAn anchor represents the position of a floating (non-cell data) object within a spreadsheet. The position is maintained as a row number + a percentage of the row's width and a column number + a percentage of the column's height.
  • AreaAn Area object represents a rectangular set of cells.
  • AutoFilterThe AutoFilter class represents the filter that is applied to a selected area of cells in a worksheet.
  • AxisAn Axis object represents a chart axis. The Axis class has two sub-classes: CategoryAxis and ValueAxis.
  • AxisLabelAn AxisLabel object represents the labels on an axis. The labels are the displayed values on the axis. Note: the title of an axis (returned by Axis.Title ) is not an axis label.
  • AxisTypeWhen creating a chart with two X or Y axes (primary and secondary), use AxisType to associate a series with a particular axis.
  • BorderA Border object represents a border around a cell or area of cells.
  • BorderPartA BorderPart object represents a particular part of a border around a cell or area of cells.
  • CategoryAxisA CategoryAxis object represents a chart's category (x) axis. CategoryAxis is a sub-class of Axis.
  • CellA Cell object represents a single cell in a worksheet. To return a Cell object use Worksheet.Cells. Specify the cell by 0-based row and column indexes or by Excel-style reference:
  • CellsA Cells collection represents the set of cells in a worksheet.
  • CellStyleThe unique cell style for a given cell.
  • CharacterRunThe class allows you to set a font on a specified range of characters within a ChartText object or a cell. To return a CharacterRun object, use Cell.GetCharacters() or ChartText.GetCharacters().
  • ChartThe Chart class represents an Excel chart. It is the main class for code-based chart creation and modification.
  • ChartDataTableA ChartDataTable object represents a chart's data table. A data table is a grid that can be added to some charts that contains the numeric data used to create the chart. The data table is usually attached to the chart's category axis, replacing the tick-mark labels on the axis.
  • ChartFillPattern
  • ChartInteriorA ChartInterior object contains formatting properties of a ChartRegion or an object extending ChartRegion ( AxisLabel, ChartText, Legend, or SeriesDataLabel ).
  • ChartLineA ChartLine object represents a line in a chart.
  • ChartPageSetupThe ChartPageSetup class represents the page layout properties of a printed chart or chart sheet. To return a ChartPageSetup object, use Chart.PageSetup
  • ChartRegionA ChartRegion object represents either a chart area or plot area. The following classes extend ChartRegion : AxisLabel, ChartText, Legend, DataPoint, and SeriesDataLabel.
  • ChartsThe Charts collection contains all charts in the specified worksheet. Chart sheets are not included in this collection. To return a Charts collection, use Worksheet.Charts.
  • ChartSettings3DThe ChartSettings3D class contains the set of properties specific to three-dimensional charts. To get a ChartSettings3D object, use Chart.ChartSettings3D.
  • ChartsheetA Chartsheet object represents a worksheet that contains only a chart.
  • ChartTextA ChartText object represents a region in a chart where text is displayed (e.g., a chart title). The ChartText extends ChartRegion.
  • ChartTextCollectionThe ChartTextCollection contains all ChartText objects in the specified chart..
  • ChartTypeThe ChartType class contains all available chart types. When setting a chart type, always specify both the major type and the sub-type, for example:
  • ColorThe class represents a single color in a spreadsheet's color palette.
  • ColumnPropertiesThe ColumnProperties class represents a single column in a worksheet.
  • CommentA object represents a note attached to a cell, or group of merged cells, separate from other cell content. A Comment must be associated with a cell, and may only be created using set Comment.Visible to true.
  • CommentsThe Comments collection contains all Comment objects in the worksheet. To return a Comments collection, use Worksheet.Comments.
  • ConditionA Condition object represents a condition within a ConditionalFormat, a format that Excel will apply to a cell or group of cells if a specified condition is met.
  • ConditionalFormatA ConditionalFormat object represents a conditional format that Excel will apply to a cell or group of cells if a specified condition is met. Each ConditionalFormat object contains up to three Condition and a Range object representing the set of cells on which the conditions will be tested.
  • CopyPastePropertiesThe CopyPasteProperties object represents the types of data that will be copied from a worksheet when you call the CopyPaste() method.
  • Data Fields
  • DataImportPropertiesThe DataImportProperties contains a set of properties that can be used when importing data into a Worksheet or Area. To return a DataImportProperties object, call Workbook.CreateDataImportProperties.
  • DataLabelPlacementTypeThe possible positions of a data label relative to its data point.
  • DataPointA DataPoint object represents a data point in a chart. To return a DataPoint object, use Series[i].
  • DataPointMarkerThe DataPointMarker class represents the style and formatting of data markers in line, radar, and scatter charts. To return a DataPointMarker object, use Series.DataPointMarker.
  • DataValidationA DataValidation object represents a rule for validating data entered in cells. The rule may be applied to a cell or a set of cells. The Workbook class contains several CreateDataValidation methods for creating DataValidation objects. To apply a DataValidation object to a cell or group of cells, use Area.SetDataValidation or Range.SetDataValidation.
  • DocumentPropertiesThe DocumentProperties object represents properties of a spreadsheet.
  • ErrorBarAn ErrorBar object represents the error bars on a series. Error bars graphically express potential error amounts relative to each data marker in a data series. You can add error bars to data series in two-dimensional area, bar, column, line, scatter, and bubble charts. In scatter and bubble charts, you can display error bars for x values, y values, or both.
  • ExcelApplicationis the main class for pure code-based workbook generation (for information about template-based workbook generation, see ExcelTemplate). This class is an engine used to open, create, and write (save or stream to a browser) workbooks. A single instance of ExcelApplication can generate multiple workbooks.
  • ExcelWriterExceptionAll methods in the ExcelWriter API can throw an exception of type ExcelWriterException.
  • FieldCollectionThe  class contains a list of PivotTableField objects. To get a FieldCollection object, use PivotTable.ColumnLabels, PivotTable.DataFields, PivotTable.RowLabels, or PivotTable.PageFields.
  • FontThe Font object represents a font style that you can use when creating a reusable Style object, or when setting the style of a cell or set of cells. To set or return a Font object, use Style.Font.
  • GlobalStyleExcelWriter creates three style types: GlobalStyle, NamedStyle, and CellStyle. All three style types derive from the Style class, and NamedStyle derives from GlobalStyle.
  • GroupA Group is a type of shape that contains other shapes. Currently, groups may not be created or have their contents modified. They may be moved, resized, and deleted.
  • GroupsGroups provides access to the collection of Group objectss contained within a drawing. Currently, only top level groups may be accessed. Nested groups are not supported. Additionally, a group may not be created or have its contents modified. However, a group can be moved, resized, and removed from a drawing. To return a Groups collection, use Worksheet.ShapeGroups.
  • HeaderFooterPictureA object represents a picture embedded in a Header or Footer.
  • HeaderFooterSectionThe HeaderFooterSection class represents an area of the header or footer. It allows you to set and retrieve the content in that area.
  • HyperlinkRepresents a hyperlink in an Area (which may contain only one cell) that points to an external URL.
  • HyperlinksThe Hyperlinks collection contains all hyperlinks in a worksheet. The Worksheet.Hyperlinks property returns a Hyperlinks collection.
  • ItemsToRetainThe ItemsToRetain class represents the number of items a PivotTable cache will retain even changes have been made to the data source.
  • LegendA Legend object represents a chart's legend. To return Legend object, use Chart.Legend.
  • NamedObjectA NamedObject object may refer to an array, number, picture, or range. To create a NamedObject in an Excel file, use the corresponding method for the specific object you wish to create (Pictures.CreatePicture(), Workbook.CreateRange(), etc). To get a NamedObject from an existing file, use Workbook.GetNamedObject(), passing in the name of the object you wish to get.
  • NamedStyleExcelWriter creates three style types: GlobalStyle, NamedStyle, and CellStyle. All three style types derive from the Style class, and NamedStyle derives from GlobalStyle.
  • NumberFormatNumberFormat is a helper class that creates custom number format strings, which are used for formatting numbers and dates. Use Style.NumberFormat to set a number format for a specific style.
  • ObjectPositioningEnumeration of the available resize and reposition behaviors of an object when the cells in the spreadsheet it spans are changed.
  • OthersheetA Othersheet object represents a sheet that is not a worksheet or a chartsheet. This sheet represents VBA Module and dialog sheets. These are not currently implemented by ExcelWriter
  • PageSetupThe PageSetup class represents the page layout properties of a printed worksheet.
  • PaletteThe Palette class represents Excel's color palette.
  • PatternPattern contains all available background patterns for pictures.
  • PictureA Picture object represents a picture in a worksheet and allows the size, position, and content of the picture to be managed. Once created, the data of a picture may not be changed or replaced with the data of another picture. Instead, delete the picture and create a new one.
  • PicturesThe Pictures collection represents the set of pictures in a worksheet. To return a Pictures collection, use Worksheet.Pictures.
  • PivotTableA PivotTable object represents a PivotTable in a worksheet and allows the PivotTable to be managed.
  • PivotTableFieldThe  represents a single field in a Pivot Table.  This can be a row label, column label, data field (or value field) or a page field (or report filter).  To get a PivotTableField object, use a FieldCollection.
  • PivotTablesThe  collection represents the set of PivotTables in a worksheet. To return a PivotTables collection, use .
  • PivotTableSettingsThe PivotTableSettings class contains the set of properties specific to pivot tables. To get a PivotTableSettings object, use PivotTable.PivotTableSettings.
  • RangeA Range object represents a range in a workbook.
  • RowPropertiesThe RowProperties class represents a single row in a worksheet. To return a RowProperties object, use Worksheet.GetRowProperties.
  • SeriesA Series object represents a single data series in a chart. To return a Series object, use one of the SeriesCollection.CreateSeries methods.
  • SeriesCollectionThe SeriesCollection class contains the set of data series in a given chart.
  • SeriesDataLabelA SeriesDataLabel represents the appearance of series labels.
  • SettingsBarColumnThe SettingsBarColumn class contains all settings that are specific to bar and column series. To return a SettingsBarColumn object, use Series.SettingsBarColumn.
  • SettingsLineAreaScatterThe SettingsLineAreaScatter class contains all settings that are specific to line, area, and scatter charts. To return a SettingsLineAreaScatter object, use Series.SettingsLineAreaScatter.
  • SettingsPieDoughnutThe SettingsPieDoughnut class contains all settings that are specific to pie and doughnut charts. To return a SettingsPieDoughnut object, use Series.SettingsPieDoughnut.
  • ShapeThe Shape class allows the appearance and behavior of drawing object to be manipulated. On its own, Shape represents a simple auto shape, such as a line, rectangle, or oval. A shape may also represent the display area of a Comment or the size, position, and formatting of a Picture.
  • ShapesThe Shapes collection contains all Shape objects in the worksheet. To return a Shapes collection, use Worksheet.Shapes.
  • ShapeTypeThe ShapeType class contains the Excel shape types supported by ExcelWriter.
  • SheetProtectionA SheetProtection object contains sheet level protection properties that control what users can interact with when a worksheet is protected. To access SheetProtection, use Worksheet.SheetProtection.
  • ShowValueAsThe ShowValueAs class contains the options for showing the value of a DataField. It is equivalent to the Show Values As tab in DataField settings in Excel.
  • SortOptionsThe SortOptions class contains all of the sorting options for a PivotTableField.
  • SourceFieldThe  represents a source field in a PivotTable. To retrieve a SourceField use PivotTable.SourceFields.
  • SourceFieldCollectionThe SourceFieldCollection class contains a list of SourceField objects. To get a SourceFieldCollection object, use PivotTable.SourceFields.
  • StyleExcelWriter has three style types: CellStyle, GlobalStyle, and NamedStyle.
  • TrendlineA Trendline object represents a series trendline. To create a Trendline object, call Trendlines.CreateTrendline .
  • TrendlinesTrendlines is a collection of all Trendline objects associated with a data series in a chart. To return a Trendlines collection, use Series.Trendlines .
  • UpDownBarAn UpDownBar object represents up/down bars in a line chart. Up/down bars connect data points in the highest and lowest series in a line chart to show motion during an interval.
  • ValueAxisA ValueAxis object represents a chart's value (y) axis. The ValueAxis class extends Axis .
  • WorkbookA Workbook object represents an Excel workbook. To return a Workbook object: Call ExcelApplication.Create() to create a new Excel workbook. Call ExcelApplication.Open() to open an existing Excel workbook.
  • WorksheetThe Worksheet class represents a single Excel worksheet.
  • WorksheetsThe Worksheets class represents the set of worksheets in an Excel workbook. This object is used to manage (add, copy, remove, etc.) the worksheets in the workbook To return a Worksheets object, use Workbook.Worksheets.
  • No labels