PDFGen Class

Properties   Methods   Events   Config Settings   Errors  

The PDFGen class creates PDF documents from scratch.

Syntax

pdfsdk.PDFGen

Remarks

PDFGen is a versatile document generation class that can be used to create PDF documents in a highly customizable way.

Preparing the document for editing is as easy as calling CreateNew. Before calling this method, optionally configure baseline properties that you would like to apply to the new document, such as its page dimensions (SetLayout), page numbering (SetDocumentProperty), or PDF/A compliance requirements (EnforcePDFA). Then start composing the document by adding content. When finished, call Close to close the document and save the changes to either OutputFile, OutputData, or the stream set in SetOutputStream.

The example below configures page numbers in the right header, adds a centered title with bold and underline formatting, and finally adds a left-aligned paragraph. PDFGen pdfgen = new PDFGen(); pdfgen.OutputFile = "output.pdf"; pdfgen.SetDocumentProperty("PageRightHeader", "%PAGENUMBER%"); pdfgen.CreateNew(); pdfgen.SetAlignment((int)HorizontalAlignments.haCenter, (int)VerticalAlignments.vaTop, false); pdfgen.SetFont("Arial", "20", "bold underline", "forestgreen"); pdfgen.AddTextBlock("The Preface"); pdfgen.SetFont("Times New Roman", "14", "regular", "black"); pdfgen.AddBreak(0); pdfgen.AddBreak(0); pdfgen.SetAlignment((int)HorizontalAlignments.haLeft, (int)VerticalAlignments.vaTop, false); pdfgen.AddParagraph("The artist is the creator of beautiful things. To reveal art and conceal the artist is art's aim. The critic is he who can translate into another manner or a new material his impression of beautiful things."); pdfgen.Close();

Canvases and the Editing Process

Every editing operation performed by PDFGen goes through a canvas, which is an editing window with a set of rules and operations defined for it that is either:

• A text canvas, which can be thought of as a multi-line rich text editor;
• A drawing canvas, a rectangular random-access drawing area; or
• A table canvas, a rectangular grid of rows and columns.

The canvas types are distinct, meaning only one of them can be used at a time to create a specific piece of content. Canvases of different types can be grouped together or used as part of other canvases, which provides a powerful and flexible tool for creating content of various types and complexities. For example, a drawing canvas containing a graphic can be embedded into a text canvas containing the document body.

When CreateNew is called, the class automatically creates a page-wide text canvas (a "page canvas") so you can start adding content right away. This canvas takes into account the dimensions of the page and any margins configured. One-inch margins are set by default. Upon reaching the end of the page, the class closes the corresponding canvas, creates a new one for the next page (thus "turning the page" behind the scenes), and continues until all the content has been added.

You can always create your own canvases (and sub-canvases) should you need to add non-standard kinds of content that go beyond the traditional document layout, such as marginal notes, watermarks, or signatures.

Additionally, a canvas exists in one of three states:

• Open, where it is in the process of editing and the content can still be changed;
• Closed, where editing has been completed and the content has been finalized ("committed"); or
• Rendered, where the content has been serialized from its internal closed representation into a PDF graphics stream.

An open canvas resembles an active editing area. Examples include a text canvas containing a line of text to which words are still being added, and a drawing canvas containing a path that has been started but not completed.

Changes made to an open canvas may influence how the content will be represented in the document when the canvas is eventually rendered. For example, any text added to a center-aligned line in a text canvas will cause existing text to move leftward. Any text added to a drawing canvas - which is random access and does not offer the capability of formatting - will not affect any other content added to it previously.

A closed canvas resembles an opaque rectangle filled with visual elements. Once a canvas is closed, all such elements become locked and their dimensions are known, which enables their absolute positions and sizes to be calculated unambiguously as the class can be certain that they will not change.

During the editing process, PDFGen creates pieces of content, fills them in, closes them, and renders them onto the page. It adds content to the document sequentially like a typewriter: once added, content cannot be deleted. However, unlike a typewriter, content can be automatically formatted by the class on a later stage. For example, updating the dimensions of a text canvas may cause elements added to it previously to be rearranged, similar to how expanding a text area control in a browser form rearranges its content.

Text Canvases

A text canvas is a vertical series of lines, each comprised of a horizontal series of elements. It is analogous to a traditional text editor and is used for creating structured (mostly textual) content, which is added element by element, line by line. Pages, signature fields added via AddSignatureField, and table cells are all kinds of text canvases.

Random access is not allowed in text canvases; instead, the class stacks elements in the current line and arranges them as they are added. This means that in general, the dimensions of a text canvas (its Width and Height) are not fixed and may expand horizontally and vertically.

If the current line is full and cannot accommodate a subsequent element (and the chosen constraints do not allow for it to be expanded), in most cases the class will complete the current line, add a new one, place the cursor at the beginning of the new line, and add the element there. However, if the element's width exceeds MaxWidth, it will not fit in the new line either, so the OutOfSpace event will fire to give your code a chance to forcefully expand the canvas or cancel the insertion of the element altogether.

Similarly, exceeding MaxHeight will also cause the class to automatically wrap to the next default canvas (e.g., the next page or column) or trigger OutOfSpace. Subscribe to that event to recover from failed calls in a flexible way.

Drawing Canvases

A drawing canvas is analogous to a drawing board and is used for creating free-form vector content in two-dimensional Cartesian space. A drawing canvas provides random access: primitives can be placed anywhere within its bounds in any order, and all coordinates are specified relative to the bottom-left corner of the canvas.

Content is built from path primitives, which include lines, curves, and closed shapes that can be stroked, filled, or used to define clipping regions. Common shapes such as rectangles, circles, and polygons are also supported directly, as is importing SVG path data via AddDrawing and placing bitmaps via AddBitmap.

The visual appearance of each primitive is controlled by the active Pen and Brush at the time the path is started. The pen governs the stroke (color, thickness, style, line cap, and line join) and the brush governs the fill (color and opacity). Use SetPen and SetBrush to configure these properties; they remain in effect until changed.

The dimensions of a drawing canvas are fixed at creation time. Content that exceeds these bounds is clipped. When committed to its parent canvas via EndDrawing, the drawing canvas can be scaled, skewed, and rotated as needed.

When committed to a text canvas, a drawing canvas is treated as an inline element and flows with surrounding content, just like text and bitmaps. When committed to another drawing canvas, it is positioned at explicit coordinates within that canvas.

Table Canvases

A table canvas is used for creating grid-based content organized into rows and columns. The column count is fixed at creation time; rows and cells are added sequentially, and the layout engine resolves all column widths and row heights when the table is committed to its parent canvas via EndTable.

