Class HPageBreaksCollection

The collection of horizontal page breaks within the print area. Each horizontal page break is represented by an HPageBreak object.

Inheritance
System.Object
CollectionBase<IHPageBreak>
CollectionBaseEx<IHPageBreak>
HPageBreaksCollection
Implements
System.Collections.Generic.IList<IHPageBreak>
System.Collections.Generic.ICollection<IHPageBreak>
System.Collections.Generic.IEnumerable<IHPageBreak>
System.Collections.IEnumerable
Inherited Members
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 HPageBreaksCollection : CollectionBaseEx<IHPageBreak>, IList<IHPageBreak>, ICollection<IHPageBreak>, IEnumerable<IHPageBreak>, IParentApplication, ICloneParent, IHPageBreaks, IEnumerable, IBiffStorage

Constructors

HPageBreaksCollection(IApplication, Object)

Creates collection and sets its Application and Parent properties.

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

Application object that represents the Microsoft Excel application.
System.Object parent

The parent object for the specified object.

Properties

Item[IRange]

Declaration
public IHPageBreak this[IRange location] { get; }
Parameters
Type Name Description
IRange location
Property Value
Type
IHPageBreak

ManualBreakCount

Returns manual breaks count. Read-only.

Declaration
public int ManualBreakCount { get; }
Property Value
Type
System.Int32

NeedDataArray

Indicates whether data array is required by this record.

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

RecordCode

Returns code of the biff storage. Read-only.

Declaration
public int RecordCode { get; }
Property Value
Type
System.Int32

StreamPos

Indicates record position in stream. This is a utility member of class and is used only in the serialization process. Does not influence the data.

Declaration
public long StreamPos { get; set; }
Property Value
Type
System.Int64

TypeCode

Returns type code of the biff storage. Read-only.

Declaration
public TBIFFRecord TypeCode { get; }
Property Value
Type
TBIFFRecord

Methods

Add(HPageBreakImpl)

Adds page break to the collection.

Declaration
public void Add(HPageBreakImpl pageBreak)
Parameters
Type Name Description
HPageBreakImpl pageBreak

Page break to add.

Add(IRange)

Adds a horizontal page break. Returns an HPageBreak object. Read-only.

Declaration
public IHPageBreak Add(IRange location)
Parameters
Type Name Description
IRange location

Object after which new page break must be inserted.
Returns
Type Description
IHPageBreak

HPageBreak which was added.
Exceptions
Type Condition
System.ArgumentException

If specified object couldn't be found in the collection.

ChangeToExcel97to03Version()

Converts pagebreaks to Excel97to03 version.

Declaration
public void ChangeToExcel97to03Version()

Clear()

Clears horizontal page breaks from HPageBreaks collection.

Declaration
public void Clear()

Clone(Object)

Creates copy of the collection.

Declaration
public override object Clone(object parent)
Parameters
Type Name Description
System.Object parent

Parent for new collection.
Returns
Type Description
System.Object

A clone of the current collection.
Overrides
Syncfusion.XlsIO.Implementation.Collections.CollectionBaseEx<Syncfusion.XlsIO.IHPageBreak>.Clone(System.Object)

FillStream(BinaryWriter, DataProvider, IEncryptor, Int32)

Save record data to stream.

Declaration
public int FillStream(BinaryWriter writer, DataProvider provider, IEncryptor encryptor, int streamPosition)
Parameters
Type Name Description
System.IO.BinaryWriter writer

Writer that will receive record data.
DataProvider provider

Object that provides access to the data.
IEncryptor encryptor

Object to encrypt data.
System.Int32 streamPosition

Position in the output stream. Used to increase performance.
Returns
Type Description
System.Int32

Size of the record.
Exceptions
Type Condition
System.ArgumentNullException

If writer is NULL.
System.ApplicationException

If m_iLength of internal record data array is less than zero.

GetPageBreak(Int32)

Returns page break at the specified row.

Declaration
public IHPageBreak GetPageBreak(int iRow)
Parameters
Type Name Description
System.Int32 iRow

One-based row index.
Returns
Type Description
IHPageBreak

Page break with corresponding row or null if not found.

GetStoreSize(ExcelVersion)

Size of the required storage space. Read-only.

Declaration
public int GetStoreSize(ExcelVersion version)
Parameters
Type Name Description
ExcelVersion version
Returns
Type
System.Int32

Parse(HorizontalPageBreaksRecord)

Parses breaks record.

Declaration
[CLSCompliant(false)]
public void Parse(HorizontalPageBreaksRecord record)
Parameters
Type Name Description
HorizontalPageBreaksRecord record

Record to parse.

Remove(IRange)

Declaration
public IHPageBreak Remove(IRange location)
Parameters
Type Name Description
IRange location
Returns
Type
IHPageBreak

Serialize(OffsetArrayList)

Serializes collection into as set of Biff records.

Declaration
[CLSCompliant(false)]
public void Serialize(OffsetArrayList records)
Parameters
Type Name Description
OffsetArrayList records

OffsetArrayList to serialize into.

Implements

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

Extension Methods