Aspose::Cells::IHorizontalPageBreakCollection Class Referenceabstract

Encapsulates a collection of IHorizontalPageBreak objects. More...

Inherits CollectionBase.

Public Member Functions

virtual intrusive_ptr< Aspose::Cells::IHorizontalPageBreakGetObjectByIndex (Aspose::Cells::Systems::Int32 index)=0
 Gets the IHorizontalPageBreak element at the specified index. More...
 
virtual intrusive_ptr< Aspose::Cells::IHorizontalPageBreakGetObjectByIndex (intrusive_ptr< Aspose::Cells::Systems::String > cellName)=0
 Gets the IHorizontalPageBreak element with the specified cell name. More...
 
virtual Aspose::Cells::Systems::Int32 Add (Aspose::Cells::Systems::Int32 row, Aspose::Cells::Systems::Int32 startColumn, Aspose::Cells::Systems::Int32 endColumn)=0
 Adds a horizontal page break to the collection. More...
 
virtual Aspose::Cells::Systems::Int32 Add (Aspose::Cells::Systems::Int32 row)=0
 Adds a horizontal page break to the collection. More...
 
virtual Aspose::Cells::Systems::Int32 Add (Aspose::Cells::Systems::Int32 row, Aspose::Cells::Systems::Int32 column)=0
 Adds a horizontal page break to the collection. More...
 
virtual Aspose::Cells::Systems::Int32 Add (intrusive_ptr< Aspose::Cells::Systems::String > cellName)=0
 Adds a horizontal page break to the collection. More...
 
virtual void RemoveAt (Aspose::Cells::Systems::Int32 index)=0
 Removes the IHorizontalPageBreak element at a specified name. More...
 

Detailed Description

Encapsulates a collection of IHorizontalPageBreak objects.

[C++]
intrusive_ptr<Aspose::Cells::IWorkbook> workbook = Factory::CreateIWorkbook();
intrusive_ptr<IWorksheet> worksheet = workbook->GetIWorksheets()->GetObjectByIndex(0);
//Add a page break at G5
worksheet->GetIHorizontalPageBreaks()->Add(new String("G5"));
worksheet->GetIVerticalPageBreaks()->Add(new String("G5"));

Member Function Documentation

◆ Add() [1/4]

virtual Aspose::Cells::Systems::Int32 Aspose::Cells::IHorizontalPageBreakCollection::Add ( Aspose::Cells::Systems::Int32  row,
Aspose::Cells::Systems::Int32  startColumn,
Aspose::Cells::Systems::Int32  endColumn 
)
pure virtual

Adds a horizontal page break to the collection.

Parameters
rowRow index, zero based.
startColumnStart column index, zero based.
endColumnEnd column index, zero based.
Returns
IHorizontalPageBreak object index.

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

◆ Add() [2/4]

virtual Aspose::Cells::Systems::Int32 Aspose::Cells::IHorizontalPageBreakCollection::Add ( Aspose::Cells::Systems::Int32  row)
pure virtual

Adds a horizontal page break to the collection.

Parameters
rowCell row index, zero based.
Returns
IHorizontalPageBreak object index.

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

◆ Add() [3/4]

virtual Aspose::Cells::Systems::Int32 Aspose::Cells::IHorizontalPageBreakCollection::Add ( Aspose::Cells::Systems::Int32  row,
Aspose::Cells::Systems::Int32  column 
)
pure virtual

Adds a horizontal page break to the collection.

Parameters
rowCell row index, zero based.
columnCell column index, zero based.
Returns
IHorizontalPageBreak object index.

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

◆ Add() [4/4]

virtual Aspose::Cells::Systems::Int32 Aspose::Cells::IHorizontalPageBreakCollection::Add ( intrusive_ptr< Aspose::Cells::Systems::String >  cellName)
pure virtual

Adds a horizontal page break to the collection.

Parameters
cellNameCell name.
Returns
IHorizontalPageBreak object index.

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

◆ GetObjectByIndex() [1/2]

virtual intrusive_ptr<Aspose::Cells::IHorizontalPageBreak> Aspose::Cells::IHorizontalPageBreakCollection::GetObjectByIndex ( Aspose::Cells::Systems::Int32  index)
pure virtual

Gets the IHorizontalPageBreak element at the specified index.

Parameters
indexThe zero based index of the element.
Returns
The element at the specified index.

◆ GetObjectByIndex() [2/2]

virtual intrusive_ptr<Aspose::Cells::IHorizontalPageBreak> Aspose::Cells::IHorizontalPageBreakCollection::GetObjectByIndex ( intrusive_ptr< Aspose::Cells::Systems::String >  cellName)
pure virtual

Gets the IHorizontalPageBreak element with the specified cell name.

Parameters
cellNameCell name.
Returns
The element with the specified cell name.

◆ RemoveAt()

virtual void Aspose::Cells::IHorizontalPageBreakCollection::RemoveAt ( Aspose::Cells::Systems::Int32  index)
pure virtual

Removes the IHorizontalPageBreak element at a specified name.

Parameters
indexElement index, zero based.