Documentation

Class WorkbookFormulaChartData

Represents workbook formula chart data. This type of chart data holds a formula which refers to the actual data in a workbook.

Inheritance
System.Object
FormulaChartData
WorkbookFormulaChartData
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.Windows.Documents.Spreadsheet.Model.Charts
Assembly: Telerik.Windows.Documents.Spreadsheet.dll

Syntax

public class WorkbookFormulaChartData : FormulaChartData, IChartData

Constructors

WorkbookFormulaChartData(Workbook, String)

Initializes a new instance of the WorkbookFormulaChartData class.

Declaration
public WorkbookFormulaChartData(Workbook workbook, string formula)
Parameters
Workbook workbook

The workbook the formula refer to.
System.String formula

The formula which refers to the chart data.

WorkbookFormulaChartData(Worksheet, CellRange[])

Initializes a new instance of the WorkbookFormulaChartData class.

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

The worksheet the ranges refer to.
CellRange[] ranges

The ranges that refer to the chart data.

Properties

Workbook

Gets the workbook that the formula refers to get the chart data.

Declaration
public Workbook Workbook { get; }
Property Value
Workbook

Methods

Clone()

Creates a deep copy of the object.

Declaration
public override IChartData Clone()
Returns
IChartData

The deep copy of the object.
Overrides

EnumerateCellRanges(out Worksheet)

Enumerates the cell ranges that contain the actual chart data.

Declaration
public IEnumerable<CellRange> EnumerateCellRanges(out Worksheet worksheet)
Parameters
Worksheet worksheet

Returns
System.Collections.Generic.IEnumerable<CellRange>

The result cell ranges.
Exceptions
System.FormatException

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

TryEnumerateCellRanges(out IEnumerable<CellRange>, out Worksheet)

Enumerates the cell ranges that contain the actual chart data. Returns a value indicating whether the enumeration was successful.

Declaration
public bool TryEnumerateCellRanges(out IEnumerable<CellRange> resultCellRanges, out Worksheet worksheet)
Parameters
System.Collections.Generic.IEnumerable<CellRange> resultCellRanges

The result cell ranges.
Worksheet worksheet

The worksheet the cell ranges are located in.
Returns
System.Boolean

A value indicating whether the ranges have been retrieved.

Extension Methods