Each cell is itself a text canvas, so any content that can be added to a page can also be added to a cell, including paragraphs, bitmaps, and nested drawing canvases. Cells can span multiple columns or rows, which the layout engine automatically accounts for when distributing space.

Width constraints can be specified at both the table and cell level. When no preferred width is given, the layout engine distributes available space proportionally across columns based on their content. Row heights follow the same principle: the height of each row is determined by the tallest cell it contains, unless a fixed or minimum height is specified via StartTableRow.

The Pen and Brush active when a cell is opened determine its border style and background fill. Individual cell borders can be suppressed via a bitmask passed to StartTableCell, allowing any combination of top, right, bottom, and left borders to be hidden independently.

Property List

---

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

Method List

---

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

Event List

---

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

Config Settings

---

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

Attachments Property (PDFGen Class)

A collection of all attached files added to the document.

Syntax

public PDFAttachmentList getAttachments();

Remarks

This property is used to access the details of all the attached files added to the document. Use the AddAttachment and RemoveAttachment methods to add and remove attachments to/from this collection respectively.

This property is not available at design time.

Please refer to the PDFAttachment type for a complete list of fields.

Brush Property (PDFGen Class)

The current brush settings.

Syntax

public PDFBrush getBrush();

Remarks

This property is used to access the fill configuration most recently applied via SetBrush.

This property is read-only and not available at design time.

Please refer to the PDFBrush type for a complete list of fields.

Canvas Property (PDFGen Class)

The current canvas.

Syntax

public PDFCanvas getCanvas();

Remarks

This property is used to access the details of the current canvas after one of the following methods is called:

• CreateNew (page canvas)
• StartDrawing (drawing canvas)
• StartEditing (text canvas)
• StartSignatureField (signature field canvas)
• StartTable (table canvas)
• StartTableCell (cell canvas)

It may be used to adjust the maximum dimensions of the canvas before calling the corresponding End* method.

This property is read-only and not available at design time.

Please refer to the PDFCanvas type for a complete list of fields.

Font Property (PDFGen Class)

The currently set font.

Syntax

public PDFFont getFont();

Remarks

This property is used to access the font details specified using the SetFont method.

This property is read-only and not available at design time.

Please refer to the PDFFont type for a complete list of fields.

Layout Property (PDFGen Class)

The current page layout.

Syntax

public PDFPageLayout getLayout();

Remarks

This property is used to access the current page settings specified using the SetLayout method.

This property is read-only and not available at design time.

Please refer to the PDFPageLayout type for a complete list of fields.

OutputData Property (PDFGen Class)

A byte array containing the PDF document after processing.

Syntax

public byte[] getOutputData();

Remarks

This property is used to read the byte array containing the produced output after the operation has completed. It will only be set if an output file and output stream have not been assigned via OutputFile and SetOutputStream respectively.

This property is read-only and not available at design time.

OutputFile Property (PDFGen Class)

The path to a local file where the output will be written.

Syntax

public String getOutputFile();
public void setOutputFile(String outputFile);

Default Value

""

Remarks

This property is used to provide a path where the resulting PDF document will be saved after the operation has completed.

Overwrite Property (PDFGen Class)

Whether or not the class should overwrite files.

Syntax

public boolean isOverwrite();
public void setOverwrite(boolean overwrite);

Default Value

False

Remarks

This property indicates whether or not the class will overwrite OutputFile. If set to false, an error will be thrown whenever OutputFile exists before an operation.

Pen Property (PDFGen Class)

The current pen settings.

Syntax

public PDFPen getPen();

Remarks

This property is used to access the stroke configuration most recently applied via SetPen.

This property is read-only and not available at design time.

Please refer to the PDFPen type for a complete list of fields.

AddAttachment Method (PDFGen Class)

Adds an attachment to the document.

Syntax

public void addAttachment(String fileName, String description);

Remarks

This method is used to add an attachment (embedded file) to the document and to the Attachments collection.

FileName and Description specify the filename and description of the attachment respectively.

Example: pdfgen.AddAttachment("foo.txt", "desc"); // Alternatively, create a PDFAttachment object and add it to Attachments manually: PDFAttachment attachment = new PDFAttachment(); attachment.FileName = "foo.txt"; // or attachment.DataB = new byte[] { ... }; // or attachment.InputStream = new FileStream(...); attachment.Description = "desc"; pdfgen.Attachments.Add(attachment); // Or using one of the constructors: pdfgen.Attachments.Add(new PDFAttachment("foo.txt", "desc")); pdfgen.Close(); The full list of attachments is contained in the Attachments collection.

AddBitmap Method (PDFGen Class)

Adds a bitmap image to the current canvas.

Syntax

public void addBitmap(String format, byte[] bytes, int bitmapWidth, int bitmapHeight, String scaleWidth, String scaleHeight);

Remarks

This method is used to add a bitmap image to the current canvas.

Its behavior differs depending on the type of canvas it is called on. On a text canvas, the image is treated as an inline element and placed in the normal flow of content, following the same layout rules as text and other content. On a drawing canvas, the image is placed at the current pen position.

Format specifies the image format and color space of the supplied bytes, as a combined string (e.g., png-rgb, jpeg-cmyk).

Bytes contains the raw image data.

BitmapWidth and BitmapHeight specify the intrinsic pixel dimensions of the image.

ScaleWidth and ScaleHeight specify the rendered dimensions of the image in points.

AddBreak Method (PDFGen Class)

Adds a break to the text canvas.

Syntax

public void addBreak(int breakKind);

Remarks

This method is used to add a break to the current text canvas, completing the current section early.

BreakKind specifies the kind of break to add. Possible values are:

NOTE: This method will throw an exception if the current canvas is not a text canvas.

AddButton Method (PDFGen Class)

Adds a button field to the form.

Syntax

public void addButton(String name, String caption, String width, int actionType);

Remarks

This method is used to create a button field with name Name and caption Caption.

Width specifies the width of the button in either points (e.g., 30pt) or characters (e.g., 30).

ActionType specifies the type of action that will be executed when the button is pressed. Possible values are:

AddCheckBox Method (PDFGen Class)

Adds a checkbox field to the form.

Syntax

public void addCheckBox(String name, boolean defaultValue);

Remarks

This method is used to create a checkbox field with name Name.

DefaultValue specifies the initial state of the checkbox (checked/unchecked).

AddComboBox Method (PDFGen Class)

Adds a combo box field to the form.

Syntax

public void addComboBox(String name, String options, String defaultValue, String width);

Remarks

This method is used to create a combo box field with name Name.

Options specifies a list of choices as a multi-line string.

DefaultValue specifies the initial value selected in the combo box.

Width specifies the width of the combo box in either points (e.g., 30pt) or characters (e.g., 30).

