New to Telerik Document Processing? Start a free 30-day trial

WorkbookFormulaChartData

Class

Formula-based chart data that resolves to cell ranges within a workbook for dynamic chart series and values.

Definition

Namespace:Telerik.Windows.Documents.Spreadsheet.Model.Charts

Assembly:Telerik.Windows.Documents.Spreadsheet.dll

Syntax:

public class WorkbookFormulaChartData : FormulaChartData, IChartData

Inheritance: objectFormulaChartDataWorkbookFormulaChartData

Implements: IChartData

Inherited Members FormulaChartData.ChartDataTypeFormulaChartData.Formula

Constructors

WorkbookFormulaChartData(Workbook, string)

Initializes a new WorkbookFormulaChartData with a formula string that references chart data in the workbook.

public WorkbookFormulaChartData(Workbook workbook, string formula)

Parameters:workbookWorkbook

The workbook the formula refer to.

formulastring

The formula which refers to the chart data.

WorkbookFormulaChartData(Worksheet, params CellRange[])

Initializes a new WorkbookFormulaChartData from cell ranges in the specified worksheet.

public WorkbookFormulaChartData(Worksheet worksheet, params CellRange[] ranges)

Parameters:worksheetWorksheet

The worksheet the ranges refer to.

rangesCellRange[]

The ranges that refer to the chart data.

Methods

Clone()

IChartData

Creates a deep copy of this chart data instance with the same formula and workbook reference.

public override IChartData Clone()

Returns:

IChartData

The deep copy of the object.

Overrides: FormulaChartData.Clone()

EnumerateCellRanges(out Worksheet)

IEnumerable<CellRange>

Resolves the formula to cell ranges and returns them along with the containing worksheet.

public IEnumerable<CellRange> EnumerateCellRanges(out Worksheet worksheet)

Parameters:worksheetWorksheetReturns:

IEnumerable<CellRange>

The result cell ranges.

Exceptions:

FormatException

Thrown when the formula referring to the data cannot be parsed to cell ranges.

TryEnumerateCellRanges(out IEnumerable<CellRange>, out Worksheet)

bool

Attempts to resolve the formula to cell ranges and returns whether the resolution succeeded.

public bool TryEnumerateCellRanges(out IEnumerable<CellRange> resultCellRanges, out Worksheet worksheet)

Parameters:resultCellRangesIEnumerable<CellRange>

The result cell ranges.

worksheetWorksheet

The worksheet the cell ranges are located in.

Returns:

bool

A value indicating whether the ranges have been retrieved.

Properties

Workbook

The workbook containing the cell ranges referenced by this chart data formula.

public Workbook Workbook { get; }