Class ExcelDrawings
Collection for Drawing objects.
Inheritance
Implements
Inherited Members
Namespace: OfficeOpenXml.Drawing
Assembly: EPPlus.dll
Syntax
public class ExcelDrawings : IEnumerable<ExcelDrawing>, IEnumerable, IDisposable, IPictureRelationDocument
Properties
Count
Number of items in the collection
Declaration
public int Count { get; }
Property Value
| Type | Description |
|---|---|
| System.Int32 |
DrawingXml
A reference to the drawing xml document
Declaration
public XmlDocument DrawingXml { get; }
Property Value
| Type | Description |
|---|---|
| System.Xml.XmlDocument |
Item[Int32]
Returns the drawing at the specified position.
Declaration
public ExcelDrawing this[int PositionID] { get; }
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | PositionID | The position of the drawing. 0-base |
Property Value
| Type | Description |
|---|---|
| ExcelDrawing |
Item[String]
Returns the drawing matching the specified name
Declaration
public ExcelDrawing this[string Name] { get; }
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | Name | The name of the worksheet |
Property Value
| Type | Description |
|---|---|
| ExcelDrawing |
Methods
AddAreaChart(String, eAreaChartType)
Add a new area chart to the worksheet.
Declaration
public ExcelAreaChart AddAreaChart(string Name, eAreaChartType ChartType)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | Name | |
| eAreaChartType | ChartType | Type of linechart |
Returns
| Type | Description |
|---|---|
| ExcelAreaChart | The chart |
AddAreaChart(String, eAreaChartType, ExcelPivotTable)
Adds a new area chart to the worksheet.
Declaration
public ExcelAreaChart AddAreaChart(string Name, eAreaChartType ChartType, ExcelPivotTable PivotTableSource)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | Name | |
| eAreaChartType | ChartType | Type of chart |
| ExcelPivotTable | PivotTableSource | The pivottable source for a pivotchart |
Returns
| Type | Description |
|---|---|
| ExcelAreaChart | The chart |
AddBarChart(String, eBarChartType)
Adds a new barchart to the worksheet.
Declaration
public ExcelBarChart AddBarChart(string Name, eBarChartType ChartType)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | Name | |
| eBarChartType | ChartType | Type of linechart |
Returns
| Type | Description |
|---|---|
| ExcelBarChart | The chart |
AddBarChart(String, eLineChartType, ExcelPivotTable)
Adds a new column- or bar- chart to the worksheet.
Declaration
public ExcelBarChart AddBarChart(string Name, eLineChartType ChartType, ExcelPivotTable PivotTableSource)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | Name | |
| eLineChartType | ChartType | Type of chart |
| ExcelPivotTable | PivotTableSource | The pivottable source for a pivotchart |
Returns
| Type | Description |
|---|---|
| ExcelBarChart | The chart |
AddBoxWhiskerChart(String)
Adds a new box & whisker chart to the worksheet.
Declaration
public ExcelBoxWhiskerChart AddBoxWhiskerChart(string Name)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | Name |
Returns
| Type | Description |
|---|---|
| ExcelBoxWhiskerChart | The chart |
AddBubbleChart(String, eBubbleChartType)
Adds a new bubble chart to the worksheet.
Declaration
public ExcelBubbleChart AddBubbleChart(string Name, eBubbleChartType ChartType)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | Name | |
| eBubbleChartType | ChartType | Type of chart |
Returns
| Type | Description |
|---|---|
| ExcelBubbleChart | The chart |
AddBubbleChart(String, eBubbleChartType, ExcelPivotTable)
Adds a new bubble chart to the worksheet.
Declaration
public ExcelBubbleChart AddBubbleChart(string Name, eBubbleChartType ChartType, ExcelPivotTable PivotTableSource)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | Name | |
| eBubbleChartType | ChartType | Type of chart |
| ExcelPivotTable | PivotTableSource | The pivottable source for a pivotchart |
Returns
| Type | Description |
|---|---|
| ExcelBubbleChart | The chart |
AddButtonControl(String)
Adds a button form control to the worksheet
Declaration
public ExcelControlButton AddButtonControl(string Name)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | Name | The name of the button |
Returns
| Type | Description |
|---|---|
| ExcelControlButton | The button form control |
AddChart(String, eChartType)
Adds a new chart to the worksheet. Do not support Stock charts .
Declaration
public ExcelChart AddChart(string Name, eChartType ChartType)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | Name | |
| eChartType | ChartType | Type of chart |
Returns
| Type | Description |
|---|---|
| ExcelChart | The chart |
AddChart(String, eChartType, ExcelPivotTable, eEditAs)
Adds a new chart to the worksheet. Stock charts can not be added by this method. See AddStockChart(String, eStockChartType, ExcelRangeBase)
Declaration
public ExcelChart AddChart(string Name, eChartType ChartType, ExcelPivotTable PivotTableSource, eEditAs DrawingType = eEditAs.TwoCell)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | Name | |
| eChartType | ChartType | Type of chart |
| ExcelPivotTable | PivotTableSource | The pivottable source for a pivotchart |
| eEditAs | DrawingType | The top element drawingtype. Default is OneCellAnchor for Pictures and TwoCellAnchor from Charts and Shapes |
Returns
| Type | Description |
|---|---|
| ExcelChart | The chart |
AddChartFromTemplate(FileInfo, String)
Adds a new chart using an crtx template
Declaration
public ExcelChart AddChartFromTemplate(FileInfo crtxFile, string name)
Parameters
| Type | Name | Description |
|---|---|---|
| System.IO.FileInfo | crtxFile | The crtx file |
| System.String | name | The name of the chart |
Returns
| Type | Description |
|---|---|
| ExcelChart | The new chart |
AddChartFromTemplate(FileInfo, String, ExcelPivotTable)
Adds a new chart using an crtx template
Declaration
public ExcelChart AddChartFromTemplate(FileInfo crtxFile, string name, ExcelPivotTable pivotTableSource)
Parameters
| Type | Name | Description |
|---|---|---|
| System.IO.FileInfo | crtxFile | The crtx file |
| System.String | name | The name of the chart |
| ExcelPivotTable | pivotTableSource | Pivot table source, if the chart is a pivottable |
Returns
| Type | Description |
|---|---|
| ExcelChart | The new chart |
AddChartFromTemplate(Stream, String)
Adds a new chart using an crtx template
Declaration
public ExcelChart AddChartFromTemplate(Stream crtxStream, string name)
Parameters
| Type | Name | Description |
|---|---|---|
| System.IO.Stream | crtxStream | The crtx file as a stream |
| System.String | name | The name of the chart |
Returns
| Type | Description |
|---|---|
| ExcelChart | The new chart |
AddChartFromTemplate(Stream, String, ExcelPivotTable)
Adds a new chart using an crtx template
Declaration
public ExcelChart AddChartFromTemplate(Stream crtxStream, string name, ExcelPivotTable pivotTableSource)
Parameters
| Type | Name | Description |
|---|---|---|
| System.IO.Stream | crtxStream | The crtx file as a stream |
| System.String | name | The name of the chart |
| ExcelPivotTable | pivotTableSource | Pivot table source, if the chart is a pivottable |
Returns
| Type | Description |
|---|---|
| ExcelChart | The new chart |
AddCheckBoxControl(String)
Adds a checkbox form control to the worksheet
Declaration
public ExcelControlCheckBox AddCheckBoxControl(string Name)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | Name | The name of the checkbox control |
Returns
| Type | Description |
|---|---|
| ExcelControlCheckBox | The checkbox form control |
AddControl(String, eControlType)
Declaration
public ExcelControl AddControl(string Name, eControlType ControlType)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | Name | |
| eControlType | ControlType |
Returns
| Type | Description |
|---|---|
| ExcelControl |
AddDoughnutChart(String, eDoughnutChartType)
Adds a new doughnut chart to the worksheet.
Declaration
public ExcelDoughnutChart AddDoughnutChart(string Name, eDoughnutChartType ChartType)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | Name | |
| eDoughnutChartType | ChartType | Type of chart |
Returns
| Type | Description |
|---|---|
| ExcelDoughnutChart | The chart |
AddDoughnutChart(String, eDoughnutChartType, ExcelPivotTable)
Adds a new doughnut chart to the worksheet.
Declaration
public ExcelDoughnutChart AddDoughnutChart(string Name, eDoughnutChartType ChartType, ExcelPivotTable PivotTableSource)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | Name | |
| eDoughnutChartType | ChartType | Type of chart |
| ExcelPivotTable | PivotTableSource | The pivottable source for a pivotchart |
Returns
| Type | Description |
|---|---|
| ExcelDoughnutChart | The chart |
AddDropDownControl(String)
Adds a drop-down form control to the worksheet
Declaration
public ExcelControlDropDown AddDropDownControl(string Name)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | Name | The name of the drop-down control |
Returns
| Type | Description |
|---|---|
| ExcelControlDropDown | The drop-down form control |
AddExtendedChart(String, eChartExType)
Adds a new chart to the worksheet.
Declaration
public ExcelChartEx AddExtendedChart(string Name, eChartExType ChartType)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | Name | |
| eChartExType | ChartType | Type of chart |
Returns
| Type | Description |
|---|---|
| ExcelChartEx | The chart |
AddExtendedChart(String, eChartExType, ExcelPivotTable)
Adds a new extended chart to the worksheet. Extended charts are
Declaration
public ExcelChartEx AddExtendedChart(string Name, eChartExType ChartType, ExcelPivotTable PivotTableSource)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | Name | |
| eChartExType | ChartType | Type of chart |
| ExcelPivotTable | PivotTableSource | The pivottable source for a pivotchart |
Returns
| Type | Description |
|---|---|
| ExcelChartEx | The chart |
AddFunnelChart(String)
Adds a funnel chart to the worksheet.
Declaration
public ExcelFunnelChart AddFunnelChart(string Name)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | Name |
Returns
| Type | Description |
|---|---|
| ExcelFunnelChart | The chart |
AddGroupBoxControl(String)
Adds a group box form control to the worksheet
Declaration
public ExcelControlGroupBox AddGroupBoxControl(string Name)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | Name | The name of the group box control |
Returns
| Type | Description |
|---|---|
| ExcelControlGroupBox | The group box form control |
AddHistogramChart(String, Boolean)
Adds a new Histogram or Pareto chart to the worksheet.
Declaration
public ExcelHistogramChart AddHistogramChart(string Name, bool AddParetoLine = false)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | Name | |
| System.Boolean | AddParetoLine | If true a pareto line is added to the chart. The ChartType will also be Pareto. |
Returns
| Type | Description |
|---|---|
| ExcelHistogramChart | The chart |
AddLabelControl(String)
Adds a label form control to the worksheet
Declaration
public ExcelControlLabel AddLabelControl(string Name)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | Name | The name of the label control |
Returns
| Type | Description |
|---|---|
| ExcelControlLabel | The label form control |
AddLineChart(String, eLineChartType)
Add a new linechart to the worksheet.
Declaration
public ExcelLineChart AddLineChart(string Name, eLineChartType ChartType)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | Name | |
| eLineChartType | ChartType | Type of linechart |
Returns
| Type | Description |
|---|---|
| ExcelLineChart | The chart |
AddLineChart(String, eLineChartType, ExcelPivotTable)
Adds a new linechart to the worksheet.
Declaration
public ExcelLineChart AddLineChart(string Name, eLineChartType ChartType, ExcelPivotTable PivotTableSource)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | Name | |
| eLineChartType | ChartType | Type of chart |
| ExcelPivotTable | PivotTableSource | The pivottable source for a pivotchart |
Returns
| Type | Description |
|---|---|
| ExcelLineChart | The chart |
AddListBoxControl(String)
Adds a list box form control to the worksheet
Declaration
public ExcelControlListBox AddListBoxControl(string Name)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | Name | The name of the list box control |
Returns
| Type | Description |
|---|---|
| ExcelControlListBox | The list box form control |
AddOfPieChart(String, eOfPieChartType)
Adds a new line chart to the worksheet.
Declaration
public ExcelOfPieChart AddOfPieChart(string Name, eOfPieChartType ChartType)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | Name | |
| eOfPieChartType | ChartType | Type of chart |
Returns
| Type | Description |
|---|---|
| ExcelOfPieChart | The chart |
AddOfPieChart(String, eOfPieChartType, ExcelPivotTable)
Add a new pie of pie or bar of pie chart to the worksheet.
Declaration
public ExcelOfPieChart AddOfPieChart(string Name, eOfPieChartType ChartType, ExcelPivotTable PivotTableSource)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | Name | |
| eOfPieChartType | ChartType | Type of chart |
| ExcelPivotTable | PivotTableSource | The pivottable source for a pivotchart |
Returns
| Type | Description |
|---|---|
| ExcelOfPieChart | The chart |
AddPicture(String, Image)
Adds a picture to the worksheet
Declaration
public ExcelPicture AddPicture(string Name, Image image)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | Name | |
| System.Drawing.Image | image | An image. Allways saved in then JPeg format |
Returns
| Type | Description |
|---|---|
| ExcelPicture |
AddPicture(String, Image, Uri)
Adds a picture to the worksheet
Declaration
public ExcelPicture AddPicture(string Name, Image Image, Uri Hyperlink)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | Name | |
| System.Drawing.Image | Image | An image. Allways saved in then JPeg format |
| System.Uri | Hyperlink | Picture Hyperlink |
Returns
| Type | Description |
|---|---|
| ExcelPicture | A picture object |
AddPicture(String, FileInfo)
Adds a picture to the worksheet
Declaration
public ExcelPicture AddPicture(string Name, FileInfo ImageFile)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | Name | |
| System.IO.FileInfo | ImageFile | The image file |
Returns
| Type | Description |
|---|---|
| ExcelPicture | A picture object |
AddPicture(String, FileInfo, Uri)
Adds a picture to the worksheet
Declaration
public ExcelPicture AddPicture(string Name, FileInfo ImageFile, Uri Hyperlink)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | Name | |
| System.IO.FileInfo | ImageFile | The image file |
| System.Uri | Hyperlink | Picture Hyperlink |
Returns
| Type | Description |
|---|---|
| ExcelPicture | A picture object |
AddPicture(String, Stream, ePictureType)
Adds a picture to the worksheet
Declaration
public ExcelPicture AddPicture(string Name, Stream PictureStream, ePictureType PictureType)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | Name | |
| System.IO.Stream | PictureStream | An stream image. |
| ePictureType | PictureType | The type of image |
Returns
| Type | Description |
|---|---|
| ExcelPicture | A picture object |
AddPicture(String, Stream, ePictureType, Uri)
Adds a picture to the worksheet
Declaration
public ExcelPicture AddPicture(string Name, Stream pictureStream, ePictureType pictureType, Uri Hyperlink)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | Name | |
| System.IO.Stream | pictureStream | An stream image. |
| ePictureType | pictureType | The type of image |
| System.Uri | Hyperlink | Picture Hyperlink |
Returns
| Type | Description |
|---|---|
| ExcelPicture | A picture object |
AddPictureAsync(String, FileInfo)
Adds a picture to the worksheet
Declaration
public Task<ExcelPicture> AddPictureAsync(string Name, FileInfo ImageFile)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | Name | |
| System.IO.FileInfo | ImageFile | The image file |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<ExcelPicture> | A picture object |
AddPictureAsync(String, FileInfo, Uri)
Adds a picture to the worksheet
Declaration
public Task<ExcelPicture> AddPictureAsync(string Name, FileInfo ImageFile, Uri Hyperlink)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | Name | |
| System.IO.FileInfo | ImageFile | The image file |
| System.Uri | Hyperlink | Picture Hyperlink |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<ExcelPicture> | A picture object |
AddPictureAsync(String, Stream, ePictureType)
Adds a picture to the worksheet
Declaration
public Task<ExcelPicture> AddPictureAsync(string Name, Stream PictureStream, ePictureType PictureType)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | Name | |
| System.IO.Stream | PictureStream | An stream image. |
| ePictureType | PictureType | The type of image |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<ExcelPicture> | A picture object |
AddPictureAsync(String, Stream, ePictureType, Uri)
Adds a picture to the worksheet
Declaration
public Task<ExcelPicture> AddPictureAsync(string Name, Stream pictureStream, ePictureType pictureType, Uri Hyperlink)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | Name | |
| System.IO.Stream | pictureStream | An stream image. |
| ePictureType | pictureType | The type of image |
| System.Uri | Hyperlink | Picture Hyperlink |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<ExcelPicture> | A picture object |
AddPieChart(String, ePieChartType)
Adds a new pie chart to the worksheet.
Declaration
public ExcelPieChart AddPieChart(string Name, ePieChartType ChartType)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | Name | |
| ePieChartType | ChartType | Type of chart |
Returns
| Type | Description |
|---|---|
| ExcelPieChart | The chart |
AddPieChart(String, ePieChartType, ExcelPivotTable)
Adds a new pie chart to the worksheet.
Declaration
public ExcelPieChart AddPieChart(string Name, ePieChartType ChartType, ExcelPivotTable PivotTableSource)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | Name | |
| ePieChartType | ChartType | Type of chart |
| ExcelPivotTable | PivotTableSource | The pivottable source for a pivotchart |
Returns
| Type | Description |
|---|---|
| ExcelPieChart | The chart |
AddRadarChart(String, eRadarChartType)
Adds a new radar chart to the worksheet.
Declaration
public ExcelRadarChart AddRadarChart(string Name, eRadarChartType ChartType)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | Name | |
| eRadarChartType | ChartType | Type of chart |
Returns
| Type | Description |
|---|---|
| ExcelRadarChart | The chart |
AddRadarChart(String, eRadarChartType, ExcelPivotTable)
Adds a new radar chart to the worksheet.
Declaration
public ExcelRadarChart AddRadarChart(string Name, eRadarChartType ChartType, ExcelPivotTable PivotTableSource)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | Name | |
| eRadarChartType | ChartType | Type of chart |
| ExcelPivotTable | PivotTableSource | The pivottable source for a pivotchart |
Returns
| Type | Description |
|---|---|
| ExcelRadarChart | The chart |
AddRadioButtonControl(String)
Adds a radio button form control to the worksheet
Declaration
public ExcelControlRadioButton AddRadioButtonControl(string Name)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | Name | The name of the radio button control |
Returns
| Type | Description |
|---|---|
| ExcelControlRadioButton | The radio button form control |
AddRegionMapChart(String)
Adds a region map chart to the worksheet. Note that EPPlus rely on the spreadsheet application to create the geocache data
Declaration
public ExcelRegionMapChart AddRegionMapChart(string Name)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | Name |
Returns
| Type | Description |
|---|---|
| ExcelRegionMapChart | The chart |
AddScatterChart(String, eScatterChartType)
Adds a new scatter chart to the worksheet.
Declaration
public ExcelScatterChart AddScatterChart(string Name, eScatterChartType ChartType)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | Name | |
| eScatterChartType | ChartType | Type of chart |
Returns
| Type | Description |
|---|---|
| ExcelScatterChart | The chart |
AddScatterChart(String, eScatterChartType, ExcelPivotTable)
Adds a new scatter chart to the worksheet.
Declaration
public ExcelScatterChart AddScatterChart(string Name, eScatterChartType ChartType, ExcelPivotTable PivotTableSource)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | Name | |
| eScatterChartType | ChartType | Type of chart |
| ExcelPivotTable | PivotTableSource | The pivottable source for a pivotchart |
Returns
| Type | Description |
|---|---|
| ExcelScatterChart | The chart |
AddScrollBarControl(String)
Adds a scroll bar control to the worksheet
Declaration
public ExcelControlScrollBar AddScrollBarControl(string Name)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | Name | The name of the scroll bar control |
Returns
| Type | Description |
|---|---|
| ExcelControlScrollBar | The scroll bar form control |
AddShape(String, eShapeStyle)
Adds a new shape to the worksheet
Declaration
public ExcelShape AddShape(string Name, eShapeStyle Style)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | Name | Name |
| eShapeStyle | Style | Shape style |
Returns
| Type | Description |
|---|---|
| ExcelShape | The shape object |
AddShape(String, ExcelShape)
Adds a new shape to the worksheet
Declaration
public ExcelShape AddShape(string Name, ExcelShape Source)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | Name | Name |
| ExcelShape | Source | Source shape |
Returns
| Type | Description |
|---|---|
| ExcelShape | The shape object |
AddSpinButtonControl(String)
Adds a spin button control to the worksheet
Declaration
public ExcelControlSpinButton AddSpinButtonControl(string Name)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | Name | The name of the spin button control |
Returns
| Type | Description |
|---|---|
| ExcelControlSpinButton | The spin button form control |
AddStockChart(String, eStockChartType, ExcelRangeBase)
Adds a new stock chart to the worksheet. Requires a range with four, five or six columns depending on the stock chart type. The first column is the category series. The following columns in the range depend on the stock chart type (HLC, OHLC, VHLC, VOHLC).
Declaration
public ExcelStockChart AddStockChart(string Name, eStockChartType ChartType, ExcelRangeBase Range)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | Name | |
| eStockChartType | ChartType | The Stock chart type |
| ExcelRangeBase | Range | The category serie. A serie containng dates |
Returns
| Type | Description |
|---|---|
| ExcelStockChart | The chart |
AddStockChart(String, ExcelRangeBase, ExcelRangeBase, ExcelRangeBase, ExcelRangeBase, ExcelRangeBase, ExcelRangeBase)
Adds a new stock chart to the worksheet. The stock chart type will depend on if the parameters OpenSerie and/or VolumeSerie is supplied
Declaration
public ExcelStockChart AddStockChart(string Name, ExcelRangeBase CategorySerie, ExcelRangeBase HighSerie, ExcelRangeBase LowSerie, ExcelRangeBase CloseSerie, ExcelRangeBase OpenSerie = null, ExcelRangeBase VolumeSerie = null)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | Name | |
| ExcelRangeBase | CategorySerie | The category serie. A serie containng dates |
| ExcelRangeBase | HighSerie | The high price serie |
| ExcelRangeBase | LowSerie | The low price serie |
| ExcelRangeBase | CloseSerie | The close price serie containing |
| ExcelRangeBase | OpenSerie | The opening price serie. Supplying this serie will create a StockOHLC or StockVOHLC chart |
| ExcelRangeBase | VolumeSerie | The volume represented as a column chart. Supplying this serie will create a StockVHLC or StockVOHLC chart |
Returns
| Type | Description |
|---|---|
| ExcelStockChart | The chart |
AddStockChart(String, String, String, String, String, String, String)
Adds a new stock chart to the worksheet. The stock chart type will depend on if the parameters OpenSerie and/or VolumeSerie is supplied
Declaration
public ExcelStockChart AddStockChart(string Name, string CategorySerie, string HighSerie, string LowSerie, string CloseSerie, string OpenSerie = null, string VolumeSerie = null)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | Name | |
| System.String | CategorySerie | The category serie. A serie containing dates |
| System.String | HighSerie | The high price serie |
| System.String | LowSerie | The low price serie |
| System.String | CloseSerie | The close price serie containing |
| System.String | OpenSerie | The opening price serie. Supplying this serie will create a StockOHLC or StockVOHLC chart |
| System.String | VolumeSerie | The volume represented as a column chart. Supplying this serie will create a StockVHLC or StockVOHLC chart |
Returns
| Type | Description |
|---|---|
| ExcelStockChart | The chart |
AddSunburstChart(String)
Adds a new sunburst chart to the worksheet.
Declaration
public ExcelSunburstChart AddSunburstChart(string Name)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | Name |
Returns
| Type | Description |
|---|---|
| ExcelSunburstChart | The chart |
AddSurfaceChart(String, eSurfaceChartType)
Adds a new surface chart to the worksheet.
Declaration
public ExcelSurfaceChart AddSurfaceChart(string Name, eSurfaceChartType ChartType)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | Name | |
| eSurfaceChartType | ChartType | Type of chart |
Returns
| Type | Description |
|---|---|
| ExcelSurfaceChart | The chart |
AddSurfaceChart(String, eSurfaceChartType, ExcelPivotTable)
Adds a new surface chart to the worksheet.
Declaration
public ExcelSurfaceChart AddSurfaceChart(string Name, eSurfaceChartType ChartType, ExcelPivotTable PivotTableSource)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | Name | |
| eSurfaceChartType | ChartType | Type of chart |
| ExcelPivotTable | PivotTableSource | The pivottable source for a pivotchart |
Returns
| Type | Description |
|---|---|
| ExcelSurfaceChart | The chart |
AddTableSlicer(ExcelTableColumn)
Adds a slicer to a table column
Declaration
public ExcelTableSlicer AddTableSlicer(ExcelTableColumn TableColumn)
Parameters
| Type | Name | Description |
|---|---|---|
| ExcelTableColumn | TableColumn | The table column |
Returns
| Type | Description |
|---|---|
| ExcelTableSlicer | The slicer drawing |
AddTreemapChart(String)
Adds a new treemap chart to the worksheet.
Declaration
public ExcelTreemapChart AddTreemapChart(string Name)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | Name |
Returns
| Type | Description |
|---|---|
| ExcelTreemapChart | The chart |
AddWaterfallChart(String)
Adds a waterfall chart to the worksheet.
Declaration
public ExcelWaterfallChart AddWaterfallChart(string Name)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | Name |
Returns
| Type | Description |
|---|---|
| ExcelWaterfallChart | The chart |
Clear()
Removes all drawings from the collection
Declaration
public void Clear()
Dispose()
Disposes the object
Declaration
public void Dispose()
GetEnumerator()
Get the enumerator
Declaration
public IEnumerator GetEnumerator()
Returns
| Type | Description |
|---|---|
| System.Collections.IEnumerator | The enumerator |
Remove(ExcelDrawing)
Removes a drawing.
Declaration
public void Remove(ExcelDrawing Drawing)
Parameters
| Type | Name | Description |
|---|---|---|
| ExcelDrawing | Drawing | The drawing |
Remove(Int32)
Removes a drawing.
Declaration
public void Remove(int Index)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | Index | The index of the drawing |
Remove(String)
Removes a drawing.
Declaration
public void Remove(string Name)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | Name | The name of the drawing |
Explicit Interface Implementations
IEnumerable<ExcelDrawing>.GetEnumerator()
Declaration
IEnumerator<ExcelDrawing> IEnumerable<ExcelDrawing>.GetEnumerator()
Returns
| Type | Description |
|---|---|
| System.Collections.Generic.IEnumerator<ExcelDrawing> |