Reading the values or properties of a field is a DynamicPDF Merger Standard Edition feature (for modifying field values see below). One of the following licenses is required for non-evaluation usage:
<list type="bullet">
<item>DynamicPDF Merger for .NET Standard Edition</item>
<item>DynamicPDF Merger for .NET Professional Edition</item>
<item>DynamicPDF Merger for .NET Enterprise Edition</item>
<item>DynamicPDF Core Suite for .NET Professional Edition</item>
<item>DynamicPDF Core Suite for .NET Enterprise Edition</item>
</list>
Modiying the values of the fields (i.e. form filling) is a Professional Edition Feature. One of the following licenses is required for non-evaluation usage:
<list type="bullet">
<item>DynamicPDF Merger for .NET Professional Edition</item>
<item>DynamicPDF Merger for .NET Enterprise Edition</item>
<item>DynamicPDF Core Suite for .NET Professional Edition</item>
<item>DynamicPDF Core Suite for .NET Enterprise Edition</item>
</list>
</licensing>
</member>
<member name="T:ceTe.DynamicPDF.Forms.FormField">
<summary>
Represents a PDF form field.
</summary>
<licensing>
Reading the values or properties of a field is a DynamicPDF Merger Standard Edition feature (for modifying field values see below). One of the following licenses is required for non-evaluation usage:
<list type="bullet">
<item>DynamicPDF Merger for .NET Standard Edition</item>
<item>DynamicPDF Merger for .NET Professional Edition</item>
<item>DynamicPDF Merger for .NET Enterprise Edition</item>
<item>DynamicPDF Core Suite for .NET Professional Edition</item>
<item>DynamicPDF Core Suite for .NET Enterprise Edition</item>
</list>
Modiying the values of the fields (i.e. form filling) is a Professional Edition Feature. One of the following licenses is required for non-evaluation usage:
<list type="bullet">
<item>DynamicPDF Merger for .NET Professional Edition</item>
<item>DynamicPDF Merger for .NET Enterprise Edition</item>
<item>DynamicPDF Core Suite for .NET Professional Edition</item>
<item>DynamicPDF Core Suite for .NET Enterprise Edition</item>
</list>
</licensing>
</member>
<member name="T:ceTe.DynamicPDF.Resource">
<summary>
Base class from which all resources are derived.
</summary>
<licensing>
This class is a DynamicPDF Generator Professional Edition feature. One of the following licenses is required for non-evaluation usage:
<list type="bullet">
<item>DynamicPDF Generator for .NET Professional Edition</item>
<item>DynamicPDF Generator for .NET Enterprise Edition</item>
<item>DynamicPDF Merger for .NET Professional Edition</item>
<item>DynamicPDF Merger for .NET Enterprise Edition</item>
<item>DynamicPDF ReportWriter for .NET Professional Edition</item>
<item>DynamicPDF ReportWriter for .NET Enterprise Edition</item>
<item>DynamicPDF Core Suite for .NET Professional Edition</item>
<item>DynamicPDF Core Suite for .NET Enterprise Edition</item>
</list>
</licensing>
</member>
<member name="M:ceTe.DynamicPDF.Resource.#ctor">
<summary>
Initializes a new instance of the <see cref="T:ceTe.DynamicPDF.Resource"/> class using the next UID.
Reading the values or properties of a field is a DynamicPDF Merger Standard Edition feature (for modifying field values see below). One of the following licenses is required for non-evaluation usage:
<list type="bullet">
<item>DynamicPDF Merger for .NET Standard Edition</item>
<item>DynamicPDF Merger for .NET Professional Edition</item>
<item>DynamicPDF Merger for .NET Enterprise Edition</item>
<item>DynamicPDF Core Suite for .NET Professional Edition</item>
<item>DynamicPDF Core Suite for .NET Enterprise Edition</item>
</list>
Modiying the values of the fields (i.e. form filling) is a Professional Edition Feature. One of the following licenses is required for non-evaluation usage:
<list type="bullet">
<item>DynamicPDF Merger for .NET Professional Edition</item>
<item>DynamicPDF Merger for .NET Enterprise Edition</item>
<item>DynamicPDF Core Suite for .NET Professional Edition</item>
<item>DynamicPDF Core Suite for .NET Enterprise Edition</item>
Reading the values or properties of a field is a DynamicPDF Merger Standard Edition feature (for modifying field values see below). One of the following licenses is required for non-evaluation usage:
<list type="bullet">
<item>DynamicPDF Merger for .NET Standard Edition</item>
<item>DynamicPDF Merger for .NET Professional Edition</item>
<item>DynamicPDF Merger for .NET Enterprise Edition</item>
<item>DynamicPDF Core Suite for .NET Professional Edition</item>
<item>DynamicPDF Core Suite for .NET Enterprise Edition</item>
</list>
Modiying the values of the fields (i.e. form filling) is a Professional Edition Feature. One of the following licenses is required for non-evaluation usage:
<list type="bullet">
<item>DynamicPDF Merger for .NET Professional Edition</item>
<item>DynamicPDF Merger for .NET Enterprise Edition</item>
<item>DynamicPDF Core Suite for .NET Professional Edition</item>
<item>DynamicPDF Core Suite for .NET Enterprise Edition</item>
Reading the values or properties of a field is a DynamicPDF Merger Standard Edition feature (for modifying field values see below). One of the following licenses is required for non-evaluation usage:
<list type="bullet">
<item>DynamicPDF Merger for .NET Standard Edition</item>
<item>DynamicPDF Merger for .NET Professional Edition</item>
<item>DynamicPDF Merger for .NET Enterprise Edition</item>
<item>DynamicPDF Core Suite for .NET Professional Edition</item>
<item>DynamicPDF Core Suite for .NET Enterprise Edition</item>
</list>
Modiying the values of the fields (i.e. form filling) is a Professional Edition Feature. One of the following licenses is required for non-evaluation usage:
<list type="bullet">
<item>DynamicPDF Merger for .NET Professional Edition</item>
<item>DynamicPDF Merger for .NET Enterprise Edition</item>
<item>DynamicPDF Core Suite for .NET Professional Edition</item>
<item>DynamicPDF Core Suite for .NET Enterprise Edition</item>
Reading the values or properties of a field is a DynamicPDF Merger Standard Edition feature (for modifying field values see below). One of the following licenses is required for non-evaluation usage:
<list type="bullet">
<item>DynamicPDF Merger for .NET Standard Edition</item>
<item>DynamicPDF Merger for .NET Professional Edition</item>
<item>DynamicPDF Merger for .NET Enterprise Edition</item>
<item>DynamicPDF Core Suite for .NET Professional Edition</item>
<item>DynamicPDF Core Suite for .NET Enterprise Edition</item>
</list>
Modiying the values of the fields (i.e. form filling) is a Professional Edition Feature. One of the following licenses is required for non-evaluation usage:
<list type="bullet">
<item>DynamicPDF Merger for .NET Professional Edition</item>
<item>DynamicPDF Merger for .NET Enterprise Edition</item>
<item>DynamicPDF Core Suite for .NET Professional Edition</item>
<item>DynamicPDF Core Suite for .NET Enterprise Edition</item>
Reading the values or properties of a field is a DynamicPDF Merger Standard Edition feature (for modifying field values see below). One of the following licenses is required for non-evaluation usage:
<list type="bullet">
<item>DynamicPDF Merger for .NET Standard Edition</item>
<item>DynamicPDF Merger for .NET Professional Edition</item>
<item>DynamicPDF Merger for .NET Enterprise Edition</item>
<item>DynamicPDF Core Suite for .NET Professional Edition</item>
<item>DynamicPDF Core Suite for .NET Enterprise Edition</item>
</list>
Modiying the values of the fields (i.e. form filling) is a Professional Edition Feature. One of the following licenses is required for non-evaluation usage:
<list type="bullet">
<item>DynamicPDF Merger for .NET Professional Edition</item>
<item>DynamicPDF Merger for .NET Enterprise Edition</item>
<item>DynamicPDF Core Suite for .NET Professional Edition</item>
<item>DynamicPDF Core Suite for .NET Enterprise Edition</item>
Provides data for the <see cref="P:ceTe.DynamicPDF.Forms.FormEventArgs.Form">Form's</see> FieldsAdded event.
</summary>
<licensing>
Reading the values or properties of a field is a DynamicPDF Merger Standard Edition feature (for modifying field values see below). One of the following licenses is required for non-evaluation usage:
<list type="bullet">
<item>DynamicPDF Merger for .NET Standard Edition</item>
<item>DynamicPDF Merger for .NET Professional Edition</item>
<item>DynamicPDF Merger for .NET Enterprise Edition</item>
<item>DynamicPDF Core Suite for .NET Professional Edition</item>
<item>DynamicPDF Core Suite for .NET Enterprise Edition</item>
</list>
Modiying the values of the fields (i.e. form filling) is a Professional Edition Feature. One of the following licenses is required for non-evaluation usage:
<list type="bullet">
<item>DynamicPDF Merger for .NET Professional Edition</item>
<item>DynamicPDF Merger for .NET Enterprise Edition</item>
<item>DynamicPDF Core Suite for .NET Professional Edition</item>
<item>DynamicPDF Core Suite for .NET Enterprise Edition</item>
Reading the values or properties of a field is a DynamicPDF Merger Standard Edition feature (for modifying field values see below). One of the following licenses is required for non-evaluation usage:
<list type="bullet">
<item>DynamicPDF Merger for .NET Standard Edition</item>
<item>DynamicPDF Merger for .NET Professional Edition</item>
<item>DynamicPDF Merger for .NET Enterprise Edition</item>
<item>DynamicPDF Core Suite for .NET Professional Edition</item>
<item>DynamicPDF Core Suite for .NET Enterprise Edition</item>
</list>
Modiying the values of the fields (i.e. form filling) is a Professional Edition Feature. One of the following licenses is required for non-evaluation usage:
<list type="bullet">
<item>DynamicPDF Merger for .NET Professional Edition</item>
<item>DynamicPDF Merger for .NET Enterprise Edition</item>
<item>DynamicPDF Core Suite for .NET Professional Edition</item>
<item>DynamicPDF Core Suite for .NET Enterprise Edition</item>
Represents the method that will handle the <see cref="E:ceTe.DynamicPDF.Forms.Form.FormFieldsAdded"/> event of the <see cref="T:ceTe.DynamicPDF.Forms.Form"/>.
</summary>
<param name="sender">Reference of type <see cref="T:System.Object"/>.</param>
<param name="e">Reference of type <see cref="T:ceTe.DynamicPDF.Forms.FormEventArgs"/>.</param>
Reading the values or properties of a field is a DynamicPDF Merger Standard Edition feature (for modifying field values see below). One of the following licenses is required for non-evaluation usage:
<list type="bullet">
<item>DynamicPDF Merger for .NET Standard Edition</item>
<item>DynamicPDF Merger for .NET Professional Edition</item>
<item>DynamicPDF Merger for .NET Enterprise Edition</item>
<item>DynamicPDF Core Suite for .NET Professional Edition</item>
<item>DynamicPDF Core Suite for .NET Enterprise Edition</item>
</list>
Modiying the values of the fields (i.e. form filling) is a Professional Edition Feature. One of the following licenses is required for non-evaluation usage:
<list type="bullet">
<item>DynamicPDF Merger for .NET Professional Edition</item>
<item>DynamicPDF Merger for .NET Enterprise Edition</item>
<item>DynamicPDF Core Suite for .NET Professional Edition</item>
<item>DynamicPDF Core Suite for .NET Enterprise Edition</item>
Reading the values or properties of a field is a DynamicPDF Merger Standard Edition feature (for modifying field values see below). One of the following licenses is required for non-evaluation usage:
<list type="bullet">
<item>DynamicPDF Merger for .NET Standard Edition</item>
<item>DynamicPDF Merger for .NET Professional Edition</item>
<item>DynamicPDF Merger for .NET Enterprise Edition</item>
<item>DynamicPDF Core Suite for .NET Professional Edition</item>
<item>DynamicPDF Core Suite for .NET Enterprise Edition</item>
</list>
Modiying the values of the fields (i.e. form filling) is a Professional Edition Feature. One of the following licenses is required for non-evaluation usage:
<list type="bullet">
<item>DynamicPDF Merger for .NET Professional Edition</item>
<item>DynamicPDF Merger for .NET Enterprise Edition</item>
<item>DynamicPDF Core Suite for .NET Professional Edition</item>
<item>DynamicPDF Core Suite for .NET Enterprise Edition</item>
Reading the values or properties of a field is a DynamicPDF Merger Standard Edition feature (for modifying field values see below). One of the following licenses is required for non-evaluation usage:
<list type="bullet">
<item>DynamicPDF Merger for .NET Standard Edition</item>
<item>DynamicPDF Merger for .NET Professional Edition</item>
<item>DynamicPDF Merger for .NET Enterprise Edition</item>
<item>DynamicPDF Core Suite for .NET Professional Edition</item>
<item>DynamicPDF Core Suite for .NET Enterprise Edition</item>
</list>
Modiying the values of the fields (i.e. form filling) is a Professional Edition Feature. One of the following licenses is required for non-evaluation usage:
<list type="bullet">
<item>DynamicPDF Merger for .NET Professional Edition</item>
<item>DynamicPDF Merger for .NET Enterprise Edition</item>
<item>DynamicPDF Core Suite for .NET Professional Edition</item>
<item>DynamicPDF Core Suite for .NET Enterprise Edition</item>
Reading the values or properties of a field is a DynamicPDF Merger Standard Edition feature (for modifying field values see below). One of the following licenses is required for non-evaluation usage:
<list type="bullet">
<item>DynamicPDF Merger for .NET Standard Edition</item>
<item>DynamicPDF Merger for .NET Professional Edition</item>
<item>DynamicPDF Merger for .NET Enterprise Edition</item>
<item>DynamicPDF Core Suite for .NET Professional Edition</item>
<item>DynamicPDF Core Suite for .NET Enterprise Edition</item>
</list>
Modiying the values of the fields (i.e. form filling) is a Professional Edition Feature. One of the following licenses is required for non-evaluation usage:
<list type="bullet">
<item>DynamicPDF Merger for .NET Professional Edition</item>
<item>DynamicPDF Merger for .NET Enterprise Edition</item>
<item>DynamicPDF Core Suite for .NET Professional Edition</item>
<item>DynamicPDF Core Suite for .NET Enterprise Edition</item>
Reading the values or properties of a field is a DynamicPDF Merger Standard Edition feature (for modifying field values see below). One of the following licenses is required for non-evaluation usage:
<list type="bullet">
<item>DynamicPDF Merger for .NET Standard Edition</item>
<item>DynamicPDF Merger for .NET Professional Edition</item>
<item>DynamicPDF Merger for .NET Enterprise Edition</item>
<item>DynamicPDF Core Suite for .NET Professional Edition</item>
<item>DynamicPDF Core Suite for .NET Enterprise Edition</item>
</list>
Modiying the values of the fields (i.e. form filling) is a Professional Edition Feature. One of the following licenses is required for non-evaluation usage:
<list type="bullet">
<item>DynamicPDF Merger for .NET Professional Edition</item>
<item>DynamicPDF Merger for .NET Enterprise Edition</item>
<item>DynamicPDF Core Suite for .NET Professional Edition</item>
<item>DynamicPDF Core Suite for .NET Enterprise Edition</item>
Transforms the coordinate space for the current area.
</summary>
<param name="x">The x coordinate of the area.</param>
<param name="y">The y coordinate of the area.</param>
<param name="width">The width of the area.</param>
<param name="height">The height of the area.</param>
<remarks>You must call <see cref="M:ceTe.DynamicPDF.IO.OperatorWriter.ResetDimensions"/> once you are done using the transformed coordinate space.</remarks>
Transforms the coordinate space for the current area.
</summary>
<param name="x">The x coordinate of the area.</param>
<param name="y">The y coordinate of the area.</param>
<param name="angle">The angle coordinate of the area.</param>
<remarks>You must call <see cref="M:ceTe.DynamicPDF.IO.OperatorWriter.ResetDimensions"/> once you are done using the transformed coordinate space.</remarks>
Transforms the coordinate space for the current area.
</summary>
<param name="x">The x coordinate of the area.</param>
<param name="y">The y coordinate of the area.</param>
<param name="xX">The XX value of the angle of the area.</param>
<param name="xY">The XY value of the angle of the area.</param>
<param name="yX">The YX value of the angle of the area.</param>
<param name="yY">The YY value of the angle of the area.</param>
<remarks>You must call <see cref="M:ceTe.DynamicPDF.IO.OperatorWriter.ResetDimensions"/> once you are done using the transformed coordinate space.</remarks>
Transforms the coordinate space for the current area.
</summary>
<param name="x">The x coordinate of the area.</param>
<param name="y">The y coordinate of the area.</param>
<param name="width">The width of the area.</param>
<param name="height">The height of the area.</param>
<param name="angle">The angle coordinate of the area.</param>
<remarks>You must call <see cref="M:ceTe.DynamicPDF.IO.OperatorWriter.ResetDimensions"/> once you are done using the transformed coordinate space.</remarks>
Transforms the coordinate space for the current area.
</summary>
<param name="x">The x coordinate of the area.</param>
<param name="y">The y coordinate of the area.</param>
<param name="width">The width of the area.</param>
<param name="height">The height of the area.</param>
<param name="xX">The XX value of the angle of the area.</param>
<param name="xY">The XY value of the angle of the area.</param>
<param name="yX">The YX value of the angle of the area.</param>
<param name="yY">The YY value of the angle of the area.</param>
<remarks>You must call <see cref="M:ceTe.DynamicPDF.IO.OperatorWriter.ResetDimensions"/> once you are done using the transformed coordinate space.</remarks>
Transforms the coordinate space for the current area.
</summary>
<param name="x">The x coordinate of the area.</param>
<param name="y">The y coordinate of the area.</param>
<param name="width">The width of the area.</param>
<param name="height">The height of the area.</param>
<param name="scaleX">The x scale of the area.</param>
<param name="scaleY">The y scale of the area.</param>
<remarks>You must call <see cref="M:ceTe.DynamicPDF.IO.OperatorWriter.ResetDimensions"/> once you are done using the transformed coordinate space.</remarks>
Transforms the coordinate space for the current area.
</summary>
<param name="x">The x coordinate of the area.</param>
<param name="y">The y coordinate of the area.</param>
<param name="width">The width of the area.</param>
<param name="height">The height of the area.</param>
<param name="angle">The angle coordinate of the area.</param>
<param name="scaleX">The x scale of the area.</param>
<param name="scaleY">The y scale of the area.</param>
<remarks>You must call <see cref="M:ceTe.DynamicPDF.IO.OperatorWriter.ResetDimensions"/> once you are done using the transformed coordinate space.</remarks>
Transforms the coordinate space for the current area.
</summary>
<param name="x">The x coordinate of the area.</param>
<param name="y">The y coordinate of the area.</param>
<param name="width">The width of the area.</param>
<param name="height">The height of the area.</param>
<param name="xX">The XX value of the angle of the area.</param>
<param name="xY">The XY value of the angle of the area.</param>
<param name="yX">The YX value of the angle of the area.</param>
<param name="yY">The YY value of the angle of the area.</param>
<param name="scaleX">The x scale of the area.</param>
<param name="scaleY">The y scale of the area.</param>
<remarks>You must call <see cref="M:ceTe.DynamicPDF.IO.OperatorWriter.ResetDimensions"/> once you are done using the transformed coordinate space.</remarks>
<param name="storeState"><b>true</b> if the <see cref="T:ceTe.DynamicPDF.IO.PageWriterState"/> should be stored for later retrieval by a "Q" operator.</param>
<param name="restoreState"><b>true</b> if the <see cref="T:ceTe.DynamicPDF.IO.PageWriterState"/> should be restored from a previous "q" operator.</param>
The exception that is thrown for a DynamicPDF Merger form filling error.
</summary>
<licensing>
Reading the values or properties of a field is a DynamicPDF Merger Standard Edition feature. One of the following licenses is required for non-evaluation usage:
<list type="bullet">
<item>DynamicPDF Merger for .NET Standard Edition</item>
<item>DynamicPDF Merger for .NET Professional Edition</item>
<item>DynamicPDF Merger for .NET Enterprise Edition</item>
<item>DynamicPDF Core Suite for .NET Professional Edition</item>
<item>DynamicPDF Core Suite for .NET Enterprise Edition</item>
Reading the values or properties of a field is a DynamicPDF Merger Standard Edition feature. One of the following licenses is required for non-evaluation usage:
<list type="bullet">
<item>DynamicPDF Merger for .NET Standard Edition</item>
<item>DynamicPDF Merger for .NET Professional Edition</item>
<item>DynamicPDF Merger for .NET Enterprise Edition</item>
<item>DynamicPDF Core Suite for .NET Professional Edition</item>
<item>DynamicPDF Core Suite for .NET Enterprise Edition</item>
Reading the values or properties of a field is a DynamicPDF Merger Standard Edition feature. One of the following licenses is required for non-evaluation usage:
<list type="bullet">
<item>DynamicPDF Merger for .NET Standard Edition</item>
<item>DynamicPDF Merger for .NET Professional Edition</item>
<item>DynamicPDF Merger for .NET Enterprise Edition</item>
<item>DynamicPDF Core Suite for .NET Professional Edition</item>
<item>DynamicPDF Core Suite for .NET Enterprise Edition</item>
Sets the position of a page element to the coordinates of the form field.
</summary>
<param name="pageElement">Page element whose coordinates should be set.</param>
<param name="page">Page that contains the page element.</param>
<remarks>The page element must implement <see cref="T:ceTe.DynamicPDF.PageElements.IArea"/> and/or <see cref="T:ceTe.DynamicPDF.PageElements.ICoordinate"/>
in order for it's coordinates to be set.</remarks>
Reading the values or properties of a field is a DynamicPDF Merger Standard Edition feature. One of the following licenses is required for non-evaluation usage:
<list type="bullet">
<item>DynamicPDF Merger for .NET Standard Edition</item>
<item>DynamicPDF Merger for .NET Professional Edition</item>
<item>DynamicPDF Merger for .NET Enterprise Edition</item>
<item>DynamicPDF Core Suite for .NET Professional Edition</item>
<item>DynamicPDF Core Suite for .NET Enterprise Edition</item>
Reading the values or properties of a field is a DynamicPDF Merger Standard Edition feature. One of the following licenses is required for non-evaluation usage:
<list type="bullet">
<item>DynamicPDF Merger for .NET Standard Edition</item>
<item>DynamicPDF Merger for .NET Professional Edition</item>
<item>DynamicPDF Merger for .NET Enterprise Edition</item>
<item>DynamicPDF Core Suite for .NET Professional Edition</item>
<item>DynamicPDF Core Suite for .NET Enterprise Edition</item>
Representing a collection of form fields in a PDF document.
</summary>
<licensing>
Reading the values or properties of a field is a DynamicPDF Merger Standard Edition feature. One of the following licenses is required for non-evaluation usage:
<list type="bullet">
<item>DynamicPDF Merger for .NET Standard Edition</item>
<item>DynamicPDF Merger for .NET Professional Edition</item>
<item>DynamicPDF Merger for .NET Enterprise Edition</item>
<item>DynamicPDF Core Suite for .NET Professional Edition</item>
<item>DynamicPDF Core Suite for .NET Enterprise Edition</item>
Reading the values or properties of a field is a DynamicPDF Merger Standard Edition feature. One of the following licenses is required for non-evaluation usage:
<list type="bullet">
<item>DynamicPDF Merger for .NET Standard Edition</item>
<item>DynamicPDF Merger for .NET Professional Edition</item>
<item>DynamicPDF Merger for .NET Enterprise Edition</item>
<item>DynamicPDF Core Suite for .NET Professional Edition</item>
<item>DynamicPDF Core Suite for .NET Enterprise Edition</item>
Reading the values or properties of a field is a DynamicPDF Merger Standard Edition feature. One of the following licenses is required for non-evaluation usage:
<list type="bullet">
<item>DynamicPDF Merger for .NET Standard Edition</item>
<item>DynamicPDF Merger for .NET Professional Edition</item>
<item>DynamicPDF Merger for .NET Enterprise Edition</item>
<item>DynamicPDF Core Suite for .NET Professional Edition</item>
<item>DynamicPDF Core Suite for .NET Enterprise Edition</item>
<font color="red">Obsolete.</font> Gets a collection or child outlines.
</summary>
<remarks><font color="red">NOTE: This property is now obsolete.</font> Use the <see cref="P:ceTe.DynamicPDF.Outline.ChildOutlines"/> property instead.</remarks>
PdfDocument pdfC = new PdfDocument( @"C:\MyDocumentC.pdf" );
document.Append( pdfC, 2, 1);
// Save the PDF
document.Draw( @"C:\MyDocument.pdf" );
}
}
</code>
</example>
<licensing>
This class is a DynamicPDF Merger Standard Edition feature (NOTE: Some properties require additional licensing and are noted accordingly). One of the following licenses is required for non-evaluation usage:
<list type="bullet">
<item>DynamicPDF Merger for .NET Standard Edition</item>
<item>DynamicPDF Merger for .NET Professional Edition</item>
<item>DynamicPDF Merger for .NET Enterprise Edition</item>
<item>DynamicPDF Core Suite for .NET Professional Edition</item>
<item>DynamicPDF Core Suite for .NET Enterprise Edition</item>
</list>
</licensing>
</member>
<member name="T:ceTe.DynamicPDF.Document">
<summary>
Represents a PDF Document.
</summary>
<remarks>
This is the primary class used to generate the Dynamic PDF document. It
represents a single PDF Document and is made up of Pages and Outlines.
The document can have a <see cref="P:ceTe.DynamicPDF.Document.Security"/> object associated with it
to control document security and encryption. The document can be output
to any object derived from the <see cref="T:System.IO.Stream"/> class that
supports writing and can easily be integrated with ASP.NET to stream the
document to Internet Information Server's HTTP output stream.
</remarks>
<example>This example shows how to use the document in the creation of a simple PDF document.<p/>
page.Elements.Add( new Label( "My PDF Document", 0, 0, 512, 40, Font.Helvetica, 30, TextAlign.Center ) );
// Save the PDF document to a byte array
byte[] pdfData = document.Draw();
}
}
</code>
</example>
<exception cref="T:ceTe.DynamicPDF.GeneratorException">The PDF could not be created because of an internal problem.</exception>
<exception cref="T:ceTe.DynamicPDF.Merger.MergerException">If you DynamicPDF Merger is being used and a merging error ocured.</exception>
<exception cref="T:ceTe.DynamicPDF.Merger.PdfParsingException">If you DynamicPDF Merger is being used and one of the input PDF files cannot be parsed because it is likely corrupt or invalid.</exception>
page.Elements.Add( new Label( "My PDF Document", 0, 0, 512, 40, Font.Helvetica, 30, TextAlign.Center ) );
// Save the PDF document
document.Draw( @"C:\MyDocument.pdf" );
}
}
</code>
</example>
<exception cref="T:ceTe.DynamicPDF.GeneratorException">The PDF could not be created because of an internal problem.</exception>
<exception cref="T:ceTe.DynamicPDF.Merger.MergerException">If you DynamicPDF Merger is being used and a merging error ocured.</exception>
<exception cref="T:ceTe.DynamicPDF.Merger.PdfParsingException">If you DynamicPDF Merger is being used and one of the input PDF files cannot be parsed because it is likely corrupt or invalid.</exception>
Dim outputStream As MemoryStream = New MemoryStream
' Output the PDF to the MemoryStream
MyDocument.Draw(outputStream)
End Sub
End Module
</code>
<code lang="C#">
using System;
using System.IO;
using ceTe.DynamicPDF;
using ceTe.DynamicPDF.PageElements;
class MyClass
{
static void Main()
{
// Create a PDF Document
Document document = new Document();
// Create a Page and add it to the document
Page page = new Page();
document.Pages.Add( page );
// Add a label to the page
page.Elements.Add( new Label( "My PDF Document", 0, 0, 512, 40, Font.Helvetica, 30, TextAlign.Center ) );
// Create a memory stream object to save to
MemoryStream outputStream = new MemoryStream();
// Output the PDF to the MemoryStream
document.Draw( outputStream );
}
}
</code>
</example>
<exception cref="T:ceTe.DynamicPDF.GeneratorException">The PDF could not be created because of an internal problem.</exception>
<exception cref="T:ceTe.DynamicPDF.Merger.MergerException">If you DynamicPDF Merger is being used and a merging error ocured.</exception>
<exception cref="T:ceTe.DynamicPDF.Merger.PdfParsingException">If you DynamicPDF Merger is being used and one of the input PDF files cannot be parsed because it is likely corrupt or invalid.</exception>
#if NET20
<exception cref="T:ceTe.DynamicPDF.TimestampException">If there was failure in the connection or if there is no Timestamp Info present.</exception>
page.Elements.Add( new Label( "My PDF Document", 0, 0, 512, 40, Font.Helvetica, 30, TextAlign.Center ) );
// Save the PDF document
document.DrawToWeb();
}
}
</code>
</example>
<exception cref="T:ceTe.DynamicPDF.GeneratorException">The PDF could not be created because of an internal problem.</exception>
<exception cref="T:ceTe.DynamicPDF.Merger.MergerException">If you DynamicPDF Merger is being used and a merging error ocured.</exception>
<exception cref="T:ceTe.DynamicPDF.Merger.PdfParsingException">If you DynamicPDF Merger is being used and one of the input PDF files cannot be parsed because it is likely corrupt or invalid.</exception>
This method is a DynamicPDF WebCache or DynamicPDF Generator Enterprise Edition feature. One of the following licenses is required for non-evaluation usage:
<list type="bullet">
<item>DynamicPDF WebCache for .NET</item>
<item>DynamicPDF Generator for .NET Enterprise Edition</item>
<item>DynamicPDF Merger for .NET Enterprise Edition</item>
<item>DynamicPDF ReportWriter for .NET Enterprise Edition</item>
<item>DynamicPDF Core Suite for .NET Enterprise Edition</item>
</list>
</licensing>
<exception cref="T:ceTe.DynamicPDF.GeneratorException">The PDF could not be created because of an internal problem.</exception>
<exception cref="T:ceTe.DynamicPDF.Merger.MergerException">If you DynamicPDF Merger is being used and a merging error ocured.</exception>
<exception cref="T:ceTe.DynamicPDF.Merger.PdfParsingException">If you DynamicPDF Merger is being used and one of the input PDF files cannot be parsed because it is likely corrupt or invalid.</exception>
page.Elements.Add( new Label( "My PDF Document", 0, 0, 512, 40, Font.Helvetica, 30, TextAlign.Center ) );
// Save the PDF document
document.DrawToWeb( true );
}
}
</code>
</example>
<exception cref="T:ceTe.DynamicPDF.GeneratorException">The PDF could not be created because of an internal problem.</exception>
<exception cref="T:ceTe.DynamicPDF.Merger.MergerException">If you DynamicPDF Merger is being used and a merging error ocured.</exception>
<exception cref="T:ceTe.DynamicPDF.Merger.PdfParsingException">If you DynamicPDF Merger is being used and one of the input PDF files cannot be parsed because it is likely corrupt or invalid.</exception>
page.Elements.Add( new Label( "My PDF Document", 0, 0, 512, 40, Font.Helvetica, 30, TextAlign.Center ) );
// Save the PDF document
document.DrawToWeb( "MyDocument.pdf" );
}
}
</code>
</example>
<exception cref="T:ceTe.DynamicPDF.GeneratorException">The PDF could not be created because of an internal problem.</exception>
<exception cref="T:ceTe.DynamicPDF.Merger.MergerException">If you DynamicPDF Merger is being used and a merging error ocured.</exception>
<exception cref="T:ceTe.DynamicPDF.Merger.PdfParsingException">If you DynamicPDF Merger is being used and one of the input PDF files cannot be parsed because it is likely corrupt or invalid.</exception>
page.Elements.Add( new Label( "My PDF Document", 0, 0, 512, 40, Font.Helvetica, 30, TextAlign.Center ) );
// Save the PDF document
document.DrawToWeb( "MyDocument.pdf", true );
}
}
</code>
</example>
<exception cref="T:ceTe.DynamicPDF.GeneratorException">The PDF could not be created because of an internal problem.</exception>
<exception cref="T:ceTe.DynamicPDF.Merger.MergerException">If you DynamicPDF Merger is being used and a merging error ocured.</exception>
<exception cref="T:ceTe.DynamicPDF.Merger.PdfParsingException">If you DynamicPDF Merger is being used and one of the input PDF files cannot be parsed because it is likely corrupt or invalid.</exception>
<exception cref="T:ceTe.DynamicPDF.GeneratorException">The PDF could not be created because of an internal problem.</exception>
<exception cref="T:ceTe.DynamicPDF.Merger.MergerException">If you DynamicPDF Merger is being used and a merging error ocured.</exception>
<exception cref="T:ceTe.DynamicPDF.Merger.PdfParsingException">If you DynamicPDF Merger is being used and one of the input PDF files cannot be parsed because it is likely corrupt or invalid.</exception>
Gets or sets a <see cref="P:ceTe.DynamicPDF.Document.Template"/> object for the <b>Document</b>. All page elements within this Template will appear in the background of the other contents of the PDF.
Gets or sets a <see cref="P:ceTe.DynamicPDF.Document.Template"/> object for the <b>Document</b>. All page elements within this Template will appear in the foreground of the other contents of the PDF.
<font color="red">Obsolete.</font> Gets the prepress settings for the document.
</summary>
<remarks><font color="red">NOTE: This method is now obsolete.</font> Use the <see cref="P:ceTe.DynamicPDF.Document.OutputIntents"/> and <see cref="P:ceTe.DynamicPDF.Document.PdfXVersion"/> properties instead.</remarks>
<licensing>
This property is a DynamicPDF Generator Enterprise Edition feature. One of the following licenses is required for non-evaluation usage:
<list type="bullet">
<item>DynamicPDF Generator for .NET Enterprise Edition</item>
<item>DynamicPDF Merger for .NET Enterprise Edition</item>
<item>DynamicPDF ReportWriter for .NET Enterprise Edition</item>
<item>DynamicPDF Core Suite for .NET Enterprise Edition</item>
Gets or sets an object to control the security and encryption of the <b>Document</b>.
</summary>
<remarks>This object controls the encryption and security of the generated PDF document.</remarks>
<example>The following example will set the high security of the document so that the anyone who logs in
with the user password will not be able to print at high resolution, edit or add annotations or form fields, or access this document from other accessibility programs.<p/>
<code lang="VB">
Imports System
Imports ceTe.DynamicPDF
Imports ceTe.DynamicPDF.PageElements
Module MyModule
Sub Main()
' Create a PDF Document
Dim MyDocument As Document = New Document
' Create a Page and add it to the document
Dim MyPage As Page = New Page
MyDocument.Pages.Add(MyPage)
' Create a high security object
Dim security As HighSecurity = New HighSecurity("owner", "user")
' Set the permissions on that security object
security.AllowAccessibility = False
security.AllowDocumentAssembly = False
security.AllowHighResolutionPrinting = False
' Add the security object to the document
MyDocument.Security = security
' Create and display a label as a reference
Dim text As String = "This document has been encrypted with 128 bit encryption."
This property is a DynamicPDF Generator Enterprise Edition feature. One of the following licenses is required for non-evaluation usage:
<list type="bullet">
<item>DynamicPDF Generator for .NET Enterprise Edition</item>
<item>DynamicPDF Merger for .NET Enterprise Edition</item>
<item>DynamicPDF ReportWriter for .NET Enterprise Edition</item>
<item>DynamicPDF Core Suite for .NET Enterprise Edition</item>
</list>
</licensing>
</member>
<member name="P:ceTe.DynamicPDF.Document.Form">
<summary>
Gets or sets a form object for the PDF document.
</summary>
<licensing>
Reading the values or properties of a field is a DynamicPDF Merger Standard Edition feature (for modifying field values see below). One of the following licenses is required for non-evaluation usage:
<list type="bullet">
<item>DynamicPDF Merger for .NET Standard Edition</item>
<item>DynamicPDF Merger for .NET Professional Edition</item>
<item>DynamicPDF Merger for .NET Enterprise Edition</item>
<item>DynamicPDF Core Suite for .NET Professional Edition</item>
<item>DynamicPDF Core Suite for .NET Enterprise Edition</item>
</list>
Modiying the values of the fields (i.e. form filling) is a Professional Edition Feature. One of the following licenses is required for non-evaluation usage:
<list type="bullet">
<item>DynamicPDF Merger for .NET Professional Edition</item>
<item>DynamicPDF Merger for .NET Enterprise Edition</item>
<item>DynamicPDF Core Suite for .NET Professional Edition</item>
<item>DynamicPDF Core Suite for .NET Enterprise Edition</item>
Initializes a new instance of the <see cref="T:ceTe.DynamicPDF.Merger.MergeDocument"/> class.
</summary>
<param name="filePath">The physical file path of the PDF to import.</param>
<exception cref="T:ceTe.DynamicPDF.Merger.PdfParsingException">The PDF file cannot be parsed because it is likely corrupt or invalid.</exception>
<exception cref="T:ceTe.DynamicPDF.Merger.PdfSecurityException">The PDF file cannot be read because it is encrypted and the owner password is incorrect or not supplied.</exception>
Initializes a new instance of the <see cref="T:ceTe.DynamicPDF.Merger.MergeDocument"/> class.
</summary>
<param name="pdfDocument">The <see cref="T:ceTe.DynamicPDF.Merger.PdfDocument"/> to import.</param>
<exception cref="T:ceTe.DynamicPDF.Merger.PdfParsingException">The PDF file cannot be parsed because it is likely corrupt or invalid.</exception>
<exception cref="T:ceTe.DynamicPDF.Merger.PdfSecurityException">The PDF file cannot be read because it is encrypted and the owner password is incorrect or not supplied.</exception>
Initializes a new instance of the <see cref="T:ceTe.DynamicPDF.Merger.MergeDocument"/> class.
</summary>
<param name="filePath">The physical file path of the PDF to import.</param>
<param name="options">A <see cref="T:ceTe.DynamicPDF.Merger.MergeOptions"/> object specifying the merge options.</param>
<exception cref="T:ceTe.DynamicPDF.Merger.PdfParsingException">The PDF file cannot be parsed because it is likely corrupt or invalid.</exception>
<exception cref="T:ceTe.DynamicPDF.Merger.PdfSecurityException">The PDF file cannot be read because it is encrypted and the owner password is incorrect or not supplied.</exception>
Initializes a new instance of the <see cref="T:ceTe.DynamicPDF.Merger.MergeDocument"/> class.
</summary>
<param name="filePath">The physical file path of the PDF to import.</param>
<param name="startPage">The page to start importing from.</param>
<param name="pageCount">The number of pages to import.</param>
<exception cref="T:ceTe.DynamicPDF.Merger.PdfParsingException">The PDF file cannot be parsed because it is likely corrupt or invalid.</exception>
<exception cref="T:ceTe.DynamicPDF.Merger.PdfSecurityException">The PDF file cannot be read because it is encrypted and the owner password is incorrect or not supplied.</exception>
Initializes a new instance of the <see cref="T:ceTe.DynamicPDF.Merger.MergeDocument"/> class.
</summary>
<param name="filePath">The physical file path of the PDF to import.</param>
<param name="startPage">The page to start importing from.</param>
<param name="pageCount">The number of pages to import.</param>
<param name="options">A <see cref="T:ceTe.DynamicPDF.Merger.MergeOptions"/> object specifying the merge options.</param>
<exception cref="T:ceTe.DynamicPDF.Merger.PdfParsingException">The PDF file cannot be parsed because it is likely corrupt or invalid.</exception>
<exception cref="T:ceTe.DynamicPDF.Merger.PdfSecurityException">The PDF file cannot be read because it is encrypted and the owner password is incorrect or not supplied.</exception>
<param name="filePath">The physical file path of the PDF to import.</param>
<returns>An array of <see cref="T:ceTe.DynamicPDF.Merger.AppendedPage"/>s that were appended to the document.</returns>
<exception cref="T:ceTe.DynamicPDF.Merger.PdfParsingException">The PDF file cannot be parsed because it is likely corrupt or invalid.</exception>
<exception cref="T:ceTe.DynamicPDF.Merger.PdfSecurityException">The PDF file cannot be read because it is encrypted and the owner password is incorrect or not supplied.</exception>
<param name="filePath">The physical file path of the PDF to import.</param>
<param name="options">A <see cref="T:ceTe.DynamicPDF.Merger.MergeOptions"/> object specifying the merge options.</param>
<returns>An array of <see cref="T:ceTe.DynamicPDF.Merger.AppendedPage"/>s that were appended to the document.</returns>
<exception cref="T:ceTe.DynamicPDF.Merger.PdfParsingException">The PDF file cannot be parsed because it is likely corrupt or invalid.</exception>
<exception cref="T:ceTe.DynamicPDF.Merger.PdfSecurityException">The PDF file cannot be read because it is encrypted and the owner password is incorrect or not supplied.</exception>
<param name="filePath">The physical file path of the PDF to import.</param>
<param name="startPage">The page to start importing from.</param>
<param name="pageCount">The number of pages to import.</param>
<returns>An array of <see cref="T:ceTe.DynamicPDF.Merger.AppendedPage"/>s that were appended to the document.</returns>
<exception cref="T:ceTe.DynamicPDF.Merger.PdfParsingException">The PDF file cannot be parsed because it is likely corrupt or invalid.</exception>
<exception cref="T:ceTe.DynamicPDF.Merger.PdfSecurityException">The PDF file cannot be read because it is encrypted and the owner password is incorrect or not supplied.</exception>
<param name="filePath">The physical file path of the PDF to import.</param>
<param name="startPage">The page to start importing from.</param>
<param name="pageCount">The number of pages to import.</param>
<param name="options">A <see cref="T:ceTe.DynamicPDF.Merger.MergeOptions"/> object specifying the merge options.</param>
<returns>An array of <see cref="T:ceTe.DynamicPDF.Merger.AppendedPage"/>s that were appended to the document.</returns>
<exception cref="T:ceTe.DynamicPDF.Merger.PdfParsingException">The PDF file cannot be parsed because it is likely corrupt or invalid.</exception>
<exception cref="T:ceTe.DynamicPDF.Merger.PdfSecurityException">The PDF file cannot be read because it is encrypted and the owner password is incorrect or not supplied.</exception>
<param name="firstDocumentFilePath">The physical file path to the first PDF document.</param>
<param name="secondDocumentFilePath">The physical file path to the second PDF document.</param>
<returns>A <see cref="T:ceTe.DynamicPDF.Merger.MergeDocument"/> containing the pages from both PDF documents.</returns>
<exception cref="T:ceTe.DynamicPDF.Merger.PdfParsingException">One or both of the PDF files cannot be parsed because they are likely corrupt or invalid.</exception>
<exception cref="T:ceTe.DynamicPDF.Merger.PdfSecurityException">One or both of the PDF files cannot be read because they are encrypted and the owner password is incorrect or not supplied.</exception>
<param name="firstDocument">A <see cref="T:ceTe.DynamicPDF.Merger.PdfDocument"/> class representing the first PDF document.</param>
<param name="secondDocument">A <see cref="T:ceTe.DynamicPDF.Merger.PdfDocument"/> class representing the second PDF document.</param>
<returns>A <see cref="T:ceTe.DynamicPDF.Merger.MergeDocument"/> containing the pages from both PDF documents.</returns>
<exception cref="T:ceTe.DynamicPDF.Merger.PdfParsingException">One or both of the PDF files cannot be parsed because they are likely corrupt or invalid.</exception>
<param name="firstDocumentFilePath">The physical file path to the first PDF document.</param>
<param name="firstDocumentOptions">A <see cref="T:ceTe.DynamicPDF.Merger.MergeOptions"/> object specifying the merge options for the first PDF document.</param>
<param name="secondDocumentFilePath">The physical file path to the second PDF document.</param>
<param name="secondDocumentOptions">A <see cref="T:ceTe.DynamicPDF.Merger.MergeOptions"/> object specifying the merge options for the second PDF document.</param>
<returns>A <see cref="T:ceTe.DynamicPDF.Merger.MergeDocument"/> containing the pages from both PDF documents.</returns>
<exception cref="T:ceTe.DynamicPDF.Merger.PdfParsingException">One or both of the PDF files cannot be parsed because they are likely corrupt or invalid.</exception>
<exception cref="T:ceTe.DynamicPDF.Merger.PdfSecurityException">One or both of the PDF files cannot be read because they are encrypted and the owner password is incorrect or not supplied.</exception>
<param name="firstDocument">A <see cref="T:ceTe.DynamicPDF.Merger.PdfDocument"/> class representing the first PDF document.</param>
<param name="firstDocumentOptions">A <see cref="T:ceTe.DynamicPDF.Merger.MergeOptions"/> object specifying the merge options for the first PDF document.</param>
<param name="secondDocument">A <see cref="T:ceTe.DynamicPDF.Merger.PdfDocument"/> class representing the second PDF document.</param>
<param name="secondDocumentOptions">A <see cref="T:ceTe.DynamicPDF.Merger.MergeOptions"/> object specifying the merge options for the second PDF document.</param>
<returns>A <see cref="T:ceTe.DynamicPDF.Merger.MergeDocument"/> containing the pages from both PDF documents.</returns>
<exception cref="T:ceTe.DynamicPDF.Merger.PdfParsingException">One or both of the PDF files cannot be parsed because they are likely corrupt or invalid.</exception>
<font color="red">Obsolete.</font> Gets or sets a value indicating if prepress data should be imported.
</summary>
<remarks><font color="red">NOTE: This property is now obsolete.</font> Use the <see cref="P:ceTe.DynamicPDF.Merger.MergeOptions.OutputIntent"/> property instead.</remarks>
Initializes a new instance of the <see cref="T:ceTe.DynamicPDF.Merger.PdfDocument"/> class.
</summary>
<param name="stream"><see cref="T:System.IO.Stream"/> object containing the PDF document data.</param>
<exception cref="T:ceTe.DynamicPDF.Merger.PdfParsingException">The PDF file cannot be parsed because it is likely corrupt or invalid.</exception>
<exception cref="T:ceTe.DynamicPDF.Merger.PdfSecurityException">The PDF file cannot be read because it is encrypted and the owner password is incorrect or not supplied.</exception>
<licensing>
This class is a DynamicPDF Merger Standard Edition feature. One of the following licenses is required for non-evaluation usage:
<list type="bullet">
<item>DynamicPDF Merger for .NET Standard Edition</item>
<item>DynamicPDF Merger for .NET Professional Edition</item>
<item>DynamicPDF Merger for .NET Enterprise Edition</item>
<item>DynamicPDF Core Suite for .NET Professional Edition</item>
<item>DynamicPDF Core Suite for .NET Enterprise Edition</item>
Initializes a new instance of the <see cref="T:ceTe.DynamicPDF.Merger.PdfDocument"/> class.
</summary>
<param name="data">A byte array containing the PDF document data.</param>
<exception cref="T:ceTe.DynamicPDF.Merger.PdfParsingException">The PDF file cannot be parsed because it is likely corrupt or invalid.</exception>
<exception cref="T:ceTe.DynamicPDF.Merger.PdfSecurityException">The PDF file cannot be read because it is encrypted and the owner password is incorrect or not supplied.</exception>
<licensing>
This class is a DynamicPDF Merger Standard Edition feature. One of the following licenses is required for non-evaluation usage:
<list type="bullet">
<item>DynamicPDF Merger for .NET Standard Edition</item>
<item>DynamicPDF Merger for .NET Professional Edition</item>
<item>DynamicPDF Merger for .NET Enterprise Edition</item>
<item>DynamicPDF Core Suite for .NET Professional Edition</item>
<item>DynamicPDF Core Suite for .NET Enterprise Edition</item>
Initializes a new instance of the <see cref="T:ceTe.DynamicPDF.Merger.PdfDocument"/> class.
</summary>
<param name="filePath">Physical file path of the PDF document.</param>
<exception cref="T:ceTe.DynamicPDF.Merger.PdfParsingException">The PDF file cannot be parsed because it is likely corrupt or invalid.</exception>
<exception cref="T:ceTe.DynamicPDF.Merger.PdfSecurityException">The PDF file cannot be read because it is encrypted and the owner password is incorrect or not supplied.</exception>
<licensing>
This class is a DynamicPDF Merger Standard Edition feature. One of the following licenses is required for non-evaluation usage:
<list type="bullet">
<item>DynamicPDF Merger for .NET Standard Edition</item>
<item>DynamicPDF Merger for .NET Professional Edition</item>
<item>DynamicPDF Merger for .NET Enterprise Edition</item>
<item>DynamicPDF Core Suite for .NET Professional Edition</item>
<item>DynamicPDF Core Suite for .NET Enterprise Edition</item>
Initializes a new instance of the <see cref="T:ceTe.DynamicPDF.Merger.PdfDocument"/> class.
</summary>
<param name="stream"><see cref="T:System.IO.Stream"/> object containing the PDF document data.</param>
<param name="password">Owner password of the encrypted PDF document.</param>
<exception cref="T:ceTe.DynamicPDF.Merger.PdfParsingException">The PDF file cannot be parsed because it is likely corrupt or invalid.</exception>
<exception cref="T:ceTe.DynamicPDF.Merger.PdfSecurityException">The PDF file cannot be read because it is encrypted and the owner password is incorrect or not supplied.</exception>
<licensing>
This class is a DynamicPDF Merger Standard Edition feature. One of the following licenses is required for non-evaluation usage:
<list type="bullet">
<item>DynamicPDF Merger for .NET Standard Edition</item>
<item>DynamicPDF Merger for .NET Professional Edition</item>
<item>DynamicPDF Merger for .NET Enterprise Edition</item>
<item>DynamicPDF Core Suite for .NET Professional Edition</item>
<item>DynamicPDF Core Suite for .NET Enterprise Edition</item>
Initializes a new instance of the <see cref="T:ceTe.DynamicPDF.Merger.PdfDocument"/> class.
</summary>
<param name="data">A byte array containing the PDF document data.</param>
<param name="password">Owner password of the encrypted PDF document.</param>
<exception cref="T:ceTe.DynamicPDF.Merger.PdfParsingException">The PDF file cannot be parsed because it is likely corrupt or invalid.</exception>
<exception cref="T:ceTe.DynamicPDF.Merger.PdfSecurityException">The PDF file cannot be read because it is encrypted and the owner password is incorrect or not supplied.</exception>
<licensing>
This class is a DynamicPDF Merger Standard Edition feature. One of the following licenses is required for non-evaluation usage:
<list type="bullet">
<item>DynamicPDF Merger for .NET Standard Edition</item>
<item>DynamicPDF Merger for .NET Professional Edition</item>
<item>DynamicPDF Merger for .NET Enterprise Edition</item>
<item>DynamicPDF Core Suite for .NET Professional Edition</item>
<item>DynamicPDF Core Suite for .NET Enterprise Edition</item>
Initializes a new instance of the <see cref="T:ceTe.DynamicPDF.Merger.PdfDocument"/> class.
</summary>
<param name="filePath">Physical file path of the PDF document.</param>
<param name="password">Owner password of the encrypted PDF document.</param>
<exception cref="T:ceTe.DynamicPDF.Merger.PdfParsingException">The PDF file cannot be parsed because it is likely corrupt or invalid.</exception>
<exception cref="T:ceTe.DynamicPDF.Merger.PdfSecurityException">The PDF file cannot be read because it is encrypted and the owner password is incorrect or not supplied.</exception>
<licensing>
This class is a DynamicPDF Merger Standard Edition feature. One of the following licenses is required for non-evaluation usage:
<list type="bullet">
<item>DynamicPDF Merger for .NET Standard Edition</item>
<item>DynamicPDF Merger for .NET Professional Edition</item>
<item>DynamicPDF Merger for .NET Enterprise Edition</item>
<item>DynamicPDF Core Suite for .NET Professional Edition</item>
<item>DynamicPDF Core Suite for .NET Enterprise Edition</item>
Gets a new instance of the <see cref="T:ceTe.DynamicPDF.PageElements.BarCoding.MacroPdf417"/> class.
</summary>
<returns>Returns a <see cref="T:ceTe.DynamicPDF.PageElements.BarCoding.MacroPdf417"/> object.</returns>
<remarks>This method returns a new <b>MacroPdf417</b> object that contains the remaining data that did not fit.</remarks>
<example>The following example shows you how to use the GetOverflowMacroPdf417 method to allow MacroPdf417 bar codes to flow onto new pages as needed.<p/>
<code lang="VB">
Imports System
Imports System.IO;
Imports ceTe.DynamicPDF
Imports ceTe.DynamicPDF.PageElements.BarCoding
Module MyModule
Sub Main()
' Create a PDF Document
Dim MyDocument As Document = New Document
Dim bytArry(100) As Byte
Try
Dim fs As FileStream = New FileStream("C:/Textdata.txt", FileMode.Open)
Dim avail As Integer = CType(fi.Length,Integer)
ReDim bytArry(avial)
fs.Read(bytArry, 0, avial)
fs.Close()
Catch e As System.Exception
Console.WriteLine("EXCEPTION")
End Try
Dim x As Single
x = 10
Dim y As Single
y = 10
' Create a MacroPdf417 bar code
Dim macroPdf417 As MacroPdf417 = New MacroPdf417(bytArry, x, y, 14, 0.5F)
Gets a new instance of the <see cref="T:ceTe.DynamicPDF.PageElements.BarCoding.MacroPdf417"/> class.
</summary>
<param name="x">The X coordinate of the macro PDF417 bar code.</param>
<param name="y">The Y coordinate of the macro PDF417 bar code.</param>
<returns>Returns a <see cref="T:ceTe.DynamicPDF.PageElements.BarCoding.MacroPdf417"/> object.</returns>
<remarks>This method returns a new <b>MacroPdf417</b> object that contains the remaining data that did not fit.</remarks>
<example>The following example shows you how to use the GetOverflowMacroPdf417 method with x and y co ordinates to allow MacroPdf417 bar codes to flow onto new pages as needed.<p/>
<code lang="VB">
Imports System
Imports System.IO;
Imports ceTe.DynamicPDF
Imports ceTe.DynamicPDF.PageElements.BarCoding
Module MyModule
Sub Main()
' Create a PDF Document
Dim MyDocument As Document = New Document
' Create a Page and add it to the document
Dim MyPage As Page = New Page
MyDocument.Pages.Add(MyPage)
Dim bytArry(100) As Byte
Try
Dim fs As FileStream = New FileStream("C:/Textdata.txt", FileMode.Open)
Dim avail As Integer = CType(fi.Length,Integer)
ReDim bytArry(avail)
fs.Read(bytArry, 0, avail)
fs.Close()
Catch e As System.Exception
Console.WriteLine("EXCEPTION")
End Try
Dim x As Single
x = 10
Dim y As Single
y = 10
' Create a MacroPdf417 bar code
Dim macroPdf417 As MacroPdf417 = New MacroPdf417(bytArry, x, y, 14, 0.5F)
Gets or sets the <see cref="P:ceTe.DynamicPDF.PageElements.Charting.Axes.XAxis.XAxisAnchorType"/> enumeration that specifies the position of the XAxis.
Gets or sets the <see cref="P:ceTe.DynamicPDF.PageElements.Charting.Axes.XAxis.XAxisAnchorType"/> enumeration that specifies the position of the XAxis.
Gets or sets <see cref="P:ceTe.DynamicPDF.PageElements.Charting.Axes.DateTimeXAxis.DateTimeType"/> enumeration that specifies the DateTimeType of the DateTimeXAxis.
Adds a <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Axes.DateTimeXAxisLabel"/> to the end of the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Axes.DateTimeXAxisLabelList"/> object.
</summary>
<param name="dateTimeAxisLabel">The <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Axes.DateTimeXAxisLabel"/> to be added to the end of the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Axes.DateTimeXAxisLabelList"/>.</param>
Gets or sets the <see cref="P:ceTe.DynamicPDF.PageElements.Charting.Axes.DateTimeYAxis.DateTimeType"/> enumeration that specifies the DateTimeType of the DateTimeYAxis.
Adds a <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Axes.DateTimeYAxisLabel"/> to the end of the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Axes.DateTimeYAxisLabelList"/> object.
</summary>
<param name="dateTimeYAxisLabel">the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Axes.DateTimeYAxisLabel"/> to be added to the end of the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Axes.DateTimeYAxisLabelList"/>.</param>
Adds an <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Axes.IndexedXAxisLabel"/> to the end of the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Axes.IndexedXAxisLabelList"/> object.
</summary>
<param name="indexedXAxisLabel">The <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Axes.IndexedXAxisLabel"/> to be added to the end of the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Axes.IndexedXAxisLabelList"/>.</param>
Adds an <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Axes.IndexedYAxisLabel"/> to the end of the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Axes.IndexedYAxisLabelList"/> object.
</summary>
<param name="indexedYAxisLabel">The <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Axes.IndexedYAxisLabel"/> to be added to the end of the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Axes.IndexedYAxisLabelList"/>.</param>
Adds a <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Axes.NumericXAxisLabel"/> to the end of the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Axes.NumericXAxisLabelList"/> object.
</summary>
<param name="numericXAxisLabel">The<see cref="T:ceTe.DynamicPDF.PageElements.Charting.Axes.NumericXAxisLabel"/> to be added to the end of the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Axes.NumericXAxisLabelList"/>.</param>
Adds a <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Axes.NumericYAxisLabel"/>to the end of the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Axes.NumericYAxisLabelList"/> object.
</summary>
<param name="numericYAxisLabel">The<see cref="T:ceTe.DynamicPDF.PageElements.Charting.Axes.NumericYAxisLabel"/> to be added to the end of the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Axes.NumericYAxisLabelList"/>.</param>
Adds a <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Axes.PercentageXAxisLabel"/> to the end of the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Axes.PercentageXAxisLabelList"/> object.
</summary>
<param name="percentageXAxisLabel">The<see cref="T:ceTe.DynamicPDF.PageElements.Charting.Axes.PercentageXAxisLabel"/> to be added to the end of the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Axes.PercentageXAxisLabelList"/>.</param>
Adds a <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Axes.PercentageYAxisLabel"/> to the end of the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Axes.PercentageYAxisLabelList"/> object.
</summary>
<param name="percentageAxisLabel">The <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Axes.PercentageYAxisLabel"/> to be added to the end of the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Axes.PercentageYAxisLabelList"/>.</param>
Gets or sets the <see cref="P:ceTe.DynamicPDF.PageElements.Charting.GridLines.LineStyle"/> enumeration that specifies the line style of the grid lines.
Adds an <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Axes.XAxis"/> to the end of the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Axes.XAxisList"/> object.
</summary>
<param name="xAxis">The <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Axes.XAxis"/> to be displayed in the plot area.</param>
Gets or sets the <see cref="P:ceTe.DynamicPDF.PageElements.Charting.Axes.XAxisList.NumericXAxis"/> object to use for the default numeric xAxis of the plot area.
Gets or sets the <see cref="P:ceTe.DynamicPDF.PageElements.Charting.Axes.XAxisList.IndexedXAxis"/> object to use for the default indexed xAxis of the plot area.
Gets or sets the <see cref="P:ceTe.DynamicPDF.PageElements.Charting.Axes.XAxisList.DateTimeXAxis"/> object to use for the default dateTime xAxis of the plot area.
Gets or sets the <see cref="P:ceTe.DynamicPDF.PageElements.Charting.Axes.XAxisList.PercentageXAxis"/> object to use for the default percentage xAxis of the plot area.
Gets or sets the <see cref="P:ceTe.DynamicPDF.PageElements.Charting.Axes.XAxisList.NumericXAxis"/> object to use for the default numeric xAxis of the plot area.
Gets or sets the <see cref="P:ceTe.DynamicPDF.PageElements.Charting.Axes.XAxisList.IndexedXAxis"/> object to use for the default indexed xAxis of the plot area.
Gets or sets the <see cref="P:ceTe.DynamicPDF.PageElements.Charting.Axes.XAxisList.DateTimeXAxis"/> object to use for the default dateTime xAxis of the plot area.
Gets or sets the <see cref="P:ceTe.DynamicPDF.PageElements.Charting.Axes.XAxisList.PercentageXAxis"/> object to use for the default percentage xAxis of the plot area.
Gets or sets the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Axes.XAxisTickMarksPosition"/> enumeration that specifies the position of the XAxisTickMarks.
Adds a <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Axes.YAxis"/> to the end of the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Axes.YAxisList"/> object.
</summary>
<param name="yAxis"><see cref="T:ceTe.DynamicPDF.PageElements.Charting.Axes.YAxis"/> to be displayed in the plot area.</param>
Gets or sets the <see cref="P:ceTe.DynamicPDF.PageElements.Charting.Axes.YAxisList.NumericYAxis"/> object to use for the default numeric yAxis of the plot area.
Gets or sets the <see cref="P:ceTe.DynamicPDF.PageElements.Charting.Axes.YAxisList.IndexedYAxis"/> object to use for the default indexed yAxis of the plot area.
Gets or sets the <see cref="P:ceTe.DynamicPDF.PageElements.Charting.Axes.YAxisList.DateTimeYAxis"/> object to use for the default dateTime yAxis of the plot area.
Gets or sets the <see cref="P:ceTe.DynamicPDF.PageElements.Charting.Axes.YAxisList.PercentageYAxis"/> object to use for the default percentage yAxis of the plot area.
Gets or sets the <see cref="P:ceTe.DynamicPDF.PageElements.Charting.Axes.YAxisList.NumericYAxis"/> object to use for the default numeric yAxis of the plot area.
Gets or sets the <see cref="P:ceTe.DynamicPDF.PageElements.Charting.Axes.YAxisList.IndexedYAxis"/> object to use for the default indexed yAxis of the plot area.
Gets or sets the <see cref="P:ceTe.DynamicPDF.PageElements.Charting.Axes.YAxisList.DateTimeYAxis"/> object to use for the default dateTime yAxis of the plot area.
Gets or sets the <see cref="P:ceTe.DynamicPDF.PageElements.Charting.Axes.YAxisList.PercentageYAxis"/> object to use for the default percentage yAxis of the plot area.
Gets or sets the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Axes.YAxisTickMarksPosition"/> enumeration that specifies the position of the YaxisTickMarks.
Gets or sets the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.ValuePositionDataLabel"/> to use for the data label of the column series. This is the
Initializes a new instance of <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Series.DateTime100PercentStackedAreaSeries"/> object.
</summary>
<param name="xAxis"> <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Axes.DateTimeXAxis"/> of the dateTime 100Percent stacked area series.</param>
<param name="yAxis"> <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Axes.PercentageYAxis"/> of the dateTime 100Percent stacked area series.</param>
Initializes a new instance of <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Series.DateTime100PercentStackedAreaSeries"/> object.
</summary>
<param name="xAxis"><see cref="T:ceTe.DynamicPDF.PageElements.Charting.Axes.DateTimeXAxis"/> of the eateTime 100Percent stacked area series.</param>
<param name="yAxis"><see cref="T:ceTe.DynamicPDF.PageElements.Charting.Axes.PercentageYAxis"/> of the dateTime 100Percent stacked area series. </param>
<param name="legend">Legend of the dateTime 100Percent stacked area series.</param>
Initializes a new instance of <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Series.DateTime100PercentStackedAreaSeries"/> object.
</summary>
<param name="yAxis"><see cref="T:ceTe.DynamicPDF.PageElements.Charting.Axes.PercentageYAxis"/> of the dateTime 100Percent stacked area series. </param>
Gets or sets the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.PercentageDataLabel"/> object to use for the DataLabel of the stacked 100Percent series element. This is the
<font color="red">Obsolete.</font>Gets or sets the format to use for the percentage of the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.PercentageDataLabel"/> object.
</summary>
<remarks><font color="red">NOTE: This Property is now obsolete.</font> Use the <see cref="P:ceTe.DynamicPDF.PageElements.Charting.Series.Stacked100PercentSeriesElement.PercentageFormat"/> property instead.</remarks>
Gets or sets the <see cref="P:ceTe.DynamicPDF.PageElements.Charting.Series.Stacked100PercentAreaSeriesElement.Marker"/> of the Stacked100PercentAreaSeriesElement.
Initializes a new instance of the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Series.DateTime100PercentStackedBarSeries"/> class.
</summary>
<param name="percentageXAxis"> <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Axes.PercentageXAxis"/>of the dateTime 100Percent stacked barSeries. </param>
<param name="dateTimeYAxis"><see cref="T:ceTe.DynamicPDF.PageElements.Charting.Axes.DateTimeYAxis"/> of the dateTime 100Percent stacked barSeries. </param>
<param name="legend"> <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Legend"/>of the dateTime 100Percent stacked barSeries. </param>
Initializes a new instance of the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Series.DateTime100PercentStackedBarSeries"/> class.
</summary>
<param name="percentageXAxis"><see cref="T:ceTe.DynamicPDF.PageElements.Charting.Axes.PercentageXAxis"/> of the date time 100Percent stacked bar series. </param>
Initializes a new instance of the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Series.DateTime100PercentStackedColumnSeries"/> class.
</summary>
<param name="dateTimeXAxis"> <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Axes.DateTimeXAxis"/> of the date time 100Percent stacked column series.</param>
<param name="percentageYAxis"><see cref="T:ceTe.DynamicPDF.PageElements.Charting.Axes.PercentageYAxis"/> of the date time 100Percent stacked column series.</param>
Initializes a new instance of the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Series.DateTime100PercentStackedColumnSeries"/> class.
</summary>
<param name="dateTimeXAxis"><see cref="T:ceTe.DynamicPDF.PageElements.Charting.Axes.DateTimeXAxis"/> of the date time 100Percent stacked column series.</param>
<param name="percentageYAxis"><see cref="T:ceTe.DynamicPDF.PageElements.Charting.Axes.PercentageYAxis"/> of the date time 100Percent stacked column series.</param>
<param name="legend"><see cref="T:ceTe.DynamicPDF.PageElements.Charting.Legend"/> of the date time 100Percent stacked column series.</param>
Initializes a new instance of the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Series.DateTime100PercentStackedColumnSeries"/> class.
</summary>
<param name="percentageYAxis"><see cref="T:ceTe.DynamicPDF.PageElements.Charting.Axes.PercentageYAxis"/> of the date time 100Percent stacked column series.</param>
Adds a <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Series.DateTime100PercentStackedColumnSeriesElement"/> object to the end of the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Series.DateTime100PercentStackedColumnSeries"/> element list.
</summary>
<param name="dateTimeStackedColumnSeriesElement"> <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Series.DateTime100PercentStackedColumnSeriesElement"/> to be added. </param>
Gets the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.DateTime100PercentStackedColumnValueList"/> object contained in the DateTime100PercentStackedColumnSeriesElement.
Initializes a new instance of the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Series.DateTime100PercentStackedLineSeries"/> object.
</summary>
<param name="xAxis"><see cref="T:ceTe.DynamicPDF.PageElements.Charting.Axes.DateTimeXAxis"/> of the dateTime 100Percent stacked line series. </param>
<param name="yAxis"><see cref="T:ceTe.DynamicPDF.PageElements.Charting.Axes.PercentageYAxis"/> of the dateTime 100Percent stacked line series. </param>
<param name="legend"> Legend of the dateTime 100Percent stacked line series.</param>
Adds a <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Series.DateTime100PercentStackedLineSeriesElement"/> object to the
<see cref="T:ceTe.DynamicPDF.PageElements.Charting.Series.DateTime100PercentStackedLineSeries"/> elements list.
</summary>
<param name="element"> <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Series.DateTime100PercentStackedLineSeriesElement"/> object to be added.</param>
Gets or sets the <see cref="P:ceTe.DynamicPDF.PageElements.Charting.Series.Stacked100PercentLineSeriesElement.Marker"/> of the Stacked100PercentLineSeriesElement.
Gets or sets the <see cref="P:ceTe.DynamicPDF.PageElements.Charting.Series.Stacked100PercentLineSeriesElement.LineCap"/> of the Stacked100PercentLineSeriesElement.
Gets or sets the <see cref="P:ceTe.DynamicPDF.PageElements.Charting.Series.Stacked100PercentLineSeriesElement.LineJoin"/> of the Stacked100PercentLineSeriesElement.
Gets or sets the <see cref="P:ceTe.DynamicPDF.PageElements.Charting.Series.Stacked100PercentLineSeriesElement.LineStyle"/> of the Stacked100PercentLineSeriesElement.
Gets the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.DateTime100PercentStackedLineValueList"/> contained in the DateTime100PercentStackedLineSeriesElement.
Adds a <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Series.DateTimeStackedAreaSeriesElement"/> object to the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Series.DateTimeStackedAreaSeries"/> elements list.
</summary>
<param name="element"><see cref="T:ceTe.DynamicPDF.PageElements.Charting.Series.DateTimeStackedAreaSeriesElement"/> object to be added.</param>
Gets the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.ValuePositionDataLabel"/> object to use for the DataLabel of the stacked series element. This is the
Adds a <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Series.DateTimeStackedBarSeriesElement"/> object to the end of the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Series.DateTimeStackedBarSeries"/> element list.
</summary>
<param name="dateTimeStackedBarSeriesElement"><see cref="T:ceTe.DynamicPDF.PageElements.Charting.Series.DateTimeStackedBarSeriesElement"/> object to be added.</param>
Gets the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.DateTimeStackedBarValueList"/> object contained in the DateTimeStackedBarSeriesElement.
Adds a <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Series.DateTimeStackedColumnSeriesElement"/> object to the end of the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Series.DateTimeStackedColumnSeries"/> element list.
</summary>
<param name="dateTimeStackedColumnSeriesElement"><see cref="T:ceTe.DynamicPDF.PageElements.Charting.Series.DateTimeStackedColumnSeriesElement"/> to be added. </param>
Gets the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.DateTimeStackedColumnValueList"/> object contained in the DateTimeStackedColumnSeriesElement.
Adds a <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Series.DateTimeStackedLineSeriesElement"/> object to the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Series.DateTimeStackedLineSeries"/> elements list.
</summary>
<param name="element"><see cref="T:ceTe.DynamicPDF.PageElements.Charting.Series.DateTimeStackedLineSeriesElement"/> object to be added.</param>
Gets the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.DateTimeStackedLineValueList"/> object contained in the DateTimeStackedLineSeriesElement.
Adds an <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Series.Indexed100PercentStackedAreaSeriesElement"/> object to the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Series.Indexed100PercentStackedAreaSeries"/> elements list.
</summary>
<param name="element"><see cref="T:ceTe.DynamicPDF.PageElements.Charting.Series.Indexed100PercentStackedAreaSeriesElement"/> object to be added.</param>
Gets the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.Indexed100PercentStackedAreaValueList"/> object contained in the Indexed100PercentStackedAreaSeriesElement.
Initializes a new instance of the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Series.Indexed100PercentStackedBarSeries"/> class.
</summary>
<param name="percentageXAxis"><see cref="T:ceTe.DynamicPDF.PageElements.Charting.Axes.PercentageXAxis"/> of the indexed 100Percent stacked bar series. </param>
<param name="indexedYAxis"><see cref="T:ceTe.DynamicPDF.PageElements.Charting.Axes.IndexedYAxis"/> of the indexed 100Percent stacked bar series. </param>
Initializes a new instance of the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Series.Indexed100PercentStackedBarSeries"/> class.
</summary>
<param name="percentageXAxis"><see cref="T:ceTe.DynamicPDF.PageElements.Charting.Axes.PercentageXAxis"/> of the indexed 100Percent stacked bar series. </param>
<param name="indexedYAxis"><see cref="T:ceTe.DynamicPDF.PageElements.Charting.Axes.IndexedYAxis"/> of the indexed 100Percent stacked bar series.</param>
<param name="legend"><see cref="T:ceTe.DynamicPDF.PageElements.Charting.Legend"/> of the indexed 100Percent stacked bar series. </param>
Initializes a new instance of the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Series.Indexed100PercentStackedBarSeries"/> class.
</summary>
<param name="percentageXAxis"><see cref="T:ceTe.DynamicPDF.PageElements.Charting.Axes.PercentageXAxis"/> of the indexed 100Percent stacked bar series. </param>
Adds an <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Series.Indexed100PercentStackedBarSeriesElement"/> to the end of the Indexed100PercentStackedBarSeriesElement list.
</summary>
<param name="indexedStackedBarSeriesElement"><see cref="T:ceTe.DynamicPDF.PageElements.Charting.Series.Indexed100PercentStackedBarSeriesElement"/> to be added.</param>
Gets the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.Indexed100PercentStackedBarValueList"/> object contained in the Indexed100PercentStackedBarSeriesElement.
Adds an <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Series.Indexed100PercentStackedColumnSeriesElement"/> object to the end of the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Series.Indexed100PercentStackedColumnSeries"/> element list.
</summary>
<param name="indexedStackedColumnSeriesElement"> <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Series.Indexed100PercentStackedColumnSeriesElement"/> to be added. </param>
Gets the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.Indexed100PercentStackedColumnValueList"/> object contained in the Indexed100PercentStackedColumnSeriesElement.
Adds an <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Series.Indexed100PercentStackedLineSeriesElement"/> object to the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Series.Indexed100PercentStackedLineSeries"/> elements list.
</summary>
<param name="element"><see cref="T:ceTe.DynamicPDF.PageElements.Charting.Series.Indexed100PercentStackedLineSeriesElement"/> object to be added.</param>
Initializes a new instance of the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Series.Indexed100PercentStackedLineSeriesElement"/> object.
</summary>
<param name="name"> Name of the indexed 100Percent stacked lineSeries element.</param>
<param name="lineWidth">Line width of the indexed 100Percent stacked line series element.</param>
<param name="style"><see cref="T:ceTe.DynamicPDF.LineStyle"/> of the indexed 100Percent stacked line series element.</param>
<param name="color"><see cref="T:ceTe.DynamicPDF.Color"/> of the indexed 100Percent stacked line series element.</param>
<param name="marker"><see cref="T:ceTe.DynamicPDF.PageElements.Charting.Marker"/> of the indexed indexed 100Percent stacked line series element.</param>
<param name="legend"><see cref="T:ceTe.DynamicPDF.PageElements.Charting.Legend"/> of the indexed 100Percent stacked line series element.</param>
Gets the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.Indexed100PercentStackedLineValueList"/> object contained in the Indexed100PercentStackedLineSeriesElement.
Adds an <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Series.IndexedStackedAreaSeriesElement"/> to the end of the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Series.IndexedStackedAreaSeries"/> element list.
</summary>
<param name="element"><see cref="T:ceTe.DynamicPDF.PageElements.Charting.Series.IndexedStackedAreaSeriesElement"/> to be added.</param>
Gets the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.IndexedStackedAreaValueList"/> object contained in the IndexedStackedAreaSeriesElement.
Adds an <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Series.IndexedStackedBarSeriesElement"/> to the end of the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Series.IndexedStackedBarSeries"/> element list.
</summary>
<param name="indexedStackedBarSeriesElement"><see cref="T:ceTe.DynamicPDF.PageElements.Charting.Series.IndexedStackedBarSeriesElement"/> to be added. </param>
Gets the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.IndexedStackedBarValueList"/> object contained in the IndexedStackedBarseriesElement.
Adds an <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Series.IndexedStackedColumnSeriesElement"/> object to the end of the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Series.IndexedStackedColumnSeries"/> element list.
</summary>
<param name="indexedStackedColumnSeriesElement"><see cref="T:ceTe.DynamicPDF.PageElements.Charting.Series.IndexedStackedColumnSeriesElement"/> to be added. </param>
Gets the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.IndexedStackedColumnValueList"/> object contained in the IndexedStackedColumnSeriesElement.
Adds an <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Series.IndexedStackedLineSeriesElement"/> object to the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Series.IndexedStackedLineSeries"/> elements list.
</summary>
<param name="element"><see cref="T:ceTe.DynamicPDF.PageElements.Charting.Series.IndexedStackedLineSeriesElement"/> object to be added.</param>
Gets the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.IndexedStackedLineValueList"/> object contained in the IndexedStackedLineSeriesElement.
Gets or sets <see cref="T:ceTe.DynamicPDF.PageElements.Charting.ScalarDataLabelPosition"/> enumeration that specifies the display position of the data label.
Adds a <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Series.PieSeriesElement"/> to the end of the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Series.PieSeriesElementList"/> object.
</summary>
<param name="pieSeriesElement"><see cref="T:ceTe.DynamicPDF.PageElements.Charting.Series.PieSeriesElement"/> object to be added. </param>
Adds a <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Series.PieSeriesElement"/> to the end of the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Series.PieSeriesElementList"/> object.
</summary>
<param name="value1">Value of the pie series element. </param>
<returns> A <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Series.PieSeriesElement"/> object. </returns>
Adds a <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Series.PieSeriesElement"/> to the end of the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Series.PieSeriesElementList"/> object.
</summary>
<param name="value1">Value of the pie series element. </param>
<param name="name">Name of the pie series element </param>
<returns> A <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Series.PieSeriesElement"/> object. </returns>
Adds an array of <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Series.PieSeriesElement"/> objects to the end of the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Series.PieSeriesElementList"/> object.
</summary>
<param name="value1">Value of the pie series elements. </param>
<returns> Array of <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Series.PieSeriesElement"/> objects. </returns>
Initializes a new instance of the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Series.SeriesLabel"/> class.
</summary>
<param name="text">Text to display in the series label.</param>
<param name="seriesNameDisplay"><see cref="T:ceTe.DynamicPDF.PageElements.Charting.Series.SeriesNameDisplay"/> enumeration indicating display position of series label.</param>
Initializes a new instance of the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Series.SeriesLabel"/> class.
</summary>
<param name="text">Text to display in the series label.</param>
<param name="font"><see cref="P:ceTe.DynamicPDF.PageElements.Charting.Series.SeriesLabel.Font"/> for the text of the series label.</param>
<param name="seriesNameDisplay"><see cref="T:ceTe.DynamicPDF.PageElements.Charting.Series.SeriesNameDisplay"/> enumeration indicating display position of series label.</param>
Initializes a new instance of the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Series.SeriesLabel"/> class.
</summary>
<param name="text">Text to display in the series label.</param>
<param name="textColor"><see cref="T:ceTe.DynamicPDF.Color"/> for the text of the series label.</param>
<param name="font"><see cref="P:ceTe.DynamicPDF.PageElements.Charting.Series.SeriesLabel.Font"/> for the text of the series label.</param>
<param name="fontSize">Size for the text of the series label.</param>
<param name="seriesNameDisplay"><see cref="T:ceTe.DynamicPDF.PageElements.Charting.Series.SeriesNameDisplay"/> enumeration indicating display position of series label.</param>
Gets or sets the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Series.SeriesNameDisplay"/> enumeration that specifies the display position of the SeriesLabel.
Adds a <see cref="T:ceTe.DynamicPDF.PageElements.Charting.SeriesBase"/> to the end of the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Series.SeriesList"/> object.
</summary>
<param name="series"><see cref="T:ceTe.DynamicPDF.PageElements.Charting.SeriesBase"/> object to be added.</param>
Adds a <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Series.StackedSeries"/> to the end of the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Series.SeriesList"/> object.
</summary>
<param name="stackedSeries"><see cref="T:ceTe.DynamicPDF.PageElements.Charting.Series.StackedSeries"/> to be added.</param>
Adds a <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.DateTime100PercentStackedAreaValue"/> object to the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.DateTime100PercentStackedAreaValueList"/> object.
</summary>
<param name="areaValue"> the dateTime 100Percent stacked area value.</param>
Gets or sets the <see cref="P:ceTe.DynamicPDF.PageElements.Charting.Values.Stacked100PercentBarValue.Color"/> object to use for the color of the Stacked100PercentBarValue.
Gets or sets the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.PercentageDataLabel"/> object to use for the DataLabel of the Stacked100PercentBarValue.
<param name="dateTimeStackedBarValue"><see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.DateTime100PercentStackedBarValue"/> to be added. </param>
Gets or sets the <see cref="P:ceTe.DynamicPDF.PageElements.Charting.Values.Stacked100PercentColumnValue.Color"/> object to use for the color of the Stacked100PercentColumnValue.
Gets or sets the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.PercentageDataLabel"/>to use for the DataLabel of the Stacked100PercentColumnValue.
Adds a <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.DateTime100PercentStackedColumnValue"/> to the end of the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.DateTime100PercentStackedColumnValueList"/>.
</summary>
<param name="value1">Value of the datetime 100Percent stacked column value. </param>
<param name="position">Position of the datetime 100Percent stacked column value. </param>
Adds a <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.DateTime100PercentStackedColumnValue"/> object to the end of the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.DateTime100PercentStackedColumnValueList"/> object.
</summary>
<param name="dateTimeStackedColumnValue"> <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.DateTime100PercentStackedColumnValue"/> to be added.</param>
Adds a <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.DateTimeAreaValue"/> object to the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.DateTimeAreaValueList"/> object.
</summary>
<param name="areaValue">Value of the dateTime area Value</param>
Adds a <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.DateTimeColumnValue"/> object to the end of the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.DateTimeColumnValueList"/> object.
</summary>
<param name="value1">Value of the date time column value. </param>
<param name="position">Position of the date time column value. </param>
<returns> A <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.DateTimeColumnValue"/> object. </returns>
Adds a <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.DateTimeColumnValue"/> object to the end of the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.DateTimeColumnValueList"/> object.
</summary>
<param name="dateTimeColumnValue"><see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.DateTimeColumnValue"/> to be added. </param>
Adds a <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.DateTimeLineValue"/> object to the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.DateTimeLineValueList"/> object.
</summary>
<param name="lineValue"> Value of the dateTime line value. </param>
Adds a <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.DateTimeLineValue"/> object to the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.DateTimeLineValueList"/> object.
</summary>
<param name="value1">Value of the dateTime line Value. </param>
<param name="obj">Position of the dateTime line Value. </param>
Adds a <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.DateTimeStackedAreaValue"/> object to the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.DateTimeStackedAreaValueList"/> object.
</summary>
<param name="value1">Value of the dateTime stacked area value. </param>
<param name="obj">Position of the dateTime stacked area value. </param>
Adds a <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.DateTimeStackedAreaValue"/> object to the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.DateTimeStackedAreaValueList"/> object.
</summary>
<param name="areaValue">Value of the dateTime stacked areaValue. </param>
Gets or sets the <see cref="P:ceTe.DynamicPDF.PageElements.Charting.Values.StackedBarValue.Color"/> object to use for the color of the StackedBarValue.
Adds a <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.DateTimeStackedBarValue"/> object to the end of the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.DateTimeStackedBarValueList"/> object.
</summary>
<param name="value1"> Value of date time stacked bar value. </param>
<param name="position">Position of the date time stacked bar value. </param>
Adds a <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.DateTimeStackedBarValue"/> object to the end of the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.DateTimeStackedBarValueList"/> object.
</summary>
<param name="dateTimeStackedBarValue"><see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.DateTimeStackedBarValue"/> to be added.</param>
Gets or sets the <see cref="P:ceTe.DynamicPDF.PageElements.Charting.Values.StackedColumnValue.Color"/> object to use for the color of the StackedColumnValue.
Gets or sets the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.ValuePositionDataLabel"/> object to use for the DataLabel of the StackedColumnValue.
Gets the <see cref="M:ceTe.DynamicPDF.PageElements.Charting.Values.StackedColumnValueList.StackedColumnValue(System.Single,System.Int32)"/> object at the given index.
</summary>
<param name="index">Position of the required stacked column value. </param>
Adds a <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.DateTimeStackedColumnValue"/> object to the end of the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.DateTimeStackedColumnValueList"/> object.
</summary>
<param name="value1">Value of the date time stacked column value. </param>
<param name="position">Position of the date time stacked column value. </param>
<returns> A <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.DateTimeStackedColumnValue"/> object. </returns>
Adds a <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.DateTimeStackedColumnValue"/> object to the end of the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.DateTimeStackedColumnValueList"/> object.
</summary>
<param name="dateTimeStackedColumnValue"><see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.DateTimeStackedColumnValue"/> to be added. </param>
Adds a <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.DateTimeStackedLineValue"/> object to the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.DateTimeStackedLineValueList"/> object.
</summary>
<param name="lineValue">Value of the dateTime stacked line value. </param>
Adds a <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.DateTimeStackedLineValue"/> object to the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.DateTimeStackedLineValueList"/> object.
</summary>
<param name="value1">Value of the dateTime stacked line value. </param>
<param name="obj">Position of the dateTime stacked line value. </param>
Adds an <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.Indexed100PercentStackedAreaValue"/> object to the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.Indexed100PercentStackedAreaValueList"/> object.
</summary>
<param name="areaValue">The indexed 100Percent stacked area value object. </param>
Adds a <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.Stacked100PercentAreaValue"/> object to the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.Indexed100PercentStackedAreaValueList"/> object.
</summary>
<param name="val">Value of the indexed 100Percent stacked area value. </param>
Adds an <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.Indexed100PercentStackedAreaValue"/> object to the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.Indexed100PercentStackedAreaValueList"/> object.
</summary>
<param name="value1"> values of the indexed 100Percent stacked area values. </param>
<returns> A <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.Stacked100PercentAreaValue"/> object array. </returns>
Adds an <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.Indexed100PercentStackedAreaValue"/> object to the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.Indexed100PercentStackedAreaValueList"/> object.
</summary>
<param name="value1">Value of the indexed 100Percent stacked area value. </param>
<param name="position"> Position of the indexed 100Percent stacked area value. </param>
Adds a <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.Stacked100PercentBarValue"/> object to the end of the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.Indexed100PercentStackedBarValueList"/> object.
</summary>
<param name="value1"> Value of stacked 100Percent barvalue.</param>
Adds an array of the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.Stacked100PercentBarValue"/> object to the end of the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.Indexed100PercentStackedBarValueList"/> object.
</summary>
<param name="value1">Values of the stacked 100Percent barvalues.</param>
<returns> Array of <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.Stacked100PercentBarValue"/> objects.</returns>
Adds an <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.Indexed100PercentStackedBarValue"/> object to the end of the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.Indexed100PercentStackedBarValueList"/> object.
</summary>
<param name="value1">Value of the indexed 100Percent stacked bar value. </param>
<param name="position">Position of the indexed 100Percent stacked bar value. </param>
<returns> A <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.Indexed100PercentStackedBarValue"/> object.</returns>
Adds an <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.Indexed100PercentStackedBarValue"/> object to the end of the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.Indexed100PercentStackedBarValueList"/> object.
</summary>
<param name="indexedStackedBarValue"><see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.Indexed100PercentStackedBarValue"/> to be added.</param>
Adds a <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.Stacked100PercentColumnValue"/> object to the end of the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.Indexed100PercentStackedColumnValueList"/> object.
</summary>
<param name="value1">Value of the stacked 100Percent column value. </param>
<returns> A <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.Stacked100PercentColumnValue"/> object. </returns>
Adds an array of <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.Stacked100PercentColumnValue"/> objects to the end of the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.Indexed100PercentStackedColumnValueList"/> object.
</summary>
<param name="value1">Values of stacked 100Percent column values. </param>
<returns> Array of <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.Stacked100PercentColumnValue"/> objects. </returns>
Adds an <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.Indexed100PercentStackedColumnValue"/> object to the end of the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.Indexed100PercentStackedColumnValueList"/> object.
</summary>
<param name="value1">Value of the indexed 100Percent stacked column value. </param>
<param name="position">Position of the indexed 100Percent stacked column value. </param>
<returns> A <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.Indexed100PercentStackedColumnValue"/> object. </returns>
Adds an <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.Indexed100PercentStackedColumnValue"/> object to the end of the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.Indexed100PercentStackedColumnValueList"/> object.
</summary>
<param name="indexedStackedColumnValue"><see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.Indexed100PercentStackedColumnValue"/> object to be added. </param>
Adds an <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.Indexed100PercentStackedLineValue"/> object to the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.Indexed100PercentStackedLineValueList"/> object.
</summary>
<param name="lineValue">Value of the indexed 100Percent Stacked line value.</param>
Adds a <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.Stacked100PercentLineValue"/> object to the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.Indexed100PercentStackedLineValueList"/> object.
</summary>
<param name="value1">Value of the indexed 100Percent stacked line value.</param>
Adds a <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.Stacked100PercentLineValue"/> object to the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.Indexed100PercentStackedLineValueList"/> object.
</summary>
<param name="value1">values of the indexed 100Percent stacked line values.</param>
Adds an <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.Indexed100PercentStackedLineValue"/> object to the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.Indexed100PercentStackedLineValueList"/> object.
</summary>
<param name="value1">Value of the indexed 100Percent stacked line value.</param>
<param name="position">Position of the indexed 100Percent stacked line value.</param>
Adds an <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.IndexedAreaValue"/> object to the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.IndexedAreaValueList"/> object.
</summary>
<param name="value1">Value of the indexed area value.</param>
<param name="position">Position of the indexed area value.</param>
<returns> A <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.AreaValue"/> object.</returns>
Adds an <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.IndexedAreaValue"/> object to the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.IndexedAreaValueList"/> object.
</summary>
<param name="areaValue">Value of the indexed area value. </param>
Adds an <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.AreaValue"/> object to the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.IndexedAreaValueList"/> object.
</summary>
<param name="value1">Value of the area value.</param>
<returns> A <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.AreaValue"/> object.</returns>
Adds an <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.AreaValue"/> object to the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.IndexedAreaValueList"/> object.
</summary>
<param name="value1">Array of values of the area values.</param>
Adds a <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.BarValue"/> object to the end of the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.IndexedBarValueList"/> object.
</summary>
<param name="value1"> Value of the bar value.</param>
Adds an array of <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.BarValue"/> objects to the end of the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.IndexedBarValueList"/> object.
</summary>
<param name="value1"> Value of the bar values.</param>
<returns> Array of <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.BarValue"/> objects.</returns>
Adds an <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.IndexedBarValue"/> object to the end of the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.IndexedBarValueList"/> object.
</summary>
<param name="value1"> Value of the indexed bar value.</param>
<param name="position">Position of the indexed bar value.</param>
Adds an <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.IndexedBarValue"/> object to the end of the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.IndexedBarValueList"/> object.
</summary>
<param name="indexedBarValue"><see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.IndexedBarValue"/> object to be added.</param>
Adds a <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.ColumnValue"/> object to the end of the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.IndexedColumnValueList"/> object.
</summary>
<param name="value1">Value of the column value. </param>
<returns> A <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.ColumnValue"/> object. </returns>
Adds an array of <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.ColumnValue"/> objects to the end of the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.IndexedColumnValueList"/> object.
</summary>
<param name="value1">Value of column values to be added. </param>
<returns> Array of <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.ColumnValue"/> objects. </returns>
Adds an <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.IndexedColumnValue"/> object to the end of the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.IndexedColumnValueList"/> object.
</summary>
<param name="value1">Value of the indexed column value. </param>
<param name="position">Position of the indexed column value. </param>
<returns> A <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.IndexedColumnValue"/> object. </returns>
Adds an <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.IndexedColumnValue"/> object to the end of the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.IndexedColumnValueList"/> object.
</summary>
<param name="indexedColumnValue"><see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.IndexedColumnValue"/> to be added. </param>
Adds an <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.IndexedLineValue"/> object to the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.IndexedLineValueList"/> object.
</summary>
<param name="lineValue">Value of the indexed line value.</param>
Adds a <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.LineValue"/> object to the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.IndexedLineValueList"/> object.
</summary>
<param name="value1">Value of the line value.</param>
Adds a <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.LineValue"/> object to the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.IndexedLineValueList"/> object.
</summary>
<param name="value1">Array of values of the line values.</param>
Adds an <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.IndexedLineValue"/> object to the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.IndexedLineValueList"/> object.
</summary>
<param name="value1">Value of the indexed line value.</param>
<param name="position">Position of the indexed line value.</param>
<returns> A <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.LineValue"/> object.</returns>
Adds an <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.IndexedStackedAreaValue"/> object to the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.IndexedStackedAreaValueList"/> object.
</summary>
<param name="areaValue">indexed stacked area value.</param>
Adds a <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.StackedAreaValue"/> object to the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.IndexedStackedAreaValueList"/> object.
</summary>
<param name="value1">Value of the stacked area value.</param>
Adds an <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.AreaValue"/> object to the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.IndexedStackedAreaValueList"/> object.
</summary>
<param name="value1">Array of values of the stacked area values.</param>
Adds an <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.IndexedStackedAreaValue"/> object to the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.IndexedStackedAreaValueList"/> object.
</summary>
<param name="value1">Value of the indexed stacked area value.</param>
<param name="position">Position of the indexed stacked area value.</param>
Adds a <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.StackedBarValue"/> object to the end of the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.IndexedStackedBarValueList"/> object.
</summary>
<param name="value1">Value of stacked bar value.</param>
<returns> A <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.StackedBarValue"/> object.</returns>
Adds an array of <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.StackedBarValue"/> objects to the end of the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.IndexedStackedBarValueList"/> object.
</summary>
<param name="value1">Value of the stacked bar values.</param>
<returns>Array of <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.StackedBarValue"/> objects.</returns>
Adds an <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.IndexedStackedBarValue"/> object to the end of the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.IndexedStackedBarValueList"/> object.
</summary>
<param name="value1">Value of the indexed stacked bar value.</param>
<param name="position">Position of the indexed stacked bar value.</param>
<returns> A <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.IndexedStackedBarValue"/> object.</returns>
Adds an <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.IndexedStackedBarValue"/> object to the end of the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.IndexedStackedBarValueList"/> object.
</summary>
<param name="indexedStackedBarValue"><see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.IndexedStackedBarValue"/> to be added.</param>
Adds a <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.StackedColumnValue"/> object to the end of the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.IndexedStackedColumnValueList"/> object.
</summary>
<param name="value1">Value of the stacked column value. </param>
<returns> A <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.StackedColumnValue"/> object. </returns>
Adds an array of <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.StackedColumnValue"/> objects to the end of the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.IndexedStackedColumnValueList"/> object.
</summary>
<param name="value1">Value of stacked column values. </param>
<returns> Array of <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.StackedColumnValue"/> objects. </returns>
Adds an <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.IndexedStackedColumnValue"/> object to the end of the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.IndexedStackedColumnValueList"/> object.
</summary>
<param name="value1">Value of the indexed stacked column value. </param>
<param name="position">Position of the indexed stacked column value. </param>
<returns> A <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.IndexedStackedColumnValue"/> object. </returns>
Adds an <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.IndexedStackedColumnValue"/> object to the end of the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.IndexedStackedColumnValueList"/> object.
</summary>
<param name="indexedStackedColumnValue"><see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.IndexedStackedColumnValue"/> object to be added. </param>
Adds an <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.IndexedStackedLineValue"/> object to the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.IndexedStackedLineValueList"/> object.
</summary>
<param name="lineValue">Value of the indexed Stacked Line Value.</param>
Adds a <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.StackedLineValue"/> object to the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.IndexedStackedLineValueList"/> object.
</summary>
<param name="value1">Value of the stacked Line Value.</param>
<returns> A <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.StackedLineValue"/> object.</returns>
Adds a <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.StackedLineValue"/> object to the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.IndexedStackedLineValueList"/> object.
</summary>
<param name="value1">values of the stacked line values.</param>
Adds an <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.IndexedStackedLineValue"/> object to the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.IndexedStackedLineValueList"/> object.
</summary>
<param name="value1">Value of the indexed Stacked Line Value.</param>
<param name="position">Position of the indexed Stacked Line Value.</param>
Adds a <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.XYScatterValue"/> object to the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.XYScatterValueList"/> object.
</summary>
<param name="val">Value of the XYScatter value. </param>
<param name="position">Position of the XYScatter value. </param>
<returns> A <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.XYScatterValue"/> object. </returns>
Adds a <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.XYScatterValue"/> object to the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Values.XYScatterValueList"/> object.
</summary>
<param name="val">The XYScatter value to be added to the XYScatter value list. </param>
<font color="red">Obsolete.</font> Gets the instance of the Marker type as an Asterisk.
</summary>
<remarks><font color="red">NOTE: This method is now obsolete.</font> Use the <see cref="M:ceTe.DynamicPDF.PageElements.Charting.Marker.GetAsterisk(System.Single)"/> method instead.</remarks>
<param name="size">The size of the marker.</param>
Adds a <see cref="T:ceTe.DynamicPDF.PageElements.Charting.Title"/> to the end of the <see cref="T:ceTe.DynamicPDF.PageElements.Charting.TitleList"/> object.
</summary>
<param name="title">Title to be displayed in the chart.</param>
<font color="red"><b>NOTE:</b> This class required the .NET Framework 2.0 or greater.</font><p/>
The signature can be of visible or invisible. Use this constructor to create a visible signature field. For creating a invisible field refer
<see cref="M:ceTe.DynamicPDF.Document.Sign(System.String,ceTe.DynamicPDF.Certificate)"/>. A signature field that does not have corresponding entry at <see cref="M:ceTe.DynamicPDF.Document.Sign(System.String,ceTe.DynamicPDF.Certificate)"/> will behave as empty
signature field and can be signed later. <br/> The visible signature field is divided into three panels.
<list type="bullet">
<item>
<term>Left or Top Panel</term>
<description>By default this panel holds the subject name of the given certificate.</description>
</item>
<item>
<term>Right or Bottom Panel</term>
<description>This panel is set to hold information related with certificate and the signer.</description>
</item>
<item>
<term>Full Panel</term>
<description>This panel constitues complete area of the signature. It does not hold any default values, but can be used to show
up full area text or image.</description>
</item>
</list>
</remarks>
<example>
This example shows how to create a signature and sign it with a certificate.
<code lang="VB">
Imports ceTe.DynamicPDF
Imports ceTe.DynamicPDF.PageElements.Forms
Module Module1
Sub Main()
' Create a PDF Document
Dim MyDocument As Document = New Document
' Create a PDF Page
Dim MyPage As Page = New Page
' Create a signature form field
Dim MySignature As Signature = New Signature("MySigField", 10, 10, 300, 100)
<font color="red"><b>NOTE:</b> This class required the .NET Framework 2.0 or greater.</font><p/>
Assigning zero to x,y,height and width will make the signature as invisible althougth required resources will be added. This method
is not recommended and advised to call <see cref="M:ceTe.DynamicPDF.Document.Sign(System.String,ceTe.DynamicPDF.Certificate)"/> directly without adding any signature field with corresponding name.
</remarks>
<param name="name">Name of a signature field.</param>
<param name="x">X coordinate of a signature.</param>
<param name="y">Y coordinate of a signature.</param>
<param name="width">Widht of a signature.</param>
<param name="height">Height of a signature.</param>
Hides all text visibility for the panel. <see cref="M:ceTe.DynamicPDF.PageElements.Forms.Signature.HideAllText"/> for hiding all the text in all the panels.
Default - true[only for the right or bottom panel]. It also requires <see cref="P:ceTe.DynamicPDF.PageElements.Forms.Signature.Reason"/> should be set.
Gets or sets a value indicating display of location.
</summary>
<remarks>
Default - true[only for the right or bottom panel]. It also requires <see cref="P:ceTe.DynamicPDF.PageElements.Forms.Signature.Location"/> should be set.
<remarks>This class can be used to place an image on the page that will be stretched to the dimensions of the page.
If an image will be used more than once, please see the <a href="Image ReUse.html">Image Reuse</a> topic.</remarks>
<example>The following example will place an image on the page making it the background for that page.<p/>
<code lang="VB">
Imports System
Imports ceTe.DynamicPDF
Imports ceTe.DynamicPDF.PageElements
Module MyModule
Sub Main()
' Create a PDF Document
Dim MyDocument As Document = New Document
' Create a Page and add it to the document
Dim MyPage As Page = New Page
MyDocument.Pages.Add(MyPage)
' Create a background image
Dim MyBackgroundImage As BackgroundImage = New BackgroundImage("C:\MyImage.jpg")
' Place the image with in the page margins
MyBackgroundImage.UseMargins = True
' Add the background image to the page
MyPage.Elements.Add(MyBackgroundImage)
' Save the PDF
MyDocument.Draw("C:\MyDocument.pdf")
End Sub
End Module
</code>
<code lang="C#">
using System;
using ceTe.DynamicPDF;
using ceTe.DynamicPDF.PageElements;
class MyClass
{
static void Main()
{
// Create a PDF Document
Document document = new Document();
// Create a page and add it to the document
Page page = new Page();
document.Pages.Add( page );
// Create a background image
BackgroundImage backgroundImage = new BackgroundImage( @"C:\MyImage.jpg" );
// Place the image with in the page margins
backgroundImage.UseMargins = true;
// Add the background image to the page
page.Elements.Add( backgroundImage );
//Save the PDF
document.Draw( @"C:\MyDocument.pdf" );
}
}
</code>
</example>
<licensing>
This class is a DynamicPDF Generator Professional Edition feature, except for the use of 64 bit PNG images (in this case see below). One of the following licenses is required for non-evaluation usage:
<list type="bullet">
<item>DynamicPDF Generator for .NET Professional Edition</item>
<item>DynamicPDF Generator for .NET Enterprise Edition</item>
<item>DynamicPDF Merger for .NET Professional Edition</item>
<item>DynamicPDF Merger for .NET Enterprise Edition</item>
<item>DynamicPDF ReportWriter for .NET Professional Edition</item>
<item>DynamicPDF ReportWriter for .NET Enterprise Edition</item>
<item>DynamicPDF Core Suite for .NET Professional Edition</item>
<item>DynamicPDF Core Suite for .NET Enterprise Edition</item>
</list>
Use of 64 bit PNG images with this class is an Enterprise Edition feature. One of the following licenses is required for non-evaluation usage:
<list type="bullet">
<item>DynamicPDF Generator for .NET Enterprise Edition</item>
<item>DynamicPDF Merger for .NET Enterprise Edition</item>
<item>DynamicPDF ReportWriter for .NET Enterprise Edition</item>
<item>DynamicPDF Core Suite for .NET Enterprise Edition</item>
Gets or sets the padding of the cell. By default this value is set to float.MinValue. Being set to 'Not a Number' implies that the cell's padding will be pulled from the padding for the row containing that cell.
Adds a <see cref="T:ceTe.DynamicPDF.PageElements.Cell"/> to the end of the <see cref="T:ceTe.DynamicPDF.PageElements.CellList"/> with the specified page element.
</summary>
<param name="element">Page element to be displayed in the cell.</param>
<returns>Returns a <see cref="T:ceTe.DynamicPDF.PageElements.Cell"/> object.</returns>
<remarks>This method is used to add any page element to the table. Note that a page element should only be added to the cell directly if that page element impliments <see cref="T:ceTe.DynamicPDF.PageElements.IArea"/>. If the page element does not impliment IArea then it is recommended you place your page element(s) in an <see cref="T:ceTe.DynamicPDF.PageElements.AreaGroup"/>. This will assuree that the row will adjust to the height of the page element as needed.</remarks>
<example>The following example shows you how to build a simple table where some cells contain page elements.<p/>
<code lang="VB">
Imports System
Imports ceTe.DynamicPDF
Imports ceTe.DynamicPDF.PageElements
Module MyModule
Sub Main()
' Create a PDF Document
Dim MyDocument As Document = New Document
Dim MyPage As Page = New Page
MyDocument.Pages.Add(MyPage)
Dim MyTable As Table = New Table(0, 0, 600, 600)
MyTable.Align = TextAlign.Center
MyTable.VAlign = VAlign.Center
' Add columns to the table
MyTable.Columns.Add(150)
MyTable.Columns.Add(150)
MyTable.Columns.Add(150)
' Add rows to the table and add cells to the rows
Dim MyRow1 As Row = MyTable.Rows.Add(0, Font.HelveticaBold, 16, _
Adds a <see cref="T:ceTe.DynamicPDF.PageElements.Cell"/> to the end of the <see cref="T:ceTe.DynamicPDF.PageElements.CellList"/> with the specified page element.
</summary>
<param name="element">Page element to be displayed in the cell.</param>
<param name="colSpan">Number of columns that the cell will span.</param>
<returns>Returns a <see cref="T:ceTe.DynamicPDF.PageElements.Cell"/> object.</returns>
<remarks>This method is used to add any page element to the table. Note that a page element should only be added to the cell directly if that page element impliments <see cref="T:ceTe.DynamicPDF.PageElements.IArea"/>. If the page element does not impliment IArea then it is recommended you place your page element(s) in an <see cref="T:ceTe.DynamicPDF.PageElements.AreaGroup"/>. This will assuree that the row will adjust to the height of the page element as needed.</remarks>
<example>The following example shows you how to build a simple table where some cells contain page elements.<p/>
<code lang="VB">
Imports System
Imports ceTe.DynamicPDF
Imports ceTe.DynamicPDF.PageElements
Module MyModule
Sub Main()
' Create a PDF Document
Dim MyDocument As Document = New Document
Dim MyPage As Page = New Page
MyDocument.Pages.Add(MyPage)
Dim MyTable As Table = New Table(0, 0, 600, 600)
MyTable.Align = TextAlign.Center
MyTable.VAlign = VAlign.Center
' Add columns to the table
MyTable.Columns.Add(150)
MyTable.Columns.Add(150)
MyTable.Columns.Add(150)
' Add rows to the table and add cells to the rows
Dim MyRow1 As Row = MyTable.Rows.Add(0, Font.HelveticaBold, 16, _
Adds a <see cref="T:ceTe.DynamicPDF.PageElements.Cell"/> to the end of the <see cref="T:ceTe.DynamicPDF.PageElements.CellList"/> with the specified page element.
</summary>
<param name="element">Page element to be displayed in the cell.</param>
<param name="colSpan">Number of columns that the cell will span.</param>
<param name="rowSpan">Number of rows that the cell will span.</param>
<returns>Returns a <see cref="T:ceTe.DynamicPDF.PageElements.Cell"/> object.</returns>
<remarks>This method is used to add any page element to the table. Note that a page element should only be added to the cell directly if that page element impliments <see cref="T:ceTe.DynamicPDF.PageElements.IArea"/>. If the page element does not impliment IArea then it is recommended you place your page element(s) in an <see cref="T:ceTe.DynamicPDF.PageElements.AreaGroup"/>. This will assuree that the row will adjust to the height of the page element as needed.</remarks>
<example>The following example shows you how to build a simple table where some cells contain page elements.<p/>
<code lang="VB">
Imports System
Imports ceTe.DynamicPDF
Imports ceTe.DynamicPDF.PageElements
Module MyModule
Sub Main()
' Create a PDF Document
Dim MyDocument As Document = New Document
Dim MyPage As Page = New Page
MyDocument.Pages.Add(MyPage)
Dim MyTable As Table = New Table(0, 0, 600, 600)
MyTable.Align = TextAlign.Center
MyTable.VAlign = VAlign.Center
' Add columns to the table
MyTable.Columns.Add(150)
MyTable.Columns.Add(150)
MyTable.Columns.Add(150)
' Add rows to the table and add cells to the rows
Dim MyRow1 As Row = MyTable.Rows.Add(0, Font.HelveticaBold, 16, _
<remarks>This class is the base class for all sub paths. SubPath's derived classes are: <see cref="T:ceTe.DynamicPDF.PageElements.CurveFromSubPath"/>, <see cref="T:ceTe.DynamicPDF.PageElements.CurveToSubPath"/>, <see cref="T:ceTe.DynamicPDF.PageElements.CurveSubPath"/> and <see cref="T:ceTe.DynamicPDF.PageElements.LineSubPath"/></remarks>
<licensing>
This class is a DynamicPDF Generator Professional Edition feature. One of the following licenses is required for non-evaluation usage:
<list type="bullet">
<item>DynamicPDF Generator for .NET Professional Edition</item>
<item>DynamicPDF Generator for .NET Enterprise Edition</item>
<item>DynamicPDF Merger for .NET Professional Edition</item>
<item>DynamicPDF Merger for .NET Enterprise Edition</item>
<item>DynamicPDF ReportWriter for .NET Professional Edition</item>
<item>DynamicPDF ReportWriter for .NET Enterprise Edition</item>
<item>DynamicPDF Core Suite for .NET Professional Edition</item>
<item>DynamicPDF Core Suite for .NET Enterprise Edition</item>
Returns a new <see cref="T:ceTe.DynamicPDF.PageElements.FormattedTextArea"/> object containing the overflow text.
</summary>
<returns>A <see cref="T:ceTe.DynamicPDF.PageElements.FormattedTextArea"/> if there is overflow text; otherwise, <b>null</b>.</returns>
<remarks>This method returns a new <b>TextArea</b> object that contains the remaining text that did not fit.</remarks>
<example>The following example shows you how to use the GetOverflowTextArea object to allow text of variable length to flow onto new pages as needed.<p/>
<code lang="VB">
Imports System
Imports ceTe.DynamicPDF
Imports ceTe.DynamicPDF.PageElements
Module MyModule
Sub Main()
' Create a PDF Document
Dim MyDocument As Document = New Document
' Create a string and assign it to text of variable length
Dim myVariableText As String = ""
Dim i As Integer
For i = 0 To 50
MyVariableText &= "<i>This</i> is a <font color='FF0000'>sentence</font> that " + _
"I will use as my <b>variable length</b> text. "
Next
' Create an formatted text area
Dim MyFormattedTextArea As FormattedTextArea = New FormattedTextArea(MyVariableText, 0, 0, 250, 200, FontFamily.Helvetica, 12, False)
Do
' Create a new page
Dim MyPage As Page = New Page
' Add the text area to the page;
MyPage.Elements.Add(MyFormattedTextArea)
' Add the page to the document
MyDocument.Pages.Add(MyPage)
' Set the text area object equal to the rest of the text that did not fit
' if all the text fit this will set textArea to null
Returns a new <see cref="T:ceTe.DynamicPDF.PageElements.FormattedTextArea"/> object containing the overflow text.
</summary>
<param name="x">X coordinate of the new object.</param>
<param name="y">Y coordinate of the new object.</param>
<returns>A <see cref="T:ceTe.DynamicPDF.PageElements.FormattedTextArea"/> if there is overflow text; otherwise, <b>null</b>.</returns>
<remarks>This method returns a new <b>TextArea</b> object that contains the remaining text that did not fit.</remarks>
<example>The following example shows you how to use the GetOverflowTextArea object to allow text of variable length to flow onto new pages as needed.<p/>
<code lang="VB">
Imports System
Imports ceTe.DynamicPDF
Imports ceTe.DynamicPDF.PageElements
Module MyModule
Sub Main()
' Create a PDF Document
Dim MyDocument As Document = New Document
' Create a string and assign it to text of variable length
Dim myVariableText As String = ""
Dim i As Integer
For i = 0 To 50
MyVariableText &= "<i>This</i> is a <font color='FF0000'>sentence</font> that " + _
"I will use as my <b>variable length</b> text. "
Next
' Create an formatted text area
Dim MyFormattedTextArea As FormattedTextArea = New FormattedTextArea(MyVariableText, 0, 0, 250, 200, FontFamily.Helvetica, 12, False)
Do
' Create a new page
Dim MyPage As Page = New Page
' Add the text area to the page;
MyPage.Elements.Add(MyFormattedTextArea)
' Add the page to the document
MyDocument.Pages.Add(MyPage)
' Set the text area object equal to the rest of the text that did not fit
' if all the text fit this will set textArea to null
Returns a new <see cref="T:ceTe.DynamicPDF.PageElements.FormattedTextArea"/> object containing the overflow text.
</summary>
<param name="x">X coordinate of the new object.</param>
<param name="y">Y coordinate of the new object.</param>
<param name="height">Height of the new object.</param>
<returns>A <see cref="T:ceTe.DynamicPDF.PageElements.FormattedTextArea"/> if there is overflow text; otherwise, <b>null</b>.</returns>
<remarks>This method returns a new <b>TextArea</b> object that contains the remaining text that did not fit.</remarks>
<example>The following example shows you how to use the GetOverflowTextArea object to allow text of variable length to flow onto new pages as needed.<p/>
<code lang="VB">
Imports System
Imports ceTe.DynamicPDF
Imports ceTe.DynamicPDF.PageElements
Module MyModule
Sub Main()
' Create a PDF Document
Dim MyDocument As Document = New Document
' Create a string and assign it to text of variable length
Dim myVariableText As String = ""
Dim i As Integer
For i = 0 To 50
MyVariableText &= "<i>This</i> is a <font color='FF0000'>sentence</font> that " + _
"I will use as my <b>variable length</b> text. "
Next
' Create an formatted text area
Dim MyFormattedTextArea As FormattedTextArea = New FormattedTextArea(MyVariableText, 0, 0, 250, 200, FontFamily.Helvetica, 12, False)
Do
' Create a new page
Dim MyPage As Page = New Page
' Add the text area to the page;
MyPage.Elements.Add(MyFormattedTextArea)
' Add the page to the document
MyDocument.Pages.Add(MyPage)
' Set the text area object equal to the rest of the text that did not fit
' if all the text fit this will set textArea to null
Gets or sets the <see cref="T:ceTe.DynamicPDF.PageElements.FormattedTextAreaStyle"/> object used to specify the initial style of the formatted text area.
<remarks>This class can be used to define a certain style of text to be used with an <see cref="T:ceTe.DynamicPDF.PageElements.FormattedTextArea"/>.</remarks>
<example>The following example shows a paragraph of formatted formatted text being displayed on the page.<p/>
<code lang="VB">
Imports System
Imports ceTe.DynamicPDF
Imports ceTe.DynamicPDF.PageElements
Module MyModule
Sub Main()
' Create a PDF Document
Dim MyDocument As Document = New Document
' Create a Page and add it to the document
Dim MyPage As Page = New Page
MyDocument.Pages.Add(MyPage)
' Create an formatted style
Dim style As FormattedTextAreaStyle = New FormattedTextAreaStyle(FontFamily.Helvetica, 12, False)
' Create the text and the formatted text area
Dim formattedText As String = "<p>Formatted text area provide rich formatting support for " + _
"text that appears in the document. You have complete control over 8 paragraph " + _
"properties: spacing before, spacing after, first line indentation, left indentation," + _
" right indentation, alignment, allowing orphan lines, and white space preservation; " + _
"6 font properties: <font face='Times'>font face, </font><font " + _
Returns the <see cref="F:ceTe.DynamicPDF.PageElements.FormattedTextAreaStyle.Font"/> to use from the <see cref="T:ceTe.DynamicPDF.FontFamily"/> of the style.
</summary>
<returns>The <see cref="F:ceTe.DynamicPDF.PageElements.FormattedTextAreaStyle.Font"/> of the style</returns>
<remarks>This class can be used to place images on a page. If an image will be used more than once,
please see the <a href="Image ReUse.html">Image Reuse</a> topic.</remarks>
<example>The following example will place an image on the page and then set the Y scale to twice as much as the X scale.<p/>
<code lang="VB">
Imports System
Imports System.Drawing;
Imports ceTe.DynamicPDF
Imports ceTe.DynamicPDF.PageElements
Module MyModule
Sub Main()
' Create a PDF Document
Dim MyDocument As Document = New Document
' Create a Page and add it to the document
Dim MyPage As Page = New Page
MyDocument.Pages.Add(MyPage)
' Create an image
Dim MyImage As Image = New Image("C:\MyImage.jpg", 0, 0)
' Add the image to the page
MyPage.Elements.Add(MyImage)
' Save the PDF
MyDocument.Draw("C:\MyDocument.pdf")
End Sub
End Module
</code>
<code lang="C#">
using System;
using System.Drawing;
using ceTe.DynamicPDF;
using ceTe.DynamicPDF.PageElements;
class MyClass
{
static void Main()
{
// Create a PDF Document
Document document = new Document();
// Create a Page and add it to the document
Page page = new Page();
document.Pages.Add( page );
// Create an image
Image image = new Image( @"C:\MyImage.jpg", 0, 0 );
// Add the image to the page
page.Elements.Add( image );
// Save the PDF
document.Draw( @"C:\MyDocument.pdf" );
}
}
</code>
</example>
<licensing>
The use of the GIF image type is a DynamicPDF Generator Community Edition feature. All other image types (JPEG, JPEG 2000, PNG, BMP, EMF, EXIF, TIFF and WMF) are a DynamicPDF Generator Professional Edition feature, except for the use of 64 bit PNG images (in this case see below). One of the following licenses is required for non-evaluation usage:
<list type="bullet">
<item>DynamicPDF Generator for .NET Professional Edition</item>
<item>DynamicPDF Generator for .NET Enterprise Edition</item>
<item>DynamicPDF Merger for .NET Professional Edition</item>
<item>DynamicPDF Merger for .NET Enterprise Edition</item>
<item>DynamicPDF ReportWriter for .NET Professional Edition</item>
<item>DynamicPDF ReportWriter for .NET Enterprise Edition</item>
<item>DynamicPDF Core Suite for .NET Professional Edition</item>
<item>DynamicPDF Core Suite for .NET Enterprise Edition</item>
</list>
Use of 64 bit PNG images with this class is an Enterprise Edition feature. One of the following licenses is required for non-evaluation usage:
<list type="bullet">
<item>DynamicPDF Generator for .NET Enterprise Edition</item>
<item>DynamicPDF Merger for .NET Enterprise Edition</item>
<item>DynamicPDF ReportWriter for .NET Enterprise Edition</item>
<item>DynamicPDF Core Suite for .NET Enterprise Edition</item>
Gets or sets the <see cref="P:ceTe.DynamicPDF.PageElements.Image.Align"/> enumeration that specifies horizontal alignment of the image on the X coordinate.
Gets or sets the <see cref="P:ceTe.DynamicPDF.PageElements.Image.VAlign"/> enumeration that specifies vertical alignment of the image on the Y coordinate.
<remarks>See the <a href="Lists.html">Lists</a> topic for more on ordered lists.
<p/><b>NOTE:</b> This page element cannot be used within a table cell, or tranformation group.</remarks>
<example>The following example shows a OrderedList text being displayed on the page.<p/>
<code lang="VB">
Imports System
Imports ceTe.DynamicPDF
Imports ceTe.DynamicPDF.PageElements
Module MyModule
Sub Main()
' Create a PDF Document
Dim MyDocument As Document = New Document
' Create a Page and add it to the document
Dim MyPage As Page = New Page
MyDocument.Pages.Add(MyPage)
' Create an OrderedList.
Dim list As OrderedList = New OrderedList(50,120,300,500)
list.ListItemTopMargin = 5
list.ListItemBottomMargin = 5
list.BulletPrefix = "("
list.BulletSuffix = ")"
list.TextColor = RgbColor.HotPink
Dim label1 As Label = New Label("CeTe Software specializes in components for dynamic PDF generation and manipulation. The DynamicPDFΓäó product line allows you to dynamically generate PDF documents, merge PDF documents and add new content to existing PDF documents from within your applications.",50,50,400,200)
label1.Align = TextAlign.Justify
' Add ListItem to the List.
Dim item1 As ListItem = list.Items.Add(".NET products")
item1.Underline = true
Dim item2 As ListItem = list.Items.Add("JAVA products")
item2.Underline = true
Dim item3 As ListItem = list.Items.Add("COM products")
item3.Underline = true
' Add OrderedSubList under ListItem item1.
Dim subList1 As OrderedSubList = item1.SubLists.AddOrderedSubList(NumberingStyle.RomanUpperCase)
subList1.TextColor = RgbColor.DarkGoldenRod
Dim item4 As ListItem = subList1.Items.Add("DynamicPDFΓäó Generator for .NET")
Dim item5 As ListItem = subList1.Items.Add("DynamicPDFΓäó Merger for .NET")
Dim subList2 As OrderedSubList = item2.SubLists.AddOrderedSubList(NumberingStyle.RomanUpperCase)
subList2.TextColor = RgbColor.DarkGoldenRod
Dim item6 As ListItem = subList2.Items.Add("DynamicPDFΓäó Generator for JAVA")
Dim item7 As ListItem = subList2.Items.Add("DynamicPDFΓäó Merger for JAVA")
Dim subList3 As OrderedSubList = item3.SubLists.AddOrderedSubList(NumberingStyle.RomanUpperCase)
subList3.TextColor = RgbColor.DarkGoldenRod
Dim item8 As ListItem = subList3.Items.Add("DynamicPDFΓäó Generator")
Dim item9 As ListItem = subList3.Items.Add("DynamicPDFΓäó ReportWriter")
Dim subList4 As OrderedSubList = item6.SubLists.AddOrderedSubList(NumberingStyle.AlphabeticLowerCase)
subList4.TextColor = RgbColor.BlueViolet
Dim item10 As ListItem = subList4.Items.Add("Community Edition")
Dim item11 As ListItem = subList4.Items.Add("Developer Edition")
Dim item12 As ListItem = subList4.Items.Add("Server Edition")
Dim subList5 As OrderedSubList = item7.SubLists.AddOrderedSubList(NumberingStyle.AlphabeticLowerCase)
subList5.TextColor = RgbColor.BlueViolet
Dim item13 As ListItem = subList5.Items.Add("Evaluation Edition")
Dim item14 As ListItem = subList5.Items.Add("Developer Edition")
Dim item15 As ListItem = subList5.Items.Add("Server Edition")
Dim subList6 As OrderedSubList = item4.SubLists.AddOrderedSubList(NumberingStyle.AlphabeticLowerCase)
subList6.TextColor = RgbColor.BlueViolet
Dim item16 As ListItem = subList6.Items.Add("Community Edition")
Dim item17 As ListItem = subList6.Items.Add("Professional Edition")
Dim item18 As ListItem = subList6.Items.Add("Enterprise Edition")
Dim subList7 As OrderedSubList = item5.SubLists.AddOrderedSubList(NumberingStyle.AlphabeticLowerCase)
subList7.TextColor = RgbColor.BlueViolet
Dim item19 As ListItem = subList7.Items.Add("Standard Edition")
Dim item20 As ListItem = subList7.Items.Add("Professional Edition")
Dim item21 As ListItem = subList7.Items.Add("Enterprise Edition")
'Add the OrderedList to the page
MyPage.Elements.Add(list)
MyPage.Elements.Add(label1)
' Save the PDF
MyDocument.Draw("C:\MyDocument.pdf")
End Sub
End Module
</code>
<code lang="C#">
using System;
using ceTe.DynamicPDF;
using ceTe.DynamicPDF.PageElements;
class MyClass
{
static void Main()
{
// Create a PDF Document.
Document doc = new Document();
// Create a Page.
Page page1 = new Page();
// Create a OrderedList.
OrderedList list = new OrderedList(50,120,300,500);
list.ListItemTopMargin = 5;
list.ListItemBottomMargin = 5;
list.BulletPrefix = "(";
list.BulletSuffix = ")";
list.TextColor = RgbColor.HotPink;
Label label1 = new Label("CeTe Software specializes in components for dynamic PDF generation and manipulation. The DynamicPDFΓäó product line allows you to dynamically generate PDF documents, merge PDF documents and add new content to existing PDF documents from within your applications.",50,50,400,200);
Gets a OrderedList object containing the List Text.
</summary>
<returns>Returns a OrderedList object.</returns>
<remarks>This method returns a new <b>OrderedList</b> object that contains the remaining text that did not fit.</remarks>
<example>The following example shows you how to use the GetOverflowList object to allow text of variable length to flow onto new pages as needed.<p/>
<code lang="VB">
Imports System
Imports ceTe.DynamicPDF
Imports ceTe.DynamicPDF.PageElements
Module MyModule
Sub Main()
' Create a PDF Document
Dim MyDocument As Document = New Document
' Create a Page and add it to the document
Dim MyPage As Page = New Page
MyDocument.Pages.Add(MyPage)
' Create a OrderedList.
Dim list As OrderedList = New OrderedList(50,120,300,210)
list.ListItemTopMargin = 5
list.ListItemBottomMargin = 5
list.BulletPrefix = "("
list.BulletSuffix = ")"
list.TextColor = RgbColor.HotPink
Dim label1 As Label = New Label("CeTe Software specializes in components for dynamic PDF generation and manipulation. The DynamicPDFΓäó product line allows you to dynamically generate PDF documents, merge PDF documents and add new content to existing PDF documents from within your applications.",50,50,400,200)
label1.Align = TextAlign.Justify
' Add ListItem to the List.
Dim item1 As ListItem = list.Items.Add(".NET products")
item1.Underline = true
Dim item2 As ListItem = list.Items.Add("JAVA products")
item2.Underline = true
Dim item3 As ListItem = list.Items.Add("COM products")
item3.Underline = true
' Add OrderedSubList under ListItem item1
Dim subList1 As OrderedSubList = item1.SubLists.AddOrderedSubList(NumberingStyle.RomanUpperCase)
subList1.TextColor = RgbColor.DarkGoldenRod
Dim item4 As ListItem = subList1.Items.Add("DynamicPDFΓäó Generator for .NET")
Dim item5 As ListItem = subList1.Items.Add("DynamicPDFΓäó Merger for .NET")
Dim subList2 As OrderedSubList = item2.SubLists.AddOrderedSubList(NumberingStyle.RomanUpperCase)
subList2.TextColor = RgbColor.DarkGoldenRod
Dim item6 As ListItem = subList2.Items.Add("DynamicPDFΓäó Generator for JAVA")
Dim item7 As ListItem = subList2.Items.Add("DynamicPDFΓäó Merger for JAVA")
Dim subList3 As OrderedSubList = item3.SubLists.AddOrderedSubList(NumberingStyle.RomanUpperCase)
subList3.TextColor = RgbColor.DarkGoldenRod
Dim item8 As ListItem = subList3.Items.Add("DynamicPDFΓäó Generator")
Dim item9 As ListItem = subList3.Items.Add("DynamicPDFΓäó ReportWriter")
Dim subList4 As OrderedSubList = item6.SubLists.AddOrderedSubList(NumberingStyle.AlphabeticLowerCase)
subList4.TextColor = RgbColor.BlueViolet
Dim item10 As ListItem = subList4.Items.Add("Community Edition")
Dim item11 As ListItem = subList4.Items.Add("Developer Edition")
Dim item12 As ListItem = subList4.Items.Add("Server Edition")
Dim subList5 As OrderedSubList = item7.SubLists.AddOrderedSubList(NumberingStyle.AlphabeticLowerCase)
subList5.TextColor = RgbColor.BlueViolet
Dim item13 As ListItem = subList5.Items.Add("Evaluation Edition")
Dim item14 As ListItem = subList5.Items.Add("Developer Edition")
Dim item15 As ListItem = subList5.Items.Add("Server Edition")
Dim subList6 As OrderedSubList = item4.SubLists.AddOrderedSubList(NumberingStyle.AlphabeticLowerCase)
subList6.TextColor = RgbColor.BlueViolet
Dim item16 As ListItem = subList6.Items.Add("Community Edition")
Dim item17 As ListItem = subList6.Items.Add("Professional Edition")
Dim item18 As ListItem = subList6.Items.Add("Enterprise Edition")
Dim subList7 As OrderedSubList = item5.SubLists.AddOrderedSubList(NumberingStyle.AlphabeticLowerCase)
subList7.TextColor = RgbColor.BlueViolet
Dim item19 As ListItem = subList7.Items.Add("Standard Edition")
Dim item20 As ListItem = subList7.Items.Add("Professional Edition")
Dim item21 As ListItem = subList7.Items.Add("Enterprise Edition")
' Add the OrderedList to the Page.
MyPage.Elements.Add(list)
MyPage.Elements.Add(label1)
' Set the OrderedList object equal to the rest of the text that did not fit
' if all the text did fit, GetOverflowList will return null
list = list.GetOverFlowList()
while Not list is Nothing
MyPage= new Page(PageSize.A4)
MyPage.Elements.Add(list)
MyDocument.Pages.Add(MyPage)
list = list.GetOverFlowList()
End While
' Save the PDF.
MyDocument.Draw("C:\MyDocument.pdf")
End Sub
End Module
</code>
<code lang="C#">
using System;
using ceTe.DynamicPDF;
using ceTe.DynamicPDF.PageElements;
class MyClass
{
static void Main()
{
// Create a PDF Document.
Document doc = new Document();
// Create a Page.
Page page1 = new Page();
// Create a OrderedList.
OrderedList list = new OrderedList(50,120,300,210);
list.ListItemTopMargin = 5;
list.ListItemBottomMargin = 5;
list.BulletPrefix = "(";
list.BulletSuffix = ")";
list.TextColor = RgbColor.HotPink;
Label label1 = new Label("CeTe Software specializes in components for dynamic PDF generation and manipulation. The DynamicPDFΓäó product line allows you to dynamically generate PDF documents, merge PDF documents and add new content to existing PDF documents from within your applications.",50,50,400,200);
Gets a OrderedList object containing the List Text.
</summary>
<param name="x">New X coordinate of the OrderedList.</param>
<param name="y">New Y coordinate of the OrderedList.</param>
<returns>Returns a OrderedList object.</returns>
<remarks>This method returns a new <b>OrderedList</b> object that contains the remaining text that did not fit.</remarks>
<example>The following example shows you how to use the GetOverflowList object to allow text of variable length to flow onto new pages as needed.<p/>
<code lang="VB">
Imports System
Imports ceTe.DynamicPDF
Imports ceTe.DynamicPDF.PageElements
Module MyModule
Sub Main()
' Create a PDF Document
Dim MyDocument As Document = New Document
' Create a Page and add it to the document
Dim MyPage As Page = New Page
MyDocument.Pages.Add(MyPage)
' Create an OrderedList.
Dim list As OrderedList = New OrderedList(50,120,300,210)
list.ListItemTopMargin = 5
list.ListItemBottomMargin = 5
list.BulletPrefix = "("
list.BulletSuffix = ")"
list.TextColor = RgbColor.HotPink
Dim label1 As Label = New Label("CeTe Software specializes in components for dynamic PDF generation and manipulation. The DynamicPDFΓäó product line allows you to dynamically generate PDF documents, merge PDF documents and add new content to existing PDF documents from within your applications.",50,50,400,200)
label1.Align = TextAlign.Justify
' Add ListItem to the List.
Dim item1 As ListItem = list.Items.Add(".NET products")
item1.Underline = true
Dim item2 As ListItem = list.Items.Add("JAVA products")
item2.Underline = true
Dim item3 As ListItem = list.Items.Add("COM products")
item3.Underline = true
' Add OrderedSubList under ListItem item1
Dim subList1 As OrderedSubList = item1.SubLists.AddOrderedSubList(NumberingStyle.RomanUpperCase)
subList1.TextColor = RgbColor.DarkGoldenRod
Dim item4 As ListItem = subList1.Items.Add("DynamicPDFΓäó Generator for .NET")
Dim item5 As ListItem = subList1.Items.Add("DynamicPDFΓäó Merger for .NET")
Dim subList2 As OrderedSubList = item2.SubLists.AddOrderedSubList(NumberingStyle.RomanUpperCase)
subList2.TextColor = RgbColor.DarkGoldenRod
Dim item6 As ListItem = subList2.Items.Add("DynamicPDFΓäó Generator for JAVA")
Dim item7 As ListItem = subList2.Items.Add("DynamicPDFΓäó Merger for JAVA")
Dim subList3 As OrderedSubList = item3.SubLists.AddOrderedSubList(NumberingStyle.RomanUpperCase)
subList3.TextColor = RgbColor.DarkGoldenRod
Dim item8 As ListItem = subList3.Items.Add("DynamicPDFΓäó Generator")
Dim item9 As ListItem = subList3.Items.Add("DynamicPDFΓäó ReportWriter")
Dim subList4 As OrderedSubList = item6.SubLists.AddOrderedSubList(NumberingStyle.AlphabeticLowerCase)
subList4.TextColor = RgbColor.BlueViolet
Dim item10 As ListItem = subList4.Items.Add("Community Edition")
Dim item11 As ListItem = subList4.Items.Add("Developer Edition")
Dim item12 As ListItem = subList4.Items.Add("Server Edition")
Dim subList5 As OrderedSubList = item7.SubLists.AddOrderedSubList(NumberingStyle.AlphabeticLowerCase)
subList5.TextColor = RgbColor.BlueViolet
Dim item13 As ListItem = subList5.Items.Add("Evaluation Edition")
Dim item14 As ListItem = subList5.Items.Add("Developer Edition")
Dim item15 As ListItem = subList5.Items.Add("Server Edition")
Dim subList6 As OrderedSubList = item4.SubLists.AddOrderedSubList(NumberingStyle.AlphabeticLowerCase)
subList6.TextColor = RgbColor.BlueViolet
Dim item16 As ListItem = subList6.Items.Add("Community Edition")
Dim item17 As ListItem = subList6.Items.Add("Professional Edition")
Dim item18 As ListItem = subList6.Items.Add("Enterprise Edition")
Dim subList7 As OrderedSubList = item5.SubLists.AddOrderedSubList(NumberingStyle.AlphabeticLowerCase)
subList7.TextColor = RgbColor.BlueViolet
Dim item19 As ListItem = subList7.Items.Add("Standard Edition")
Dim item20 As ListItem = subList7.Items.Add("Professional Edition")
Dim item21 As ListItem = subList7.Items.Add("Enterprise Edition")
' Add the OrderedList to the Page.
MyPage.Elements.Add(list)
MyPage.Elements.Add(label1)
' Set the OrderedList object equal to the rest of the text that did not fit
' if all the text did fit, GetOverflowList will return null
list = list.GetOverFlowList(50,50)
while Not list is Nothing
MyPage= new Page(PageSize.A4)
MyPage.Elements.Add(list)
MyDocument.Pages.Add(MyPage)
list = list.GetOverFlowList(50,50)
End While
' Save the PDF.
MyDocument.Draw("C:\MyDocument.pdf")
End Sub
End Module
</code>
<code lang="C#">
using System;
using ceTe.DynamicPDF;
using ceTe.DynamicPDF.PageElements;
class MyClass
{
static void Main()
{
// Create a PDF Document.
Document doc = new Document();
// Create a Page.
Page page1 = new Page();
// Create a OrderedList.
OrderedList list = new OrderedList(50,120,300,500);
list.ListItemTopMargin = 5;
list.ListItemBottomMargin = 5;
list.BulletPrefix = "(";
list.BulletSuffix = ")";
list.TextColor = RgbColor.HotPink;
Label label1 = new Label("CeTe Software specializes in components for dynamic PDF generation and manipulation. The DynamicPDFΓäó product line allows you to dynamically generate PDF documents, merge PDF documents and add new content to existing PDF documents from within your applications.",50,50,400,200);
Gets or sets the <see cref="P:ceTe.DynamicPDF.PageElements.PageNumberingLabel.VAlign"/> enumeration that specifies the vertical text alignment of the label.
Gets <see cref="T:ceTe.DynamicPDF.PageElements.SubPathList"/> that contains a collection of <see cref="T:ceTe.DynamicPDF.PageElements.SubPath"/> objects.
Gets or sets the padding of the cells in the row. By default this value is set to float.MinValue. Being set to 'Not a Number' implies that the row's padding will be pulled from the padding for the table containing that row.
<remarks>If no height is specified for a Row this value will return -1. A -1 signifies that the height will automatically adjust to the height of the text.</remarks>
Returns a <see cref="T:ceTe.DynamicPDF.PageElements.Table"/> object containing the overflow rows.
</summary>
<returns>Returns a <see cref="T:ceTe.DynamicPDF.PageElements.Table"/> object.</returns>
<remarks>This method returns a new <b>Table</b> object that contains the remaining rows that did not fit.</remarks>
<example>The following example shows you how to use the GetOverflowRows method to allow tables of variable length to flow onto new pages as needed.<p/>
Returns a <see cref="T:ceTe.DynamicPDF.PageElements.Table"/> object containing the overflow rows.
</summary>
<param name="x">X coordinate of the new table.</param>
<param name="y">Y coordinate of the new table.</param>
<returns>Returns a <see cref="T:ceTe.DynamicPDF.PageElements.Table"/> object.</returns>
<remarks>This method returns a new <b>Table</b> object that contains the remaining rows that did not fit. This new table will be assigned the specified values for x and y.</remarks>
<example>The following example shows you how to use the GetOverflowRows method to allow tables of variable length to flow onto new pages as needed.<p/>
Returns a <see cref="T:ceTe.DynamicPDF.PageElements.Table"/> object containing the overflow rows.
</summary>
<param name="x">X coordinate of the new table.</param>
<param name="y">Y coordinate of the new table.</param>
<param name="width">Width of the new table.</param>
<param name="height">Height of the new table.</param>
<returns>Returns a <see cref="T:ceTe.DynamicPDF.PageElements.Table"/> object.</returns>
<remarks>This method returns a new <b>Table</b> object that contains the remaining rows that did not fit. This new table will be assigned the specified values for x, y, height and width.</remarks>
<example>The following example shows you how to use the GetOverflowRows method to allow tables of variable length to flow onto new pages as needed.<p/>
Returns a <see cref="T:ceTe.DynamicPDF.PageElements.Table"/> object containing the overflow columns.
</summary>
<returns>Returns a <see cref="T:ceTe.DynamicPDF.PageElements.Table"/> object.</returns>
<remarks>This method returns a new <b>Table</b> object that contains the remaining columns that did not fit.</remarks>
<example>The following example shows you how to use the GetOverflowColumns method to allow tables of variable length to flow onto new pages as needed.<p/>
Returns a <see cref="T:ceTe.DynamicPDF.PageElements.Table"/> object containing the overflow columns.
</summary>
<param name="x">X coordinate of the new table.</param>
<param name="y">Y coordinate of the new table.</param>
<returns>Returns a <see cref="T:ceTe.DynamicPDF.PageElements.Table"/> object.</returns>
<remarks>This method returns a new <b>Table</b> object that contains the remaining columns that did not fit. This new table will be assigned the specified values for x and y.</remarks>
<example>The following example shows you how to use the GetOverflowColumns method to allow tables of variable length to flow onto new pages as needed.<p/>
Returns a <see cref="T:ceTe.DynamicPDF.PageElements.Table"/> object containing the overflow columns.
</summary>
<param name="x">X coordinate of the new table.</param>
<param name="y">Y coordinate of the new table.</param>
<param name="width">Width of the new table.</param>
<param name="height">Height of the new table.</param>
<returns>Returns a <see cref="T:ceTe.DynamicPDF.PageElements.Table"/> object.</returns>
<remarks>This method returns a new <b>Table</b> object that contains the remaining columns that did not fit. This new table will be assigned the specified values for x, y, height and width.</remarks>
<example>The following example shows you how to use the GetOverflowColumns method to allow tables of variable length to flow onto new pages as needed.<p/>
Gets or sets the number of columns that will be repeated as the row header. This number is only considered if RepeatColumnHeader is set to true. This is set to 0 by default.
Gets or sets the number of initial rows in the table that should also be drawn as the first rows on all subsequent row overflow tables. This is set to 0 by default.
<remarks>This class can be used to place text on a page. Using the methods GetOverflowText or GetOverflowTextArea and HasOverflowText,
users can control the pagination of TextAreas that come from a source of unknown length. See the <a href="Text Continuation.html">Text Continuation</a> topic for more on text continuation.</remarks>
<example>The following example will display text on the page.<p/>
<code lang="VB">
Imports System
Imports ceTe.DynamicPDF
Imports ceTe.DynamicPDF.PageElements
Module MyModule
Sub Main()
' Create a PDF Document
Dim MyDocument As Document = New Document
' Create a Page and add it to the document
Dim MyPage As Page = New Page
MyDocument.Pages.Add(MyPage)
' Create a text area
Dim MyTextArea As TextArea = New TextArea("This is the " + _
"underlined text of a TextArea", 100, 100, 400, 30, _
ceTe.DynamicPDF.Font.HelveticaBoldOblique, 18)
' Change the underline property to true
MyTextArea.Underline = True
' Add the text to the page
MyPage.Elements.Add(MyTextArea)
' Save the PDF
MyDocument.Draw("C:\MyDocument.pdf")
End Sub
End Module
</code>
<code lang="C#">
using System;
using ceTe.DynamicPDF;
using ceTe.DynamicPDF.PageElements;
class MyClass
{
static void Main()
{
// Create a PDF Document
Document document = new Document();
// Create a Page and add it to the document
Page page = new Page();
document.Pages.Add( page );
// Create a text area
TextArea textArea = new TextArea( "This is the underlined " +
"text of a TextArea", 100, 100, 400, 30,
ceTe.DynamicPDF.Font.HelveticaBoldOblique, 18 );
// Change the underline property to true
textArea.Underline = true;
// Add the text area to the page
page.Elements.Add( textArea );
// Save the PDF
document.Draw( @"C:\MyDocument.pdf" );
}
}
</code>
</example>
<licensing>
This class is a DynamicPDF Generator Professional Edition feature. One of the following licenses is required for non-evaluation usage:
<list type="bullet">
<item>DynamicPDF Generator for .NET Professional Edition</item>
<item>DynamicPDF Generator for .NET Enterprise Edition</item>
<item>DynamicPDF Merger for .NET Professional Edition</item>
<item>DynamicPDF Merger for .NET Enterprise Edition</item>
<item>DynamicPDF ReportWriter for .NET Professional Edition</item>
<item>DynamicPDF ReportWriter for .NET Enterprise Edition</item>
<item>DynamicPDF Core Suite for .NET Professional Edition</item>
<item>DynamicPDF Core Suite for .NET Enterprise Edition</item>
Returns a <b>TextArea</b> object containing the overflow text.
</summary>
<returns>Returns a <b>TextArea</b> object.</returns>
<remarks>This method returns a new <b>TextArea</b> object that contains the remaining text that did not fit.</remarks>
<example>The following example shows you how to use the GetOverflowTextArea object to allow text of variable length to flow onto new pages as needed.<p/>
<code lang="VB">
Imports System
Imports ceTe.DynamicPDF
Imports ceTe.DynamicPDF.PageElements
Module MyModule
Sub Main()
' Create a PDF Document
Dim MyDocument As Document = New Document
' Create a string and assign it to text of variable length
Dim myVariableText As String = ""
Dim i As Integer
For i = 0 To 50
myVariableText &= "This is a sentence that I will use as my variable length text. "
Next
' Create a text area
Dim MyTextArea As TextArea = New TextArea(myVariableText, 0, 0, 250, 200)
Do
' Create a new page
Dim MyPage As Page = New Page
' Add the text area to the page;
MyPage.Elements.Add(MyTextArea)
' Add the page to the document
MyDocument.Pages.Add(MyPage)
' Set the text area object equal to the rest of the text that did not fit
' if all the text fit this will set textArea to null
MyTextArea = MyTextArea.GetOverflowTextArea()
Loop While Not MyTextArea Is Nothing
' Save the PDF
MyDocument.Draw("C:\MyDocument.pdf")
End Sub
End Module
</code>
<code lang="C#">
using System;
using ceTe.DynamicPDF;
using ceTe.DynamicPDF.PageElements;
class MyClass
{
static void Main()
{
// 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 += "This is a sentence that I will use as my variable length text. ";
Returns a <b>TextArea</b> object containing the overflow text.
</summary>
<param name="x">X coordinate of the new text area.</param>
<param name="y">Y coordinate of the new text area.</param>
<returns>Returns a <b>TextArea</b> object.</returns>
<remarks>This method returns a new <b>TextArea</b> object that contains the remaining text that did not fit.</remarks>
<example>The following example shows you how to use the GetOverflowTextArea object to allow text of variable length to flow onto new pages as needed.<p/>
<code lang="VB">
Imports System
Imports ceTe.DynamicPDF
Imports ceTe.DynamicPDF.PageElements
Module MyModule
Sub Main()
' Create a PDF Document
Dim MyDocument As Document = New Document
' Create a string and assign it to text of variable length
Dim myVariableText As String = ""
Dim i As Integer
For i = 0 To 50
myVariableText &= "This is a sentence that I will use as my variable length text. "
Next
' Create a text area
Dim MyTextArea As TextArea = New TextArea(myVariableText, 0, 0, 250, 200)
Do
' Create a new page
Dim MyPage As Page = New Page
' Add the text area to the page;
MyPage.Elements.Add(MyTextArea)
' Add the page to the document
MyDocument.Pages.Add(MyPage)
' Set the text area object equal to the rest of the text that did not fit
' if all the text fit this will set textArea to null
Returns a <b>TextArea</b> object containing the overflow text.
</summary>
<param name="x">X coordinate of the new text area.</param>
<param name="y">Y coordinate of the new text area.</param>
<param name="width">Width of the new text area.</param>
<param name="height">Height of the new text area.</param>
<returns>Returns a <b>TextArea</b> object.</returns>
<remarks>This method returns a new <b>TextArea</b> object that contains the remaining text that did not fit.</remarks>
<example>The following example shows you how to use the GetOverflowTextArea object to allow text of variable length to flow onto new pages as needed.<p/>
<code lang="VB">
Imports System
Imports ceTe.DynamicPDF
Imports ceTe.DynamicPDF.PageElements
Module MyModule
Sub Main()
' Create a PDF Document
Dim MyDocument As Document = New Document
' Create a string and assign it to text of variable length
Dim myVariableText As String = ""
Dim i As Integer
For i = 0 To 50
myVariableText &= "This is a sentence that I will use as my variable length text. "
Next
' Create a text area
Dim MyTextArea As TextArea = New TextArea(myVariableText, 0, 0, 250, 200)
Do
' Create a new page
Dim MyPage As Page = New Page
' Add the text area to the page;
MyPage.Elements.Add(MyTextArea)
' Add the page to the document
MyDocument.Pages.Add(MyPage)
' Set the text area object equal to the rest of the text that did not fit
' if all the text fit this will set textArea to null
<exception cref="T:ceTe.DynamicPDF.GeneratorException">If <see cref="P:ceTe.DynamicPDF.PageElements.TextArea.KerningEnabled"/> is set to false.</exception>
<example>
The following exmaple demonstrates how to apply custom kerning.
<code lang="VB">
Imports ceTe.DynamicPDF
Imports ceTe.DynamicPDF.Text
Imports ceTe.DynamicPDF.PageElements
Module Module1
Sub Main()
' Create a PDF Document
Dim MyDocument As Document = New Document
' Create a PDF Page
Dim MyPage As Page = New Page
' Create a Texr Area
Dim MyTextArea As TextArea = New TextArea("Text with kerning", 10, 10, 200, 100)
' Enable the kerning for the text area
MyTextArea.KerningEnabled = True
' Get the Kerning Pairs for the text area
Dim MyKerningValues As KerningValues = MyTextArea.GetKerningValue
' Apply a custom kerning value between 'T' & 'e' in 'Text'
' so that chars will be closer than normal
MyKerningValues.Spacing(0) = 200
' Add the text area to the page
MyPage.Elements.Add(MyTextArea)
' Add the page to the document
MyDocument.Pages.Add(MyPage)
' Save the document
MyDocument.Draw("C:\MyDocument.pdf")
End Sub
End Module
</code>
<code lang="C#">
using System;
using ceTe.DynamicPDF;
using ceTe.DynamicPDF.Text;
using ceTe.DynamicPDF.PageElements;
class MyClass
{
static void Main(string[] args)
{
// Create a PDF Document
Document document = new Document();
// Create a PDF Page
Page page = new Page();
// Create a Texr Area
TextArea textArea = new TextArea("Text with kerning", 10, 10, 200, 100);
Gets or sets the leading for the text of the text area.
</summary>
<remarks>Setting this property will automatically set the <see cref="P:ceTe.DynamicPDF.PageElements.TextArea.AutoLeading"/> property to false.</remarks>
Gets or sets a value indicating whether the leading of the text area should be calculated automatically.
</summary>
<remarks>This property is automatically set to false any time the <see cref="P:ceTe.DynamicPDF.PageElements.TextArea.Leading"/> property is set.</remarks>
<remarks>See the <a href="Lists.html">Lists</a> topic for more on unordered lists.
<p/><b>NOTE:</b> This page element cannot be used within a table cell, or tranformation group.</remarks>
<example>The following example shows a UnorderedList text being displayed on the page.<p/>
<code lang="VB">
Imports System
Imports ceTe.DynamicPDF
Imports ceTe.DynamicPDF.PageElements
Module MyModule
Sub Main()
' Create a PDF Document
Dim MyDocument As Document = New Document
' Create a Page and add it to the document
Dim MyPage As Page = New Page
MyDocument.Pages.Add(MyPage)
' Create an UnorderedList.
Dim list As UnorderedList = New UnorderedList(50,120,300,500,Font.Helvetica,12,UnorderedListStyle.Disc)
list.ListItemTopMargin = 5
list.ListItemBottomMargin = 5
list.TextColor = RgbColor.HotPink
Dim label1 As Label = New Label("CeTe Software specializes in components for dynamic PDF generation and manipulation. The DynamicPDFΓäó product line allows you to dynamically generate PDF documents, merge PDF documents and add new content to existing PDF documents from within your applications.",50,50,400,200)
label1.Align = TextAlign.Justify
' Add ListItem to the List.
Dim item1 As ListItem = list.Items.Add(".NET products")
item1.Underline = true
Dim item2 As ListItem = list.Items.Add("JAVA products")
item2.Underline = true
Dim item3 As ListItem = list.Items.Add("COM products")
item3.Underline = true
' Add UnorderedSubList under ListItem item1.
Dim subList1 As UnorderedSubList = item1.SubLists.AddUnorderedSubList(UnorderedListStyle.Square)
subList1.TextColor = RgbColor.DarkGoldenRod
Dim item4 As ListItem = subList1.Items.Add("DynamicPDFΓäó Generator for .NET")
Dim item5 As ListItem = subList1.Items.Add("DynamicPDFΓäó Merger for .NET")
Dim subList2 As UnorderedSubList = item2.SubLists.AddUnorderedSubList(UnorderedListStyle.Square)
subList2.TextColor = RgbColor.DarkGoldenRod
Dim item6 As ListItem = subList2.Items.Add("DynamicPDFΓäó Generator for JAVA")
Dim item7 As ListItem = subList2.Items.Add("DynamicPDFΓäó Merger for JAVA")
Dim subList3 As UnorderedSubList = item3.SubLists.AddUnorderedSubList(UnorderedListStyle.Asterisk)
subList3.TextColor = RgbColor.DarkGoldenRod
Dim item8 As ListItem = subList3.Items.Add("DynamicPDFΓäó Generator")
Dim item9 As ListItem = subList3.Items.Add("DynamicPDFΓäó ReportWriter")
Dim subList4 As UnorderedSubList = item6.SubLists.AddUnorderedSubList(UnorderedListStyle.Asterisk)
subList4.TextColor = RgbColor.BlueViolet
Dim item10 As ListItem = subList4.Items.Add("Community Edition")
Dim item11 As ListItem = subList4.Items.Add("Developer Edition")
Dim item12 As ListItem = subList4.Items.Add("Server Edition")
Dim subList5 As UnorderedSubList = item7.SubLists.AddUnorderedSubList(UnorderedListStyle.Asterisk)
subList5.TextColor = RgbColor.BlueViolet
Dim item13 As ListItem = subList5.Items.Add("Evaluation Edition")
Dim item14 As ListItem = subList5.Items.Add("Developer Edition")
Dim item15 As ListItem = subList5.Items.Add("Server Edition")
Dim subList6 As UnorderedSubList = item4.SubLists.AddUnorderedSubList(UnorderedListStyle.Asterisk)
subList6.TextColor = RgbColor.BlueViolet
Dim item16 As ListItem = subList6.Items.Add("Community Edition")
Dim item17 As ListItem = subList6.Items.Add("Professional Edition")
Dim item18 As ListItem = subList6.Items.Add("Enterprise Edition")
Dim subList7 As UnorderedSubList = item5.SubLists.AddUnorderedSubList(UnorderedListStyle.Asterisk)
subList7.TextColor = RgbColor.BlueViolet
Dim item19 As ListItem = subList7.Items.Add("Standard Edition")
Dim item20 As ListItem = subList7.Items.Add("Professional Edition")
Dim item21 As ListItem = subList7.Items.Add("Enterprise Edition")
' Add UnorderedList to the page.
MyPage.Elements.Add(list)
MyPage.Elements.Add(label1)
' Save the PDF
MyDocument.Draw("C:\MyDocument.pdf")
End Sub
End Module
</code>
<code lang="c#">
using System;
using ceTe.DynamicPDF;
using ceTe.DynamicPDF.PageElements;
class MyClass
{
static void Main()
{
// Create a PDF Document.
Document doc = new Document();
// Create a Page.
Page page1 = new Page();
// Create a UnorderedList.
UnorderedList list = new UnorderedList(50,120,300,500,Font.Helvetica,12,UnorderedListStyle.Disc);
list.ListItemTopMargin = 5;
list.ListItemBottomMargin = 5;
list.TextColor = RgbColor.HotPink;
Label label1 = new Label("CeTe Software specializes in components for dynamic PDF generation and manipulation. The DynamicPDFΓäó product line allows you to dynamically generate PDF documents, merge PDF documents and add new content to existing PDF documents from within your applications.",50,50,400,200);
Gets a UnorderedList object containing the List Text.
</summary>
<returns>Returns a UnorderedList object.</returns>
<remarks>This method returns a new <b>UnorderedList</b> object that contains the remaining text that did not fit.</remarks>
<example>The following example shows you how to use the GetOverflowList object to allow text of variable length to flow onto new pages as needed.<p/>
<code lang="VB">
Imports System
Imports ceTe.DynamicPDF
Imports ceTe.DynamicPDF.PageElements
Module MyModule
Sub Main()
' Create a PDF Document
Dim MyDocument As Document = New Document
' Create a Page and add it to the document
Dim MyPage As Page = New Page
MyDocument.Pages.Add(MyPage)
' Create the UnOrderedList.
Dim list As UnorderedList = New UnorderedList(50,120,300,500,Font.Helvetica,12,UnorderedListStyle.Disc)
list.ListItemTopMargin = 5
list.ListItemBottomMargin = 5
list.TextColor = RgbColor.HotPink
Dim label1 As Label = New Label("CeTe Software specializes in components for dynamic PDF generation and manipulation. The DynamicPDFΓäó product line allows you to dynamically generate PDF documents, merge PDF documents and add new content to existing PDF documents from within your applications.",50,50,400,200)
label1.Align = TextAlign.Justify
' Add ListItem to the List.
Dim item1 As ListItem = list.Items.Add(".NET products")
item1.Underline = true
Dim item2 As ListItem = list.Items.Add("JAVA products")
item2.Underline = true
Dim item3 As ListItem = list.Items.Add("COM products")
item3.Underline = true
' Add UnorderedSubList under ListItem item1.
Dim subList1 As UnorderedSubList = item1.SubLists.AddUnorderedSubList(UnorderedListStyle.Square)
subList1.TextColor = RgbColor.DarkGoldenRod
Dim item4 As ListItem = subList1.Items.Add("DynamicPDFΓäó Generator for .NET")
Dim item5 As ListItem = subList1.Items.Add("DynamicPDFΓäó Merger for .NET")
Dim subList2 As UnorderedSubList = item2.SubLists.AddUnorderedSubList(UnorderedListStyle.Square)
subList2.TextColor = RgbColor.DarkGoldenRod
Dim item6 As ListItem = subList2.Items.Add("DynamicPDFΓäó Generator for JAVA")
Dim item7 As ListItem = subList2.Items.Add("DynamicPDFΓäó Merger for JAVA")
Dim subList3 As UnorderedSubList = item3.SubLists.AddUnorderedSubList(UnorderedListStyle.Asterisk)
subList3.TextColor = RgbColor.DarkGoldenRod
Dim item8 As ListItem = subList3.Items.Add("DynamicPDFΓäó Generator")
Dim item9 As ListItem = subList3.Items.Add("DynamicPDFΓäó ReportWriter")
Dim subList4 As UnorderedSubList = item6.SubLists.AddUnorderedSubList(UnorderedListStyle.Asterisk)
subList4.TextColor = RgbColor.BlueViolet
Dim item10 As ListItem = subList4.Items.Add("Community Edition")
Dim item11 As ListItem = subList4.Items.Add("Developer Edition")
Dim item12 As ListItem = subList4.Items.Add("Server Edition")
Dim subList5 As UnorderedSubList = item7.SubLists.AddUnorderedSubList(UnorderedListStyle.Asterisk)
subList5.TextColor = RgbColor.BlueViolet
Dim item13 As ListItem = subList5.Items.Add("Evaluation Edition")
Dim item14 As ListItem = subList5.Items.Add("Developer Edition")
Dim item15 As ListItem = subList5.Items.Add("Server Edition")
Dim subList6 As UnorderedSubList = item4.SubLists.AddUnorderedSubList(UnorderedListStyle.Asterisk)
subList6.TextColor = RgbColor.BlueViolet
Dim item16 As ListItem = subList6.Items.Add("Community Edition")
Dim item17 As ListItem = subList6.Items.Add("Professional Edition")
Dim item18 As ListItem = subList6.Items.Add("Enterprise Edition")
Dim subList7 As UnorderedSubList = item5.SubLists.AddUnorderedSubList(UnorderedListStyle.Asterisk)
subList7.TextColor = RgbColor.BlueViolet
Dim item19 As ListItem = subList7.Items.Add("Standard Edition")
Dim item20 As ListItem = subList7.Items.Add("Professional Edition")
Dim item21 As ListItem = subList7.Items.Add("Enterprise Edition")
' Add the UnorderedList to the Page.
MyPage.Elements.Add(list)
MyPage.Elements.Add(label1)
' Set the UnorderedList object equal to the rest of the text that did not fit
' if all the text did fit, GetOverflowList will return null
list = list.GetOverFlowList()
while Not list is Nothing
MyPage= new Page(PageSize.A4)
MyPage.Elements.Add(list)
MyDocument.Pages.Add(MyPage)
list = list.GetOverFlowList()
End While
' Save the PDF.
MyDocument.Draw("C:\MyDocument.pdf")
End sub
End Module
</code>
<code lang="C#">
using System;
using ceTe.DynamicPDF;
using ceTe.DynamicPDF.PageElements;
class MyClass
{
static void Main()
{
// Create a PDF Document.
Document doc = new Document();
// Create a Page.
Page page1 = new Page();
// Create an UnorderedList.
UnorderedList list = new UnorderedList(50,120,300,500,Font.Helvetica,12,UnorderedListStyle.Disc);
list.ListItemTopMargin = 5;
list.ListItemBottomMargin = 5;
list.TextColor = RgbColor.HotPink;
Label label1 = new Label("CeTe Software specializes in components for dynamic PDF generation and manipulation. The DynamicPDFΓäó product line allows you to dynamically generate PDF documents, merge PDF documents and add new content to existing PDF documents from within your applications.",50,50,400,200);
Gets a UnorderedList object containing the List Text.
</summary>
<param name="x">New X coordinate of the UnorderedList.</param>
<param name="y">New Y coordinate of the UnorderedList.</param>
<returns>Returns a UnorderedList object.</returns>
<remarks>This method returns a new <b>UnorderedList</b> object that contains the remaining text that did not fit.</remarks>
<example>The following example shows you how to use the GetOverflowList object to allow text of variable length to flow onto new pages as needed.<p/>
<code lang="VB">
Imports System
Imports ceTe.DynamicPDF
Imports ceTe.DynamicPDF.PageElements
Module MyModule
Sub Main()
' Create a PDF Document
Dim MyDocument As Document = New Document
' Create a Page and add it to the document
Dim MyPage As Page = New Page
MyDocument.Pages.Add(MyPage)
' Create an UnorderedList.
Dim list As UnorderedList = New UnorderedList(50,120,300,500,Font.Helvetica,12,UnorderedListStyle.Disc)
list.ListItemTopMargin = 5
list.ListItemBottomMargin = 5
list.TextColor = RgbColor.HotPink
Dim label1 As Label = New Label("CeTe Software specializes in components for dynamic PDF generation and manipulation. The DynamicPDFΓäó product line allows you to dynamically generate PDF documents, merge PDF documents and add new content to existing PDF documents from within your applications.",50,50,400,200)
label1.Align = TextAlign.Justify
' Add ListItem to the List.
Dim item1 As ListItem = list.Items.Add(".NET products")
item1.Underline = true
Dim item2 As ListItem = list.Items.Add("JAVA products")
item2.Underline = true
Dim item3 As ListItem = list.Items.Add("COM products")
item3.Underline = true
' Add UnorderedSubList under ListItem item1.
Dim subList1 As UnorderedSubList = item1.SubLists.AddUnorderedSubList(UnorderedListStyle.Square)
subList1.TextColor = RgbColor.DarkGoldenRod
Dim item4 As ListItem = subList1.Items.Add("DynamicPDFΓäó Generator for .NET")
Dim item5 As ListItem = subList1.Items.Add("DynamicPDFΓäó Merger for .NET")
Dim subList2 As UnorderedSubList = item2.SubLists.AddUnorderedSubList(UnorderedListStyle.Square)
subList2.TextColor = RgbColor.DarkGoldenRod
Dim item6 As ListItem = subList2.Items.Add("DynamicPDFΓäó Generator for JAVA")
Dim item7 As ListItem = subList2.Items.Add("DynamicPDFΓäó Merger for JAVA")
Dim subList3 As UnorderedSubList = item3.SubLists.AddUnorderedSubList(UnorderedListStyle.Asterisk)
subList3.TextColor = RgbColor.DarkGoldenRod
Dim item8 As ListItem = subList3.Items.Add("DynamicPDFΓäó Generator")
Dim item9 As ListItem = subList3.Items.Add("DynamicPDFΓäó ReportWriter")
Dim subList4 As UnorderedSubList = item6.SubLists.AddUnorderedSubList(UnorderedListStyle.Asterisk)
subList4.TextColor = RgbColor.BlueViolet
Dim item10 As ListItem = subList4.Items.Add("Community Edition")
Dim item11 As ListItem = subList4.Items.Add("Developer Edition")
Dim item12 As ListItem = subList4.Items.Add("Server Edition")
Dim subList5 As UnorderedSubList = item7.SubLists.AddUnorderedSubList(UnorderedListStyle.Asterisk)
subList5.TextColor = RgbColor.BlueViolet
Dim item13 As ListItem = subList5.Items.Add("Evaluation Edition")
Dim item14 As ListItem = subList5.Items.Add("Developer Edition")
Dim item15 As ListItem = subList5.Items.Add("Server Edition")
Dim subList6 As UnorderedSubList = item4.SubLists.AddUnorderedSubList(UnorderedListStyle.Asterisk)
subList6.TextColor = RgbColor.BlueViolet
Dim item16 As ListItem = subList6.Items.Add("Community Edition")
Dim item17 As ListItem = subList6.Items.Add("Professional Edition")
Dim item18 As ListItem = subList6.Items.Add("Enterprise Edition")
Dim subList7 As UnorderedSubList = item5.SubLists.AddUnorderedSubList(UnorderedListStyle.Asterisk)
subList7.TextColor = RgbColor.BlueViolet
Dim item19 As ListItem = subList7.Items.Add("Standard Edition")
Dim item20 As ListItem = subList7.Items.Add("Professional Edition")
Dim item21 As ListItem = subList7.Items.Add("Enterprise Edition")
' Add UnOrderedList to the page.
MyPage.Elements.Add(list)
MyPage.Elements.Add(label1)
' Set the UnorderedList object equal to the rest of the text that did not fit
' if all the text did fit, GetOverflowList will return null
list = list.GetOverFlowList(50,50)
while Not list is Nothing
MyPage= new Page(PageSize.A4)
MyPage.Elements.Add(list)
MyDocument.Pages.Add(MyPage)
list = list.GetOverFlowList(50,50)
End While
' Save the PDF.
MyDocument.Draw("C:\MyDocument.pdf")
End sub
End Module
</code>
<code lang="C#">
using System;
using ceTe.DynamicPDF;
using ceTe.DynamicPDF.PageElements;
class MyClass
{
static void Main()
{
// Create a PDF Document.
Document doc = new Document();
// Create a Page.
Page page1 = new Page();
// Create a UnorderedList.
UnorderedList list = new UnorderedList(50,120,300,500,Font.Helvetica,12,UnorderedListStyle.Disc);
list.ListItemTopMargin = 5;
list.ListItemBottomMargin = 5;
list.TextColor = RgbColor.HotPink;
Label label1 = new Label("CeTe Software specializes in components for dynamic PDF generation and manipulation. The DynamicPDFΓäó product line allows you to dynamically generate PDF documents, merge PDF documents and add new content to existing PDF documents from within your applications.",50,50,400,200);
Initializes a new instance of the <see cref="T:ceTe.DynamicPDF.ReportWriter.Data.ClosingRecordSetEventArgs"/> class.
</summary>
<param name="recordSet">The <see cref="P:ceTe.DynamicPDF.ReportWriter.Data.ClosingRecordSetEventArgs.RecordSet"/> to use for the <see cref="T:ceTe.DynamicPDF.ReportWriter.Data.ClosingRecordSetEventArgs"/>.</param>
<param name="layoutWriter">The <see cref="P:ceTe.DynamicPDF.ReportWriter.Data.ClosingRecordSetEventArgs.LayoutWriter"/> to use for the <see cref="T:ceTe.DynamicPDF.ReportWriter.Data.ClosingRecordSetEventArgs"/>.</param>
Represents the method that will handle the <see cref="E:ceTe.DynamicPDF.ReportWriter.Data.Query.ClosingRecordSet"/> event of the <see cref="T:ceTe.DynamicPDF.ReportWriter.Data.Query"/>.
</summary>
<param name="sender">Reference of type <see cref="T:System.Object"/>.</param>
<param name="e">Reference of type <see cref="T:ceTe.DynamicPDF.ReportWriter.Data.ClosingRecordSetEventArgs"/>.</param>
<licensing>
This class is a DynamicPDF ReportWriter Professional Edition feature. One of the following licenses is required for non-evaluation usage:
<list type="bullet">
<item>DynamicPDF ReportWriter for .NET Professional Edition</item>
<item>DynamicPDF ReportWriter for .NET Enterprise Edition</item>
<item>DynamicPDF Suite for .NET Professional Edition</item>
<item>DynamicPDF Suite for .NET Enterprise Edition</item>
Initializes a new instance of the <see cref="T:ceTe.DynamicPDF.ReportWriter.Data.OpeningRecordSetEventArgs"/> class.
</summary>
<param name="layoutWriter">The <see cref="P:ceTe.DynamicPDF.ReportWriter.Data.OpeningRecordSetEventArgs.LayoutWriter"/> to use for the <see cref="T:ceTe.DynamicPDF.ReportWriter.Data.OpeningRecordSetEventArgs"/>.</param>
Represents the method that will handle the <see cref="E:ceTe.DynamicPDF.ReportWriter.Data.Query.OpeningRecordSet"/> event of the <see cref="T:ceTe.DynamicPDF.ReportWriter.Data.Query"/>.
</summary>
<param name="sender">Reference of type <see cref="T:System.Object"/>.</param>
<param name="e">Reference of type <see cref="T:ceTe.DynamicPDF.ReportWriter.Data.OpeningRecordSetEventArgs"/>.</param>
<licensing>
This class is a DynamicPDF ReportWriter Professional Edition feature. One of the following licenses is required for non-evaluation usage:
<list type="bullet">
<item>DynamicPDF ReportWriter for .NET Professional Edition</item>
<item>DynamicPDF ReportWriter for .NET Enterprise Edition</item>
<item>DynamicPDF Suite for .NET Professional Edition</item>
<item>DynamicPDF Suite for .NET Enterprise Edition</item>
Gets or sets the <see cref="P:ceTe.DynamicPDF.ReportWriter.Layout.LayoutTextArea.VAlign"/> enumeration that specifies the vertical text alignment of the report text area.
Gets or sets the <see cref="P:ceTe.DynamicPDF.ReportWriter.Layout.LayoutTextArea.Font"/> object used to specify the font of the text for the report text area.
Gets or sets the leading for the text of the report text area.
</summary>
<remarks>Setting this property will automatically set the <see cref="P:ceTe.DynamicPDF.ReportWriter.Layout.LayoutTextArea.AutoLeading"/> property to false.</remarks>
Gets or sets a value indicating whether the leading of the report text area should be calculated automatically.
</summary>
<remarks>This property is automatically set to false any time the <see cref="P:ceTe.DynamicPDF.ReportWriter.Layout.LayoutTextArea.Leading"/> property is set.</remarks>
Gets or sets the <see cref="T:ceTe.DynamicPDF.PageElements.FormattedTextAreaStyle"/> object used to specify the initial style of the formatted record area.
Gets the <see cref="P:ceTe.DynamicPDF.ReportWriter.ReportElements.FormattedRecordAreaLaidOutEventArgs.LayoutWriter"/> argument of the FormattedRecordArea's LaidOut Event.
Gets the <see cref="P:ceTe.DynamicPDF.ReportWriter.ReportElements.FormattedRecordAreaLaidOutEventArgs.FormattedTextArea"/> element of the FormattedRecordArea's LaidOut event.
Represents the method that will handle the <see cref="E:ceTe.DynamicPDF.ReportWriter.ReportElements.FormattedRecordArea.LaidOut"/> event of the <see cref="T:ceTe.DynamicPDF.ReportWriter.ReportElements.FormattedRecordArea"/>.
</summary>
<param name="sender">Reference of type <see cref="T:System.Object"/>.</param>
<param name="e">Reference of type <see cref="T:ceTe.DynamicPDF.ReportWriter.ReportElements.FormattedRecordAreaLaidOutEventArgs"/>.</param>
<licensing>
This class is a DynamicPDF ReportWriter Professional Edition feature. One of the following licenses is required for non-evaluation usage:
<list type="bullet">
<item>DynamicPDF ReportWriter for .NET Professional Edition</item>
<item>DynamicPDF ReportWriter for .NET Enterprise Edition</item>
<item>DynamicPDF Suite for .NET Professional Edition</item>
<item>DynamicPDF Suite for .NET Enterprise Edition</item>
Represents the method that will handle the <see cref="E:ceTe.DynamicPDF.ReportWriter.ReportElements.Image.LaidOut"/> event of the <see cref="T:ceTe.DynamicPDF.ReportWriter.ReportElements.Image"/>.
</summary>
<param name="sender">Reference of type <see cref="T:System.Object"/>.</param>
<param name="e">Reference of type <see cref="T:ceTe.DynamicPDF.ReportWriter.ReportElements.ImageLaidOutEventArgs"/>.</param>
<licensing>
This class is a DynamicPDF ReportWriter Professional Edition feature. One of the following licenses is required for non-evaluation usage:
<list type="bullet">
<item>DynamicPDF ReportWriter for .NET Professional Edition</item>
<item>DynamicPDF ReportWriter for .NET Enterprise Edition</item>
<item>DynamicPDF Suite for .NET Professional Edition</item>
<item>DynamicPDF Suite for .NET Enterprise Edition</item>
Gets or sets the <see cref="P:ceTe.DynamicPDF.ReportWriter.ReportElements.Label.VAlign"/> enumeration that specifies the vertical text alignment of the label.
Represents the method that will handle the <see cref="E:ceTe.DynamicPDF.ReportWriter.ReportElements.Label.LaidOut"/> event of the <see cref="T:ceTe.DynamicPDF.ReportWriter.ReportElements.Label"/>.
</summary>
<param name="sender">Reference of type <see cref="T:System.Object"/>.</param>
<param name="e">Reference of type <see cref="T:ceTe.DynamicPDF.ReportWriter.ReportElements.LabelLaidOutEventArgs"/>.</param>
<licensing>
This class is a DynamicPDF ReportWriter Professional Edition feature. One of the following licenses is required for non-evaluation usage:
<list type="bullet">
<item>DynamicPDF ReportWriter for .NET Professional Edition</item>
<item>DynamicPDF ReportWriter for .NET Enterprise Edition</item>
<item>DynamicPDF Suite for .NET Professional Edition</item>
<item>DynamicPDF Suite for .NET Enterprise Edition</item>
Represents the method that will handle the <see cref="E:ceTe.DynamicPDF.ReportWriter.ReportElements.Line.LaidOut"/> event of the <see cref="T:ceTe.DynamicPDF.ReportWriter.ReportElements.Line"/>.
</summary>
<param name="sender">Reference of type <see cref="T:System.Object"/>.</param>
<param name="e">Reference of type <see cref="T:ceTe.DynamicPDF.ReportWriter.ReportElements.LineLaidOutEventArgs"/>.</param>
<licensing>
This class is a DynamicPDF ReportWriter Professional Edition feature. One of the following licenses is required for non-evaluation usage:
<list type="bullet">
<item>DynamicPDF ReportWriter for .NET Professional Edition</item>
<item>DynamicPDF ReportWriter for .NET Enterprise Edition</item>
<item>DynamicPDF Suite for .NET Professional Edition</item>
<item>DynamicPDF Suite for .NET Enterprise Edition</item>
Gets or sets the <see cref="P:ceTe.DynamicPDF.ReportWriter.ReportElements.PageNumberingLabel.Align"/> enumeration that specifies the text alignment of the page numbering label.
Gets or sets the <see cref="P:ceTe.DynamicPDF.ReportWriter.ReportElements.PageNumberingLabel.Font"/> object to use for the text of the page numbering label.
Gets or sets the <see cref="P:ceTe.DynamicPDF.ReportWriter.ReportElements.PageNumberingLabel.VAlign"/> enumeration that specifies the vertical text alignment of the page numbering label.
Provides data for the <see cref="P:ceTe.DynamicPDF.ReportWriter.ReportElements.PageNumberingLabelLaidOutEventArgs.PageNumberingLabel">PageNumberingLabel's</see> LaidOut event.
</summary>
<licensing>
This class is a DynamicPDF ReportWriter Professional Edition feature. One of the following licenses is required for non-evaluation usage:
<list type="bullet">
<item>DynamicPDF ReportWriter for .NET Professional Edition</item>
<item>DynamicPDF ReportWriter for .NET Enterprise Edition</item>
<item>DynamicPDF Suite for .NET Professional Edition</item>
<item>DynamicPDF Suite for .NET Enterprise Edition</item>
Gets the <see cref="P:ceTe.DynamicPDF.ReportWriter.ReportElements.PageNumberingLabelLaidOutEventArgs.LayoutWriter"/> argument of the PageNumberingLabel's LaidOut Event.
Gets the <see cref="P:ceTe.DynamicPDF.ReportWriter.ReportElements.PageNumberingLabelLaidOutEventArgs.PageNumberingLabel"/> element of the PageNumberingLabel's LaidOut event.
Represents the method that will handle the <see cref="E:ceTe.DynamicPDF.ReportWriter.ReportElements.PageNumberingLabel.LaidOut"/> event of the <see cref="T:ceTe.DynamicPDF.ReportWriter.ReportElements.PageNumberingLabel"/>.
</summary>
<param name="sender">Reference of type <see cref="T:System.Object"/>.</param>
<param name="e">Reference of type <see cref="T:ceTe.DynamicPDF.ReportWriter.ReportElements.PageNumberingLabelLaidOutEventArgs"/>.</param>
<licensing>
This class is a DynamicPDF ReportWriter Professional Edition feature. One of the following licenses is required for non-evaluation usage:
<list type="bullet">
<item>DynamicPDF ReportWriter for .NET Professional Edition</item>
<item>DynamicPDF ReportWriter for .NET Enterprise Edition</item>
<item>DynamicPDF Suite for .NET Professional Edition</item>
<item>DynamicPDF Suite for .NET Enterprise Edition</item>
Gets the <see cref="P:ceTe.DynamicPDF.ReportWriter.ReportElements.PlaceHolderLaidOutEventArgs.LayoutWriter"/> argument of the PlaceHolder's LaidOut Event.
Gets the <see cref="P:ceTe.DynamicPDF.ReportWriter.ReportElements.PlaceHolderLaidOutEventArgs.ContentArea"/> argument of the PlaceHolder's LaidOut event.
Represents the method that will handle the <see cref="E:ceTe.DynamicPDF.ReportWriter.ReportElements.PlaceHolder.LaidOut"/> event of the <see cref="T:ceTe.DynamicPDF.ReportWriter.ReportElements.PlaceHolder"/>.
</summary>
<param name="sender">Reference of type <see cref="T:System.Object"/>.</param>
<param name="e">Reference of type <see cref="T:ceTe.DynamicPDF.ReportWriter.ReportElements.PlaceHolderLaidOutEventArgs"/>.</param>
<licensing>
This class is a DynamicPDF ReportWriter Professional Edition feature. One of the following licenses is required for non-evaluation usage:
<list type="bullet">
<item>DynamicPDF ReportWriter for .NET Professional Edition</item>
<item>DynamicPDF ReportWriter for .NET Enterprise Edition</item>
<item>DynamicPDF Suite for .NET Professional Edition</item>
<item>DynamicPDF Suite for .NET Enterprise Edition</item>
Gets or sets a value indicating whether the leading of the record area should be calculated automatically.
</summary>
<remarks>This property is automatically set to false any time the <see cref="P:ceTe.DynamicPDF.ReportWriter.ReportElements.RecordArea.Leading"/> property is set.</remarks>
Gets or sets the <see cref="P:ceTe.DynamicPDF.ReportWriter.ReportElements.RecordArea.Font"/> object used to specify the font of the text for the record area.
Gets or sets the leading for the text of the record area.
</summary>
<remarks>Setting this property will automatically set the <see cref="P:ceTe.DynamicPDF.ReportWriter.ReportElements.RecordArea.AutoLeading"/> property to false.</remarks>
Gets or sets the <see cref="P:ceTe.DynamicPDF.ReportWriter.ReportElements.RecordArea.VAlign"/> enumeration that specifies the vertical text alignment of the record area.
Gets the <see cref="P:ceTe.DynamicPDF.ReportWriter.ReportElements.RecordAreaLaidOutEventArgs.LayoutWriter"/> argument of the RecordArea's LaidOut Event.
Represents the method that will handle the <see cref="E:ceTe.DynamicPDF.ReportWriter.ReportElements.RecordArea.LaidOut"/> event of the <see cref="T:ceTe.DynamicPDF.ReportWriter.ReportElements.RecordArea"/>.
</summary>
<param name="sender">Reference of type <see cref="T:System.Object"/>.</param>
<param name="e">Reference of type <see cref="T:ceTe.DynamicPDF.ReportWriter.ReportElements.RecordAreaLaidOutEventArgs"/>.</param>
<licensing>
This class is a DynamicPDF ReportWriter Professional Edition feature. One of the following licenses is required for non-evaluation usage:
<list type="bullet">
<item>DynamicPDF ReportWriter for .NET Professional Edition</item>
<item>DynamicPDF ReportWriter for .NET Enterprise Edition</item>
<item>DynamicPDF Suite for .NET Professional Edition</item>
<item>DynamicPDF Suite for .NET Enterprise Edition</item>
Gets or sets a value indicating whether the leading of the record box should be calculated automatically.
</summary>
<remarks>This property is automatically set to false any time the <see cref="P:ceTe.DynamicPDF.ReportWriter.ReportElements.RecordBox.Leading"/> property is set.</remarks>
Gets or sets the <see cref="P:ceTe.DynamicPDF.ReportWriter.ReportElements.RecordBox.Font"/> object used to specify the font of the text for the record box.
Gets or sets the leading for the text of the record box.
</summary>
<remarks>Setting this property will automatically set the <see cref="P:ceTe.DynamicPDF.ReportWriter.ReportElements.RecordBox.AutoLeading"/> property to false.</remarks>
Gets or sets the <see cref="P:ceTe.DynamicPDF.ReportWriter.ReportElements.RecordBox.VAlign"/> enumeration that specifies the vertical text alignment of the record box.
Represents the method that will handle the <see cref="E:ceTe.DynamicPDF.ReportWriter.ReportElements.RecordBox.LaidOut"/> event of the <see cref="T:ceTe.DynamicPDF.ReportWriter.ReportElements.RecordBox"/>.
</summary>
<param name="sender">Reference of type <see cref="T:System.Object"/>.</param>
<param name="e">Reference of type <see cref="T:ceTe.DynamicPDF.ReportWriter.ReportElements.RecordBoxLaidOutEventArgs"/>.</param>
<licensing>
This class is a DynamicPDF ReportWriter Professional Edition feature. One of the following licenses is required for non-evaluation usage:
<list type="bullet">
<item>DynamicPDF ReportWriter for .NET Professional Edition</item>
<item>DynamicPDF ReportWriter for .NET Enterprise Edition</item>
<item>DynamicPDF Suite for .NET Professional Edition</item>
<item>DynamicPDF Suite for .NET Enterprise Edition</item>
Represents the method that will handle the <see cref="E:ceTe.DynamicPDF.ReportWriter.ReportElements.Rectangle.LaidOut"/> event of the <see cref="T:ceTe.DynamicPDF.ReportWriter.ReportElements.Rectangle"/>.
</summary>
<param name="sender">Reference of type <see cref="T:System.Object"/>.</param>
<param name="e">Reference of type <see cref="T:ceTe.DynamicPDF.ReportWriter.ReportElements.RectangleLaidOutEventArgs"/>.</param>
<licensing>
This class is a DynamicPDF ReportWriter Professional Edition feature. One of the following licenses is required for non-evaluation usage:
<list type="bullet">
<item>DynamicPDF ReportWriter for .NET Professional Edition</item>
<item>DynamicPDF ReportWriter for .NET Enterprise Edition</item>
<item>DynamicPDF Suite for .NET Professional Edition</item>
<item>DynamicPDF Suite for .NET Enterprise Edition</item>
Represents the method that will handle the <see cref="E:ceTe.DynamicPDF.ReportWriter.ReportElements.Symbol.LaidOut"/> event of the <see cref="T:ceTe.DynamicPDF.ReportWriter.ReportElements.Symbol"/>.
</summary>
<param name="sender">Reference of type <see cref="T:System.Object"/>.</param>
<param name="e">Reference of type <see cref="T:ceTe.DynamicPDF.ReportWriter.ReportElements.SymbolLaidOutEventArgs"/>.</param>
<licensing>
This class is a DynamicPDF ReportWriter Professional Edition feature. One of the following licenses is required for non-evaluation usage:
<list type="bullet">
<item>DynamicPDF ReportWriter for .NET Professional Edition</item>
<item>DynamicPDF ReportWriter for .NET Enterprise Edition</item>
<item>DynamicPDF Suite for .NET Professional Edition</item>
<item>DynamicPDF Suite for .NET Enterprise Edition</item>
Initializes a new instance of the <see cref="T:ceTe.DynamicPDF.ReportWriter.DocumentLayout"/> class.
</summary>
<param name="dplx">The <see cref="T:ceTe.DynamicPDF.ReportWriter.DplxFile"/> to use to create the <see cref="T:ceTe.DynamicPDF.ReportWriter.DocumentLayout"/> class.</param>
Represents the method that will handle the <see cref="E:ceTe.DynamicPDF.ReportWriter.FixedPage.PageLaidOut"/> event of the <see cref="T:ceTe.DynamicPDF.ReportWriter.FixedPage"/>.
</summary>
<param name="sender">Reference of type <see cref="T:System.Object"/>.</param>
<param name="e">Reference of type <see cref="T:ceTe.DynamicPDF.ReportWriter.PageLaidOutEventArgs"/>.</param>
<licensing>
This class is a DynamicPDF ReportWriter Professional Edition feature. One of the following licenses is required for non-evaluation usage:
<list type="bullet">
<item>DynamicPDF ReportWriter for .NET Professional Edition</item>
<item>DynamicPDF ReportWriter for .NET Enterprise Edition</item>
<item>DynamicPDF Suite for .NET Professional Edition</item>
<item>DynamicPDF Suite for .NET Enterprise Edition</item>
Represents the method that will handle the <see cref="E:ceTe.DynamicPDF.ReportWriter.FixedPage.PageLayingOut"/> event of the <see cref="T:ceTe.DynamicPDF.ReportWriter.FixedPage"/>.
</summary>
<param name="sender">Reference of type <see cref="T:System.Object"/>.</param>
<param name="e">Reference of type <see cref="T:ceTe.DynamicPDF.ReportWriter.PageLayingOutEventArgs"/>.</param>
<licensing>
This class is a DynamicPDF ReportWriter Professional Edition feature. One of the following licenses is required for non-evaluation usage:
<list type="bullet">
<item>DynamicPDF ReportWriter for .NET Professional Edition</item>
<item>DynamicPDF ReportWriter for .NET Enterprise Edition</item>
<item>DynamicPDF Suite for .NET Professional Edition</item>
<item>DynamicPDF Suite for .NET Enterprise Edition</item>
Represents the method that will handle the <see cref="E:ceTe.DynamicPDF.ReportWriter.Report.ReportLaidOut"/> event of the <see cref="T:ceTe.DynamicPDF.ReportWriter.Report"/>.
</summary>
<param name="sender">Reference of type <see cref="T:System.Object"/>.</param>
<param name="e">Reference of type <see cref="T:ceTe.DynamicPDF.ReportWriter.ReportLaidOutEventArgs"/>.</param>
<licensing>
This class is a DynamicPDF ReportWriter Professional Edition feature. One of the following licenses is required for non-evaluation usage:
<list type="bullet">
<item>DynamicPDF ReportWriter for .NET Professional Edition</item>
<item>DynamicPDF ReportWriter for .NET Enterprise Edition</item>
<item>DynamicPDF Suite for .NET Professional Edition</item>
<item>DynamicPDF Suite for .NET Enterprise Edition</item>
Represents the method that will handle the <see cref="E:ceTe.DynamicPDF.ReportWriter.Report.ReportLayingOut"/> event of the <see cref="T:ceTe.DynamicPDF.ReportWriter.Report"/>.
</summary>
<param name="sender">Reference of type <see cref="T:System.Object"/>.</param>
<param name="e">Reference of type <see cref="T:ceTe.DynamicPDF.ReportWriter.ReportLayingOutEventArgs"/>.</param>
<licensing>
This class is a DynamicPDF ReportWriter Professional Edition feature. One of the following licenses is required for non-evaluation usage:
<list type="bullet">
<item>DynamicPDF ReportWriter for .NET Professional Edition</item>
<item>DynamicPDF ReportWriter for .NET Enterprise Edition</item>
<item>DynamicPDF Suite for .NET Professional Edition</item>
<item>DynamicPDF Suite for .NET Enterprise Edition</item>
Represents the method that will handle the <see cref="E:ceTe.DynamicPDF.ReportWriter.Report.ReportPageLaidOut"/> event of the <see cref="T:ceTe.DynamicPDF.ReportWriter.Report"/>.
</summary>
<param name="sender">Reference of type <see cref="T:System.Object"/>.</param>
<param name="e">Reference of type <see cref="T:ceTe.DynamicPDF.ReportWriter.ReportPageLaidOutEventArgs"/>.</param>
<licensing>
This class is a DynamicPDF ReportWriter Professional Edition feature. One of the following licenses is required for non-evaluation usage:
<list type="bullet">
<item>DynamicPDF ReportWriter for .NET Professional Edition</item>
<item>DynamicPDF ReportWriter for .NET Enterprise Edition</item>
<item>DynamicPDF Suite for .NET Professional Edition</item>
<item>DynamicPDF Suite for .NET Enterprise Edition</item>
Represents the method that will handle the <see cref="E:ceTe.DynamicPDF.ReportWriter.Report.ReportPageLayingOut"/> event of the <see cref="T:ceTe.DynamicPDF.ReportWriter.Report"/>.
</summary>
<param name="sender">Reference of type <see cref="T:System.Object"/>.</param>
<param name="e">Reference of type <see cref="T:ceTe.DynamicPDF.ReportWriter.ReportPageLayingOutEventArgs"/>.</param>
<licensing>
This class is a DynamicPDF ReportWriter Professional Edition feature. One of the following licenses is required for non-evaluation usage:
<list type="bullet">
<item>DynamicPDF ReportWriter for .NET Professional Edition</item>
<item>DynamicPDF ReportWriter for .NET Enterprise Edition</item>
<item>DynamicPDF Suite for .NET Professional Edition</item>
<item>DynamicPDF Suite for .NET Enterprise Edition</item>
Base class from which single byte encoders are derived.
</summary>
<remarks>See the <a href="Text Encodings.html">Text Encodings</a> topic for more details on this.</remarks>
<example>This example shows how to Change the encoding of a built in font.<p/>
<code lang="VB">
Imports System
Imports ceTe.DynamicPDF
Imports ceTe.DynamicPDF.Text
Imports ceTe.DynamicPDF.PageElements
Module MyModule
Sub Main()
' Create a PDF Document
Dim MyDocument As Document = New Document
' Create a Page and add it to the document
Dim MyPage As Page = New Page
MyDocument.Pages.Add(MyPage)
' Create a core font with a specified encoding
Dim MyCentralEuropeHelveticaFont As Font = New Helvetica(Encoder.CentralEurope)
' Use the font in a text area Page Element
MyPage.Elements.Add(New TextArea("Text using the Central Europe encoder", 0, 0, 200, 12, MyCentralEuropeHelveticaFont, 12))
' Save the PDF document
MyDocument.Draw("C:\MyDocument.pdf")
End Sub
End Module
</code>
<code lang="C#">
using System;
using ceTe.DynamicPDF;
using ceTe.DynamicPDF.Text;
using ceTe.DynamicPDF.PageElements;
class MyClass
{
static void Main()
{
// Create a PDF Document
Document document = new Document();
// Create a Page and add it to the document
Page page = new Page();
document.Pages.Add( page );
// Create a core font with a specified encoding
Font centralEuropeHelveticaFont = new Helvetica( Encoder.CentralEurope );
// Use the font in a text area Page Element
page.Elements.Add( new TextArea( "Text using the Central Europe encoder", 0, 0, 200, 12, centralEuropeHelveticaFont, 12 ) );
// Save the PDF document
document.Draw( @"C:\MyDocument.pdf" );
}
}
</code>
</example>
<licensing>
This class is a DynamicPDF Generator Community Edition feature.
</licensing>
</member>
<member name="T:ceTe.DynamicPDF.Text.Encoder">
<summary>
Base class from which encoders are derived.
</summary>
<remarks>This class contains the static properties from which all encodings are accessed. See the <a href="Text Encodings.html">Text Encodings</a> topic for more details on this.</remarks>
<example>This example shows how to Change the encoding of a built in font.<p/>
<code lang="VB">
Imports System
Imports ceTe.DynamicPDF
Imports ceTe.DynamicPDF.Text
Imports ceTe.DynamicPDF.PageElements
Module MyModule
Sub Main()
' Create a PDF Document
Dim MyDocument As Document = New Document
' Create a Page and add it to the document
Dim MyPage As Page = New Page
MyDocument.Pages.Add(MyPage)
' Create a core font with a specified encoding
Dim MyCentralEuropeHelveticaFont As Font = New Helvetica(Encoder.CentralEurope)
' Use the font in a text area Page Element
MyPage.Elements.Add(New TextArea("Text using the Central Europe encoder", 0, 0, 200, 12, MyCentralEuropeHelveticaFont, 12))
' Save the PDF document
MyDocument.Draw("C:\MyDocument.pdf")
End Sub
End Module
</code>
<code lang="C#">
using System;
using ceTe.DynamicPDF;
using ceTe.DynamicPDF.Text;
using ceTe.DynamicPDF.PageElements;
class MyClass
{
static void Main()
{
// Create a PDF Document
Document document = new Document();
// Create a Page and add it to the document
Page page = new Page();
document.Pages.Add( page );
// Create a core font with a specified encoding
Font centralEuropeHelveticaFont = new Helvetica( Encoder.CentralEurope );
// Use the font in a text area Page Element
page.Elements.Add( new TextArea( "Text using the Central Europe encoder", 0, 0, 200, 12, centralEuropeHelveticaFont, 12 ) );
// Save the PDF document
document.Draw( @"C:\MyDocument.pdf" );
}
}
</code>
</example>
<licensing>
This class is a DynamicPDF Generator Community Edition feature.
Returns the <see cref="T:ceTe.DynamicPDF.Text.KerningValues"/>.
</summary>
<remarks>
The spacing array of <see cref="T:ceTe.DynamicPDF.Text.KerningValues"/> will contain zeros if there is not kern pair in the font or the combination glyphs
did not have any kerning.
</remarks>
<param name="rightToLeft">true if the text need to taken from right to left order.</param>
Draws the Paged-Text Schema to the given <see cref="T:ceTe.DynamicPDF.Xmp.XmpWriter"/> object.
</summary>
<param name="xwriter"><see cref="T:ceTe.DynamicPDF.Xmp.XmpWriter"/> object to receive the Paged-Text Schema's output.</param>
</member>
<member name="T:ceTe.DynamicPDF.Xmp.PdfASchema">
<summary>
Class represents PdfA Schema.
</summary>
<example>This example demonstrates the elements needed to specify a document as PDF/A-1b compatible.<p/>
<code lang="VB">
Imports System
Imports ceTe.DynamicPDF
Imports ceTe.DynamicPDF.PageElements
Imports ceTe.DynamicPDF.Xmp
Imports ceTe.DynamicPDF.Text
Module MyModule
Sub Main()
' Create a PDF Document
Dim MyDocument As Document = New Document
' Set Document Title Property
MyDocument.Title = "PDF/A1 Document"
' Create a XmpaMetadata instance
Dim MyXmp As XmpMetadata = New XmpMetadata()
' Add PDF/A schema with the conformance level.
Dim MyPdfaSchema As PdfASchema = New PdfASchema(PdfAStandard.PDF_A_1b_2005)
MyXmp.AddSchema(MyPdfaSchema)
Dim MyDc As DublinCoreSchema = MyXmp.DublinCore
MyDc.Title.AddLang("en-us", "PDF/A1 Document")
MyDocument.XmpMetadata = MyXmp
' Embedded iccprofile file.
Dim MyIccProfile As IccProfile = New IccProfile("C:\Temp\IccProfile\sRGB_IEC61966-2-1_noBPC.icc")
' Create Outputintent and add to documnet's outputIntents
Dim MyOutputIntents As OutputIntent = New OutputIntent("","IEC 61966-2.1 Default RGB colour space - sRGB 1 ","http://www.color.org","sRGB IEC61966-2.1 1",MyIccProfile)
AutoGradient autogradient = new AutoGradient(90, CmykColor.Blue, CmykColor.Red);
// Assign autogradient to Fillcolor property of rectangle
rectangle.FillColor = autogradient;
// Add the rectangle to the page
page.Elements.Add( rectangle );
// Save the PDF
document.Draw( @"C:\MyDocument.pdf" );
}
}
</code>
</example>
<licensing>
This class is a DynamicPDF Generator Professional Edition feature. One of the following licenses is required for non-evaluation usage:
<list type="bullet">
<item>DynamicPDF Generator for .NET Professional Edition</item>
<item>DynamicPDF Generator for .NET Enterprise Edition</item>
<item>DynamicPDF Merger for .NET Professional Edition</item>
<item>DynamicPDF Merger for .NET Enterprise Edition</item>
<item>DynamicPDF ReportWriter for .NET Professional Edition</item>
<item>DynamicPDF ReportWriter for .NET Enterprise Edition</item>
<item>DynamicPDF Core Suite for .NET Professional Edition</item>
<item>DynamicPDF Core Suite for .NET Enterprise Edition</item>
</list>
</licensing>
</member>
<member name="T:ceTe.DynamicPDF.Gradient">
<summary>
Represents a gradient pattern.
</summary>
<remarks>See the <a href="Colors.html">Colors</a> topic for more on gradient patterns.</remarks>
<licensing>
This class is a DynamicPDF Generator Professional Edition feature. One of the following licenses is required for non-evaluation usage:
<list type="bullet">
<item>DynamicPDF Generator for .NET Professional Edition</item>
<item>DynamicPDF Generator for .NET Enterprise Edition</item>
<item>DynamicPDF Merger for .NET Professional Edition</item>
<item>DynamicPDF Merger for .NET Enterprise Edition</item>
<item>DynamicPDF ReportWriter for .NET Professional Edition</item>
<item>DynamicPDF ReportWriter for .NET Enterprise Edition</item>
<item>DynamicPDF Core Suite for .NET Professional Edition</item>
<item>DynamicPDF Core Suite for .NET Enterprise Edition</item>
</list>
</licensing>
</member>
<member name="T:ceTe.DynamicPDF.Pattern">
<summary>
Represents the base class for all pattern colors are derived.
</summary>
<licensing>
This class is a DynamicPDF Generator Community Edition feature.
</licensing>
</member>
<member name="T:ceTe.DynamicPDF.Color">
<summary>
Base class representing color.
</summary>
<remarks>Color's derived classes are: <see cref="T:ceTe.DynamicPDF.CmykColor"/>, <see cref="T:ceTe.DynamicPDF.Grayscale"/>, <see cref="T:ceTe.DynamicPDF.WebColor"/>, <see cref="T:ceTe.DynamicPDF.RgbColor"/>, <see cref="T:ceTe.DynamicPDF.Gradient"/> and <see cref="T:ceTe.DynamicPDF.SpotColor"/>. See the <a href="Colors.html">Colors</a> topic for more on colors.</remarks>
<licensing>
This class is a DynamicPDF Generator Community Edition feature.
</licensing>
</member>
<member name="M:ceTe.DynamicPDF.Color.#ctor">
<summary>
Initializes a new instance of the <see cref="T:ceTe.DynamicPDF.Color"/> class.
Initializes a new instance of the <see cref="T:ceTe.DynamicPDF.AutoGradient"/> class.
</summary>
<param name="angle">Angle of the AutoGradient.</param>
<param name="color1">First RGB color.</param>
<param name="color2">Second RGB color.</param>
<remarks><b>NOTE:</b> The X1, Y1, X2 and Y2 properties of this class will be automatically calculated. If these values are set, they will be overwritten.</remarks>
Initializes a new instance of the <see cref="T:ceTe.DynamicPDF.AutoGradient"/> class.
</summary>
<param name="angle">Angle of the AutoGradient.</param>>
<param name="color1">First CMYK color.</param>
<param name="color2">Second CMYK color.</param>
<remarks><b>NOTE:</b> The X1, Y1, X2 and Y2 properties of this class will be automatically calculated. If these values are set, they will be overwritten.</remarks>
<remarks><b>NOTE:</b> The X1, Y1, X2 and Y2 properties of this class will be automatically calculated. If these values are set, they will be overwritten.</remarks>
Initializes a new instance of the <see cref="T:ceTe.DynamicPDF.AutoGradient"/> class.
</summary>
<param name="angle">Angle of the AutoGradient.</param>
<param name="color1">First RGB color.</param>
<param name="color2">Second RGB color.</param>
<remarks><b>NOTE:</b> The X1, Y1, X2 and Y2 properties of this class will be automatically calculated. If these values are set, they will be overwritten.</remarks>
Initializes a new instance of the <see cref="T:ceTe.DynamicPDF.AutoGradient"/> class.
</summary>
<param name="angle">Angle of the AutoGradient.</param>>
<param name="color1">First CMYK color.</param>
<param name="color2">Second CMYK color.</param>
<remarks><b>NOTE:</b> The X1, Y1, X2 and Y2 properties of this class will be automatically calculated. If these values are set, they will be overwritten.</remarks>
<remarks><b>NOTE:</b> The X1, Y1, X2 and Y2 properties of this class will be automatically calculated. If these values are set, they will be overwritten.</remarks>
Permitted changes are filling in forms, instantiating page templates, signing, annotation creation, deletion, and modification; other changes invalidate the signature
</summary>
</member>
<member name="T:ceTe.DynamicPDF.CmykColor">
<summary>
Represents a CMYK color.
</summary>
<remarks>See the <a href="Colors.html">Colors</a> topic for more on CMYK colors.</remarks>
<licensing>
This class is a DynamicPDF Generator Community Edition feature.
</licensing>
</member>
<member name="T:ceTe.DynamicPDF.DeviceColor">
<summary>
Represents the base class for which all solid colors are derived.
</summary>
<licensing>
This class is a DynamicPDF Generator Community Edition feature.
This class is a DynamicPDF Generator Community Edition feature.
</licensing>
</member>
<member name="T:ceTe.DynamicPDF.PageDimensions">
<summary>
Represents the dimensions of a page.
</summary>
<remarks>This class can be used to specify the dimensions and other formatting details of a page. It can then be passed into a <see cref="T:ceTe.DynamicPDF.Page"/> constructor.</remarks>
<example>The following example creates a new page using a <see cref="T:ceTe.DynamicPDF.PageDimensions"/> to set the margins of that page.
It then places a label on the page and rotates the page 90 degrees.<p/>
<code lang="VB">
Imports System
Imports ceTe.DynamicPDF
Imports ceTe.DynamicPDF.PageElements
Module MyModule
Sub Main()
' Create a PDF Document
Dim MyDocument As Document = New Document
' Create a page dimensions object and set the margins
Dim dimensions As PageDimensions = New PageDimensions(PageSize.Letter, PageOrientation.Portrait)
dimensions.BottomMargin = 50
dimensions.TopMargin = 50
dimensions.LeftMargin = 35
dimensions.RightMargin = 35
' Create a page using a page dimensions object and add it to the document
128 bit PDF security is compatible with PDF version 1.4 and higher and can be read
with Adobe Acrobat Reader version 5 and higher. Older readers will not be able to
read document encrypted with this security. For more details on high 128 bit security take a look at the <a href="Security.html">Security</a> topic.
</remarks>
<example>The following example will set the high security of the document so that the anyone who logs in
with the user password will not be able to print at high resolution, edit or add annotations or form fields, or access this document from other accessibility programs.<p/>
<code lang="VB">
Imports System
Imports ceTe.DynamicPDF
Imports ceTe.DynamicPDF.PageElements
Module MyModule
Sub Main()
' Create a PDF Document
Dim MyDocument As Document = New Document
' Create a Page and add it to the document
Dim MyPage As Page = New Page
MyDocument.Pages.Add(MyPage)
' Create a high security object
Dim security As HighSecurity = New HighSecurity("owner", "user")
' Set the permissions on that security object
security.AllowAccessibility = False
security.AllowDocumentAssembly = False
security.AllowHighResolutionPrinting = False
' Add the security object to the document
MyDocument.Security = security
' Create and display a label as a reference
Dim text As String = "This document has been encrypted with 128 bit encryption."
Dim MyIccProfile As IccProfile = New IccProfile("C:\ICC Profiles\USWebCoatedSWOP.icc")
Dim MyOutputIntent As OutputIntent = New OutputIntent("CGATS TR 001-1995 (SWOP)", "CGATS TR 001", "http://www.color.org", "U.S. Web Coated (SWOP) v2", MyIccProfile)
<returns>The size in typesetting points.</returns>
</member>
<member name="T:ceTe.DynamicPDF.UrlAction">
<summary>
Represents an action linking to an external URL.
</summary>
<remarks>This class can be used to specify a URL when defining a <see cref="T:ceTe.DynamicPDF.PageElements.Link"/> or a <see cref="T:ceTe.DynamicPDF.PageElements.Bookmark"/>.</remarks>
<example>This example shows how to create an outline for a PDF document using UrlAction.<p/>
<code lang="VB">
Imports System
Imports ceTe.DynamicPDF
Module MyModule
Sub Main()
' Create a PDF Document
Dim MyDocument As Document = New Document
' Add three blank pages
MyDocument.Pages.Add(New Page(PageSize.Letter))
MyDocument.Pages.Add(New Page(PageSize.Letter))
MyDocument.Pages.Add(New Page(PageSize.Letter))
' Add a top level outline and set properties
Dim MyOutline1 As Outline = MyDocument.Outlines.Add("Outline1")
MyOutline1.Style = TextStyle.Bold
MyOutline1.Color = New RgbColor(255, 0, 0)
' Add child outlines
Dim MyOutline1A As Outline = MyOutline1.Outlines.Add("Outline1A", New UrlAction("http://www.dynamicpdf.com"))
MyOutline1A.Expanded = False
Dim MyOutline1A1 As Outline = MyOutline1A.Outlines.Add("Outline1A1", New XYDestination(2, 0, 0))
Dim MyOutline1A2 As Outline = MyOutline1A.Outlines.Add("Outline1A2", New ZoomDestination(2, PageZoom.FitHeight))
Dim MyOutline1B As Outline = MyOutline1.Outlines.Add("Outline1B", New ZoomDestination(2, PageZoom.FitWidth))
' Add a second top level outline
Dim MyOutline2 As Outline = MyDocument.Outlines.Add("Outline2", New XYDestination(3, 0, 300))
' Add a child outline
Dim MyOutline2A As Outline = MyOutline2.Outlines.Add("Outline2A")
' Save the PDF document
MyDocument.Draw("C:\MyDocument.pdf")
End Sub
End Module
</code>
<code lang="C#">
using System;
using ceTe.DynamicPDF;
class MyClass
{
static void Main()
{
// Create a PDF Document
Document document = new Document();
// Add three blank pages
document.Pages.Add( new Page( PageSize.Letter ) );
document.Pages.Add( new Page( PageSize.Letter ) );
document.Pages.Add( new Page( PageSize.Letter ) );
The exception that is thrown for a WebCache error.
</summary>
<licensing>
This class is a DynamicPDF WebCache or DynamicPDF Generator Enterprise Edition feature. One of the following licenses is required for non-evaluation usage:
<list type="bullet">
<item>DynamicPDF WebCache for .NET</item>
<item>DynamicPDF Generator for .NET Enterprise Edition</item>
<item>DynamicPDF Merger for .NET Enterprise Edition</item>
<item>DynamicPDF ReportWriter for .NET Enterprise Edition</item>
<item>DynamicPDF Core Suite for .NET Enterprise Edition</item>
</list>
</licensing>
</member>
<member name="T:ceTe.DynamicPDF.WebCacheItem">
<summary>
Represents an item in the WebCache.
</summary>
<licensing>
This class is a DynamicPDF WebCache or DynamicPDF Generator Enterprise Edition feature. One of the following licenses is required for non-evaluation usage:
<list type="bullet">
<item>DynamicPDF WebCache for .NET</item>
<item>DynamicPDF Generator for .NET Enterprise Edition</item>
<item>DynamicPDF Merger for .NET Enterprise Edition</item>
<item>DynamicPDF ReportWriter for .NET Enterprise Edition</item>
<item>DynamicPDF Core Suite for .NET Enterprise Edition</item>
This method is a DynamicPDF WebCache or DynamicPDF Generator Enterprise Edition feature. One of the following licenses is required for non-evaluation usage:
<list type="bullet">
<item>DynamicPDF WebCache for .NET</item>
<item>DynamicPDF Generator for .NET Enterprise Edition</item>
<item>DynamicPDF Merger for .NET Enterprise Edition</item>
<item>DynamicPDF ReportWriter for .NET Enterprise Edition</item>
<item>DynamicPDF Core Suite for .NET Enterprise Edition</item>
Gets a value indicating the file name and path to use to store the PDF.
</summary>
<licensing>
This property is a DynamicPDF WebCache or DynamicPDF Generator Enterprise Edition feature. One of the following licenses is required for non-evaluation usage:
<list type="bullet">
<item>DynamicPDF WebCache for .NET</item>
<item>DynamicPDF Generator for .NET Enterprise Edition</item>
<item>DynamicPDF Merger for .NET Enterprise Edition</item>
<item>DynamicPDF ReportWriter for .NET Enterprise Edition</item>
<item>DynamicPDF Core Suite for .NET Enterprise Edition</item>
Gets a value indicating the secure URL to use to view the PDF.
</summary>
<licensing>
This property is a DynamicPDF WebCache or DynamicPDF Generator Enterprise Edition feature. One of the following licenses is required for non-evaluation usage:
<list type="bullet">
<item>DynamicPDF WebCache for .NET</item>
<item>DynamicPDF Generator for .NET Enterprise Edition</item>
<item>DynamicPDF Merger for .NET Enterprise Edition</item>
<item>DynamicPDF ReportWriter for .NET Enterprise Edition</item>
<item>DynamicPDF Core Suite for .NET Enterprise Edition</item>
</list>
</licensing>
</member>
<member name="T:ceTe.DynamicPDF.WebColor">
<summary>
Represents an RGB color created using the web hexadecimal convention.
</summary>
<remarks>See the <a href="Colors.html">Colors</a> topic for more on web colors.</remarks>
<licensing>
This class is a DynamicPDF Generator Community Edition feature.
Initializes a new instance of the <see cref="T:ceTe.DynamicPDF.WebColor"/> class.
</summary>
<param name="webColor">The hexadecimal string representing the color.</param>
</member>
<member name="T:ceTe.DynamicPDF.XYDestination">
<summary>
Represents a destination to a coordinate on a page.
</summary>
<remarks>This class can be used to specify a certain page and X Y location for defining a <see cref="T:ceTe.DynamicPDF.PageElements.Link"/> or a <see cref="T:ceTe.DynamicPDF.PageElements.Bookmark"/>.</remarks>
<example>This example shows how to create an outline for a PDF document using XYDestination.<p/>
<code lang="VB">
Imports System
Imports ceTe.DynamicPDF
Module MyModule
Sub Main()
' Create a PDF Document
Dim MyDocument As Document = New Document
' Add three blank pages
MyDocument.Pages.Add(New Page(PageSize.Letter))
MyDocument.Pages.Add(New Page(PageSize.Letter))
MyDocument.Pages.Add(New Page(PageSize.Letter))
' Add a top level outline and set properties
Dim MyOutline1 As Outline = MyDocument.Outlines.Add("Outline1")
MyOutline1.Style = TextStyle.Bold
MyOutline1.Color = New RgbColor(255, 0, 0)
' Add child outlines
Dim MyOutline1A As Outline = MyOutline1.Outlines.Add("Outline1A", New UrlAction("http://www.dynamicpdf.com"))
MyOutline1A.IsExpanded = False
Dim MyOutline1A1 As Outline = MyOutline1A.Outlines.Add("Outline1A1", New XYDestination(2, 0, 0))
Dim MyOutline1A2 As Outline = MyOutline1A.Outlines.Add("Outline1A2", New ZoomDestination(2, PageZoom.FitHeight))
Dim MyOutline1B As Outline = MyOutline1.Outlines.Add("Outline1B", New ZoomDestination(2, PageZoom.FitWidth))
' Add a second top level outline
Dim MyOutline2 As Outline = MyDocument.Outlines.Add("Outline2", New XYDestination(3, 0, 300))
' Add a child outline
Dim MyOutline2A As Outline = MyOutline2.Outlines.Add("Outline2A")
' Save the PDF document
MyDocument.Draw("C:\MyDocument.pdf")
End Sub
End Module
</code>
<code lang="C#">
using System;
using ceTe.DynamicPDF;
class MyClass
{
static void Main()
{
// Create a PDF Document
Document document = new Document();
// Add three blank pages
document.Pages.Add( new Page( PageSize.Letter ) );
document.Pages.Add( new Page( PageSize.Letter ) );
document.Pages.Add( new Page( PageSize.Letter ) );
Draws the destination to the specified <see cref="T:ceTe.DynamicPDF.IO.DocumentWriter"/> object.
</summary>
<param name="writer"><see cref="T:ceTe.DynamicPDF.IO.DocumentWriter"/> object to receive the destinations output.</param>
</member>
<member name="P:ceTe.DynamicPDF.XYDestination.X">
<summary>
Gets or sets the X coordinate targeted by the destination.
</summary>
</member>
<member name="P:ceTe.DynamicPDF.XYDestination.Y">
<summary>
Gets or sets the Y coordinate targeted by the destination.
</summary>
</member>
<member name="T:ceTe.DynamicPDF.ZoomDestination">
<summary>
Represents a destination to a page at a given zoom.
</summary>
<remarks>This class can be used to specify a certain page at a certain zoom when defining a <see cref="T:ceTe.DynamicPDF.PageElements.Link"/> or a <see cref="T:ceTe.DynamicPDF.PageElements.Bookmark"/>.</remarks>
<example>This example shows how to create an outline for a PDF document using ZoomDestination.<p/>
<code lang="VB">
Imports System
Imports ceTe.DynamicPDF
Module MyModule
Sub Main()
' Create a PDF Document
Dim MyDocument As Document = New Document
' Add three blank pages
MyDocument.Pages.Add(New Page(PageSize.Letter))
MyDocument.Pages.Add(New Page(PageSize.Letter))
MyDocument.Pages.Add(New Page(PageSize.Letter))
' Add a top level outline and set properties
Dim MyOutline1 As Outline = MyDocument.Outlines.Add("Outline1")
MyOutline1.Style = TextStyle.Bold
MyOutline1.Color = New RgbColor(255, 0, 0)
' Add child outlines
Dim MyOutline1A As Outline = MyOutline1.Outlines.Add("Outline1A", New UrlAction("http://www.dynamicpdf.com"))
MyOutline1A.IsExpanded = False
Dim MyOutline1A1 As Outline = MyOutline1A.Outlines.Add("Outline1A1", New XYDestination(2, 0, 0))
Dim MyOutline1A2 As Outline = MyOutline1A.Outlines.Add("Outline1A2", New ZoomDestination(2, PageZoom.FitHeight))
Dim MyOutline1B As Outline = MyOutline1.Outlines.Add("Outline1B", New ZoomDestination(2, PageZoom.FitWidth))
' Add a second top level outline
Dim MyOutline2 As Outline = MyDocument.Outlines.Add("Outline2", New XYDestination(3, 0, 300))
' Add a child outline
Dim MyOutline2A As Outline = MyOutline2.Outlines.Add("Outline2A")
' Save the PDF document
MyDocument.Draw("C:\MyDocument.pdf")
End Sub
End Module
</code>
<code lang="C#">
using System;
using ceTe.DynamicPDF;
class MyClass
{
static void Main()
{
// Create a PDF Document
Document document = new Document();
// Add three blank pages
document.Pages.Add( new Page( PageSize.Letter ) );
document.Pages.Add( new Page( PageSize.Letter ) );
document.Pages.Add( new Page( PageSize.Letter ) );