To create a combo box incrementally instead of all at once, use the StartComboBox and EndComboBox methods.

AddCopy Method (PDFGen Class)

Adds a copy of a previously saved element to the text canvas.

Syntax

public void addCopy(String name);

Remarks

This method is currently unsupported.

AddDrawing Method (PDFGen Class)

Adds a vector drawing described by an SVG path string to the current canvas.

Syntax

public void addDrawing(String svgPath, String scaleX, String scaleY);

Remarks

This method is used to parse an SVG path data string and add the resulting drawing to the current canvas.

SvgPath is a standard SVG path data string using the commands M, L, H, V, C, S, Q, T, Z (and their lowercase relative equivalents). The following commands are supported:

Arc commands (A / a) are not yet supported.

ScaleX and ScaleY specify the horizontal and vertical scale factors to apply to the drawing when placing it on the parent canvas. These parameters accept real values, with 1.0 being the actual size of the drawing (100%).

If the current canvas is already a drawing canvas, the path is imported directly into it. Otherwise, a temporary drawing canvas is created, the path is added to it, and the canvas is committed to the current canvas using ScaleX and ScaleY.

AddHeading Method (PDFGen Class)

Adds a heading to the text canvas.

Syntax

public void addHeading(int level, String text);

Remarks

This method is currently unsupported.

AddLink Method (PDFGen Class)

Adds a hyperlink to the text canvas.

Syntax

public void addLink(String text, String URL);

Remarks

This method is currently unsupported.

AddListBox Method (PDFGen Class)

Adds a list box field to the form.

Syntax

public void addListBox(String name, String options, String defaultValue, String width, String height);

Remarks

This method is used to create a list box field with name Name.

Options specifies a list of choices as a multi-line string.

DefaultValue specifies the initial value selected in the list box.

Width and Height specify the width and height of the list box in either points (e.g., 30pt) or characters (e.g., 30).

To create a list box incrementally instead of all at once, use the StartListBox and EndListBox methods.

AddListItem Method (PDFGen Class)

Adds an item to a list, combo box, or list box.

Syntax

public void addListItem(String text, String name);

Remarks

This method is used to add Text as either a list item or a choice in a combo box or list box field.

Name specifies the name of the item.

To create a list item incrementally instead of all at once, use the StartListItem and EndListItem methods.

NOTE: This method will throw an exception if the current canvas is not a text canvas.

AddParagraph Method (PDFGen Class)

Adds a paragraph of text to the text canvas.

Syntax

public void addParagraph(String text);

Remarks

This method is used to add a paragraph of Text to the current text canvas, which is done by breaking the text into lines and then words, and adding each word as a separate text block. When the end of a line is reached, the class will insert a line break and apply the line spacing set in SetMargin before continuing on to the next line of the paragraph.

Use the SetAlignment and SetFont methods to adjust the parameters of the text blocks that comprise the new paragraph, and use the SetMargin method to indent the first line of the paragraph.

To create a paragraph incrementally instead of all at once, use the StartParagraph and EndParagraph methods.

NOTE: This method will throw an exception if the current canvas is not a text canvas.

AddRadioButton Method (PDFGen Class)

Adds a radio button to the form.

Syntax

public void addRadioButton(String radioGroup, String name, boolean isDefaultButton);

Remarks

This method is used to create a radio button field with name Name within the radio group RadioGroup.

IsDefaultButton specifies whether the radio button will be selected initially (i.e., whether it will be the default value of the radio group).

AddSignatureField Method (PDFGen Class)

Adds a signature field to the form.

Syntax

public void addSignatureField(String name, String width, String height);

Remarks

This method is used to create a signature field with name Name as a text canvas.

Width and Height specify the width and height of the signature field in either points (e.g., 30pt) or characters (e.g., 30).

To create a signature field incrementally instead of all at once, use the StartSignatureField and EndSignatureField methods.

AddSpecial Method (PDFGen Class)

Adds a special element to the text canvas.

Syntax

public void addSpecial(int type, String content);

Remarks

This method is currently unsupported.

AddTableCell Method (PDFGen Class)

Adds a single-paragraph cell to the current table row.

Syntax

public void addTableCell(String text, String width, String minWidth, String maxWidth);

Remarks

This convenience method is used to open a new cell, add Text as a paragraph, and close the cell in a single call. It is equivalent to calling StartTableCell with ColSpan and RowSpan set to 1 and Borders set to 0, followed by AddParagraph and EndTableCell.

Text specifies the text content of the cell. If empty, an empty cell is added.

Width, MinWidth, and MaxWidth specify the cell width constraints in points, and follow the same rules as the corresponding parameters in StartTableCell. Both integer and decimal values are supported.

Use this method when a cell contains only a single plain-text paragraph and does not require colspan, rowspan, or complex inner content. For cells with richer content or spanning requirements, use StartTableCell and EndTableCell directly.

NOTE: This method will throw an exception if the current canvas is not a table canvas.

AddTextBlock Method (PDFGen Class)

Adds a block of text to the text canvas.

Syntax

public void addTextBlock(String text);

Remarks

This method is used to add a block of Text to the current line of the current text canvas. Use the SetAlignment and SetFont methods to adjust new text block parameters.

NOTE: This method only applies if the current canvas is a text canvas.

AddTextBox Method (PDFGen Class)

Adds a text box field to the form.

Syntax

public void addTextBox(String name, String defaultValue, boolean multiLine, String width, String height, boolean password);

Remarks

This method is used to create a text box field with name Name.

DefaultValue specifies the initial value contained in the text box.

MultiLine specifies whether the text box can contain multiple lines of text.

Width and Height specify the width and height of the text box in either points (e.g., 30pt) or characters (e.g., 30).

Password specifies whether the text box is intended to contain a password. If this parameter is true, the text will be displayed as asterisk characters (*).

AddTitle Method (PDFGen Class)

Adds a title to the text canvas.

Syntax

public void addTitle(String text);

Remarks

This method is currently unsupported.

Cancel Method (PDFGen Class)

Cancels the current canvas.

Syntax

public void cancel();

Remarks

This method is used to cancel the canvas that is currently being edited. It should be called after one of the following methods as an alternative to setting Choice to oscFullCancel within the OutOfSpace event:

• StartDrawing
• StartEditing
• StartSignatureField
• StartTable
• StartTableCell

Example: pdfgen.StartEditing("100", "100"); pdfgen.AddTextBlock("Hello world!"); try { pdfgen.EndEditing("", "", "1", "1", "0", "0", "0", ""); } catch (PDFSDKException ex) { pdfgen.Cancel(); } NOTE: This method will throw an exception if the current canvas is a page canvas.

Close Method (PDFGen Class)

