File Formats

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class ChartFrameFormatImpl

    Show / Hide Table of Contents

    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.m_bIsDisposed
    CommonObject.FindParent(Type)
    CommonObject.FindParent(Type, Boolean)
    CommonObject.FindParent(Object, Type)
    CommonObject.FindParent(Object, Type, Boolean)
    CommonObject.FindParents(Type[])
    CommonObject.FindParent(Type[])
    CommonObject.SetParent(Object)
    CommonObject.CheckDisposed()
    CommonObject.AddReference()
    CommonObject.ReleaseReference()
    CommonObject.Dispose()
    CommonObject.OnDispose()
    CommonObject.Application
    CommonObject.Parent
    CommonObject.AppImplementation
    CommonObject.ReferenceCount
    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 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.

    Fields

    m_chart

    Parent chart.

    Declaration
    protected ChartImpl m_chart
    Field Value
    Type Description
    ChartImpl

    m_plotAreaLayout

    Plot area layout

    Declaration
    protected ChartPlotAreaLayoutRecord m_plotAreaLayout
    Field Value
    Type Description
    Syncfusion.XlsIO.Parser.Biff_Records.Charts.ChartPlotAreaLayoutRecord

    Properties

    BackGroundColorObject

    Represents background color.

    Declaration
    public ColorObject BackGroundColorObject { get; }
    Property Value
    Type Description
    ColorObject

    Border

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

    Declaration
    public IChartBorder Border { get; }
    Property Value
    Type Description
    IChartBorder

    Fill

    Represents fill gradient format. Read-only.

    Declaration
    public IFill Fill { get; }
    Property Value
    Type Description
    IFill

    ForeGroundColorObject

    Represents foreground color.

    Declaration
    public ColorObject ForeGroundColorObject { get; }
    Property Value
    Type Description
    ColorObject

    FrameRecord

    Gets frame record. Read-only.

    Declaration
    [CLSCompliant(false)]
    public ChartFrameRecord FrameRecord { get; }
    Property Value
    Type Description
    Syncfusion.XlsIO.Parser.Biff_Records.Charts.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 Description
    System.Boolean

    HasInterior

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

    Declaration
    public bool HasInterior { get; }
    Property Value
    Type Description
    System.Boolean

    HasLineProperties

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

    Declaration
    public bool HasLineProperties { get; }
    Property Value
    Type Description
    System.Boolean

    HasShadowProperties

    This property indicates whether the shadow object has been created

    Declaration
    public bool HasShadowProperties { get; }
    Property Value
    Type Description
    System.Boolean

    Interior

    Represents frame interior. Read-only

    Declaration
    public IChartInterior Interior { get; }
    Property Value
    Type Description
    IChartInterior

    IsAutomaticFormat

    Represents if use automatic format.

    Declaration
    public bool IsAutomaticFormat { get; set; }
    Property Value
    Type Description
    System.Boolean

    IsAutoPosition

    Microsoft Excel calculates position.

    Declaration
    public bool IsAutoPosition { get; set; }
    Property Value
    Type Description
    System.Boolean

    IsAutoSize

    Microsoft Excel calculates size.

    Declaration
    public bool IsAutoSize { get; set; }
    Property Value
    Type Description
    System.Boolean

    IsBorderCornersRound

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

    Declaration
    public bool IsBorderCornersRound { get; set; }
    Property Value
    Type Description
    System.Boolean

    Layout

    Gets or sets the layout settings of chart text area.

    Declaration
    public IChartLayout Layout { get; set; }
    Property Value
    Type Description
    IChartLayout

    LineProperties

    Represents chart border. Read-only.

    Declaration
    public IChartBorder LineProperties { get; }
    Property Value
    Type Description
    IChartBorder

    Pattern

    Represents pattern.

    Declaration
    public ExcelPattern Pattern { get; set; }
    Property Value
    Type Description
    ExcelPattern

    RectangleStyle

    Gets or sets the rectangle style for the chart element.

    Declaration
    public ExcelRectangleStyle RectangleStyle { get; set; }
    Property Value
    Type Description
    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 Description
    System.Boolean

    Workbook

    Returns parent workbook. Read-only.

    Declaration
    public WorkbookImpl Workbook { get; }
    Property Value
    Type Description
    WorkbookImpl

    Methods

    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.

    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.

    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
    Back to top Generated by DocFX
    Copyright © 2001 - 2023 Syncfusion Inc. All Rights Reserved