menu

WPF

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class HeaderFooterShapeCollection - WPF API Reference | Syncfusion

    Show / Hide Table of Contents

    Class HeaderFooterShapeCollection

    Summary description for HeaderFooterShapesCollection.

    Inheritance
    System.Object
    CollectionBase<IShape>
    CollectionBaseEx<IShape>
    ShapeCollectionBase
    HeaderFooterShapeCollection
    Implements
    System.Collections.Generic.IList<IShape>
    System.Collections.Generic.ICollection<IShape>
    System.Collections.Generic.IEnumerable<IShape>
    System.Collections.IEnumerable
    IParentApplication
    ICloneParent
    Inherited Members
    CollectionBase<IShape>.Add(IShape)
    CollectionBase<IShape>.Capacity
    CollectionBase<IShape>.Clear()
    CollectionBase<IShape>.Contains(IShape)
    CollectionBase<IShape>.CopyTo(IShape[], Int32)
    CollectionBase<IShape>.Count
    CollectionBase<IShape>.GetEnumerator()
    CollectionBase<IShape>.IEnumerable.GetEnumerator()
    CollectionBase<IShape>.IndexOf(IShape)
    CollectionBase<IShape>.InnerList
    CollectionBase<IShape>.Insert(Int32, IShape)
    CollectionBase<IShape>.IsReadOnly
    CollectionBase<IShape>.List
    CollectionBase<IShape>.RemoveAt(Int32)
    CollectionBaseEx<IShape>.AppImplementation
    CollectionBaseEx<IShape>.Application
    CollectionBaseEx<IShape>.Changed
    CollectionBaseEx<IShape>.ChangeName(IDictionary, ValueChangedEventArgs)
    CollectionBaseEx<IShape>.Cleared
    CollectionBaseEx<IShape>.Clearing
    CollectionBaseEx<IShape>.ClearMaxValues()
    CollectionBaseEx<IShape>.EnsureCapacity(Int32)
    CollectionBaseEx<IShape>.FindParent(Type)
    CollectionBaseEx<IShape>.FindParent(Type, Boolean)
    CollectionBaseEx<IShape>.GenerateDefaultName(ICollection<IShape>, String)
    CollectionBaseEx<IShape>.GenerateDefaultName(ICollection, String)
    CollectionBaseEx<IShape>.GenerateDefaultName(String, ICollection[])
    CollectionBaseEx<IShape>.Inserted
    CollectionBaseEx<IShape>.Inserting
    CollectionBaseEx<IShape>.OnClear()
    CollectionBaseEx<IShape>.OnClearComplete()
    CollectionBaseEx<IShape>.OnInsert(Int32, IShape)
    CollectionBaseEx<IShape>.OnInsertComplete(Int32, IShape)
    CollectionBaseEx<IShape>.OnRemove(Int32, IShape)
    CollectionBaseEx<IShape>.OnRemoveComplete(Int32, IShape)
    CollectionBaseEx<IShape>.OnSet(Int32, IShape, IShape)
    CollectionBaseEx<IShape>.OnSetComplete(Int32, IShape, IShape)
    CollectionBaseEx<IShape>.Parent
    CollectionBaseEx<IShape>.QuietMode
    CollectionBaseEx<IShape>.Removed
    CollectionBaseEx<IShape>.Removing
    CollectionBaseEx<IShape>.Set
    CollectionBaseEx<IShape>.SetParent(Object)
    CollectionBaseEx<IShape>.Setting
    ShapeCollectionBase.AddChildShapes(MsofbtSpContainer, ExcelParseOptions)
    ShapeCollectionBase.AddCopy(IShape)
    ShapeCollectionBase.AddCopy(IShape, Dictionary<String, String>, List<Int32>)
    ShapeCollectionBase.AddCopy(ShapeImpl)
    ShapeCollectionBase.AddCopy(ShapeImpl, Dictionary<String, String>, Dictionary<Int32, Int32>)
    ShapeCollectionBase.AddGroupShape(MsofbtSpgrContainer, ExcelParseOptions)
    ShapeCollectionBase.AddShape(MsoBase, ExcelParseOptions)
    ShapeCollectionBase.AddShape(ShapeImpl)
    ShapeCollectionBase.Clone(Object)
    ShapeCollectionBase.CreateGroupShape(MsofbtSpgrContainer, ExcelParseOptions)
    ShapeCollectionBase.DEF_ID_PER_GROUP
    ShapeCollectionBase.DEF_SHAPES_ROUND_VALUE
    ShapeCollectionBase.InitializeCollection()
    ShapeCollectionBase.Item[Int32]
    ShapeCollectionBase.Item[String]
    ShapeCollectionBase.m_sheet
    ShapeCollectionBase.ParseMsoStructures(List<MsoBase>, ExcelParseOptions)
    ShapeCollectionBase.Remove(IShape)
    ShapeCollectionBase.Serialize(OffsetArrayList)
    ShapeCollectionBase.SetParents()
    ShapeCollectionBase.ShapesCount
    ShapeCollectionBase.ShapesTotalCount
    ShapeCollectionBase.Workbook
    ShapeCollectionBase.Worksheet
    ShapeCollectionBase.WorksheetBase
    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.Collections
    Assembly: Syncfusion.XlsIO.Base.dll
    Syntax
    public class HeaderFooterShapeCollection : ShapeCollectionBase, IList<IShape>, ICollection<IShape>, IEnumerable<IShape>, IEnumerable, IParentApplication, ICloneParent

    Constructors

    HeaderFooterShapeCollection(IApplication, Object)

    Declaration
    public HeaderFooterShapeCollection(IApplication application, object parent)
    Parameters
    Type Name Description
    IApplication application
    System.Object parent

    HeaderFooterShapeCollection(IApplication, Object, MsofbtSpgrContainer, ExcelParseOptions)

    Declaration
    [CLSCompliant(false)]
    public HeaderFooterShapeCollection(IApplication application, object parent, MsofbtSpgrContainer container, ExcelParseOptions options)
    Parameters
    Type Name Description
    IApplication application
    System.Object parent
    MsofbtSpgrContainer container
    ExcelParseOptions options

    Parse options.

    Properties

    RecordCode

    Code of the Biff record in which all data is stored. Read-only.

    Declaration
    public override TBIFFRecord RecordCode { get; }
    Property Value
    Type
    TBIFFRecord
    Overrides
    ShapeCollectionBase.RecordCode

    ShapeData

    Returns shared shape data for all shapes in this collection. Read-only.

    Declaration
    public override WorkbookShapeDataImpl ShapeData { get; }
    Property Value
    Type
    WorkbookShapeDataImpl
    Overrides
    ShapeCollectionBase.ShapeData

    Methods

    AddShape(MsofbtSpContainer, ExcelParseOptions)

    Adds new shape to the collection.

    Declaration
    [CLSCompliant(false)]
    protected override ShapeImpl AddShape(MsofbtSpContainer shapeContainer, ExcelParseOptions options)
    Parameters
    Type Name Description
    MsofbtSpContainer shapeContainer

    Shape container to add.

    ExcelParseOptions options

    Parse options.

    Returns
    Type Description
    ShapeImpl

    Newly added shape.

    Overrides
    ShapeCollectionBase.AddShape(MsofbtSpContainer, ExcelParseOptions)

    CreateData(Stream, MsofbtDgContainer, List<Int32>, List<List<BiffRecordRaw>>)

    Converts array of records with break indexes into bytes sequence.

    Declaration
    [CLSCompliant(false)]
    protected override void CreateData(Stream stream, MsofbtDgContainer dgContainer, List<int> arrBreaks, List<List<BiffRecordRaw>> arrRecords)
    Parameters
    Type Name Description
    System.IO.Stream stream

    Stream to put record data into.

    MsofbtDgContainer dgContainer

    Container.

    System.Collections.Generic.List<System.Int32> arrBreaks

    List with break indexes.

    System.Collections.Generic.List<System.Collections.Generic.List<Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw>> arrRecords

    List with records to serialize.

    Overrides
    ShapeCollectionBase.CreateData(Stream, MsofbtDgContainer, List<Int32>, List<List<BiffRecordRaw>>)

    CreateShape(TObjType, MsofbtSpContainer, ExcelParseOptions, List<ObjSubRecord>, Int32)

    Creates new shape object.

    Declaration
    [CLSCompliant(false)]
    protected override ShapeImpl CreateShape(TObjType objType, MsofbtSpContainer shapeContainer, ExcelParseOptions options, List<ObjSubRecord> subRecords, int cmoIndex)
    Parameters
    Type Name Description
    TObjType objType

    Object type to create.

    MsofbtSpContainer shapeContainer

    Shape container.

    ExcelParseOptions options

    Parse options.

    System.Collections.Generic.List<ObjSubRecord> subRecords

    Subrecords of the shape's OBJRecord.

    System.Int32 cmoIndex

    Index to the cmo record inside subrecords.

    Returns
    Type
    ShapeImpl
    Overrides
    ShapeCollectionBase.CreateShape(TObjType, MsofbtSpContainer, ExcelParseOptions, List<ObjSubRecord>, Int32)

    Parse(HeaderFooterImageRecord, ExcelParseOptions)

    Parses record with image data.

    Declaration
    [CLSCompliant(false)]
    public void Parse(HeaderFooterImageRecord record, ExcelParseOptions options)
    Parameters
    Type Name Description
    HeaderFooterImageRecord record

    Record to parse.

    ExcelParseOptions options

    Parse options.

    RegisterInWorksheet()

    Registers in the parent worksheet.

    Declaration
    protected override void RegisterInWorksheet()
    Overrides
    ShapeCollectionBase.RegisterInWorksheet()

    SetPicture(String, Image)

    Sets picture.

    Declaration
    public ShapeImpl SetPicture(string strShapeName, Image image)
    Parameters
    Type Name Description
    System.String strShapeName

    Shape name.

    System.Drawing.Image image

    Image to set.

    Returns
    Type
    ShapeImpl

    SetPicture(String, Image, Int32)

    Sets picture.

    Declaration
    public ShapeImpl SetPicture(string strShapeName, Image image, int iIndex)
    Parameters
    Type Name Description
    System.String strShapeName

    Shape name.

    System.Drawing.Image image

    Image to set.

    System.Int32 iIndex

    Represents new shape blip id index. If set -1 - auto indicate.

    Returns
    Type
    ShapeImpl

    SetPicture(String, Image, Int32, Boolean, String)

    Sets picture.

    Declaration
    public ShapeImpl SetPicture(string strShapeName, Image image, int iIndex, bool bIncludeOptions, string preservedStyles)
    Parameters
    Type Name Description
    System.String strShapeName

    Shape name.

    System.Drawing.Image image

    Image to set.

    System.Int32 iIndex

    Represents new shape blip id index. If set -1 - auto indicate.

    System.Boolean bIncludeOptions

    Indicates is current picture include options.

    System.String preservedStyles
    Returns
    Type
    ShapeImpl

    Implements

    System.Collections.Generic.IList<T>
    System.Collections.Generic.ICollection<T>
    System.Collections.Generic.IEnumerable<T>
    System.Collections.IEnumerable
    IParentApplication
    ICloneParent

    Extension Methods

    PivotExtension.GroupByMany<TElement>(IEnumerable<TElement>, Int32, Func<TElement, Object>[])
    PivotExtension.GroupByMany<TElement>(IEnumerable<TElement>, IEnumerable<Func<TElement, Object>>)
    FunctionalExtensions.ForEach<T>(IEnumerable, Action<T>)
    FunctionalExtensions.ForEach<T>(IEnumerable<T>, Action<T>)
    FunctionalExtensions.ToList<T>(IEnumerable)
    ChartExtensionUtils.DistinctBy<TSource, TKey>(IEnumerable<TSource>, Func<TSource, TKey>)
    Back to top Generated by DocFX
    Copyright © 2001 - 2025 Syncfusion Inc. All Rights Reserved