Closes the new document.

Syntax

public void close();

Remarks

This method is used to close the new document. It should always be preceded by a call to the CreateNew method.

Example: pdfgen.OutputFile = "output.pdf"; pdfgen.CreateNew(); // Some operation pdfgen.Close(); The document will be saved automatically to OutputFile, OutputData, or the stream set in SetOutputStream when this method is called. To configure this saving behavior, set the SaveChanges configuration setting.

Config Method (PDFGen Class)

Sets or retrieves a configuration setting.

Syntax

public String config(String configurationString);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

CreateNew Method (PDFGen Class)

Creates a new PDF document.

Syntax

public void createNew();

Remarks

This method is used to create a blank PDF document with one empty page and an underlying page canvas. Use the SetLayout method to adjust the new page dimensions and number of columns. Having created the baseline document, use the class's methods to add objects to it.

Upon completion of this method, information about the newly created page canvas can be accessed using the Canvas property.

DrawCircle Method (PDFGen Class)

Draws an ellipse or circle on the drawing canvas.

Syntax

public void drawCircle(String X, String Y, String radiusX, String radiusY);

Remarks

This method is used to add a closed elliptical shape centered at (X, Y) to the current drawing canvas.

RadiusX and RadiusY specify the horizontal and vertical radii of the ellipse in points. Both integer and decimal values are supported. To draw a perfect circle, pass equal values for both.

Use SetPen and SetBrush before calling this method to control the border style and fill color.

NOTE: This method will throw an exception if the current canvas is not a drawing canvas.

DrawCopy Method (PDFGen Class)

Draws a copy of a previously saved element onto the drawing canvas.

Syntax

public void drawCopy(String name, String X, String Y, String scaleX, String scaleY, String rotation, String skewA, String skewB);

Remarks

This method is currently unsupported.

DrawCurveTo Method (PDFGen Class)

Adds a cubic Bezier curve segment to the current path.

Syntax

public void drawCurveTo(String X, String Y, String viaX1, String viaY1, String viaX2, String viaY2);

Remarks

This method is used to extend the currently open path on the drawing canvas with a cubic Bezier curve from the current pen position to the endpoint specified by X and Y. Both integer and decimal values are supported.

ViaX1 and ViaY1 specify the first control point, which influences the curve near its start.

ViaX2 and ViaY2 specify the second control point, which influences the curve near its end.

Upon completion of this method, the current pen position will be moved to (X, Y).

NOTE: This method will throw an exception if the current canvas is not a drawing canvas or if no path has been started with StartPath.

DrawLineTo Method (PDFGen Class)

Adds a straight line segment to the current path.

Syntax

public void drawLineTo(String X, String Y);

Remarks

This method is used to extend the currently open path on the drawing canvas with a straight line from the current pen position to the point specified by X and Y. Both integer and decimal values are supported.

Upon completion of this method, the current pen position will be moved to (X, Y).

NOTE: This method will throw an exception if the current canvas is not a drawing canvas or if no path has been started with StartPath.

DrawPolygon Method (PDFGen Class)

Draws a polygon on the drawing canvas.

Syntax

public void drawPolygon(String points);

Remarks

This method is used to add a closed polygon defined by a list of vertices to the current drawing canvas.

Points specifies a comma-separated list of coordinate pairs in the form X1,Y1,X2,Y2,...,XN,YN containing at least three vertices. All coordinates are in points and are relative to the bottom-left corner of the drawing canvas.

The first vertex is used as the starting point. Subsequent vertices are connected with straight line segments. After the last vertex, the path is automatically closed back to the first vertex.

The polygon is stroked and filled using the current Pen and Brush. Use SetPen and SetBrush before calling this method to control the border style and fill color.

NOTE: This method will throw an exception if the current canvas is not a drawing canvas or if fewer than three vertices are supplied.

DrawRectangle Method (PDFGen Class)

Draws a rectangle on the drawing canvas.

Syntax

public void drawRectangle(String X, String Y, String width, String height, String cornerRadius);

Remarks

This method is used to add a rectangle to the current drawing canvas. The rectangle is defined by its bottom-left corner at (X, Y) and the specified Width and Height, all in points. Both integer and decimal values are supported.

CornerRadius specifies the radius of the rounded corners of the rectangle. If greater than 0, each corner is replaced by a circular arc of the given radius. If the radius exceeds half the shorter side of the rectangle, it is automatically clamped to that maximum.

The rectangle is stroked and filled using the current Pen and Brush. Use SetPen and SetBrush before calling this method to control the border style and fill color.

NOTE: This method will throw an exception if the current canvas is not a drawing canvas.

EndComboBox Method (PDFGen Class)

Completes the combo box field.

Syntax

public void endComboBox();

Remarks

This method is used to finalize the combo box field created in StartComboBox. Note that the combo box can no longer be modified after it is completed.

NOTE: This method will throw an exception if the current canvas is not a text canvas.

EndContent Method (PDFGen Class)

Completes the logical section.

Syntax

public void endContent();

Remarks

This method is currently unsupported.

EndDrawing Method (PDFGen Class)

Finalizes the drawing canvas and commits it to the parent canvas.

Syntax

public void endDrawing(String X, String Y, String scaleX, String scaleY, String rotation, String skewA, String skewB, String name);

Remarks

This method is used to close the drawing canvas opened in StartDrawing and commit it to its parent canvas. Any open path on the drawing canvas is automatically closed first. Note that the drawing canvas can no longer be modified after it is closed.

X and Y specify the position, in points, where the canvas will be placed relative to the bottom-left corner of its parent canvas. These parameters must be empty if the parent canvas is a text canvas; position is determined automatically in that case. If the parent canvas is a drawing canvas, X and Y default to 0 if empty.

ScaleX and ScaleY specify the horizontal and vertical scale factors to apply to the canvas when placing it on the parent canvas. These parameters default to 1 if empty.

Rotation specifies the rotation angle of the canvas in degrees counterclockwise. If empty or 0, no rotation is applied.

SkewA and SkewB specify the horizontal and vertical skew angles of the canvas in degrees. SkewA shears along the X axis and SkewB shears along the Y axis. If empty or 0, no skew is applied.

The full transformation is applied in the following order: scale, skew, rotation, translation.

Name is reserved for future use.

NOTE: This method will throw an exception if the current canvas is not a drawing canvas.

EndEditing Method (PDFGen Class)

Finalizes the text canvas and commits it to the parent canvas.

Syntax

public void endEditing(String X, String Y, String scaleX, String scaleY, String rotation, String skewA, String skewB, String name);

Remarks

This method is used to close the text canvas opened in StartEditing and commit it to its parent canvas. Note that the text canvas can no longer be modified after it is closed.

