FormattedTextArea.GetOverflowFormattedTextArea

Overloads

GetOverflowFormattedTextArea()Returns a new FormattedTextArea object containing the overflow text.
GetOverflowFormattedTextArea(Single, Single)Returns a new FormattedTextArea object containing the overflow text.
GetOverflowFormattedTextArea(Single, Single, Single)Returns a new FormattedTextArea object containing the overflow text.

GetOverflowFormattedTextArea()

Returns a new FormattedTextArea object containing the overflow text.

public FormattedTextArea GetOverflowFormattedTextArea()
Function GetOverflowFormattedTextArea() As FormattedTextArea

Returns

FormattedTextArea

A FormattedTextArea if there is overflow text; otherwise, null .

Licensing Info

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

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.

GetOverflowFormattedTextArea(Single, Single)

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

x
Single

X coordinate of the new object.

y
Single

Y coordinate of the new object.

Returns

FormattedTextArea

A FormattedTextArea if there is overflow text; otherwise, null .

Licensing Info

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

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.

GetOverflowFormattedTextArea(Single, Single, Single)

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

x
Single

X coordinate of the new object.

y
Single

Y coordinate of the new object.

height
Single

Height of the new object.

Returns

FormattedTextArea

A FormattedTextArea if there is overflow text; otherwise, null .

Licensing Info

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

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.

See Also

FormattedTextArea
ceTe.DynamicPDF.PageElements

In this topic