Class HorizontalPageBreakCollection

Namespace: Aspose.Cells
Assembly: Aspose.Cells.dll (25.2.0)

Encapsulates a collection of Aspose.Cells.HorizontalPageBreak objects.

public class HorizontalPageBreakCollection : CollectionBase<horizontalpagebreak>, IList<horizontalpagebreak>, ICollection<horizontalpagebreak>, IEnumerable<horizontalpagebreak>, ICollection, IEnumerable

Inheritance

object ← CollectionBase<horizontalpagebreak> ← HorizontalPageBreakCollection

Implements

IList<horizontalpagebreak>, ICollection<horizontalpagebreak>, IEnumerable<horizontalpagebreak>, ICollection, IEnumerable

Inherited Members

CollectionBase<horizontalpagebreak>.BinarySearch(HorizontalPageBreak), CollectionBase<horizontalpagebreak>.BinarySearch(HorizontalPageBreak, IComparer<horizontalpagebreak>), CollectionBase<horizontalpagebreak>.BinarySearch(int, int, HorizontalPageBreak, IComparer<horizontalpagebreak>), CollectionBase<horizontalpagebreak>.Contains(HorizontalPageBreak), CollectionBase<horizontalpagebreak>.CopyTo(HorizontalPageBreak[]), CollectionBase<horizontalpagebreak>.CopyTo(HorizontalPageBreak[], int), CollectionBase<horizontalpagebreak>.CopyTo(int, HorizontalPageBreak[], int, int), CollectionBase<horizontalpagebreak>.Exists(Predicate<horizontalpagebreak>), CollectionBase<horizontalpagebreak>.Find(Predicate<horizontalpagebreak>), CollectionBase<horizontalpagebreak>.FindAll(Predicate<horizontalpagebreak>), CollectionBase<horizontalpagebreak>.FindIndex(Predicate<horizontalpagebreak>), CollectionBase<horizontalpagebreak>.FindIndex(int, Predicate<horizontalpagebreak>), CollectionBase<horizontalpagebreak>.FindIndex(int, int, Predicate<horizontalpagebreak>), CollectionBase<horizontalpagebreak>.FindLast(Predicate<horizontalpagebreak>), CollectionBase<horizontalpagebreak>.FindLastIndex(Predicate<horizontalpagebreak>), CollectionBase<horizontalpagebreak>.FindLastIndex(int, Predicate<horizontalpagebreak>), CollectionBase<horizontalpagebreak>.FindLastIndex(int, int, Predicate<horizontalpagebreak>), CollectionBase<horizontalpagebreak>.IndexOf(HorizontalPageBreak), CollectionBase<horizontalpagebreak>.IndexOf(HorizontalPageBreak, int), CollectionBase<horizontalpagebreak>.IndexOf(HorizontalPageBreak, int, int), CollectionBase<horizontalpagebreak>.LastIndexOf(HorizontalPageBreak), CollectionBase<horizontalpagebreak>.LastIndexOf(HorizontalPageBreak, int), CollectionBase<horizontalpagebreak>.LastIndexOf(HorizontalPageBreak, int, int), CollectionBase<horizontalpagebreak>.GetEnumerator(), CollectionBase<horizontalpagebreak>.Clear(), CollectionBase<horizontalpagebreak>.RemoveAt(int), CollectionBase<horizontalpagebreak>.OnClearComplete(), CollectionBase<horizontalpagebreak>.OnClear(), CollectionBase<horizontalpagebreak>.Capacity, CollectionBase<horizontalpagebreak>.Count, CollectionBase<horizontalpagebreak>.InnerList, CollectionBase<horizontalpagebreak>.this[int], object.GetType(), object.MemberwiseClone(), object.ToString(), object.Equals(object?), object.Equals(object?, object?), object.ReferenceEquals(object?, object?), object.GetHashCode()

Examples

csharp
[C#]
Workbook excel = new Workbook();

//Add a pagebreak at G5
excel.Worksheets[0].HorizontalPageBreaks.Add("G5");
excel.Worksheets[0].VerticalPageBreaks.Add("G5");

[VB]
Dim excel as Workbook = new Workbook()

'Add a pagebreak at G5
excel.Worksheets(0).HorizontalPageBreaks.Add("G5")
excel.Worksheets(0).VerticalPageBreaks.Add("G5")

Properties

this[int]

Gets the Aspose.Cells.HorizontalPageBreak element at the specified index.

public HorizontalPageBreak this[int index] { get; }

Property Value

HorizontalPageBreak

this[string]

Gets the Aspose.Cells.HorizontalPageBreak element with the specified cell name.

public HorizontalPageBreak this[string cellName] { get; }

Property Value

HorizontalPageBreak

Methods

Add(int, int, int)

Adds a horizontal page break to the collection.

public int Add(int row, int startColumn, int endColumn)

Parameters

row int

Row index, zero based.

startColumn int

Start column index, zero based.

endColumn int

End column index, zero based.

Returns

int

Aspose.Cells.HorizontalPageBreak object index.

Remarks

This method is used to add a horizontal pagebreak within a print area.

Add(int)

Adds a horizontal page break to the collection.

public int Add(int row)

Parameters

row int

Cell row index, zero based.

Returns

int

Aspose.Cells.HorizontalPageBreak object index.

Remarks

Page break is added in the top left of the cell. Please set a horizontal page break and a vertical page break concurrently.

Add(int, int)

Adds a horizontal page break to the collection.

public int Add(int row, int column)

Parameters

row int

Cell row index, zero based.

column int

Cell column index, zero based.

Returns

int

Aspose.Cells.HorizontalPageBreak object index.

Remarks

Page break is added in the top left of the cell. Please set a horizontal page break and a vertical page break concurrently.

Add(string)

Adds a horizontal page break to the collection.

public int Add(string cellName)

Parameters

cellName string

Cell name.

Returns

int

Aspose.Cells.HorizontalPageBreak object index.

Remarks

Page break is added in the top left of the cell. Please set a horizontal page break and a vertical page break concurrently.

RemoveAt(int)

Removes the HPageBreak element at a specified name.

public void RemoveAt(int index)

Parameters

index int

Element index, zero based. </horizontalpagebreak></horizontalpagebreak></horizontalpagebreak></horizontalpagebreak></horizontalpagebreak></horizontalpagebreak></horizontalpagebreak></horizontalpagebreak></horizontalpagebreak></horizontalpagebreak></horizontalpagebreak></horizontalpagebreak></horizontalpagebreak></horizontalpagebreak></horizontalpagebreak></horizontalpagebreak></horizontalpagebreak></horizontalpagebreak></horizontalpagebreak></horizontalpagebreak></horizontalpagebreak></horizontalpagebreak></horizontalpagebreak></horizontalpagebreak></horizontalpagebreak></horizontalpagebreak></horizontalpagebreak></horizontalpagebreak></horizontalpagebreak></horizontalpagebreak></horizontalpagebreak></horizontalpagebreak></horizontalpagebreak></horizontalpagebreak></horizontalpagebreak></horizontalpagebreak></horizontalpagebreak></horizontalpagebreak></horizontalpagebreak></horizontalpagebreak></horizontalpagebreak></horizontalpagebreak></horizontalpagebreak></horizontalpagebreak></horizontalpagebreak></horizontalpagebreak></horizontalpagebreak></horizontalpagebreak>