X and Y specify the position, in points, where the canvas will be placed relative to the bottom-left corner of its parent canvas. These parameters must be empty if the parent canvas is a text canvas; position is determined automatically in that case.

ScaleX and ScaleY are reserved for future use.

Rotation is reserved for future use.

SkewA and SkewB are reserved for future use.

Name is reserved for future use.

NOTE: This method will throw an exception if the current canvas is not a text canvas.

EndForm Method (PDFGen Class)

Completes the form.

Syntax

public void endForm();

Remarks

This method is currently unsupported.

EndList Method (PDFGen Class)

Completes the list.

Syntax

public void endList();

Remarks

This method is used to finalize the list created in StartList. Note that the list can no longer be modified after it is completed.

NOTE: This method will throw an exception if a list is not currently being edited.

EndListBox Method (PDFGen Class)

Completes the list box field.

Syntax

public void endListBox();

Remarks

This method is used to finalize the list box field created in StartListBox. Note that the list box can no longer be modified after it is completed.

NOTE: This method will throw an exception if the current canvas is not a text canvas.

EndListItem Method (PDFGen Class)

Completes the list item.

Syntax

public void endListItem();

Remarks

This method is used to finalize the list item created in StartListItem and commit the underlying text canvas to its parent canvas. Note that the list item can no longer be modified after it is completed.

NOTE: This method will throw an exception if a list is not currently being edited.

EndParagraph Method (PDFGen Class)

Completes the paragraph.

Syntax

public void endParagraph(String name);

Remarks

This method is currently unsupported.

EndPath Method (PDFGen Class)

Completes the current path and applies it to the drawing canvas.

Syntax

public void endPath(String name, boolean closePath);

Remarks

This method is used to finalize the path started in StartPath and record it as a drawing primitive on the current drawing canvas. The path is rendered according to the drawing mode specified in StartPath when the canvas is eventually closed.

Name is reserved for future use.

ClosePath specifies whether to close the path by drawing a straight line from the current pen position back to the path's starting point before applying the drawing mode. Pass true to close the path (useful for filled shapes), or false to leave the path open.

NOTE: This method will throw an exception if the current canvas is not a drawing canvas.

EndSignatureField Method (PDFGen Class)

Completes the signature field.

Syntax

public void endSignatureField(String X, String Y, String scaleX, String scaleY, String rotation, String skewA, String skewB, String name);

Remarks

This method is used to finalize the signature field created in StartSignatureField and commit the underlying canvas to its parent canvas. Note that the signature field canvas can no longer be modified after it is closed.

X and Y are reserved for future use.

ScaleX and ScaleY are reserved for future use.

Rotation is reserved for future use.

SkewA and SkewB are reserved for future use.

Name is reserved for future use.

NOTE: This method will throw an exception if the current canvas is not a text canvas.

EndTable Method (PDFGen Class)

Finalizes the table canvas and commits it to the parent canvas.

Syntax

public void endTable(String name);

Remarks

This method is used to close the table canvas opened in StartTable and commit it to its parent canvas. Any open cell or row in the table is automatically closed before the table layout is resolved. Note that the table canvas can no longer be modified after it is closed.

Name is reserved for future use.

NOTE: This method will throw an exception if the current canvas is not a table canvas.

EndTableCell Method (PDFGen Class)

Completes the current table cell.

Syntax

public void endTableCell(String name);

Remarks

This method is used to explicitly close the cell opened in StartTableCell and commit the underlying cell canvas to its parent table canvas. Note that the cell canvas can no longer be modified after it is closed.

Name is reserved for future use.

It is not necessary to call this method before starting the next cell via StartTableCell, as open cells are closed implicitly at that point.

NOTE: This method will throw an exception if the current canvas is not a cell canvas.

EndTableRow Method (PDFGen Class)

Completes the current table row.

Syntax

public void endTableRow(String name);

Remarks

This method is used to explicitly close the row opened in StartTableRow. Any open cell in the row is automatically closed first, and any columns that have not been filled with a cell are padded with empty cells so that the row always spans the full column count of the table. Note that the row can no longer be modified after it is closed.

Name is reserved for future use.

It is not necessary to call this method before starting the next row via StartTableRow, as open rows are closed implicitly at that point.

NOTE: This method will throw an exception if the current canvas is not a table canvas.

GetDocumentProperty Method (PDFGen Class)

Returns the value of a document property.

Syntax

public String getDocumentProperty(String documentProperty);

Remarks

This method is used to obtain the value of a document property. Together with SetDocumentProperty, this method provides an extensible way of managing the document settings that are not available through other means. The list of settings below may be extended in the future.

DocumentProperty specifies the document property to read. Possible values are:

Example: string description = pdfgen.GetDocumentProperty("Xmp[dc:description]"); string metadataXml = pdfgen.GetDocumentProperty("Xmp"); // Use language descriptors for multi-language properties string descriptionEs = pdfgen.GetDocumentProperty("Xmp[dc:description[es]]");

GetFieldProperty Method (PDFGen Class)

Returns the value of a field property.

Syntax

public String getFieldProperty(String fieldName, String fieldProperty);

Remarks

This method is used to obtain the value of a field property. Together with SetFieldProperty, this method provides an extensible way of managing the field settings that are not available through other means. The list of settings below may be extended in the future.

FieldName is the name of the field of interest, and FieldProperty specifies the field property to read. Possible values are:

GetPageProperty Method (PDFGen Class)

Returns the value of a page property.

Syntax

public String getPageProperty(String pageProperty);

Remarks

This method is used to obtain the value of a page property for the current page. Together with SetPageProperty, this method provides an extensible way of managing the current page settings that are not available through other means. The list of settings below may be extended in the future.

PageProperty specifies the page property to read. Possible values are:

RemoveAttachment Method (PDFGen Class)

Removes an attachment from the document.

Syntax

public void removeAttachment(int index);

Remarks

This method is used to remove an attachment from the document and from the Attachments collection.

Index is the index of the attachment in the Attachments collection to be removed.

Example: pdfgen.RemoveAttachment(0); // Alternatively, remove an attachment from Attachments manually: PDFAttachment attachment = pdfgen.Attachments[0]; pdfgen.Attachments.Remove(attachment); pdfgen.Close();

Reset Method (PDFGen Class)

Resets the class.

Syntax

public void reset();

Remarks

This method is used to reset the class's properties and configuration settings to their default values.

SaveStyle Method (PDFGen Class)

Saves the current style parameters.

Syntax

public void saveStyle(String name);

Remarks

This method is currently unsupported.

Scroll Method (PDFGen Class)

Scrolls down the page by the given number of points.

Syntax

public void scroll(String height);

Remarks

This method is currently unsupported.

