Class VPageBreaksCollection
A collection of vertical page breaks within the print area. Each vertical page break is represented by a VPageBreak object.
Inheritance
Implements
Inherited Members
Namespace: Syncfusion.XlsIO.Implementation.Collections
Assembly: Syncfusion.XlsIO.Base.dll
Syntax
public class VPageBreaksCollection : CollectionBaseEx<IVPageBreak>, IList<IVPageBreak>, ICollection<IVPageBreak>, IEnumerable<IVPageBreak>, IParentApplication, ICloneParent, IVPageBreaks, IEnumerable, IBiffStorageConstructors
VPageBreaksCollection(IApplication, Object)
Creates collection and sets its Application and Parent properties.
Declaration
public VPageBreaksCollection(IApplication application, object parent)Parameters
| Type | Name | Description |
|---|---|---|
| IApplication | application | Application object for this collection. |
| System.Object | parent | Parent object for this collection. |
Properties
Item[IRange]
Returns single page break from the collection.
Declaration
public IVPageBreak this[IRange location] { get; }Parameters
| Type | Name | Description |
|---|---|---|
| IRange | location |
Property Value
| Type |
|---|
| IVPageBreak |
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(VPageBreakImpl)
Adds page break to the collection.
Declaration
public void Add(VPageBreakImpl pageBreak)Parameters
| Type | Name | Description |
|---|---|---|
| VPageBreakImpl | pageBreak | Page break to add. |
Add(IRange)
Adds a vertical page break. Returns a VPageBreak object.
Declaration
public IVPageBreak Add(IRange location)Parameters
| Type | Name | Description |
|---|---|---|
| IRange | location | Page break location. |
Returns
| Type | Description |
|---|---|
| IVPageBreak | Newly added page break. |
Exceptions
| Type | Condition |
|---|---|
| System.ArgumentException | When specified object cannot be found in the collection. |
ChangeToExcel97to03Version()
Converts pagebreaks to Excel97to03 version.
Declaration
public void ChangeToExcel97to03Version()Clear()
Clears Vertical page breaks from VPageBreaks 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
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 column.
Declaration
public IVPageBreak GetPageBreak(int iColumn)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | iColumn | One-based column index. |
Returns
| Type | Description |
|---|---|
| IVPageBreak | Page break with corresponding column 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(VerticalPageBreaksRecord)
Parses breaks record.
Declaration
public void Parse(VerticalPageBreaksRecord record)Parameters
| Type | Name | Description |
|---|---|---|
| VerticalPageBreaksRecord | record | Record to parse. |
Remove(IRange)
Removes vertical page break.
Declaration
public IVPageBreak Remove(IRange location)Parameters
| Type | Name | Description |
|---|---|---|
| IRange | location | Page break location. |
Returns
| Type | Description |
|---|---|
| IVPageBreak | Page break that was removed from the collection. |
Serialize(OffsetArrayList)
Serializes collection into as set of Biff records.
Declaration
public void Serialize(OffsetArrayList records)Parameters
| Type | Name | Description |
|---|---|---|
| OffsetArrayList | records | OffsetArrayList to serialize into. |