Click or drag to resize

XlsChartFrameFormat Class

Represents the format properties of a chart frame in an Excel document.
Inheritance Hierarchy

Namespace: Spire.Xls.Core.Spreadsheet.Charts
Assembly: Spire.XLS (in Spire.XLS.dll) Version: 15.4.0.0 (15.4.0.5046)
Syntax
Copy 
public class XlsChartFrameFormat : XlsObject, 
	IChartFrameFormat, IChartFillBorder

The XlsChartFrameFormat type exposes the following members.

Properties
Name Description
Public property BackGroundColor
Represents foreground known color.
Public property BackGroundColorObject
Represents background color.
Public property BackGroundKnownColor
Represents the known color used for the background in Excel.
Public property Border
Gets chart border. Read only.
Public property Code example Fill
Represents XlsFill gradient format. Read only.
Examples
The following code illustrates the use of Fill property:
Copy 
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>workbook.LoadFromFile("Sample.xlsx");</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Create chart and set range</para><para>IChart chart = worksheet.Charts.Add();</para><para>chart.DataRange = worksheet.Range["B2:C6"];</para><para>//Set chart type</para><para>chart.ChartType = ExcelChartType.Column3DClustered;</para><para>//Gets fill options for the chart element</para><para>IShapeFill fillChart = chart.ChartArea.Fill;</para><para>fillChart.FillType = ShapeFillType.Gradient;</para><para>fillChart.BackColor = Color.FromArgb(205, 217, 234);</para><para>fillChart.ForeColor = Color.White;</para><para>//Save to file</para><para>workbook.SaveToFile("Chart.xlsx");</para>
Public property ForeGroundColor
Represents foreground known color.
Public property ForeGroundColorObject
Represents foreground color.
Public property ForeGroundKnownColor
Represents foreground known color.
Public property Code example Format3D
Gets the chart3 D properties.
Examples
The following code illustrates the use of Shadow property:
Copy 
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>workbook.LoadFromFile("Sample.xlsx");</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Create chart and set range</para><para>IChart chart = worksheet.Charts.Add();</para><para>chart.DataRange = worksheet.Range["B2:C6"];</para><para>//Set chart type</para><para>chart.ChartType = ExcelChartType.Column3DClustered;</para><para>//Gets shadow formatting properties for the chart element</para><para>ChartShadow shadowChart = chart.ChartArea.Shadow;</para><para>shadowChart.ShadowPrespectiveType = XLSXChartPrespectiveType.Below;</para><para>shadowChart.Color = Color.Aqua;</para><para>shadowChart.Blur = 22;</para><para>//Save to file</para><para>workbook.SaveToFile("Chart.xlsx");</para>
Public property HasFormat3D
This property Indicates whether the Shadow object has been created(which includes the 3D properties)
Public property HasInterior
Indicates whether interior object was created. Read-only.
Public property HasLineProperties
Indicates whether border formatting object was created. Read-only.
Public property HasManualLayout Obsolete.
Indicates whether border formatting object was created. Read-only.
Public property HasShadow
This property indicates whether the shadow object has been created
Public property Height
Y-size. 1/4000 of chart plot. IsHMode Shall set to True
Public property InnerLayoutTarget Obsolete.
Gets or sets the inner layout target. Note: This property is obsolete and the get and set operations are not implemented.
Public property Interior
Gets frame interior. Read only
Public property IsAutomaticFormat
Represents if use automatic format.
Public property IsAutoPosition
Calculates position automatically.
Public property IsAutoSize
Calculates size automatically.
Public property IsBorderCornersRound
Gets or sets if border corners is round.
Public property IsHMode
false value Specifies that the Height shall be interpreted as the Bottom of the chart element..
Public property IsWMode
false value Specifies that the Width shall be interpreted as the Right of the chart element..
Public property IsXMode
true value Specifies that the X shall be interpreted as the Left of the chart element..
Public property IsYMode
true value Specifies that the Y shall be interpreted as the Top of the chart element..
Public property LineProperties
Gets chart border. Read-only.
Public property Parent
Reference to Parent object. Read-only.
(Inherited from XlsObject .)
Public property Pattern
Represents pattern.
Public property RectangleStyle Obsolete.
Rectangle style.
Protected property ReferenceCount
Get quantity of instance references.
(Inherited from XlsObject .)
Public property Code example Shadow
Gets the shadow properties.
Examples
The following code illustrates the use of Shadow property:
Copy 
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>workbook.LoadFromFile("Sample.xlsx");</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Create chart and set range</para><para>IChart chart = worksheet.Charts.Add();</para><para>chart.DataRange = worksheet.Range["B2:C6"];</para><para>//Set chart type</para><para>chart.ChartType = ExcelChartType.Column3DClustered;</para><para>//Gets shadow formatting properties for the chart element</para><para>ChartShadow shadowChart = chart.ChartArea.Shadow;</para><para>shadowChart.ShadowPrespectiveType = XLSXChartPrespectiveType.Below;</para><para>shadowChart.Color = Color.Aqua;</para><para>shadowChart.Blur = 22;</para><para>//Save to file</para><para>workbook.SaveToFile("Chart.xlsx");</para>
Public property Visible
Represents visiblity.
Public property Width
X-size. 1/4000 of chart plot. IsWMode Shall set to True
Public property X
X-position of upper-left corner. 1/4000 of chart plot. IsXMode Shall set to True
Public property Y
Y-position of upper-left corner. 1/4000 of chart plot. IsYMode Shall set to True
Top
Methods
Name Description
Protected method AddReference
Increase the quantity of reference. User must use this method when new wrapper on object is created or reference on object stored.
(Inherited from XlsObject .)
Protected method CheckDisposed
Checks whether object was disposed and throws exception if it was.
(Inherited from XlsObject .)
Public method Clear Obsolete.
Clears objects.
Public method Clone Obsolete.
Clone current Record.
Public method Dispose
Dispose object and free resources.
(Inherited from XlsObject .)
Public method Equals
Determines whether the specified object is equal to the current object.
(Inherited from Object .)
Protected method Finalize
Destructor. Call dispose method of current object.
(Inherited from XlsObject .)
Protected method FindParent(Type)
This method is used to find parent with specific type.
(Inherited from XlsObject .)
Protected method FindParent( Type )
Find parent of object.
(Inherited from XlsObject .)
Protected method FindParent(Type, Boolean)
This method is used to find parent with specific type.
(Inherited from XlsObject .)
Protected method FindParents
Finds parent objects.
(Inherited from XlsObject .)
Public method GetHashCode
Serves as the default hash function.
(Inherited from Object .)
Public method GetType
Gets the Type of the current instance.
(Inherited from Object .)
Protected method MemberwiseClone
Creates a shallow copy of the current Object .
(Inherited from Object .)
Protected method OnDispose
Method which can be overriden by users to take any specific actions when object is disposed.
(Inherited from XlsObject .)
Protected method ReleaseReference
Decrease quantity of Reference. User must call this method when freeing resources.
(Inherited from XlsObject .)
Public method SetDefaultValues Obsolete.
Set variable to the default state.
Protected method SetParent
Sets parent of the object.
(Inherited from XlsObject .)
Public method ToString
Returns a string that represents the current object.
(Inherited from Object .)
Top
Fields
Name Description
Protected field m_bIsDisposed
Flag which indicates if the object was disposed or not.
(Inherited from XlsObject .)
Top
See Also