FormattedTextArea.GetOverflowFormattedTextArea

Returns a new FormattedTextArea object containing the overflow text.

public FormattedTextArea GetOverflowFormattedTextArea()

Function GetOverflowFormattedTextArea() As FormattedTextArea

Returns

Licensing Info

This method is a full DynamicPDF Core Suite feature. One of the following is required for non-evaluation usage:

• An active DynamicPDF Ultimate Subscription
• An active DynamicPDF Professional or Professional Plus Subscription with DynamicPDF Core Suite selected.
• A DynamicPDF Core Suite for .NET v12.X Developer License.

Examples

The following example shows you how to use the GetOverflowFormattedTextArea object to allow text of variable length to flow onto new pages as needed.

using System;
using ceTe.DynamicPDF;
using ceTe.DynamicPDF.PageElements;

public class Example
{
    public static void CreatePDF(string outputPath)
	{
		// Create a PDF Document
		Document document = new Document();

		// Create a string and assign it to text of variable length
		string variableText = "";
		for( int i = 0; i < 50; i++ )
			variableText += "<i>This</i> is a <font color='FF0000'>sentence</font> that I " +
			"will use as my <b>variable length</b> text. ";

		// Create an formatted text area
		FormattedTextArea formattedTextArea = new FormattedTextArea( variableText, 0, 0, 250, 200, FontFamily.Helvetica, 12, false ); 
	
		do
		{
			// Create a new page
			Page page = new Page();
 
			// Add the text area to the page;
			page.Elements.Add( formattedTextArea );

			// Add the page to the document
			document.Pages.Add( page );

			// Set the formatted text area object equal to the rest of the text that did not fit
			// if all the text did fit, GetOverflowFormattedTextArea will return null
			formattedTextArea = formattedTextArea.GetOverflowFormattedTextArea(); 
		} while( formattedTextArea != null );
	
		// Save the PDF
		document.Draw( outputPath );
	}
}

Remarks

This method returns a new FormattedTextArea object that contains the remaining text that did not fit.

Returns a new FormattedTextArea object containing the overflow text.

public FormattedTextArea GetOverflowFormattedTextArea(float x, float y)

Function GetOverflowFormattedTextArea(x As Single, y As Single) As FormattedTextArea

Parameters

Returns

Licensing Info

This method is a full DynamicPDF Core Suite feature. One of the following is required for non-evaluation usage:

• An active DynamicPDF Ultimate Subscription
• An active DynamicPDF Professional or Professional Plus Subscription with DynamicPDF Core Suite selected.
• A DynamicPDF Core Suite for .NET v12.X Developer License.

Examples

The following example shows you how to use the GetOverflowFormattedTextArea object to allow text of variable length to flow onto new pages as needed.

using System;
using ceTe.DynamicPDF;
using ceTe.DynamicPDF.PageElements;

public class Example
{
    public static void CreatePDF(string outputPath)
	{
		// Create a PDF Document
		Document document = new Document();

		// Create a string and assign it to text of variable length
		string variableText = "";
		for( int i = 0; i < 50; i++ )
			variableText += "<i>This</i> is a <font color='FF0000'>sentence</font> that I " +
			"will use as my <b>variable length</b> text. ";

		// Create an formatted text area
		FormattedTextArea formattedTextArea = new FormattedTextArea( variableText, 0, 0, 250, 200, FontFamily.Helvetica, 12, false ); 
	
		do
		{
			// Create a new page
			Page page = new Page();
 
			// Add the text area to the page;
			page.Elements.Add( formattedTextArea );

			// Add the page to the document
			document.Pages.Add( page );

			// Set the formatted text area object equal to the rest of the text that did not fit
			// if all the text did fit, GetOverflowFormattedTextArea will return null
			formattedTextArea = formattedTextArea.GetOverflowFormattedTextArea( 50, 50 ); 
		} while( formattedTextArea != null );
	
		// Save the PDF
		document.Draw( outputPath );
	}
}

Remarks

This method returns a new FormattedTextArea object that contains the remaining text that did not fit.

Returns a new FormattedTextArea object containing the overflow text.

public FormattedTextArea GetOverflowFormattedTextArea(float x, float y, float height)

Function GetOverflowFormattedTextArea(x As Single, y As Single, height As Single) As FormattedTextArea

Parameters

Returns

Licensing Info

This method is a full DynamicPDF Core Suite feature. One of the following is required for non-evaluation usage:

• An active DynamicPDF Ultimate Subscription
• An active DynamicPDF Professional or Professional Plus Subscription with DynamicPDF Core Suite selected.
• A DynamicPDF Core Suite for .NET v12.X Developer License.

Examples

The following example shows you how to use the GetOverflowFormattedTextArea object to allow text of variable length to flow onto new pages as needed.

using System;
using ceTe.DynamicPDF;
using ceTe.DynamicPDF.PageElements;

public class Example
{
    public static void CreatePDF(string outputPath)
	{
		// Create a PDF Document
		Document document = new Document();

		// Create a string and assign it to text of variable length
		string variableText = "";
		for( int i = 0; i < 50; i++ )
			variableText += "<i>This</i> is a <font color='FF0000'>sentence</font> that I " +
			"will use as my <b>variable length</b> text. ";

		// Create an formatted text area
		FormattedTextArea formattedTextArea = new FormattedTextArea( variableText, 0, 0, 250, 200, FontFamily.Helvetica, 12, false ); 
	
		do
		{
			// Create a new page
			Page page = new Page();
 
			// Add the text area to the page;
			page.Elements.Add( formattedTextArea );

			// Add the page to the document
			document.Pages.Add( page );

			// Set the formatted text area object equal to the rest of the text that did not fit
			// if all the text did fit, GetOverflowFormattedTextArea will return null
			formattedTextArea = formattedTextArea.GetOverflowFormattedTextArea( 50, 50, 100 ); 
		} while( formattedTextArea != null );
	
		// Save the PDF
		document.Draw( outputPath );
	}
}

Remarks

This method returns a new FormattedTextArea object that contains the remaining text that did not fit.