Class EndPageLayoutEventArgs

Provides data for event once lay outing completed on the new page.

Inheritance

System.Object

System.EventArgs

PdfCancelEventArgs

EndPageLayoutEventArgs

EndTextPageLayoutEventArgs

PdfGridEndPageLayoutEventArgs

ListEndPageLayoutEventArgs

LightTableEndPageLayoutEventArgs

Inherited Members

PdfCancelEventArgs.Cancel

System.EventArgs.Empty

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Syncfusion.Pdf.Graphics

Assembly: Syncfusion.Pdf.Base.dll

Syntax

public class EndPageLayoutEventArgs : PdfCancelEventArgs

Examples

// Create a PDF document
PdfDocument doc = new PdfDocument();
//Creates a new page and adds it as the last page of the document
PdfPage page = doc.Pages.Add();
 private bool m_paginateStart = true;
PdfSolidBrush brush = new PdfSolidBrush(Color.Black);
PdfPen pen = new PdfPen(Color.Black, 1f);
//Creates a new  pdf font
PdfStandardFont pdfFont = new PdfStandardFont(PdfFontFamily.Helvetica, 11.5f);
Font font = new Font("Calibri", 14f, FontStyle.Bold);
PdfTrueTypeFont trueTypeFont = new PdfTrueTypeFont(font, true);
string path = @"..\..\Data\Essential studio.txt";
StreamReader reader = new StreamReader(path, Encoding.ASCII);
string text = reader.ReadToEnd();
reader.Close();
RectangleF column = new RectangleF(0, 20, page.Graphics.ClientSize.Width / 2f - 10f, page.Graphics.ClientSize.Height);
m_columnBounds = column;
//Create text element
PdfTextElement element = new PdfTextElement(text, pdfFont);
element.Brush = new PdfSolidBrush(Color.Black);
PdfLayoutFormat layoutFormat = new PdfLayoutFormat();
layoutFormat.Break = PdfLayoutBreakType.FitPage;
layoutFormat.Layout = PdfLayoutType.Paginate;
//Raise the event when the text flows to next page.
element.BeginPageLayout += new BeginPageLayoutEventHandler(BeginPageLayout2);
//Get the remaining text that flows beyond the boundary.
PdfTextLayoutResult result = element.Draw(page, column, layoutFormat);
//Saves the document.
doc.Save("Sample.pdf");
//End Page Layout Event Handler
private void EndPageLayout2(object sender, EndPageLayoutEventArgs e)
{
    EndTextPageLayoutEventArgs args = (EndTextPageLayoutEventArgs)e;
    PdfTextLayoutResult tlr = args.Result;
    RectangleF bounds = tlr.Bounds;
    args.NextPage = tlr.Page;   
 }

'Create a PDF document
Dim doc As New PdfDocument()
'Creates a new page and adds it as the last page of the document
Dim page As PdfPage = doc.Pages.Add()
Dim m_paginateStart As Bool= True
Dim brush As New PdfSolidBrush(Color.Black)
Dim pen As New PdfPen(Color.Black, 1f)
'Creates a new  pdf font
Dim pdfFont As New PdfStandardFont(PdfFontFamily.Helvetica, 11.5f)
Dim font As New Font("Calibri", 14f, FontStyle.Bold)
Dim trueTypeFont As New PdfTrueTypeFont(font, True)
Dim path As string = "..\..\..\..\..\..\..\..\..\Common\Data\PDF\Essential studio.txt"
Dim reader As New StreamReader(path, Encoding.ASCII)
Dim text As string = reader.ReadToEnd()
reader.Close()
Dim column As New RectangleF(0, 20, page.Graphics.ClientSize.Width / 2f - 10f, page.Graphics.ClientSize.Height)
'Create text element
Dim element As New PdfTextElement(text, pdfFont)
element.Brush = New PdfSolidBrush(Color.Black)
Dim layoutFormat As New PdfLayoutFormat()
layoutFormat.Break = PdfLayoutBreakType.FitPage
layoutFormat.Layout = PdfLayoutType.Paginate
'Raise the event when the text flows to next page.
element.BeginPageLayout += New BeginPageLayoutEventHandler(BeginPageLayout2)
'Get the remaining text that flows beyond the boundary.
Dim result As PdfTextLayoutResult = element.Draw(page, column, layoutFormat)
'Saves the document.
doc.Save("Sample.pdf")
'End Page Layout Event Handler
Private Sub EndPageLayout2(ByVal sender As object, ByVal e As EndPageLayoutEventArgs)
Dim args As EndTextPageLayoutEventArgs = CType(e, EndTextPageLayoutEventArgs)
Dim tlr As PdfTextLayoutResult = args.Result
Dim bounds As RectangleF = tlr.Bounds
args.NextPage = tlr.Page
End Sub