SetAlignment Method (PDFGen Class)

Sets the alignment for subsequent text insertion operations.

Syntax

public void setAlignment(int horizontalAlignment, int verticalAlignment, boolean wrapLines);

Remarks

This method is used to set the horizontal and vertical alignment parameters to apply to text content, including individual text blocks and paragraphs. Alignment specifies the position of the newly added text content within the lines of a text canvas.

HorizontalAlignment specifies the horizontal alignment relative to the left or right canvas boundaries. Possible values are:

VerticalAlignment specifies the vertical alignment of text blocks relative to each other. Possible values are:

WrapLines is reserved for future use.

NOTE: This method only applies if the current canvas is a text or table canvas.

SetBrush Method (PDFGen Class)

Sets the fill properties used when drawing shapes and cell backgrounds.

Syntax

public void setBrush(String color, String opacity);

Remarks

This method is used to configure the brush that is applied to the interior of all subsequently added shapes, closed paths, and table cell backgrounds.

Color specifies the fill color. If non-empty, the brush is activated and the specified color is used for all subsequent filled elements. For the full list of supported colors, see SetFont.

Opacity specifies the fill opacity as a value between 0 (fully transparent) and 1 (fully opaque). If empty, full opacity is used. Passing a non-empty opacity alone (without a color) also activates the brush using the previously stored color.

If both Color and Opacity are empty, the brush is reset to its unset state, and no fill is applied to subsequent elements. This is useful when you want a shape to be stroked only, with a transparent interior.

SetDocumentProperty Method (PDFGen Class)

Sets the value of a document property.

Syntax

public void setDocumentProperty(String documentProperty, String value);

Remarks

This method is used to adjust properties of the document, including those that apply globally to every page. Together with GetDocumentProperty, this method provides an extensible way of managing the document settings that are not available through other means. The list of settings below may be extended in the future.

DocumentProperty and Value specify the document property and value to set respectively. Possible values for the former are:

Example: pdfgen.SetDocumentProperty("PageRightHeader", "PDF 32000-1:2008"); pdfgen.SetDocumentProperty("PageLeftFooter", "© Adobe Systems Incorporated 2008 - All rights reserved"); pdfgen.SetDocumentProperty("PageRightFooter", "%PAGENUMBER%"); pdfgen.SetDocumentProperty("PageNumberFormat", "Numeric");

SetFieldProperty Method (PDFGen Class)

Sets the value of a field property.

Syntax

public void setFieldProperty(String fieldName, String fieldProperty, String value);

Remarks

This method is used to modify the value of a field property. Together with GetFieldProperty, this method provides an extensible way of managing the field settings that are not available through other means. The list of settings below may be extended in the future.

FieldName is the name of the field of interest, and FieldProperty and Value specify the field property and value to set respectively. Possible values for the former are:

SetFont Method (PDFGen Class)

Sets the font properties to be applied to text.

Syntax

public void setFont(String name, String size, String style, String color);

Remarks

This method is used to define the font attributes for text.

Name specifies the font name.

Size specifies the font size, either as an absolute value (e.g., 12) or relative adjustment (e.g., +2).

Style specifies the font style. The following syntax is supported:

