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
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.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 Description
TBIFFRecord
Overrides

ShapeData

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

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

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

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

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 Description
ShapeImpl
Overrides

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

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 Description
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 Description
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 Description
ShapeImpl

Implements

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