Constructors

EndPageLayoutEventArgs(PdfLayoutResult)

Initializes a new instance of the EndPageLayoutEventArgs class. with the specified PdfLayoutResult

Declaration

public EndPageLayoutEventArgs(PdfLayoutResult result)

Parameters

Type	Name	Description
PdfLayoutResult	result	The result.

Properties

Gets or sets a value indicating the next page where the element should be layout

Declaration

public PdfPage NextPage { get; set; }

Property Value

Type	Description
PdfPage

Remarks

The default value is null. In this case the element will be layout on the next page.

Examples

// Create a PDF document
PdfDocument doc = new PdfDocument();
//Creates a new page and adds it as the last page of the document
PdfPage page = doc.Pages.Add();
 private bool m_paginateStart = true;
PdfSolidBrush brush = new PdfSolidBrush(Color.Black);
PdfPen pen = new PdfPen(Color.Black, 1f);
//Creates a new  pdf font
PdfStandardFont pdfFont = new PdfStandardFont(PdfFontFamily.Helvetica, 11.5f);
Font font = new Font("Calibri", 14f, FontStyle.Bold);
PdfTrueTypeFont trueTypeFont = new PdfTrueTypeFont(font, true);
string path = @"..\..\Data\Essential studio.txt";
StreamReader reader = new StreamReader(path, Encoding.ASCII);
string text = reader.ReadToEnd();
reader.Close();
RectangleF column = new RectangleF(0, 20, page.Graphics.ClientSize.Width / 2f - 10f, page.Graphics.ClientSize.Height);
//Create text element
PdfTextElement element = new PdfTextElement(text, pdfFont);
element.Brush = new PdfSolidBrush(Color.Black);
PdfLayoutFormat layoutFormat = new PdfLayoutFormat();
layoutFormat.Break = PdfLayoutBreakType.FitPage;
layoutFormat.Layout = PdfLayoutType.Paginate;
//Raise the event when the text flows to next page.
element.BeginPageLayout += new BeginPageLayoutEventHandler(BeginPageLayout2);
//Get the remaining text that flows beyond the boundary.
PdfTextLayoutResult result = element.Draw(page, column, layoutFormat);
//Saves the document.
doc.Save("Sample.pdf");
//End Page Layout Event Handler
private void EndPageLayout2(object sender, EndPageLayoutEventArgs e)
{
    EndTextPageLayoutEventArgs args = (EndTextPageLayoutEventArgs)e;
    PdfTextLayoutResult tlr = args.Result;
    args.NextPage = tlr.Page;   
 }

'Create a PDF document
Dim doc As New PdfDocument()
'Creates a new page and adds it as the last page of the document
Dim page As PdfPage = doc.Pages.Add()
Dim m_paginateStart As Bool= True
Dim brush As New PdfSolidBrush(Color.Black)
Dim pen As New PdfPen(Color.Black, 1f)
'Creates a new  pdf font
Dim pdfFont As New PdfStandardFont(PdfFontFamily.Helvetica, 11.5f)
Dim font As New Font("Calibri", 14f, FontStyle.Bold)
Dim trueTypeFont As New PdfTrueTypeFont(font, True)
Dim path As string = "..\..\..\..\..\..\..\..\..\Common\Data\PDF\Essential studio.txt"
Dim reader As New StreamReader(path, Encoding.ASCII)
Dim text As string = reader.ReadToEnd()
reader.Close()
Dim column As New RectangleF(0, 20, page.Graphics.ClientSize.Width / 2f - 10f, page.Graphics.ClientSize.Height)
'Create text element
Dim element As New PdfTextElement(text, pdfFont)
element.Brush = New PdfSolidBrush(Color.Black)
Dim layoutFormat As New PdfLayoutFormat()
layoutFormat.Break = PdfLayoutBreakType.FitPage
layoutFormat.Layout = PdfLayoutType.Paginate
'Raise the event when the text flows to next page.
element.BeginPageLayout += New BeginPageLayoutEventHandler(BeginPageLayout2)
'Get the remaining text that flows beyond the boundary.
Dim result As PdfTextLayoutResult = element.Draw(page, column, layoutFormat)
'Saves the document.
doc.Save("Sample.pdf")
'End Page Layout Event Handler.
Private Sub EndPageLayout2(ByVal sender As object, ByVal e As EndPageLayoutEventArgs)
Dim tlr As PdfTextLayoutResult = args.Result
args.NextPage = tlr.Page
End Sub