[B][I][U][S][bold][italic][underline][strikethrough][##%][##%,##%][0.###][0.###]

For example:

• bold
• bold 50%
• bold italic 50%
• BI 50% 42%
• B 50% italic 0.42

If only one transparency figure is provided, it applies to both pen and brush.

Color specifies the font color in hash-prefixed hexadecimal format (such as #FF0000 for red). The following HTML color aliases are also supported:

SetLayout Method (PDFGen Class)

Sets the layout for new pages.

Syntax

public void setLayout(String size, int columns);

Remarks

This method is used to set the layout parameters for new pages to be added.

Size specifies the page size, either as an explicit dimension pair (e.g., 400 400 or 400, 400) in which the first value defines the width and the second defines the height (in points), or one of the following named sizes:

Columns specifies the number of columns the page will be divided into. The only value that is currently supported is 1.

SetMargin Method (PDFGen Class)

Sets the margin for a typical element.

Syntax

public void setMargin(int marginType, String value);

Remarks

This method is used to specify the margin to apply when adding applicable elements.

MarginType specifies the type of margin to set. Possible values are:

Value specifies the value of the margin in points. Both integer and decimal values are supported.

SetOutputStream Method (PDFGen Class)

Sets the stream to write the processed document to.

Syntax

public void setOutputStream(java.io.OutputStream outputStream);

Remarks

This method is used to set the stream to which the class will write the resulting PDF document. If an output stream is set before the class attempts to perform operations on the document, the class will write the data to the output stream instead of writing to OutputFile or populating OutputData.

NOTE: It may be useful to additionally set the CloseOutputStreamAfterProcessing configuration setting to true when using output streams.

SetPageProperty Method (PDFGen Class)

Sets the value of a page property.

Syntax

public void setPageProperty(String pageProperty, String value);

Remarks

This method is used to adjust properties of the current page, overriding the corresponding document-level properties set in SetDocumentProperty. Together with GetPageProperty, this method provides an extensible way of managing the current page settings that are not available through other means. The list of settings below may be extended in the future.

PageProperty and Value specify the page property and value to set respectively. Possible values for the former are:

Example: pdfgen.SetPageProperty("PageRightHeader", "PDF 32000-1:2008 (revised)");

SetPen Method (PDFGen Class)

Sets the stroke properties used when drawing lines, paths, and borders.

Syntax

public void setPen(String thickness, String style, String color, String opacity);

Remarks

This method is used to configure the pen that is applied to all subsequently added paths, shapes, and table borders.

Thickness specifies the stroke width in points. Both integer and decimal values are supported.

Style controls the dash pattern, line cap, and line join of the stroke via one or more keywords, which may appear in any order.

The following dash pattern keywords are supported:

A custom pattern can also be specified directly as a sequence of - and . characters, allowing any combination such as --. or --.-..

The following line cap keywords are supported:

The following line join keywords are supported:

Example Style strings:

Color specifies the stroke color. For the full list of supported colors, see SetFont.

Opacity specifies the stroke opacity as a value between 0 (fully transparent) and 1 (fully opaque). If empty, full opacity is used.

SetStyle Method (PDFGen Class)

Loads a previously saved style.

Syntax

public void setStyle(String name);

Remarks

This method is currently unsupported.

StartComboBox Method (PDFGen Class)

Begins a new combo box field for editing.

Syntax

public void startComboBox(String name, String width);

Remarks

This method is used to create a blank combo box field with name Name.

Width specifies the width of the combo box in either points (e.g., 30pt) or characters (e.g., 30).

After calling this method, use the AddListItem method to add choices to the combo box. When finished, call EndComboBox to complete it.

To create a combo box all at once instead of incrementally, use the AddComboBox method.

StartContent Method (PDFGen Class)

Begins a new logical section.

Syntax

public void startContent(int contentType, String name);

Remarks

This method is currently unsupported.

StartDrawing Method (PDFGen Class)

Initiates a new drawing canvas of the given dimensions.

Syntax

public void startDrawing(String width, String height);

Remarks

This method is used to create a new drawing canvas with size specified by Width and Height (in points). Both integer and decimal values are supported.

A drawing canvas accepts vector drawing primitives such as paths, rectangles, circles, and polygons, and can also host bitmaps and nested canvases. All coordinates used within the drawing canvas are relative to its bottom-left corner.

The current Pen and Brush are inherited by the drawing canvas and applied to each new path unless overridden before the path is started. Use SetPen and SetBrush before calling path methods to control stroke and fill.

When finished editing the drawing canvas, call EndDrawing to close it and optionally save it in the class.

NOTE: This method will throw an exception if a list is currently being edited.

StartEditing Method (PDFGen Class)

Initiates a new text canvas for editing.

Syntax

public void startEditing(String maxWidth, String maxHeight);

Remarks

This method is used to create a blank text canvas with maximum dimensions specified by MaxWidth and MaxHeight (in points). Both integer and decimal values are supported.

When finished editing the text canvas, call EndEditing to close it and optionally save it in the class.

Upon completion of this method, information about the newly created text canvas can be accessed using the Canvas property.

StartForm Method (PDFGen Class)

Begins a new form.

Syntax

public void startForm(String submitURL);

Remarks

This method is used to explicitly create a form. In general, it is not necessary to call this method before adding new fields via AddButton, AddCheckBox, AddRadioButton, and similar methods, as a form will be created implicitly when the document is saved.

SubmitURL specifies the URL to which the form data will be sent when a submit-form action is executed. Use the AddButton method to add a button that invokes this type of action when pressed.

When finished editing the form, call EndForm to complete it.

NOTE: This method will throw an exception if the current canvas is not a text canvas.

StartList Method (PDFGen Class)

Begins a new list for editing.

Syntax

public void startList(int marker);

Remarks

This method is used to create an empty list. If a list with at least one item is already being edited, a sublist will be created.

Marker specifies the character that will precede each item in the list. Possible values are:

After calling this method, use the AddListItem method (or the StartListItem and EndListItem methods) to add items to the list. When finished, call EndList to complete it.

NOTE: This method will throw an exception if the current canvas is not a text canvas.

StartListBox Method (PDFGen Class)

Begins a new list box field for editing.

Syntax

public void startListBox(String name, String width, String height);

Remarks

This method is used to create a blank list box field with name Name.

Width and Height specify the width and height of the list box in either points (e.g., 30pt) or characters (e.g., 30).

After calling this method, use the AddListItem method to add choices to the list box. When finished, call EndListBox to complete it.

To create a list box all at once instead of incrementally, use the AddListBox method.

StartListItem Method (PDFGen Class)

Begins a new list item for editing.

Syntax

public void startListItem(String name);

Remarks

This method is used to create a placeholder for a list item as a text canvas. If a list item is already being edited, it will be automatically completed before the new one is started.

Name is reserved for future use.

After calling this method, use the AddTextBlock or AddParagraph methods to populate the list item with text content. When finished, call EndListItem to complete it.

To create a list item all at once instead of incrementally, use the AddListItem method.

NOTE: This method will throw an exception if the current canvas is not a text canvas or if a list is not currently being edited.

StartParagraph Method (PDFGen Class)

Begins a new paragraph for editing.

Syntax

public void startParagraph();

Remarks

This method is currently unsupported.

StartPath Method (PDFGen Class)

Starts a new vector path at the given coordinates.

Syntax

public void startPath(String X, String Y, int drawingMode);

Remarks

This method is used to begin a new path on the current drawing canvas starting at the point specified by X and Y. Both integer and decimal values are supported. All coordinates are relative to the bottom-left corner of the drawing canvas.

DrawingMode specifies how the path interacts with the canvas when it is closed with EndPath. Possible values are:

The Pen and Brush active when this method is called determine the stroke color, stroke width, line style, and fill color for the path.

When finished with the path, call EndPath to complete it and optionally save it in the class.

NOTE: This method will throw an exception if the current canvas is not a drawing canvas or if a list is currently being edited.

StartSignatureField Method (PDFGen Class)

Begins a new signature field for editing.

Syntax

public void startSignatureField(String name, String width, String height, boolean drawing);

Remarks

This method is used to create a blank signature field with name Name as either a text or drawing canvas.

Width and Height specify the width and height of the signature field in either points (e.g., 30pt) or characters (e.g., 30).

Drawing specifies whether the signature field will be a drawing canvas.

When finished editing the signature field, call EndSignatureField to close the underlying canvas and optionally save it in the class.

To create a signature field all at once instead of incrementally, use the AddSignatureField method.

StartTable Method (PDFGen Class)

Initiates a new table canvas with a fixed number of columns.

Syntax

public void startTable(int colCount, String minWidth, String maxWidth);

Remarks

This method is used to create a new table canvas with ColCount columns. The table accumulates rows and cells until EndTable is called, at which point the layout is resolved and the table is committed to the parent canvas.

ColCount specifies the number of logical columns in the table. This value must be positive and cannot be changed after the table is started.

MinWidth specifies the minimum width of the table in points. Both integer and decimal values are supported. If empty or 0, no minimum width is enforced.

MaxWidth specifies the maximum width of the table in points. If empty or 0, the table may expand to fit its content without an upper bound.

The current Pen and Brush are inherited by the table and used to draw its outer border and background. Use SetPen and SetBrush before calling this method to control the table border style and fill color. Individual cells may override these settings.

After calling this method, use StartTableRow to begin adding rows, and use AddTableCell or StartTableCell to populate each row with content. When finished editing the table, call EndTable to close the underlying table canvas and optionally save it in the class.

NOTE: This method will throw an exception if a list is currently being edited.

StartTableCell Method (PDFGen Class)

Begins a new cell in the current table row.

Syntax

public void startTableCell(String width, String minWidth, String maxWidth, int colSpan, int rowSpan, int borders);

Remarks

This method is used to open a new cell in the current row of the table canvas. Any previously opened cell in the same row is automatically closed before the new one is started.

Width specifies the preferred width of the cell in points. Both integer and decimal values are supported. If empty or 0, the width is either inherited from the corresponding cell in the previous row or determined automatically during layout.

MinWidth specifies the minimum cell width in points. If empty or 0, the minimum width defaults to twice the cell padding.

MaxWidth specifies the maximum cell width in points. If empty or 0, no maximum width is enforced.

ColSpan specifies the number of columns the cell spans horizontally. Values that would extend the cell beyond the table boundary are clamped automatically.

RowSpan specifies the number of rows the cell spans vertically. Cells covered by a rowspan from a previous row are automatically skipped when advancing through the current row.

Borders specifies which borders of the cell are suppressed. Its value should be provided as a bitmask of the following flags:

Pass 0 to show all borders.

The current Pen and Brush are applied to the cell background and borders. Use SetPen and SetBrush before calling this method to style individual cells.

After calling this method, add content to the cell using AddParagraph, AddTextBlock, AddBitmap, or any other method applicable to a text canvas. When finished editing the cell, call EndTableCell to close it explicitly and optionally save it in the class, or begin a new cell with StartTableCell to close it implicitly.

To create a table cell all at once instead of incrementally, use the AddTableCell method.

NOTE: This method will throw an exception if the current canvas is not a table canvas.

StartTableRow Method (PDFGen Class)

Begins a new row in the current table.

Syntax

public void startTableRow(String height, String minHeight, String maxHeight, boolean isHeader);

Remarks

This method is used to open a new row in the current table canvas. Any previously opened row is automatically closed before the new one is started.

Height specifies the preferred height of the row in points. Both integer and decimal values are supported. If empty or 0, the row height is determined automatically from the tallest cell it contains.

MinHeight specifies the minimum row height in points. The row will never be shorter than this value, even if its content is smaller.

MaxHeight specifies the maximum row height in points. Content that exceeds this height will be clipped. If empty or 0, no maximum height is enforced.

IsHeader specifies whether the row is a header row. This parameter is recorded for informational purposes and future use; it does not currently alter rendering behavior.

After calling this method, add cells to the row using AddTableCell or StartTableCell. When finished editing the row, call EndTableRow to close it explicitly and optionally save it in the class, or begin a new row with StartTableRow to close it implicitly.

NOTE: This method will throw an exception if the current canvas is not a table canvas.

ActionRequired Event (PDFGen Class)

Fired when the class encounters a conflict that it cannot resolve on its own.

Syntax

public class DefaultPDFGenEventListener implements PDFGenEventListener {
  ...
  public void actionRequired(PDFGenActionRequiredEvent e) {}
  ...
}

public class PDFGenActionRequiredEvent {
  public String action;
  public String choice; //read-write
}

Remarks

This event is currently unsupported.

Error Event (PDFGen Class)

Fired when information is available about errors during data delivery.

Syntax

public class DefaultPDFGenEventListener implements PDFGenEventListener {
  ...
  public void error(PDFGenErrorEvent e) {}
  ...
}

public class PDFGenErrorEvent {
  public int errorCode;
  public String description;
}

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class throws an exception.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

Log Event (PDFGen Class)

Fired once for each log message.

Syntax

public class DefaultPDFGenEventListener implements PDFGenEventListener {
  ...
  public void log(PDFGenLogEvent e) {}
  ...
}

public class PDFGenLogEvent {
  public int logLevel;
  public String message;
  public String logType;
}

Remarks

This event is fired once for each log message generated by the class. The verbosity is controlled by the LogLevel configuration setting.

LogLevel indicates the detail level of the message. Possible values are:

Message is the log message.

LogType identifies the type of log entry. Possible values are:

• CertValidator
• Font
• HTTP
• PDFInvalidSignature
• PDFRevocationInfo
• Timestamp
• TSL

OutOfSpace Event (PDFGen Class)

Fired when an element exceeds the maximum dimensions of the current text canvas.

Syntax

public class DefaultPDFGenEventListener implements PDFGenEventListener {
  ...
  public void outOfSpace(PDFGenOutOfSpaceEvent e) {}
  ...
}

public class PDFGenOutOfSpaceEvent {
  public int spaceKind;
  public String widthAvailable;
  public String widthNeeded;
  public String heightAvailable;
  public String heightNeeded;
  public int choice; //read-write
}

Remarks

This event is fired while the class populates the text canvas to report that the content does not fit within the canvas boundaries. It can be fired from within:

• Any of the Add* methods (except AddAttachment)
• Any of the canvas-finalizing End* methods (except EndTableCell)
• EndList
• StartList
• StartListItem

SpaceKind identifies the kind of space the element has exceeded as a bitmask of the following flags:

WidthAvailable and HeightAvailable report the remaining width and height of the canvas in points.

WidthNeeded and HeightNeeded report the width and height of the element in points.

Choice specifies the decision requested of the class. Possible values:

NOTE: This event may fire repeatedly if the action the class is instructed to take does not adequately resolve the conflict.

PDFAttachment Type

The file being attached to the PDF document.

Remarks

This type contains information about the file that is being attached to the document.

• ContentType
• CreationDate
• Data
• Description
• FileName
• InputStream
• ModificationDate
• Name
• OutputStream
• Size

Fields

Constructors

public PDFAttachment();

public PDFAttachment(String fileName);

public PDFAttachment(String fileName, String description);

public PDFAttachment(byte[] data, String name, String description);

public PDFAttachment(java.io.InputStream inputStream, String name, String description);

PDFBrush Type

The fill configuration used when rendering shapes and cell backgrounds.

Remarks

This type encapsulates the fill properties applied to the interior of closed paths, rectangles, circles, polygons, and table cell backgrounds. It stores a single solid color and an opacity value.

• Color
• Opacity

Fields

Constructors

public PDFBrush();

PDFCanvas Type

Details about the current canvas.

Remarks

This type contains information about the canvas that is currently being edited.

• Drawing
• DrawingMode
• Height
• HorizontalAlignment
• MaxHeight
• MaxWidth
• VerticalAlignment
• Width
• WrapLines
• X
• Y

Fields

Constructors

public PDFCanvas();

PDFFont Type

The font used in the PDF document.

Remarks

This type contains details about the font being applied to text.

• Color
• Name
• Size
• Style

Fields

Constructors

public PDFFont();

PDFPageLayout Type

Details about the page layout.

Remarks

This type contains information about the layout of a page in the document.

• Columns
• Height
• Size
• Width

Fields

Constructors

public PDFPageLayout();

PDFPen Type

The stroke configuration used when rendering paths and borders.

Remarks

This type encapsulates the stroke properties applied when drawing lines, path outlines, table borders, and any other stroked element in a PDF document.

• Color
• Opacity
• Style
• Thickness

Fields

Constructors

public PDFPen();

Config Settings (PDFGen Class)

The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

PDFGen Config Settings

Base Config Settings

Trappable Errors (PDFGen Class)

PDFGen Errors

PDF Errors

Parsing Errors