Message-ID: <1601632629.10423.1711724499138.JavaMail.web05$@web05>
Subject: Exported From Confluence
MIME-Version: 1.0
Content-Type: multipart/related;
boundary="----=_Part_10422_447940252.1711724499138"
------=_Part_10422_447940252.1711724499138
Content-Type: text/html; charset=UTF-8
Content-Transfer-Encoding: quoted-printable
Content-Location: file:///C:/exported.html
ExcelApplication API
ExcelApplication API
- Anchor =E2=80=94 An anchor represents the position of a floating (non-cell data) obj=
ect within a spreadsheet. The position is maintained as a row number + a pe=
rcentage of the row's width and a column number + a percentage of the colum=
n's height.
- Area =E2=80=94 An Area object represents a rectangular set of cells.
- AutoFilter =E2=80=94 The AutoFilter class represents the filter that is applied =
to a selected area of cells in a worksheet.
- Axis =E2=80=94 An Axis object represents a chart axis. The Axis class has two sub-clas=
ses: CategoryAxis and ValueAxis.
- AxisLabel =E2=80=94 An AxisLabel object represents the labels on an axis. The la=
bels are the displayed values on the axis. Note: the title of an axis (retu=
rned by Axis.Title ) is not an axis label.
- AxisType =E2=80=94 When creating a chart with two X or Y axes (primary and seconda=
ry), use AxisType to associate a series with a particular axis.
- Border =E2=80=94 A Border object represents a border around a cell or area of cells.=
- BorderPart =E2=80=94 A BorderPart object represents a particular part of a borde=
r around a cell or area of cells.
- CategoryAxis =E2=80=94 A CategoryAxis object represents a chart's category (x)=
axis. CategoryAxis is a sub-class of Axis.
- Cell =E2=80=94 A 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 ind=
exes or by Excel-style reference:
- Cells =E2=80=94 A Cells collection represents the set of cells in a worksheet.=
- CellStyle =E2=80=94 The unique cell style for a given cell.
- CharacterRun =E2=80=94 The CharacterRun class allows you to set a font on a sp=
ecified range of characters within a ChartText object or a cell. To return =
a CharacterRun object, use Cell.GetCharacters() or ChartText.GetCharacters(=
).
- Chart =E2=80=94 The Chart class represents an Excel chart. It is the main class for c=
ode-based chart creation and modification.
- ChartDataTable =E2=80=94
A ChartDataTable object represents a chart's data t=
able. 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 attac=
hed to the chart's category axis, replacing the tick-mark labels on the axi=
s.
- ChartFillPattern =E2=80=
=94 The ChartFillPattern represents the fill patt=
ern to use when filling a ChartInterior.
- ChartInterior =E2=80=94 A ChartInterior object contains formatting properties=
of a ChartRegion or an object extending ChartRegion ( AxisLabel, ChartText=
, Legend, or SeriesDataLabel ).
- ChartLine =E2=80=94 A ChartLine object represents a line in a chart.
- ChartPageSetup =E2=80=94
The ChartPageSetup class represents the page layout=
properties of a printed chart or chart sheet. To return a ChartPageSetup o=
bject, use Chart.PageSetup
- ChartRegion =E2=80=94 A ChartRegion object represents either a chart area or pl=
ot area. The following classes extend ChartRegion : AxisLabel, ChartText, L=
egend, DataPoint, and SeriesDataLabel.
- Charts =E2=80=94 The Charts collection contains all charts in the specified workshee=
t. Chart sheets are not included in this collection. To return a Charts col=
lection, use Worksheet.Charts.
- ChartSettings3D =E2=80=94 =
The ChartSettings3D class contains the set of pro=
perties specific to three-dimensional charts. To get a ChartSettings3D obje=
ct, use Chart.ChartSettings3D.
- Chartsheet =E2=80=94 A Chartsheet object represents a worksheet that contains on=
ly a chart.
- ChartText =E2=80=94 A ChartText object represents a region in a chart where text=
is displayed (e.g., a chart title). The ChartText extends ChartRegion.
- ChartTextCollection =
=E2=80=94 The ChartTextCollection contains all Ch=
artText objects in the specified chart..
- ChartType =E2=80=94 The ChartType class contains all available chart types. When=
setting a chart type, always specify both the major type and the sub-type,=
for example:
- Color =E2=80=94 The class represents a single color in a spreadsheet's color palette.=
- ColumnProperties =E2=80=
=94 The ColumnProperties class represents a singl=
e column in a worksheet.
- Comment =E2=80=94 A Comment object represents a note attached to a cell, or group o=
f merged cells, separate from other cell content. A Comment must be associa=
ted with a cell, and may only be created using set Comment.Visible to true.=
- Comments =E2=80=94 The Comments collection contains all Comment objects in the wor=
ksheet. To return a Comments collection, use Worksheet.Comments.
- Condition =E2=80=94 A Condition object represents a condition within a Condition=
alFormat, a format that Excel will apply to a cell or group of cells if a s=
pecified condition is met.
- ConditionalFormat =E2=80=
=94 A ConditionalFormat object represents a condi=
tional format that Excel will apply to a cell or group of cells if a specif=
ied condition is met. Each ConditionalFormat object contains up to three Co=
ndition and a Range object representing the set of cells on which the condi=
tions will be tested.
- CopyPasteProperties =
=E2=80=94 The CopyPasteProperties object represen=
ts the types of data that will be copied from a worksheet when you call the=
CopyPaste() method.
- DataImportProperties =
=E2=80=94 The DataImportProperties contains a set=
of properties that can be used when importing data into a Worksheet or Are=
a. To return a DataImportProperties object, call Workbook.CreateDataImportP=
roperties.
- DataLabelPlacementType<=
/a> =E2=80=94 The possible positions of a data la=
bel relative to its data point.
- DataPoint =E2=80=94 A DataPoint object represents a data point in a chart. To re=
turn a DataPoint object, use Series[i].
- DataPointMarker =E2=80=94 =
The DataPointMarker class represents the style an=
d formatting of data markers in line, radar, and scatter charts. To return =
a DataPointMarker object, use Series.DataPointMarker.
- DataValidation =E2=80=94
A DataValidation object represents a rule for valid=
ating 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 cel=
l or group of cells, use Area.SetDataValidation or Range.SetDataValidation.=
- DocumentProperties =E2=
=80=94 The DocumentProperties object represents p=
roperties of a spreadsheet.
- ErrorBar =E2=80=94 An ErrorBar object represents the error bars on a series. Error=
bars graphically express potential error amounts relative to each data mar=
ker in a data series. You can add error bars to data series in two-dimensio=
nal area, bar, column, line, scatter, and bubble charts. In scatter and bub=
ble charts, you can display error bars for x values, y values, or both.
- ExcelApplication =E2=80=
=94 ExcelApplication is the main class for pure c=
ode-based workbook generation (for information about template-based workboo=
k generation, see ExcelTemplate). This class is an engine used to open, cre=
ate, and write (save or stream to a browser) workbooks. A single instance o=
f ExcelApplication can generate multiple workbooks.
- ExcelWriterException =
=E2=80=94 All methods in the ExcelWriter API can =
throw an exception of type ExcelWriterException.
- FieldCollection =E2=80=94 =
The FieldCollection class contains a list of=
PivotTableField objects. To get a FieldCollection object, use PivotTable.C=
olumnLabels, PivotTable.DataFields, PivotTable.RowLabels, or PivotTable.Pag=
eFields.
- Font =E2=80=94 The 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 cell=
s. To set or return a Font object, use Style.Font.
- FunctionValue =E2=80=94 The FunctionValue class is used to pass arguments in =
and get results from custom functions.
- FunctionValueType =E2=80=
=94 This enumeration is used to indicate what the=
value type is.
- GlobalStyle =E2=80=94 ExcelWriter creates three style types: GlobalStyle, Named=
Style, and CellStyle. All three style types derive from the Style class, an=
d NamedStyle derives from GlobalStyle.
- Group =E2=80=94 A Group is a type of shape that contains other shapes. Currently, gro=
ups may not be created or have their contents modified. They may be moved, =
resized, and deleted.
- Groups =E2=80=94 Groups provides access to the collection of Group objectss containe=
d within a drawing. Currently, only top level groups may be accessed. Neste=
d groups are not supported. Additionally, a group may not be created or hav=
e its contents modified. However, a group can be moved, resized, and remove=
d from a drawing. To return a Groups collection, use Worksheet.ShapeGroups.=
- HeaderFooterPicture =
=E2=80=94 A HeaderFooterPicture object represents=
a picture embedded in a Header or Footer.
- HeaderFooterSection =
=E2=80=94 The HeaderFooterSection class represent=
s an area of the header or footer. It allows you to set and retrieve the co=
ntent in that area.
- Hyperlink =E2=80=94 Represents a hyperlink in an Area (which may contain only on=
e cell) that points to an external URL.
- Hyperlinks =E2=80=94 The Hyperlinks collection contains all hyperlinks in a work=
sheet. The Worksheet.Hyperlinks property returns a Hyperlinks collection.=
span>
- IFunction =E2=80=94 The IFunction interface is used to implement custom Excel fu=
nctions in .NET to be passed in to ExcelWriter Application. You can registe=
r your custom logic to a specific Excel Function by using the Wor=
kbook.RegisterCustomFunction method.
- ItemsToRetain =E2=80=94 The ItemsToRetain class represents the number of item=
s a PivotTable cache will retain even changes have been made to the data so=
urce.
- Legend =E2=80=94 A Legend object represents a chart's legend. To return Legend objec=
t, use Chart.Legend.
- NamedObject =E2=80=94 A NamedObject object may refer to an array, number, pictu=
re, or range. To create a NamedObject in an Excel file, use the correspondi=
ng method for the specific object you wish to create (Pictures.CreatePictur=
e(), Workbook.CreateRange(), etc). To get a NamedObject from an existing fi=
le, use Workbook.GetNamedObject(), passing in the name of the object you wi=
sh to get.
- NamedStyle =E2=80=94 ExcelWriter creates three style types: GlobalStyle, NamedSt=
yle, and CellStyle. All three style types derive from the Style class, and =
NamedStyle derives from GlobalStyle.
- NumberFormat =E2=80=94 NumberFormat is a helper class that creates custom numb=
er format strings, which are used for formatting numbers and dates. Use Sty=
le.NumberFormat to set a number format for a specific style.
- ObjectPositioning =E2=80=
=94 Enumeration of the available resize and repos=
ition behaviors of an object when the cells in the spreadsheet it spans are=
changed.
- Othersheet =E2=80=94 A Othersheet object represents a sheet that is not a worksh=
eet or a chartsheet. This sheet represents VBA Module and dialog sheets. Th=
ese are not currently implemented by ExcelWriter
- PageSetup =E2=80=94 The PageSetup class represents the page layout properties of=
a printed worksheet.
- Palette =E2=80=94 The Palette class represents Excel's color palette.
- Pattern =E2=80=94 Pattern contains all available background patterns for pictures.<=
/span>
- Picture =E2=80=94 A Picture object represents a picture in a worksheet and allows t=
he 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 anoth=
er picture. Instead, delete the picture and create a new one.
- Pictures =E2=80=94 The Pictures collection represents the set of pictures in a wor=
ksheet. To return a Pictures collection, use Worksheet.Pictures.
- PivotTable =E2=80=94 A PivotTable object represents a PivotTable in a worksheet =
and allows the PivotTable to be managed.
- PivotTableField =E2=80=94 =
The PivotTableField represents a single fiel=
d 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 PivotT=
ableField object, use a FieldCollection.
- PivotTableLayout =E2=80=
=94 The PivotTableLayout class contains the set o=
f properties specific to the layout of pivot tables. To get a PivotTableLay=
out object, use PivotTable.PivotTableLayout .
- PivotTables =E2=80=94 The PivotTables collection represents the set of Piv=
otTables in a worksheet. To return a PivotTables collection, use Works=
heet.PivotTables.
- PivotTableSettings =E2=
=80=94 The PivotTableSettings class contains the =
set of properties specific to pivot tables. To get a PivotTableSettings obj=
ect, use PivotTable.PivotTableSettings.
- Range =E2=80=94 A Range object represents a range in a workbook.
- RowProperties =E2=80=94 The RowProperties class represents a single row in a =
worksheet. To return a RowProperties object, use Worksheet.GetRowProperties=
.
- Series =E2=80=94 A Series object represents a single data series in a chart. To retu=
rn a Series object, use one of the SeriesCollection.CreateSeries methods.=
span>
- SeriesCollection =E2=80=
=94 The SeriesCollection class contains the set o=
f data series in a given chart.
- SeriesDataLabel =E2=80=94 =
A SeriesDataLabel represents the appearance of se=
ries labels.
- SettingsBarColumn =E2=80=
=94 The SettingsBarColumn class contains all sett=
ings that are specific to bar and column series. To return a SettingsBarCol=
umn object, use Series.SettingsBarColumn.
- SettingsLineAreaScatte=
r =E2=80=94 The SettingsLineAreaScatter class=
contains all settings that are specific to line, area, and scatter charts.=
To return a SettingsLineAreaScatter object, use Series.SettingsLineAreaSca=
tter.
- SettingsPieDoughnut =
=E2=80=94 The SettingsPieDoughnut class contains =
all settings that are specific to pie and doughnut charts. To return a Sett=
ingsPieDoughnut object, use Series.SettingsPieDoughnut.
- Shape =E2=80=94 The Shape class allows the appearance and behavior of drawing object =
to be manipulated. On its own, Shape represents a simple auto shape, such a=
s a line, rectangle, or oval. A shape may also represent the display area o=
f a Comment or the size, position, and formatting of a Picture.
- Shapes =E2=80=94 The Shapes collection contains all Shape objects in the worksheet. =
To return a Shapes collection, use Worksheet.Shapes.
- ShapeType =E2=80=94 The ShapeType class contains the Excel shape types supported=
by ExcelWriter.
- SheetProtection =E2=80=94 =
A SheetProtection object contains sheet level pro=
tection properties that control what users can interact with when a workshe=
et is protected. To access SheetProtection, use Worksheet.SheetProtection.<=
/span>
- ShowValueAs =E2=80=94 The ShowValueAs class contains the options for showing th=
e value of a DataField. It is equivalent to the Show Values As tab in DataF=
ield settings in Excel.
- SortOptions =E2=80=94 The SortOptions class contains all of the sorting options=
for a PivotTableField.
- SourceField =E2=80=94 The SourceField represents a source field in a Pivot=
Table. To retrieve a SourceField use PivotTable.SourceFields.
- SourceFieldCollection =E2=80=94 The SourceFieldCollection class conta=
ins a list of SourceField objects. To get a SourceFieldCollection object, u=
se PivotTable.SourceFields.
- Style =E2=80=94 ExcelWriter has three style types: CellStyle, GlobalStyle, and NamedS=
tyle.
- Trendline =E2=80=94 A Trendline object represents a series trendline. To create =
a Trendline object, call Trendlines.CreateTrendline .
- Trendlines =E2=80=94 Trendlines is a collection of all Trendline objects associa=
ted with a data series in a chart. To return a Trendlines collection, use S=
eries.Trendlines .
- UpDownBar =E2=80=94 An UpDownBar object represents up/down bars in a line chart.=
Up/down bars connect data points in the highest and lowest series in a lin=
e chart to show motion during an interval.
- ValueAxis =E2=80=94 A ValueAxis object represents a chart's value (y) axis. The =
ValueAxis class extends Axis .
- Workbook =E2=80=94 A object represents an Excel workbook. To return a Workbook obj=
ect: Call ExcelApplication.Create() to create a new Excel workbook. Call Ex=
celApplication.Open() to open an existing Excel workbook.
- Worksheet =E2=80=94 The Worksheet class represents a single Excel worksheet.
- Worksheets =E2=80=94 The Worksheets class represents the set of worksheets in an=
Excel workbook. This object is used to manage (add, copy, remove, etc.) th=
e worksheets in the workbook To return a Worksheets object, use Workbook.Wo=
rksheets.
------=_Part_10422_447940252.1711724499138--