Class ChartFrameFormatImpl

Represent the borders and layout options of the chart elements.

Inheritance

System.Object

CommonObject

ChartFrameFormatImpl

ChartPlotAreaImpl

ChartWrappedFrameFormatImpl

Implements

IParentApplication

System.IDisposable

IChartFrameFormat

IChartFillBorder

Inherited Members

CommonObject.AddReference()

CommonObject.AppImplementation

CommonObject.Application

CommonObject.CheckDisposed()

CommonObject.Dispose()

CommonObject.FindParent(Object, Type)

CommonObject.FindParent(Object, Type, Boolean)

CommonObject.FindParent(Type)

CommonObject.FindParent(Type, Boolean)

CommonObject.FindParent(Type[])

CommonObject.FindParents(Type[])

CommonObject.m_bIsDisposed

CommonObject.OnDispose()

CommonObject.Parent

CommonObject.ReferenceCount

CommonObject.ReleaseReference()

CommonObject.SetParent(Object)

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Syncfusion.XlsIO.Implementation.Charts

Assembly: Syncfusion.XlsIO.Base.dll

Syntax

public class ChartFrameFormatImpl : CommonObject, IParentApplication, IDisposable, IChartFrameFormat, IChartFillBorder, IFillColor

Constructors

ChartFrameFormatImpl(IApplication, Object)

Creates chart and sets its Application and Parent properties to specified values.

Declaration

public ChartFrameFormatImpl(IApplication application, object parent)

Parameters

Type	Name	Description
IApplication	application	Application object for the chart.
System.Object	parent	Parent object for the chart.

ChartFrameFormatImpl(IApplication, Object, Boolean)

Creates chart and sets its Application and Parent properties to specified values.

Declaration

public ChartFrameFormatImpl(IApplication application, object parent, bool bSetDefaults)

Parameters

Type	Name	Description
IApplication	application	Application object for the chart.
System.Object	parent	Parent object for the chart.
System.Boolean	bSetDefaults	Indicates whether we should set defaults for fill and border properties.

ChartFrameFormatImpl(IApplication, Object, Boolean, Boolean, Boolean)

Creates chart and sets its Application and Parent properties to specified values.

Declaration

public ChartFrameFormatImpl(IApplication application, object parent, bool bAutoSize, bool bIsInteriorGrey, bool bSetDefaults)

Parameters

Type	Name	Description
IApplication	application	Application object for the chart.
System.Object	parent	Parent object for the chart.
System.Boolean	bAutoSize	Indicates is auto size.
System.Boolean	bIsInteriorGrey	Indicates is interior is gray.
System.Boolean	bSetDefaults	Indicates whether we should set defaults for fill and border properties.

ChartFrameFormatImpl(IApplication, Object, IList<BiffRecordRaw>, ref Int32)

Creates and parses current object.

Declaration

public ChartFrameFormatImpl(IApplication application, object parent, IList<BiffRecordRaw> data, ref int iPos)

Parameters

Type	Name	Description
IApplication	application	Application object for the chart.
System.Object	parent	Parent object for the chart.
System.Collections.Generic.IList<Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw>	data	Records storage.
System.Int32	iPos	Position in storage.

Fields

m_chart

Parent chart.

Declaration

protected ChartImpl m_chart

Field Value

Type
ChartImpl

m_plotAreaLayout

Plot area layout

Declaration

protected ChartPlotAreaLayoutRecord m_plotAreaLayout

Field Value

Type
ChartPlotAreaLayoutRecord

Properties

BackGroundColorObject

Represents background color.

Declaration

public ColorObject BackGroundColorObject { get; }

Property Value

Type
ColorObject

Border

Gets the border of the chart element. Read-only.

Declaration

public IChartBorder Border { get; }

Property Value

Type
IChartBorder

Fill

Represents fill gradient format. Read-only.

Declaration

public IFill Fill { get; }

Property Value

Type
IFill

ForeGroundColorObject

Represents foreground color.

Declaration

public ColorObject ForeGroundColorObject { get; }

Property Value

Type
ColorObject

FrameRecord

Gets frame record. Read-only.

Declaration

[CLSCompliant(false)]
public ChartFrameRecord FrameRecord { get; }

Property Value

Type
ChartFrameRecord

Has3dProperties

This property Indicates whether the Shadow object has been created(which includes the 3D properties)

Declaration

public bool Has3dProperties { get; }

Property Value

Type
System.Boolean

HasInterior

This property indicates whether interior object was created. Read-only.

Declaration

public bool HasInterior { get; }

Property Value

Type
System.Boolean

HasLineProperties

This property indicates whether border formatting object was created. Read-only.

Declaration

public bool HasLineProperties { get; }

Property Value

Type
System.Boolean

HasShadowProperties

This property indicates whether the shadow object has been created

Declaration

public bool HasShadowProperties { get; }

Property Value

Type
System.Boolean

Interior

Represents frame interior. Read-only

Declaration

public IChartInterior Interior { get; }

Property Value

Type
IChartInterior

IsAutomaticFormat

Represents if use automatic format.

