Xamarin.Android

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

    Show / Hide Table of Contents

    Class ChartGlobalFormatsCollection

    Contains primary parent axis, secondary parent axis.

    Inheritance
    System.Object
    ChartGlobalFormatsCollection
    Namespace: Syncfusion.XlsIO.Implementation.Charts
    Assembly: Syncfusion.XlsIO.Portable.dll
    Syntax
    public class ChartGlobalFormatsCollection : Object

    Constructors

    ChartGlobalFormatsCollection()

    Default constructor.

    Declaration
    public ChartGlobalFormatsCollection()

    ChartGlobalFormatsCollection(IApplication, ChartParentAxisImpl, ChartParentAxisImpl)

    Creates object and initializes collections.

    Declaration
    public ChartGlobalFormatsCollection(IApplication application, ChartParentAxisImpl primaryParent, ChartParentAxisImpl secondaryParent)
    Parameters
    Type Name Description
    IApplication application

    Application object.

    ChartParentAxisImpl primaryParent

    Parent object for primary collection.

    ChartParentAxisImpl secondaryParent

    Parent object for secondary collection.

    Fields

    DEF_MABY_COMBINATION_TYPES

    Declaration
    public static ExcelChartType[] DEF_MABY_COMBINATION_TYPES
    Field Value
    Type Description
    ExcelChartType[]

    DEF_MABY_COMBINATION_TYPES_START

    Declaration
    public static string[] DEF_MABY_COMBINATION_TYPES_START
    Field Value
    Type Description
    System.String[]

    Properties

    PrimaryFormats

    Represents primary format collection. Read-only.

    Declaration
    public ChartFormatCollection PrimaryFormats { get; }
    Property Value
    Type Description
    ChartFormatCollection

    SecondaryFormats

    Represents secondary format collection. Read-only.

    Declaration
    public ChartFormatCollection SecondaryFormats { get; }
    Property Value
    Type Description
    ChartFormatCollection

    Methods

    AddFormat(ChartFormatImpl, Int32, Int32, Boolean)

    Helper methods for adding new formats.

    Declaration
    public ChartFormatImpl AddFormat(ChartFormatImpl formatToAdd, int order, int index, bool isPrimary)
    Parameters
    Type Name Description
    ChartFormatImpl formatToAdd

    Format to add.

    System.Int32 order

    Format order.

    System.Int32 index

    Format index.

    System.Boolean isPrimary

    If true - adds in primary format; otherwise - in secondary.

    Returns
    Type Description
    ChartFormatImpl

    ChangeCollections()

    Changes primary and secondary format collections.

    Declaration
    public void ChangeCollections()

    ChangeNotIntimateSerieType(ExcelChartType, ExcelChartType, IApplication, ChartImpl, ChartSerieImpl)

    Changes not intimate types.

    Declaration
    public ChartFormatImpl ChangeNotIntimateSerieType(ExcelChartType typeToChange, ExcelChartType serieType, IApplication application, ChartImpl chart, ChartSerieImpl serieToChange)
    Parameters
    Type Name Description
    ExcelChartType typeToChange

    Type to change.

    ExcelChartType serieType

    Current Series type.

    IApplication application

    Application object.

    ChartImpl chart

    Chart object.

    ChartSerieImpl serieToChange
    Returns
    Type Description
    ChartFormatImpl

    Returns format for current type.

    ChangeShallowAxis(Boolean, Int32, Boolean, Int32)

    Change format in axis.

    Declaration
    public void ChangeShallowAxis(bool bToPrimary, int iOrder, bool bAdd, int iNewOrder)
    Parameters
    Type Name Description
    System.Boolean bToPrimary

    If true - changes format to primary. otherwise - to secondary.

    System.Int32 iOrder

    Format order.

    System.Boolean bAdd

    If true - standard add; otherwise - shallow.

    System.Int32 iNewOrder

    Represents new order.

    Clear()

    Clears all format collections.

    Declaration
    public void Clear()

    CloneForPrimary(Object)

    Clones current instance.

    Declaration
    public ChartGlobalFormatsCollection CloneForPrimary(object parent)
    Parameters
    Type Name Description
    System.Object parent

    Parent for primary collection.

    Returns
    Type Description
    ChartGlobalFormatsCollection

    Returns just cloned method.

    CloneForSecondary(ChartGlobalFormatsCollection, Object)

    Clones secondary collection.

    Declaration
    public void CloneForSecondary(ChartGlobalFormatsCollection result, object parent)
    Parameters
    Type Name Description
    ChartGlobalFormatsCollection result

    Global collection.

    System.Object parent

    Parent object.

    CreateCollection(IApplication, Object, Boolean)

    Creates format collection.

    Declaration
    public void CreateCollection(IApplication application, object parent, bool bIsPrimary)
    Parameters
    Type Name Description
    IApplication application

    Application object.

    System.Object parent

    Parent object for collection.

    System.Boolean bIsPrimary

    If true - primary collection; otherwise - secondary.

    DetectChartType(ChartSeriesCollection)

    Detects chart type.

    Declaration
    public ExcelChartType DetectChartType(ChartSeriesCollection series)
    Parameters
    Type Name Description
    ChartSeriesCollection series

    Chart series collection.

    Returns
    Type Description
    ExcelChartType

    Returns chart type.

    Parse(IList, ref Int32)

    Parses ChartAxisParent record.

    Declaration
    public void Parse(IList data, ref int iPos)
    Parameters
    Type Name Description
    System.Collections.IList data

    Array of records containing record.

    System.Int32 iPos

    Position of the record to parse.

    Exceptions
    Type Condition
    System.ArgumentOutOfRangeException

    When specified record is not ChartAxisParent record.

    Remove(ChartFormatImpl)

    If can - removes format.

    Declaration
    public void Remove(ChartFormatImpl format)
    Parameters
    Type Name Description
    ChartFormatImpl format

    Format to remove.

    RemoveFormat(Int32, Int32, Boolean)

    Removes format from collection.

    Declaration
    public void RemoveFormat(int indexToRemove, int iOrder, bool isPrimary)
    Parameters
    Type Name Description
    System.Int32 indexToRemove

    Index to remove.

    System.Int32 iOrder

    Order to remove.

    System.Boolean isPrimary

    If true - removes in primary collection; otherwise - secondary.

    Serialize(OffsetArrayList)

    Serializes chart axes.

    Declaration
    public void Serialize(OffsetArrayList records)
    Parameters
    Type Name Description
    OffsetArrayList records

    OffsetArrayList that will receive all records.

    Back to top Generated by DocFX
    Copyright © 2001 - 2023 Syncfusion Inc. All Rights Reserved