Class ChartShapeImpl
Class used for Chart Shapes.
Implements
Inherited Members
Namespace: Syncfusion.XlsIO.Implementation.Shapes
Assembly: Syncfusion.XlsIO.UWP.dll
Syntax
public class ChartShapeImpl : ShapeImpl, IDisposable, ICloneParent, INamedObject, IChartShape, IShape, IChart, ITabSheet, IParentApplication
Constructors
ChartShapeImpl(IApplication, Object)
Initializes new instance of the chart shape.
Declaration
public ChartShapeImpl(IApplication application, object parent)
Parameters
Type | Name | Description |
---|---|---|
IApplication | application | Application object for the new shape. |
System.Object | parent | Parent object for the new shape. |
ChartShapeImpl(IApplication, Object, ChartShapeImpl, Dictionary<String, String>, Dictionary<Int32, Int32>)
Initializes new instance of the shape.
Declaration
public ChartShapeImpl(IApplication application, object parent, ChartShapeImpl instance, Dictionary<string, string> hashNewNames, Dictionary<int, int> dicFontIndexes)
Parameters
Type | Name | Description |
---|---|---|
IApplication | application | Application object for the new shape. |
System.Object | parent | Parent object for the new shape. |
ChartShapeImpl | instance | Cloned object. |
System.Collections.Generic.Dictionary<System.String, System.String> | hashNewNames | Dictionary with new names. |
System.Collections.Generic.Dictionary<System.Int32, System.Int32> | dicFontIndexes | Dictionary with new font indexes. |
ChartShapeImpl(IApplication, Object, MsofbtSpContainer, ExcelParseOptions)
Initializes new instance of the chart shape.
Declaration
public ChartShapeImpl(IApplication application, object parent, MsofbtSpContainer container, ExcelParseOptions options)
Parameters
Type | Name | Description |
---|---|---|
IApplication | application | Application object for the new shape. |
System.Object | parent | Parent object for the new shape. |
MsofbtSpContainer | container | Shape container record that describes new shape. |
ExcelParseOptions | options | Flags to create. |
Properties
AutoScaling
True if Microsoft Excel scales a 3-D chart so that it's closer in size to the equivalent 2-D chart..
Declaration
public bool AutoScaling { get; set; }
Property Value
Type |
---|
System.Boolean |
BackWall
backwall property..
Declaration
public IChartWallOrFloor BackWall { get; }
Property Value
Type |
---|
IChartWallOrFloor |
Categories
Represents the category collection
Declaration
public IChartCategories Categories { get; }
Property Value
Type |
---|
IChartCategories |
CategoryAxisTitle
Title of the category axis.
Declaration
public string CategoryAxisTitle { get; set; }
Property Value
Type |
---|
System.String |
CategoryLabelLevel
Represents the category name level
Declaration
public ExcelCategoriesLabelLevel CategoryLabelLevel { get; set; }
Property Value
Type |
---|
ExcelCategoriesLabelLevel |
ChartArea
Returns an object that represents the complete chart area for the chart. Read-only.
Declaration
public IChartFrameFormat ChartArea { get; }
Property Value
Type |
---|
IChartFrameFormat |
ChartObject
Returns internal chart object. Read-only
Declaration
public ChartImpl ChartObject { get; }
Property Value
Type |
---|
ChartImpl |
Charts
Returns charts collection. Valid only for charts with own tab.
Declaration
public IChartShapes Charts { get; }
Property Value
Type |
---|
IChartShapes |
ChartTitle
Title of the chart.
Declaration
public string ChartTitle { get; set; }
Property Value
Type |
---|
System.String |
ChartTitleArea
Gets title text area. Read-only.
Declaration
public IChartTextArea ChartTitleArea { get; }
Property Value
Type |
---|
IChartTextArea |
ChartType
Type of the chart.
Declaration
public ExcelChartType ChartType { get; set; }
Property Value
Type |
---|
ExcelChartType |
CheckBoxes
Returns collection with all checkboxes inside this worksheet. Read-only.
Declaration
public ICheckBoxes CheckBoxes { get; }
Property Value
Type |
---|
ICheckBoxes |
CodeName
Gets code name of the chart.
Declaration
public string CodeName { get; }
Property Value
Type |
---|
System.String |
ComboBoxes
Returns collection with all comboboxes inside this worksheet. Read-only.
Declaration
public IComboBoxes ComboBoxes { get; }
Property Value
Type |
---|
IComboBoxes |
DataRange
DataRange for the chart series.
Declaration
public IRange DataRange { get; set; }
Property Value
Type |
---|
IRange |
DataTable
Represents charts dataTable object.
Declaration
public IChartDataTable DataTable { get; }
Property Value
Type |
---|
IChartDataTable |
DepthPercent
Returns or sets the depth of a 3-D chart as a percentage of the chart width (between 20 and 2000 percent).
Declaration
public int DepthPercent { get; set; }
Property Value
Type |
---|
System.Int32 |
DisplayBlanksAs
Represents the way that blank cells are plotted on a chart.
Declaration
public ExcelChartPlotEmpty DisplayBlanksAs { get; set; }
Property Value
Type |
---|
ExcelChartPlotEmpty |
Elevation
Returns or sets the elevation of the 3-D chart view, in degrees (�90 to +90 degrees).
Declaration
public int Elevation { get; set; }
Property Value
Type |
---|
System.Int32 |
Floor
Represents chart floor. Read-only.
Declaration
public IChartWallOrFloor Floor { get; }
Property Value
Type |
---|
IChartWallOrFloor |
GapDepth
Returns or sets the distance between the data series in a 3-D chart, as a percentage of the marker width.( 0 - 500 )
Declaration
public int GapDepth { get; set; }
Property Value
Type |
---|
System.Int32 |
HasDataTable
True if the chart has a data table.
Declaration
public bool HasDataTable { get; set; }
Property Value
Type |
---|
System.Boolean |
HasLegend
True if the chart has a legend object.
Declaration
public bool HasLegend { get; set; }
Property Value
Type |
---|
System.Boolean |
HasPlotArea
Indicates whether chart has plot area.
Declaration
public bool HasPlotArea { get; set; }
Property Value
Type |
---|
System.Boolean |
HasTitle
Gets or sets whether the chart has title.
Declaration
public bool HasTitle { get; set; }
Property Value
Type |
---|
System.Boolean |
HeightPercent
Returns or sets the height of a 3-D chart as a percentage of the chart width (between 5 and 500 percent).
Declaration
public int HeightPercent { get; set; }
Property Value
Type |
---|
System.Int32 |
Hyperlink
Get object that represents the hyperlink for the shape.
Declaration
public IHyperLink Hyperlink { get; }
Property Value
Type |
---|
IHyperLink |
IsPasswordProtected
Indicates if the worksheet is password protected.
Declaration
public bool IsPasswordProtected { get; }
Property Value
Type |
---|
System.Boolean |
IsRightToLeft
Indicates whether worksheet is displayed right to left.
Declaration
public bool IsRightToLeft { get; set; }
Property Value
Type |
---|
System.Boolean |
IsSelected
Indicates whether tab of this sheet is selected. Read-only.
Declaration
public bool IsSelected { get; }
Property Value
Type |
---|
System.Boolean |
IsSeriesInRows
True if series are in rows in DataRange; otherwise False.
Declaration
public bool IsSeriesInRows { get; set; }
Property Value
Type |
---|
System.Boolean |
Legend
Represents chart legend.
Declaration
public IChartLegend Legend { get; }
Property Value
Type |
---|
IChartLegend |
OptionButtons
Returns collection with all option buttons inside this worksheet. Read-only.
Declaration
public IOptionButtons OptionButtons { get; }
Property Value
Type |
---|
IOptionButtons |
PageSetup
Page setup for the chart. Read-only.
Declaration
public IChartPageSetup PageSetup { get; }
Property Value
Type |
---|
IChartPageSetup |
Perspective
Returns or sets the perspective for the 3-D chart view.( 0 - 100 )
Declaration
public int Perspective { get; set; }
Property Value
Type |
---|
System.Int32 |
Pictures
Returns picture collection. Valid only for charts with own tab.
Declaration
public IPictures Pictures { get; }
Property Value
Type |
---|
IPictures |
PivotChartType
Gets or sets the type of the pivot chart.
Declaration
public ExcelChartType PivotChartType { get; set; }
Property Value
Type | Description |
---|---|
ExcelChartType | The type of the pivot chart. |
PivotSource
Gets or sets the pivot source.
Declaration
public IPivotTable PivotSource { get; set; }
Property Value
Type | Description |
---|---|
IPivotTable | The pivot source. |
PlotArea
Returns plot area frame format. Read-only.
Declaration
public IChartFrameFormat PlotArea { get; }
Property Value
Type |
---|
IChartFrameFormat |
PlotVisibleOnly
True if only visible cells are plotted. False if both visible and hidden cells are plotted.
Declaration
public bool PlotVisibleOnly { get; set; }
Property Value
Type |
---|
System.Boolean |
PrimaryCategoryAxis
Returns primary category axis. Read-only.
Declaration
public IChartCategoryAxis PrimaryCategoryAxis { get; }
Property Value
Type |
---|
IChartCategoryAxis |
PrimaryFormats
Returns chart format collection in primary axis.
Declaration
public ChartFormatCollection PrimaryFormats { get; }
Property Value
Type |
---|
ChartFormatCollection |
PrimarySerieAxis
Returns primary series axis. Read-only.
Declaration
public IChartSeriesAxis PrimarySerieAxis { get; }
Property Value
Type |
---|
IChartSeriesAxis |
PrimaryValueAxis
Returns primary value axis. Read-only.
Declaration
public IChartValueAxis PrimaryValueAxis { get; }
Property Value
Type |
---|
IChartValueAxis |
ProtectContents
Indicates is current sheet is protected.
Declaration
public bool ProtectContents { get; }
Property Value
Type |
---|
System.Boolean |
ProtectDrawingObjects
True if objects are protected. Read-only.
Declaration
public bool ProtectDrawingObjects { get; }
Property Value
Type |
---|
System.Boolean |
Protection
Gets protected options. Read-only. For sets protection options use "Protect" method.
Declaration
public ExcelSheetProtection Protection { get; }
Property Value
Type |
---|
ExcelSheetProtection |
ProtectScenarios
True if the scenarios of the current sheet are protected. Read-only.
Declaration
public bool ProtectScenarios { get; }
Property Value
Type |
---|
System.Boolean |
RightAngleAxes
True if the chart axes are at right angles, independent of chart rotation or elevation.
Declaration
public bool RightAngleAxes { get; set; }
Property Value
Type |
---|
System.Boolean |
Rotation
Returns or sets the rotation of the 3-D chart view (the rotation of the plot area around the z-axis, in degrees).(0 to 360 degrees).
Declaration
public int Rotation { get; set; }
Property Value
Type |
---|
System.Int32 |
SecondaryCategoryAxis
Returns secondary category axis. Read-only.
Declaration
public IChartCategoryAxis SecondaryCategoryAxis { get; }
Property Value
Type |
---|
IChartCategoryAxis |
SecondaryCategoryAxisTitle
Title of the secondary category axis.
Declaration
public string SecondaryCategoryAxisTitle { get; set; }
Property Value
Type |
---|
System.String |
SecondaryFormats
Returns chart format collection in secondary axis.
Declaration
public ChartFormatCollection SecondaryFormats { get; }
Property Value
Type |
---|
ChartFormatCollection |
SecondaryValueAxis
Returns secondary value axis. Read-only.
Declaration
public IChartValueAxis SecondaryValueAxis { get; }
Property Value
Type |
---|
IChartValueAxis |
SecondaryValueAxisTitle
Title of the secondary value axis.
Declaration
public string SecondaryValueAxisTitle { get; set; }
Property Value
Type |
---|
System.String |
Series
Collection of the all series of this chart. Read-only.
Declaration
public IChartSeries Series { get; }
Property Value
Type |
---|
IChartSeries |
SeriesAxisTitle
Title of the series axis.
Declaration
public string SeriesAxisTitle { get; set; }
Property Value
Type |
---|
System.String |
SeriesNameLevel
Represents the series name level
Declaration
public ExcelSeriesNameLevel SeriesNameLevel { get; set; }
Property Value
Type |
---|
ExcelSeriesNameLevel |
Shapes
Returns chart shapes. Read-only.
Declaration
public IShapes Shapes { get; }
Property Value
Type |
---|
IShapes |
ShowAllFieldButtons
Gets or sets a value indicating whether [show all field buttons].
Declaration
public bool ShowAllFieldButtons { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
|
ShowAxisFieldButtons
Gets or sets a value indicating whether [show axis field buttons].
Declaration
public bool ShowAxisFieldButtons { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
|
ShowLegendFieldButtons
Gets or sets a value indicating whether [show legend field buttons].
Declaration
public bool ShowLegendFieldButtons { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
|
ShowReportFilterFieldButtons
Gets or sets a value indicating whether [show report filter field buttons].
Declaration
public bool ShowReportFilterFieldButtons { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
|
ShowValueFieldButtons
Gets or sets a value indicating whether [show value field buttons].
Declaration
public bool ShowValueFieldButtons { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
|
SideWall
sidewall property..
Declaration
public IChartWallOrFloor SideWall { get; }
Property Value
Type |
---|
IChartWallOrFloor |
SizeWithWindow
True if Microsoft Excel resizes the chart to match the size of the chart sheet window. False if the chart size isn't attached to the window size. Applies only to chart sheets.
Declaration
public bool SizeWithWindow { get; set; }
Property Value
Type |
---|
System.Boolean |
Style
Gets or sets the style index chart.
Declaration
public int Style { get; set; }
Property Value
Type |
---|
System.Int32 |
TabColor
Gets / sets tab color.
Declaration
public ExcelKnownColors TabColor { get; set; }
Property Value
Type |
---|
ExcelKnownColors |
TabColorRGB
Gets / sets tab color.
Declaration
public Color TabColorRGB { get; set; }
Property Value
Type |
---|
Windows.UI.Color |
TabIndex
Returns index in the parent ITabSheets collection. Read-only.
Declaration
public int TabIndex { get; }
Property Value
Type |
---|
System.Int32 |
TextBoxes
Returns collection with all textboxes inside this worksheet. Read-only.
Declaration
public ITextBoxes TextBoxes { get; }
Property Value
Type |
---|
ITextBoxes |
ValueAxisTitle
Title of the value axis.
Declaration
public string ValueAxisTitle { get; set; }
Property Value
Type |
---|
System.String |
Visibility
Control visibility of worksheet to end user.
Declaration
public WorksheetVisibility Visibility { get; set; }
Property Value
Type |
---|
WorksheetVisibility |
Walls
Represents chart walls. Read-only.
Declaration
public IChartWallOrFloor Walls { get; }
Property Value
Type |
---|
IChartWallOrFloor |
WallsAndGridlines2D
True if gridlines are drawn two-dimensionally on a 3-D chart.
Declaration
public bool WallsAndGridlines2D { get; set; }
Property Value
Type |
---|
System.Boolean |
XPos
X coordinate of the upper-left corner of the chart in points (1/72 inch).
Declaration
public double XPos { get; set; }
Property Value
Type |
---|
System.Double |
YPos
Y coordinate of the upper-left corner of the chart in points (1/72 inch).
Declaration
public double YPos { get; set; }
Property Value
Type |
---|
System.Double |
Zoom
Gets or sets the value that represents zoom factor of document. Value must be in range from 10 till 400.
Declaration
public int Zoom { get; set; }
Property Value
Type |
---|
System.Int32 |
Methods
Activate()
Makes the current sheet the active sheet. Equivalent to clicking the sheet's tab.
Declaration
public void Activate()
Clone(Object, Dictionary<String, String>, Dictionary<Int32, Int32>, Boolean)
Creates a clone of the current shape.
Declaration
public override IShape Clone(object parent, Dictionary<string, string> hashNewNames, Dictionary<int, int> dicFontIndexes, bool addToCollections)
Parameters
Type | Name | Description |
---|---|---|
System.Object | parent | New parent for the shape object. |
System.Collections.Generic.Dictionary<System.String, System.String> | hashNewNames | Dictionary with new worksheet names. |
System.Collections.Generic.Dictionary<System.Int32, System.Int32> | dicFontIndexes | Dictionary with new font indexes. |
System.Boolean | addToCollections | Indicates whether we should add created shape into all necessary parent collections. |
Returns
Type | Description |
---|---|
IShape | A copy of the current shape. |
Overrides
CreateDefaultOptions()
Creates default options.
Declaration
protected override MsofbtOPT CreateDefaultOptions()
Returns
Type | Description |
---|---|
MsofbtOPT | Created MsofbtOPT record. |
Overrides
OnDispose()
Disposes the charts elements
Declaration
protected override void OnDispose()
Overrides
OnPrepareForSerialization()
This method is called inside of PrepareForSerialization to make shape-dependent preparations.
Declaration
protected override void OnPrepareForSerialization()
Overrides
ParseClientAnchor(MsofbtClientAnchor)
Parses client anchor record.
Declaration
public override void ParseClientAnchor(MsofbtClientAnchor clientAnchor)
Parameters
Type | Name | Description |
---|---|---|
MsofbtClientAnchor | clientAnchor | Record to parse. |
Overrides
ParseClientData(MsofbtClientData, ExcelParseOptions)
Parses client data record.
Declaration
protected override void ParseClientData(MsofbtClientData clientData, ExcelParseOptions options)
Parameters
Type | Name | Description |
---|---|---|
MsofbtClientData | clientData | Record to parse. |
ExcelParseOptions | options | Parse options. |
Overrides
Protect(String)
Protects worksheet's content with password.
Declaration
public void Protect(string password)
Parameters
Type | Name | Description |
---|---|---|
System.String | password | Password to protect with. |
Protect(String, ExcelSheetProtection)
Protects current worksheet.
Declaration
public void Protect(string password, ExcelSheetProtection options)
Parameters
Type | Name | Description |
---|---|---|
System.String | password | Represents password to protect. |
ExcelSheetProtection | options | Represents params to protect. |
RegisterInSubCollection()
Registers shape in all required sub collections.
Declaration
public override void RegisterInSubCollection()
Overrides
Select()
Selects current tab sheet.
Declaration
public void Select()
SerializeOptions(MsoBase)
Serializes options.
Declaration
protected override MsofbtOPT SerializeOptions(MsoBase parent)
Parameters
Type | Name | Description |
---|---|---|
MsoBase | parent | Parent record for options. |
Returns
Type | Description |
---|---|
MsofbtOPT | Create options record. |
Overrides
SerializeShape(MsofbtSpgrContainer)
Parses shape group container.
Declaration
protected override void SerializeShape(MsofbtSpgrContainer spgrContainer)
Parameters
Type | Name | Description |
---|---|---|
MsofbtSpgrContainer | spgrContainer | Group container. |
Overrides
SetParents()
Searches for all parents
Declaration
protected override void SetParents()
Overrides
Unprotect(String)
Unprotects worksheet's content with password.
Declaration
public void Unprotect(string password)
Parameters
Type | Name | Description |
---|---|---|
System.String | password | Password to unprotect. |
Unselect()
Unselects current tab sheet.
Declaration
public void Unselect()
UpdateFormula(Int32, Int32, Rectangle, Int32, Rectangle)
Updates formulas after copy operation.
Declaration
public override void UpdateFormula(int iCurIndex, int iSourceIndex, Rectangle sourceRect, int iDestIndex, Rectangle destRect)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | iCurIndex | Current worksheet index. |
System.Int32 | iSourceIndex | Source worksheet index. |
Rectangle | sourceRect | Source rectangle. |
System.Int32 | iDestIndex | Destination worksheet index. |
Rectangle | destRect | Destination rectangle. |
Overrides
Operators
Implicit(ChartShapeImpl to WorksheetBaseImpl)
Converts chart shape into WorksheetBaseImpl.
Declaration
public static implicit operator WorksheetBaseImpl(ChartShapeImpl chartShape)
Parameters
Type | Name | Description |
---|---|---|
ChartShapeImpl | chartShape | Shape to convert. |
Returns
Type | Description |
---|---|
WorksheetBaseImpl | Converted object. |
Explicit Interface Implementations
IChart.Height
Height of the chart in points (1/72 inch).
Declaration
double IChart.Height { get; set; }
Returns
Type |
---|
System.Double |
IChart.Width
Width of the chart in points (1/72 inch).
Declaration
double IChart.Width { get; set; }
Returns
Type |
---|
System.Double |