Declaration

public bool IsAutomaticFormat { get; set; }

Property Value

Type
System.Boolean

IsAutoPosition

Microsoft Excel calculates position.

Declaration

public bool IsAutoPosition { get; set; }

Property Value

Type
System.Boolean

IsAutoSize

Microsoft Excel calculates size.

Declaration

public bool IsAutoSize { get; set; }

Property Value

Type
System.Boolean

IsBorderCornersRound

True if the chart area has rounded corners. otherwise False.

Declaration

public bool IsBorderCornersRound { get; set; }

Property Value

Type
System.Boolean

Layout

Gets or sets the layout settings of chart text area.

Declaration

public IChartLayout Layout { get; set; }

Property Value

Type
IChartLayout

LineProperties

Represents chart border. Read-only.

Declaration

public IChartBorder LineProperties { get; }

Property Value

Type
IChartBorder

Pattern

Represents pattern.

Declaration

public ExcelPattern Pattern { get; set; }

Property Value

Type
ExcelPattern

RectangleStyle

Gets or sets the rectangle style for the chart element.

Declaration

public ExcelRectangleStyle RectangleStyle { get; set; }

Property Value

Type
ExcelRectangleStyle

Shadow

Gets the shadow properties.

Declaration

public IShadow Shadow { get; }

Property Value

Type	Description
IShadow	The shadow properties.

ThreeD

Gets the chart3 D properties.

Declaration

public IThreeDFormat ThreeD { get; }

Property Value

Type	Description
IThreeDFormat	The chart3 D properties.

Visible

Represents visibility.

Declaration

public bool Visible { get; set; }

Property Value

Type
System.Boolean

Workbook

Returns parent workbook. Read-only.

Declaration

public WorkbookImpl Workbook { get; }

Property Value

Type
WorkbookImpl

Methods

CheckBegin(BiffRecordRaw)

Checks whether specified record is begin.

Declaration

[CLSCompliant(false)]
protected virtual bool CheckBegin(BiffRecordRaw record)

Parameters

Type	Name	Description
Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw	record	Record to check.

Returns

Type	Description
System.Boolean	True if this is begin; false otherwise.

Clear()

Clears the plot area.

Declaration

public void Clear()

Clone(Object)

Clone current Record.

Declaration

public ChartFrameFormatImpl Clone(object parent)

Parameters

Type	Name	Description
System.Object	parent	Parent object.

Returns

Type	Description
ChartFrameFormatImpl	Returns clone of current object.

Parse(IList<BiffRecordRaw>, ref Int32)

Parses frame.

Declaration

[CLSCompliant(false)]
public void Parse(IList<BiffRecordRaw> data, ref int iPos)

Parameters

Type	Name	Description
System.Collections.Generic.IList<Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw>	data	Array with frame records.
System.Int32	iPos	Position of the frame records.

ParseRecord(BiffRecordRaw, ref Int32, Boolean)

Parses single record.

Declaration

[CLSCompliant(false)]
protected virtual void ParseRecord(BiffRecordRaw record, ref int iBeginCounter, bool isPlotArea)

Parameters

Type	Name	Description
Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw	record	Record to parse.
System.Int32	iBeginCounter	Number of not closed begin record.
System.Boolean	isPlotArea

Serialize(IList<IBiffStorage>)

Saves chart frame as biff records.

Declaration

[CLSCompliant(false)]
public void Serialize(IList<IBiffStorage> records)

Parameters

Type	Name	Description
System.Collections.Generic.IList<IBiffStorage>	records	OffsetArrayList that will get biff records.

SerializeRecord(IList<IBiffStorage>, BiffRecordRaw)

Serializes single record.

Declaration

[CLSCompliant(false)]
protected virtual void SerializeRecord(IList<IBiffStorage> list, BiffRecordRaw record)

Parameters

Type	Name	Description
System.Collections.Generic.IList<IBiffStorage>	list	OffsetArrayList that will get biff records.
Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw	record	Record to serialize.

SetDefaultValues(Boolean, Boolean)

Set variable to the default state.

Declaration

public void SetDefaultValues(bool bAutoSize, bool bIsInteriorGray)

Parameters

Type	Name	Description
System.Boolean	bAutoSize	Indicates whether MS Excel should calculate size of the frame.
System.Boolean	bIsInteriorGray	Indicates is default interior is gray.

UnwrapRecord(BiffRecordRaw)

Unwraps record.

Declaration

[CLSCompliant(false)]
protected virtual BiffRecordRaw UnwrapRecord(BiffRecordRaw record)

Parameters

Type	Name	Description
Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw	record	Record to unwrap.

Returns

Type	Description
Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw	Unwrapped record.

UpdateLineColor(ExcelKnownColors)

Updates known colors.

Declaration

public static ExcelKnownColors UpdateLineColor(ExcelKnownColors color)

Parameters

Type	Name	Description
ExcelKnownColors	color	Color to update.

Returns

Type	Description
ExcelKnownColors	Returns updated color.

Implements

IParentApplication

System.IDisposable

IChartFrameFormat

IChartFillBorder