SetPageBreak Method (ISheetAxisModel)

Sets whether a page break occurs at the specified row or column.

Syntax

Visual Basic
C#

'Declaration
 
Sub SetPageBreak( _
   ByVal index As Integer, _
   ByVal value As Boolean _
)

'Usage
 
Dim instance As ISheetAxisModel
Dim index As Integer
Dim value As Boolean
 
instance.SetPageBreak(index, value)

void SetPageBreak( 
   int index,
   bool value
)

Parameters

index: Row or column index
value: Whether a page break occurs

Example

This example sets and returns the page break before the specified column.

FarPoint.Win.Spread.Model.ISheetAxisModel isa;
isa = (FarPoint.Win.Spread.Model.ISheetAxisModel)fpSpread1.ActiveSheet.Models.ColumnAxis;
fpSpread1.ActiveSheet.RowCount = 12;
fpSpread1.ActiveSheet.ColumnCount = 5;
fpSpread1.ActiveSheet.Columns[1].Width = 150;
fpSpread1.ActiveSheet.SetClip(0, 0, 1, 5, "VS Live\tSan Francisco\tScott\tScott\t12:00");
fpSpread1.ActiveSheet.SetClip(1, 0, 1, 5, "VS Live\tSan Francisco\tScott\tChris\t12:00");
fpSpread1.ActiveSheet.SetClip(2, 0, 1, 5, "VS Live\tSan Francisco\tScott\tChris\t1:00");
fpSpread1.ActiveSheet.SetClip(3, 0, 1, 5, "MSCE\tSan Francisco\tScott\tScott\t12:00");
fpSpread1.ActiveSheet.SetClip(4, 0, 1, 5, "VS Live\tOrlando\tChris\tChris\t1:00");
fpSpread1.ActiveSheet.SetClip(5, 0, 1, 5, "VS Live\tOrlando\tScott\tChris\t2:00");
fpSpread1.ActiveSheet.SetClip(6, 0, 1, 5, "VS Live\tNew York\tGreg\tGreg\t2:00");
fpSpread1.ActiveSheet.SetClip(7, 0, 1, 5, "VS Live\tNew York\tGreg\tJim\t2:00");
fpSpread1.ActiveSheet.SetClip(8, 0, 1, 5, "VS Live\tNew York\tGreg\tJim\t3:00");
fpSpread1.ActiveSheet.SetClip(9, 0, 1, 5, "VS Live\tNew York\tScott\tJim\t4:00");
fpSpread1.ActiveSheet.SetClip(10, 0, 1, 5, "PRN\tRaleigh\tScott\tScott\t7:00");
fpSpread1.ActiveSheet.SetClip(11, 0, 1, 5, "PRN\tCary\tJenny\tRyan\t6:00");
DialogResult dlg; 
dlg = MessageBox.Show("Do you want to merge the data and set a page break?", "Get/SetPageBreak", MessageBoxButtons.YesNo);
if (dlg == DialogResult.Yes)
{
isa.SetMergePolicy(-1, FarPoint.Win.Spread.Model.MergePolicy.Always);
isa.SetPageBreak(3, true);
fpSpread1.SetBounds(fpSpread1.Bounds.X, fpSpread1.Bounds.Y, fpSpread1.Bounds.Width + 1, fpSpread1.Bounds.Height);
label1.Text = "A page break will occur after page 3 = " + isa.GetPageBreak(3).ToString();
}

Visual Basic

Dim isa As FarPoint.Win.Spread.Model.ISheetAxisModel
isa = FpSpread1.ActiveSheet.Models.ColumnAxis
With FpSpread1.ActiveSheet
.RowCount = 12
.ColumnCount = 5
.Columns(1).Width = 150
.SetClip(0, 0, 1, 5, "VS Live" & vbTab & "San Francisco" & vbTab & "Scott" & vbTab & "Scott" & vbTab & "12:00")
.SetClip(1, 0, 1, 5, "VS Live" & vbTab & "San Francisco" & vbTab & "Scott" & vbTab & "Chris" & vbTab & "12:00")
.SetClip(2, 0, 1, 5, "VS Live" & vbTab & "San Francisco" & vbTab & "Scott" & vbTab & "Chris" & vbTab & "1:00")
.SetClip(3, 0, 1, 5, "MSCE" & vbTab & "San Francisco" & vbTab & "Scott" & vbTab & "Scott" & vbTab & "12:00")
.SetClip(4, 0, 1, 5, "VS Live" & vbTab & "Orlando" & vbTab & "Chris" & vbTab & "Chris" & vbTab & "1:00")
.SetClip(5, 0, 1, 5, "VS Live" & vbTab & "Orlando" & vbTab & "Scott" & vbTab & "Chris" & vbTab & "2:00")
.SetClip(6, 0, 1, 5, "VS Live" & vbTab & "New York" & vbTab & "Greg" & vbTab & "Greg" & vbTab & "2:00")
.SetClip(7, 0, 1, 5, "VS Live" & vbTab & "New York" & vbTab & "Greg" & vbTab & "Jim" & vbTab & "2:00")
.SetClip(8, 0, 1, 5, "VS Live" & vbTab & "New York" & vbTab & "Greg" & vbTab & "Jim" & vbTab & "3:00")
.SetClip(9, 0, 1, 5, "VS Live" & vbTab & "New York" & vbTab & "Scott" & vbTab & "Jim" & vbTab & "4:00")
.SetClip(10, 0, 1, 5, "PRN" & vbTab & "Raleigh" & vbTab & "Scott" & vbTab & "Scott" & vbTab & "7:00")
.SetClip(11, 0, 1, 5, "PRN" & vbTab & "Cary" & vbTab & "Jenny" & vbTab & "Ryan" & vbTab & "6:00")
End With
Dim dlg As DialogResult
dlg = MessageBox.Show("Do you want to merge the data and set a page break?", "Get/SetMergePolicy/PageBreak", MessageBoxButtons.YesNo)
If dlg = DialogResult.Yes Then
isa.SetMergePolicy(-1, FarPoint.Win.Spread.Model.MergePolicy.Always)
isa.SetPageBreak(3, True)
FpSpread1.SetBounds(FpSpread1.Bounds.X, FpSpread1.Bounds.Y, FpSpread1.Bounds.Width + 1, FpSpread1.Bounds.Height)
Label1.Text = "A page break will occur after page 3 = " & isa.GetPageBreak(3).ToString()
End If

Requirements

Target Platforms: Windows 2000 Professional (SP4), Windows 2000 Server, Windows 2003 Server (SP1), Windows Server 2012 R2, Windows 2008, Windows XP (SP2), Windows Vista, Windows 7, Windows 8, Windows 8.1, Windows 10

Reference

ISheetAxisModel Interface
ISheetAxisModel Members
GetPageBreak Method