Class ChartLayoutImpl

Class used for setting chart elements layout

Inheritance
System.Object
CommonObject
ChartLayoutImpl
Implements
System.IDisposable
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: Syncfusion.XlsIO.Implementation.Charts
Assembly: Syncfusion.XlsIO.Base.dll
Syntax
public class ChartLayoutImpl : CommonObject, IDisposable, IChartLayout, IParentApplication

Constructors

ChartLayoutImpl(IApplication, Object, Boolean)

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

Declaration
public ChartLayoutImpl(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.

ChartLayoutImpl(IApplication, Object, Boolean, Boolean, Boolean)

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

Declaration
public ChartLayoutImpl(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.

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

Creates and parses current object.

Declaration
public ChartLayoutImpl(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.

ChartLayoutImpl(IApplication, Object, Object)

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

Declaration
public ChartLayoutImpl(IApplication application, object parent, object chartObject)
Parameters
Type Name Description
IApplication application

Application object for the chart.
System.Object parent

Parent object for the chart.
System.Object chartObject

Fields

m_book

Parent chart.

Declaration
protected ChartImpl m_book
Field Value
Type Description
ChartImpl

m_chart

Chart interface

Declaration
protected IChart m_chart
Field Value
Type Description
IChart

m_chartShape

ChartShape interface

Declaration
protected IShape m_chartShape
Field Value
Type Description
IShape

m_manualLayout

Manual layout

Declaration
protected IChartManualLayout m_manualLayout
Field Value
Type Description
IChartManualLayout

m_Parent

Parent object

Declaration
protected object m_Parent
Field Value
Type Description
System.Object

Properties

Height

Gets or sets the height/bottom of the chart element as a fraction of height of the chart, based on HeightMode.

Declaration
public double Height { get; set; }
Property Value
Type Description
System.Double

HeightMode

Gets or sets a value indicating how to interpret the Height of this manual layout.

Declaration
public LayoutModes HeightMode { get; set; }
Property Value
Type Description
LayoutModes

LayoutTarget

Gets or sets the layout target for the plot area.

Declaration
public LayoutTargets LayoutTarget { get; set; }
Property Value
Type Description
LayoutTargets

Left

Gets or sets the left (x location) of the chart element as a fraction of width of the chart.

Declaration
public double Left { get; set; }
Property Value
Type Description
System.Double
Remarks

If LeftMode is factor, then the position is relative to the default position for the chart element.

LeftMode

Gets or sets a value indicating how to interpret the Left of this manual layout.

Declaration
public LayoutModes LeftMode { get; set; }
Property Value
Type Description
LayoutModes

ManualLayout

Gets or sets manual layout options for the chart element.

Declaration
public IChartManualLayout ManualLayout { get; set; }
Property Value
Type Description
IChartManualLayout

Parent

Return the parent object. Read-only.

Declaration
public object Parent { get; }
Property Value
Type Description
System.Object

Top

Gets or sets the top of the chart element as a fraction of height of the chart.

Declaration
public double Top { get; set; }
Property Value
Type Description
System.Double
Remarks

If TopMode is factor, then the position is relative to the default position for the chart element.

TopMode

Gets or sets a value indicating how to interpret the Top of this manual layout.

Declaration
public LayoutModes TopMode { get; set; }
Property Value
Type Description
LayoutModes

Width

Gets or sets the width/right of the chart element as a fraction of width of the chart, based on WidthMode.

Declaration
public double Width { get; set; }
Property Value
Type Description
System.Double

WidthMode

Gets or sets a value indicating how to interpret the Width of this manual layout.

Declaration
public LayoutModes WidthMode { get; set; }
Property Value
Type Description
LayoutModes

Workbook

Returns parent workbook. Read-only.

Declaration
public WorkbookImpl Workbook { get; }
Property Value
Type Description
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.

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)

Parses single record.

Declaration
[CLSCompliant(false)]
protected virtual void ParseRecord(BiffRecordRaw record, ref int iBeginCounter)
Parameters
Type Name Description
Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw record

Record to parse.
System.Int32 iBeginCounter

Number of not closed begin record.

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()

Set variable to the default state.

Declaration
public void SetDefaultValues()

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.

Implements

System.IDisposable