Result

Gets the lay outing result of the page.

Declaration

public PdfLayoutResult Result { get; }

Property Value

Type	Description
PdfLayoutResult

Examples

// Create a PDF document
PdfDocument doc = new PdfDocument();
//Creates a new page and adds it as the last page of the document
PdfPage page = doc.Pages.Add();
 private bool m_paginateStart = true;
PdfSolidBrush brush = new PdfSolidBrush(Color.Black);
PdfPen pen = new PdfPen(Color.Black, 1f);
//Creates a new  pdf font
PdfStandardFont pdfFont = new PdfStandardFont(PdfFontFamily.Helvetica, 11.5f);
Font font = new Font("Calibri", 14f, FontStyle.Bold);
PdfTrueTypeFont trueTypeFont = new PdfTrueTypeFont(font, true);
string path = @"..\..\Data\Essential studio.txt";
StreamReader reader = new StreamReader(path, Encoding.ASCII);
string text = reader.ReadToEnd();
reader.Close();
RectangleF column = new RectangleF(0, 20, page.Graphics.ClientSize.Width / 2f - 10f, page.Graphics.ClientSize.Height);
//Create text element
PdfTextElement element = new PdfTextElement(text, pdfFont);
element.Brush = new PdfSolidBrush(Color.Black);
PdfLayoutFormat layoutFormat = new PdfLayoutFormat();
layoutFormat.Break = PdfLayoutBreakType.FitPage;
layoutFormat.Layout = PdfLayoutType.Paginate;
//Raise the event when the text flows to next page.
element.BeginPageLayout += new BeginPageLayoutEventHandler(BeginPageLayout2);
//Get the remaining text that flows beyond the boundary.
PdfTextLayoutResult result = element.Draw(page, column, layoutFormat);
//Saves the document.
doc.Save("Sample.pdf");
//End Page Layout Event Handler
private void EndPageLayout2(object sender, EndPageLayoutEventArgs e)
{
    EndTextPageLayoutEventArgs args = (EndTextPageLayoutEventArgs)e;
    PdfTextLayoutResult tlr = args.Result;
    RectangleF bounds = tlr.Bounds;
    args.NextPage = tlr.Page;   
 }

'Create a PDF document
Dim doc As New PdfDocument()
'Creates a new page and adds it as the last page of the document
Dim page As PdfPage = doc.Pages.Add()
Dim m_paginateStart As Bool= True
Dim brush As New PdfSolidBrush(Color.Black)
Dim pen As New PdfPen(Color.Black, 1f)
'Creates a new  pdf font
Dim pdfFont As New PdfStandardFont(PdfFontFamily.Helvetica, 11.5f)
Dim font As New Font("Calibri", 14f, FontStyle.Bold)
Dim trueTypeFont As New PdfTrueTypeFont(font, True)
Dim path As string = "..\..\..\..\..\..\..\..\..\Common\Data\PDF\Essential studio.txt"
Dim reader As New StreamReader(path, Encoding.ASCII)
Dim text As string = reader.ReadToEnd()
reader.Close()
Dim column As New RectangleF(0, 20, page.Graphics.ClientSize.Width / 2f - 10f, page.Graphics.ClientSize.Height)
'Create text element
Dim element As New PdfTextElement(text, pdfFont)
element.Brush = New PdfSolidBrush(Color.Black)
Dim layoutFormat As New PdfLayoutFormat()
layoutFormat.Break = PdfLayoutBreakType.FitPage
layoutFormat.Layout = PdfLayoutType.Paginate
'Raise the event when the text flows to next page.
element.BeginPageLayout += New BeginPageLayoutEventHandler(BeginPageLayout2)
'Get the remaining text that flows beyond the boundary.
Dim result As PdfTextLayoutResult = element.Draw(page, column, layoutFormat)
'Saves the document.
doc.Save("Sample.pdf")
'End Page Layout Event Handler
Private Sub EndPageLayout2(ByVal sender As object, ByVal e As EndPageLayoutEventArgs)
Dim args As EndTextPageLayoutEventArgs = CType(e, EndTextPageLayoutEventArgs)
Dim tlr As PdfTextLayoutResult = args.Result
Dim bounds As RectangleF = tlr.Bounds
args.NextPage = tlr.Page
End Sub