PDFGen Component

Properties   Methods   Events   Config Settings   Errors  

The PDFGen component creates PDF documents from scratch.

Syntax

nsoftware.PDFSDK.PDFGen

Remarks

PDFGen is a versatile document generation component 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 component 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 component 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.

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 component 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 component 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

Random access is not allowed in text canvases; instead, the component 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 component 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 component 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

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

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 component with short descriptions. Click on the links for further details.

Method List

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

Event List

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

Config Settings

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

Attachments Property (PDFGen Component)

A collection of all attached files added to the document.

Syntax

• C#
• VB.NET

public PDFAttachmentList Attachments { get; }

Public Property Attachments As PDFAttachmentList

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.

Brush Property (PDFGen Component)

The current brush settings.

Syntax

• C#
• VB.NET

public PDFBrush Brush { get; }

Public ReadOnly Property Brush As PDFBrush

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.

Canvas Property (PDFGen Component)

The current canvas.

Syntax

• C#
• VB.NET

public PDFCanvas Canvas { get; }

Public ReadOnly Property Canvas As PDFCanvas

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)

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

Font Property (PDFGen Component)

The currently set font.

Syntax

• C#
• VB.NET

public PDFFont Font { get; }

Public ReadOnly Property Font As PDFFont

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.

Layout Property (PDFGen Component)

The current page layout.

Syntax

• C#
• VB.NET

public PDFPageLayout Layout { get; }

Public ReadOnly Property Layout As PDFPageLayout

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.

OutputData Property (PDFGen Component)

A byte array containing the PDF document after processing.

Syntax

• C#
• VB.NET

public byte[] OutputData { get; }

Public ReadOnly Property OutputData As Byte()

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 Component)

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

Syntax

• C#
• VB.NET

public string OutputFile { get; set; }

Public Property OutputFile As String

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 Component)

Whether or not the component should overwrite files.

Syntax

• C#
• VB.NET

public bool Overwrite { get; set; }

Public Property Overwrite As Boolean

Default Value

False

Remarks

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

Pen Property (PDFGen Component)

The current pen settings.

Syntax

• C#
• VB.NET

public PDFPen Pen { get; }

Public ReadOnly Property Pen As PDFPen

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.

AddAttachment Method (PDFGen Component)

Adds an attachment to the document.

Syntax

• C#
• VB.NET

public void AddAttachment(string fileName, string description);

Async Version
public async Task AddAttachment(string fileName, string description);
public async Task AddAttachment(string fileName, string description, CancellationToken cancellationToken);

Public Sub AddAttachment(ByVal FileName As String, ByVal Description As String)

Async Version
Public Sub AddAttachment(ByVal FileName As String, ByVal Description As String) As Task
Public Sub AddAttachment(ByVal FileName As String, ByVal Description As String, cancellationToken As CancellationToken) As Task

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 Component)

Adds a bitmap image to the current canvas.

Syntax

• C#
• VB.NET

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

Async Version
public async Task AddBitmap(string format, byte[] bytes, int bitmapWidth, int bitmapHeight, string scaleWidth, string scaleHeight);
public async Task AddBitmap(string format, byte[] bytes, int bitmapWidth, int bitmapHeight, string scaleWidth, string scaleHeight, CancellationToken cancellationToken);

Public Sub AddBitmap(ByVal Format As String, ByVal Bytes As Byte(), ByVal BitmapWidth As Integer, ByVal BitmapHeight As Integer, ByVal ScaleWidth As String, ByVal ScaleHeight As String)

Async Version
Public Sub AddBitmap(ByVal Format As String, ByVal Bytes As Byte(), ByVal BitmapWidth As Integer, ByVal BitmapHeight As Integer, ByVal ScaleWidth As String, ByVal ScaleHeight As String) As Task
Public Sub AddBitmap(ByVal Format As String, ByVal Bytes As Byte(), ByVal BitmapWidth As Integer, ByVal BitmapHeight As Integer, ByVal ScaleWidth As String, ByVal ScaleHeight As String, cancellationToken As CancellationToken) As Task

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 Component)

Adds a break to the text canvas.

Syntax

• C#
• VB.NET

public void AddBreak(int breakKind);

Async Version
public async Task AddBreak(int breakKind);
public async Task AddBreak(int breakKind, CancellationToken cancellationToken);

Public Sub AddBreak(ByVal BreakKind As Integer)

Async Version
Public Sub AddBreak(ByVal BreakKind As Integer) As Task
Public Sub AddBreak(ByVal BreakKind As Integer, cancellationToken As CancellationToken) As Task

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 Component)

Adds a button field to the form.

Syntax

• C#
• VB.NET

public void AddButton(string name, string caption, string width, int actionType);

Async Version
public async Task AddButton(string name, string caption, string width, int actionType);
public async Task AddButton(string name, string caption, string width, int actionType, CancellationToken cancellationToken);

Public Sub AddButton(ByVal Name As String, ByVal Caption As String, ByVal Width As String, ByVal ActionType As Integer)

Async Version
Public Sub AddButton(ByVal Name As String, ByVal Caption As String, ByVal Width As String, ByVal ActionType As Integer) As Task
Public Sub AddButton(ByVal Name As String, ByVal Caption As String, ByVal Width As String, ByVal ActionType As Integer, cancellationToken As CancellationToken) As Task

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 Component)

Adds a checkbox field to the form.

Syntax

• C#
• VB.NET

public void AddCheckBox(string name, bool defaultValue);

Async Version
public async Task AddCheckBox(string name, bool defaultValue);
public async Task AddCheckBox(string name, bool defaultValue, CancellationToken cancellationToken);

Public Sub AddCheckBox(ByVal Name As String, ByVal DefaultValue As Boolean)

Async Version
Public Sub AddCheckBox(ByVal Name As String, ByVal DefaultValue As Boolean) As Task
Public Sub AddCheckBox(ByVal Name As String, ByVal DefaultValue As Boolean, cancellationToken As CancellationToken) As Task

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 Component)

Adds a combo box field to the form.

Syntax

• C#
• VB.NET

public void AddComboBox(string name, string options, string defaultValue, string width);

Async Version
public async Task AddComboBox(string name, string options, string defaultValue, string width);
public async Task AddComboBox(string name, string options, string defaultValue, string width, CancellationToken cancellationToken);

Public Sub AddComboBox(ByVal Name As String, ByVal Options As String, ByVal DefaultValue As String, ByVal Width As String)

Async Version
Public Sub AddComboBox(ByVal Name As String, ByVal Options As String, ByVal DefaultValue As String, ByVal Width As String) As Task
Public Sub AddComboBox(ByVal Name As String, ByVal Options As String, ByVal DefaultValue As String, ByVal Width As String, cancellationToken As CancellationToken) As Task

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 Component)

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

Syntax

• C#
• VB.NET

public void AddCopy(string name);

Async Version
public async Task AddCopy(string name);
public async Task AddCopy(string name, CancellationToken cancellationToken);

Public Sub AddCopy(ByVal Name As String)

Async Version
Public Sub AddCopy(ByVal Name As String) As Task
Public Sub AddCopy(ByVal Name As String, cancellationToken As CancellationToken) As Task

Remarks

This method is currently unsupported.

AddDrawing Method (PDFGen Component)

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

Syntax

• C#
• VB.NET

public void AddDrawing(string svgPath, string scaleX, string scaleY);

Async Version
public async Task AddDrawing(string svgPath, string scaleX, string scaleY);
public async Task AddDrawing(string svgPath, string scaleX, string scaleY, CancellationToken cancellationToken);

Public Sub AddDrawing(ByVal SvgPath As String, ByVal ScaleX As String, ByVal ScaleY As String)

Async Version
Public Sub AddDrawing(ByVal SvgPath As String, ByVal ScaleX As String, ByVal ScaleY As String) As Task
Public Sub AddDrawing(ByVal SvgPath As String, ByVal ScaleX As String, ByVal ScaleY As String, cancellationToken As CancellationToken) As Task

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:

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 Component)

Adds a heading to the text canvas.

Syntax

• C#
• VB.NET

public void AddHeading(int level, string text);

Async Version
public async Task AddHeading(int level, string text);
public async Task AddHeading(int level, string text, CancellationToken cancellationToken);

Public Sub AddHeading(ByVal Level As Integer, ByVal Text As String)

Async Version
Public Sub AddHeading(ByVal Level As Integer, ByVal Text As String) As Task
Public Sub AddHeading(ByVal Level As Integer, ByVal Text As String, cancellationToken As CancellationToken) As Task

Remarks

This method is currently unsupported.

AddLink Method (PDFGen Component)

Adds a hyperlink to the text canvas.

Syntax

• C#
• VB.NET

public void AddLink(string text, string URL);

Async Version
public async Task AddLink(string text, string URL);
public async Task AddLink(string text, string URL, CancellationToken cancellationToken);

Public Sub AddLink(ByVal Text As String, ByVal URL As String)

Async Version
Public Sub AddLink(ByVal Text As String, ByVal URL As String) As Task
Public Sub AddLink(ByVal Text As String, ByVal URL As String, cancellationToken As CancellationToken) As Task

Remarks

This method is currently unsupported.

AddListBox Method (PDFGen Component)

Adds a list box field to the form.

Syntax

• C#
• VB.NET

public void AddListBox(string name, string options, string defaultValue, string width, string height);

Async Version
public async Task AddListBox(string name, string options, string defaultValue, string width, string height);
public async Task AddListBox(string name, string options, string defaultValue, string width, string height, CancellationToken cancellationToken);

Public Sub AddListBox(ByVal Name As String, ByVal Options As String, ByVal DefaultValue As String, ByVal Width As String, ByVal Height As String)

Async Version
Public Sub AddListBox(ByVal Name As String, ByVal Options As String, ByVal DefaultValue As String, ByVal Width As String, ByVal Height As String) As Task
Public Sub AddListBox(ByVal Name As String, ByVal Options As String, ByVal DefaultValue As String, ByVal Width As String, ByVal Height As String, cancellationToken As CancellationToken) As Task

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 Component)

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

Syntax

• C#
• VB.NET

public void AddListItem(string text, string name);

Async Version
public async Task AddListItem(string text, string name);
public async Task AddListItem(string text, string name, CancellationToken cancellationToken);

Public Sub AddListItem(ByVal Text As String, ByVal Name As String)

Async Version
Public Sub AddListItem(ByVal Text As String, ByVal Name As String) As Task
Public Sub AddListItem(ByVal Text As String, ByVal Name As String, cancellationToken As CancellationToken) As Task

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 Component)

Adds a paragraph of text to the text canvas.

Syntax

• C#
• VB.NET

public void AddParagraph(string text);

Async Version
public async Task AddParagraph(string text);
public async Task AddParagraph(string text, CancellationToken cancellationToken);

Public Sub AddParagraph(ByVal Text As String)

Async Version
Public Sub AddParagraph(ByVal Text As String) As Task
Public Sub AddParagraph(ByVal Text As String, cancellationToken As CancellationToken) As Task

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 component 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 Component)

Adds a radio button to the form.

Syntax

• C#
• VB.NET

public void AddRadioButton(string radioGroup, string name, bool isDefaultButton);

Async Version
public async Task AddRadioButton(string radioGroup, string name, bool isDefaultButton);
public async Task AddRadioButton(string radioGroup, string name, bool isDefaultButton, CancellationToken cancellationToken);

Public Sub AddRadioButton(ByVal RadioGroup As String, ByVal Name As String, ByVal IsDefaultButton As Boolean)

Async Version
Public Sub AddRadioButton(ByVal RadioGroup As String, ByVal Name As String, ByVal IsDefaultButton As Boolean) As Task
Public Sub AddRadioButton(ByVal RadioGroup As String, ByVal Name As String, ByVal IsDefaultButton As Boolean, cancellationToken As CancellationToken) As Task

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 Component)

Adds a signature field to the form.

Syntax

• C#
• VB.NET

public void AddSignatureField(string name, string width, string height);

Async Version
public async Task AddSignatureField(string name, string width, string height);
public async Task AddSignatureField(string name, string width, string height, CancellationToken cancellationToken);

Public Sub AddSignatureField(ByVal Name As String, ByVal Width As String, ByVal Height As String)

Async Version
Public Sub AddSignatureField(ByVal Name As String, ByVal Width As String, ByVal Height As String) As Task
Public Sub AddSignatureField(ByVal Name As String, ByVal Width As String, ByVal Height As String, cancellationToken As CancellationToken) As Task

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 Component)

Adds a special element to the text canvas.

Syntax

• C#
• VB.NET

public void AddSpecial(int type, string content);

Async Version
public async Task AddSpecial(int type, string content);
public async Task AddSpecial(int type, string content, CancellationToken cancellationToken);

Public Sub AddSpecial(ByVal Type As Integer, ByVal Content As String)

Async Version
Public Sub AddSpecial(ByVal Type As Integer, ByVal Content As String) As Task
Public Sub AddSpecial(ByVal Type As Integer, ByVal Content As String, cancellationToken As CancellationToken) As Task

Remarks

This method is currently unsupported.

AddTableCell Method (PDFGen Component)

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

Syntax

• C#
• VB.NET

public void AddTableCell(string text, string width, string minWidth, string maxWidth);

Async Version
public async Task AddTableCell(string text, string width, string minWidth, string maxWidth);
public async Task AddTableCell(string text, string width, string minWidth, string maxWidth, CancellationToken cancellationToken);

Public Sub AddTableCell(ByVal Text As String, ByVal Width As String, ByVal MinWidth As String, ByVal MaxWidth As String)

Async Version
Public Sub AddTableCell(ByVal Text As String, ByVal Width As String, ByVal MinWidth As String, ByVal MaxWidth As String) As Task
Public Sub AddTableCell(ByVal Text As String, ByVal Width As String, ByVal MinWidth As String, ByVal MaxWidth As String, cancellationToken As CancellationToken) As Task

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 Component)

Adds a block of text to the text canvas.

Syntax

• C#
• VB.NET

public void AddTextBlock(string text);

Async Version
public async Task AddTextBlock(string text);
public async Task AddTextBlock(string text, CancellationToken cancellationToken);

Public Sub AddTextBlock(ByVal Text As String)

Async Version
Public Sub AddTextBlock(ByVal Text As String) As Task
Public Sub AddTextBlock(ByVal Text As String, cancellationToken As CancellationToken) As Task

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 Component)

Adds a text box field to the form.

Syntax

• C#
• VB.NET

public void AddTextBox(string name, string defaultValue, bool multiLine, string width, string height, bool password);

Async Version
public async Task AddTextBox(string name, string defaultValue, bool multiLine, string width, string height, bool password);
public async Task AddTextBox(string name, string defaultValue, bool multiLine, string width, string height, bool password, CancellationToken cancellationToken);

Public Sub AddTextBox(ByVal Name As String, ByVal DefaultValue As String, ByVal MultiLine As Boolean, ByVal Width As String, ByVal Height As String, ByVal Password As Boolean)

Async Version
Public Sub AddTextBox(ByVal Name As String, ByVal DefaultValue As String, ByVal MultiLine As Boolean, ByVal Width As String, ByVal Height As String, ByVal Password As Boolean) As Task
Public Sub AddTextBox(ByVal Name As String, ByVal DefaultValue As String, ByVal MultiLine As Boolean, ByVal Width As String, ByVal Height As String, ByVal Password As Boolean, cancellationToken As CancellationToken) As Task

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 Component)

Adds a title to the text canvas.

Syntax

• C#
• VB.NET

public void AddTitle(string text);

Async Version
public async Task AddTitle(string text);
public async Task AddTitle(string text, CancellationToken cancellationToken);

Public Sub AddTitle(ByVal Text As String)

Async Version
Public Sub AddTitle(ByVal Text As String) As Task
Public Sub AddTitle(ByVal Text As String, cancellationToken As CancellationToken) As Task

Remarks

This method is currently unsupported.

Cancel Method (PDFGen Component)

Cancels the current canvas.

Syntax

• C#
• VB.NET

public void Cancel();

Async Version
public async Task Cancel();
public async Task Cancel(CancellationToken cancellationToken);

Public Sub Cancel()

Async Version
Public Sub Cancel() As Task
Public Sub Cancel(cancellationToken As CancellationToken) As Task

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

Close Method (PDFGen Component)

Closes the new document.

Syntax

• C#
• VB.NET

public void Close();

Async Version
public async Task Close();
public async Task Close(CancellationToken cancellationToken);

Public Sub Close()

Async Version
Public Sub Close() As Task
Public Sub Close(cancellationToken As CancellationToken) As Task

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 Component)

Sets or retrieves a configuration setting.

Syntax

• C#
• VB.NET

public string Config(string configurationString);

Async Version
public async Task<string> Config(string configurationString);
public async Task<string> Config(string configurationString, CancellationToken cancellationToken);

Public Function Config(ByVal ConfigurationString As String) As String

Async Version
Public Function Config(ByVal ConfigurationString As String) As Task(Of String)
Public Function Config(ByVal ConfigurationString As String, cancellationToken As CancellationToken) As Task(Of String)

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, 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 Component)

Creates a new PDF document.

Syntax

• C#
• VB.NET

public void CreateNew();

Async Version
public async Task CreateNew();
public async Task CreateNew(CancellationToken cancellationToken);

Public Sub CreateNew()

Async Version
Public Sub CreateNew() As Task
Public Sub CreateNew(cancellationToken As CancellationToken) As Task

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 component'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 Component)

Draws an ellipse or circle on the drawing canvas.

Syntax

• C#
• VB.NET

public void DrawCircle(string X, string Y, string radiusX, string radiusY);

Async Version
public async Task DrawCircle(string X, string Y, string radiusX, string radiusY);
public async Task DrawCircle(string X, string Y, string radiusX, string radiusY, CancellationToken cancellationToken);

Public Sub DrawCircle(ByVal X As String, ByVal Y As String, ByVal RadiusX As String, ByVal RadiusY As String)

Async Version
Public Sub DrawCircle(ByVal X As String, ByVal Y As String, ByVal RadiusX As String, ByVal RadiusY As String) As Task
Public Sub DrawCircle(ByVal X As String, ByVal Y As String, ByVal RadiusX As String, ByVal RadiusY As String, cancellationToken As CancellationToken) As Task

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 Component)

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

Syntax

• C#
• VB.NET

public void DrawCopy(string name, string X, string Y, string scaleX, string scaleY, string rotation, string skewA, string skewB);

Async Version
public async Task DrawCopy(string name, string X, string Y, string scaleX, string scaleY, string rotation, string skewA, string skewB);
public async Task DrawCopy(string name, string X, string Y, string scaleX, string scaleY, string rotation, string skewA, string skewB, CancellationToken cancellationToken);

Public Sub DrawCopy(ByVal Name As String, ByVal X As String, ByVal Y As String, ByVal ScaleX As String, ByVal ScaleY As String, ByVal Rotation As String, ByVal SkewA As String, ByVal SkewB As String)

Async Version
Public Sub DrawCopy(ByVal Name As String, ByVal X As String, ByVal Y As String, ByVal ScaleX As String, ByVal ScaleY As String, ByVal Rotation As String, ByVal SkewA As String, ByVal SkewB As String) As Task
Public Sub DrawCopy(ByVal Name As String, ByVal X As String, ByVal Y As String, ByVal ScaleX As String, ByVal ScaleY As String, ByVal Rotation As String, ByVal SkewA As String, ByVal SkewB As String, cancellationToken As CancellationToken) As Task

Remarks

This method is currently unsupported.

DrawCurveTo Method (PDFGen Component)

Adds a cubic Bezier curve segment to the current path.

Syntax

• C#
• VB.NET

public void DrawCurveTo(string X, string Y, string viaX1, string viaY1, string viaX2, string viaY2);

Async Version
public async Task DrawCurveTo(string X, string Y, string viaX1, string viaY1, string viaX2, string viaY2);
public async Task DrawCurveTo(string X, string Y, string viaX1, string viaY1, string viaX2, string viaY2, CancellationToken cancellationToken);

Public Sub DrawCurveTo(ByVal X As String, ByVal Y As String, ByVal ViaX1 As String, ByVal ViaY1 As String, ByVal ViaX2 As String, ByVal ViaY2 As String)

Async Version
Public Sub DrawCurveTo(ByVal X As String, ByVal Y As String, ByVal ViaX1 As String, ByVal ViaY1 As String, ByVal ViaX2 As String, ByVal ViaY2 As String) As Task
Public Sub DrawCurveTo(ByVal X As String, ByVal Y As String, ByVal ViaX1 As String, ByVal ViaY1 As String, ByVal ViaX2 As String, ByVal ViaY2 As String, cancellationToken As CancellationToken) As Task

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 Component)

Adds a straight line segment to the current path.

Syntax

• C#
• VB.NET

public void DrawLineTo(string X, string Y);

Async Version
public async Task DrawLineTo(string X, string Y);
public async Task DrawLineTo(string X, string Y, CancellationToken cancellationToken);

Public Sub DrawLineTo(ByVal X As String, ByVal Y As String)

Async Version
Public Sub DrawLineTo(ByVal X As String, ByVal Y As String) As Task
Public Sub DrawLineTo(ByVal X As String, ByVal Y As String, cancellationToken As CancellationToken) As Task

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 Component)

Draws a polygon on the drawing canvas.

Syntax

• C#
• VB.NET

public void DrawPolygon(string points);

Async Version
public async Task DrawPolygon(string points);
public async Task DrawPolygon(string points, CancellationToken cancellationToken);

Public Sub DrawPolygon(ByVal Points As String)

Async Version
Public Sub DrawPolygon(ByVal Points As String) As Task
Public Sub DrawPolygon(ByVal Points As String, cancellationToken As CancellationToken) As Task

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 Component)

Draws a rectangle on the drawing canvas.

Syntax

• C#
• VB.NET

public void DrawRectangle(string X, string Y, string width, string height, string cornerRadius);

Async Version
public async Task DrawRectangle(string X, string Y, string width, string height, string cornerRadius);
public async Task DrawRectangle(string X, string Y, string width, string height, string cornerRadius, CancellationToken cancellationToken);

Public Sub DrawRectangle(ByVal X As String, ByVal Y As String, ByVal Width As String, ByVal Height As String, ByVal CornerRadius As String)

Async Version
Public Sub DrawRectangle(ByVal X As String, ByVal Y As String, ByVal Width As String, ByVal Height As String, ByVal CornerRadius As String) As Task
Public Sub DrawRectangle(ByVal X As String, ByVal Y As String, ByVal Width As String, ByVal Height As String, ByVal CornerRadius As String, cancellationToken As CancellationToken) As Task

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 Component)

Completes the combo box field.

Syntax

• C#
• VB.NET

public void EndComboBox();

Async Version
public async Task EndComboBox();
public async Task EndComboBox(CancellationToken cancellationToken);

Public Sub EndComboBox()

Async Version
Public Sub EndComboBox() As Task
Public Sub EndComboBox(cancellationToken As CancellationToken) As Task

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 Component)

Completes the logical section.

Syntax

• C#
• VB.NET

public void EndContent();

Async Version
public async Task EndContent();
public async Task EndContent(CancellationToken cancellationToken);

Public Sub EndContent()

Async Version
Public Sub EndContent() As Task
Public Sub EndContent(cancellationToken As CancellationToken) As Task

Remarks

This method is currently unsupported.

EndDrawing Method (PDFGen Component)

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

Syntax

• C#
• VB.NET

public void EndDrawing(string X, string Y, string scaleX, string scaleY, string rotation, string skewA, string skewB, string name);

Async Version
public async Task EndDrawing(string X, string Y, string scaleX, string scaleY, string rotation, string skewA, string skewB, string name);
public async Task EndDrawing(string X, string Y, string scaleX, string scaleY, string rotation, string skewA, string skewB, string name, CancellationToken cancellationToken);

Public Sub EndDrawing(ByVal X As String, ByVal Y As String, ByVal ScaleX As String, ByVal ScaleY As String, ByVal Rotation As String, ByVal SkewA As String, ByVal SkewB As String, ByVal Name As String)

Async Version
Public Sub EndDrawing(ByVal X As String, ByVal Y As String, ByVal ScaleX As String, ByVal ScaleY As String, ByVal Rotation As String, ByVal SkewA As String, ByVal SkewB As String, ByVal Name As String) As Task
Public Sub EndDrawing(ByVal X As String, ByVal Y As String, ByVal ScaleX As String, ByVal ScaleY As String, ByVal Rotation As String, ByVal SkewA As String, ByVal SkewB As String, ByVal Name As String, cancellationToken As CancellationToken) As Task

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 Component)

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

Syntax

• C#
• VB.NET

public void EndEditing(string X, string Y, string scaleX, string scaleY, string rotation, string skewA, string skewB, string name);

Async Version
public async Task EndEditing(string X, string Y, string scaleX, string scaleY, string rotation, string skewA, string skewB, string name);
public async Task EndEditing(string X, string Y, string scaleX, string scaleY, string rotation, string skewA, string skewB, string name, CancellationToken cancellationToken);

Public Sub EndEditing(ByVal X As String, ByVal Y As String, ByVal ScaleX As String, ByVal ScaleY As String, ByVal Rotation As String, ByVal SkewA As String, ByVal SkewB As String, ByVal Name As String)

Async Version
Public Sub EndEditing(ByVal X As String, ByVal Y As String, ByVal ScaleX As String, ByVal ScaleY As String, ByVal Rotation As String, ByVal SkewA As String, ByVal SkewB As String, ByVal Name As String) As Task
Public Sub EndEditing(ByVal X As String, ByVal Y As String, ByVal ScaleX As String, ByVal ScaleY As String, ByVal Rotation As String, ByVal SkewA As String, ByVal SkewB As String, ByVal Name As String, cancellationToken As CancellationToken) As Task

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 Component)

Completes the form.

Syntax

• C#
• VB.NET

public void EndForm();

Async Version
public async Task EndForm();
public async Task EndForm(CancellationToken cancellationToken);

Public Sub EndForm()

Async Version
Public Sub EndForm() As Task
Public Sub EndForm(cancellationToken As CancellationToken) As Task

Remarks

This method is currently unsupported.

EndList Method (PDFGen Component)

Completes the list.

Syntax

• C#
• VB.NET

public void EndList();

Async Version
public async Task EndList();
public async Task EndList(CancellationToken cancellationToken);

Public Sub EndList()

Async Version
Public Sub EndList() As Task
Public Sub EndList(cancellationToken As CancellationToken) As Task

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 Component)

Completes the list box field.

Syntax

• C#
• VB.NET

public void EndListBox();

Async Version
public async Task EndListBox();
public async Task EndListBox(CancellationToken cancellationToken);

Public Sub EndListBox()

Async Version
Public Sub EndListBox() As Task
Public Sub EndListBox(cancellationToken As CancellationToken) As Task

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 Component)

Completes the list item.

Syntax

• C#
• VB.NET

public void EndListItem();

Async Version
public async Task EndListItem();
public async Task EndListItem(CancellationToken cancellationToken);

Public Sub EndListItem()

Async Version
Public Sub EndListItem() As Task
Public Sub EndListItem(cancellationToken As CancellationToken) As Task

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 Component)

Completes the paragraph.

Syntax

• C#
• VB.NET

public void EndParagraph(string name);

Async Version
public async Task EndParagraph(string name);
public async Task EndParagraph(string name, CancellationToken cancellationToken);

Public Sub EndParagraph(ByVal Name As String)

Async Version
Public Sub EndParagraph(ByVal Name As String) As Task
Public Sub EndParagraph(ByVal Name As String, cancellationToken As CancellationToken) As Task

Remarks

This method is currently unsupported.

EndPath Method (PDFGen Component)

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

Syntax

• C#
• VB.NET

public void EndPath(string name, bool closePath);

Async Version
public async Task EndPath(string name, bool closePath);
public async Task EndPath(string name, bool closePath, CancellationToken cancellationToken);

Public Sub EndPath(ByVal Name As String, ByVal ClosePath As Boolean)

Async Version
Public Sub EndPath(ByVal Name As String, ByVal ClosePath As Boolean) As Task
Public Sub EndPath(ByVal Name As String, ByVal ClosePath As Boolean, cancellationToken As CancellationToken) As Task

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 Component)

Completes the signature field.

Syntax

• C#
• VB.NET

public void EndSignatureField(string X, string Y, string scaleX, string scaleY, string rotation, string skewA, string skewB, string name);

Async Version
public async Task EndSignatureField(string X, string Y, string scaleX, string scaleY, string rotation, string skewA, string skewB, string name);
public async Task EndSignatureField(string X, string Y, string scaleX, string scaleY, string rotation, string skewA, string skewB, string name, CancellationToken cancellationToken);

Public Sub EndSignatureField(ByVal X As String, ByVal Y As String, ByVal ScaleX As String, ByVal ScaleY As String, ByVal Rotation As String, ByVal SkewA As String, ByVal SkewB As String, ByVal Name As String)

Async Version
Public Sub EndSignatureField(ByVal X As String, ByVal Y As String, ByVal ScaleX As String, ByVal ScaleY As String, ByVal Rotation As String, ByVal SkewA As String, ByVal SkewB As String, ByVal Name As String) As Task
Public Sub EndSignatureField(ByVal X As String, ByVal Y As String, ByVal ScaleX As String, ByVal ScaleY As String, ByVal Rotation As String, ByVal SkewA As String, ByVal SkewB As String, ByVal Name As String, cancellationToken As CancellationToken) As Task

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 Component)

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

Syntax

• C#
• VB.NET

public void EndTable(string name);

Async Version
public async Task EndTable(string name);
public async Task EndTable(string name, CancellationToken cancellationToken);

Public Sub EndTable(ByVal Name As String)

Async Version
Public Sub EndTable(ByVal Name As String) As Task
Public Sub EndTable(ByVal Name As String, cancellationToken As CancellationToken) As Task

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 Component)

Completes the current table cell.

Syntax

• C#
• VB.NET

public void EndTableCell(string name);

Async Version
public async Task EndTableCell(string name);
public async Task EndTableCell(string name, CancellationToken cancellationToken);

Public Sub EndTableCell(ByVal Name As String)

Async Version
Public Sub EndTableCell(ByVal Name As String) As Task
Public Sub EndTableCell(ByVal Name As String, cancellationToken As CancellationToken) As Task

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 Component)

Completes the current table row.

Syntax

• C#
• VB.NET

public void EndTableRow(string name);

Async Version
public async Task EndTableRow(string name);
public async Task EndTableRow(string name, CancellationToken cancellationToken);

Public Sub EndTableRow(ByVal Name As String)

Async Version
Public Sub EndTableRow(ByVal Name As String) As Task
Public Sub EndTableRow(ByVal Name As String, cancellationToken As CancellationToken) As Task

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 Component)

Returns the value of a document property.

Syntax

• C#
• VB.NET

public string GetDocumentProperty(string documentProperty);

Async Version
public async Task<string> GetDocumentProperty(string documentProperty);
public async Task<string> GetDocumentProperty(string documentProperty, CancellationToken cancellationToken);

Public Function GetDocumentProperty(ByVal DocumentProperty As String) As String

Async Version
Public Function GetDocumentProperty(ByVal DocumentProperty As String) As Task(Of String)
Public Function GetDocumentProperty(ByVal DocumentProperty As String, cancellationToken As CancellationToken) As Task(Of String)

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 Component)

Returns the value of a field property.

Syntax

• C#
• VB.NET

public string GetFieldProperty(string fieldName, string fieldProperty);

Async Version
public async Task<string> GetFieldProperty(string fieldName, string fieldProperty);
public async Task<string> GetFieldProperty(string fieldName, string fieldProperty, CancellationToken cancellationToken);

Public Function GetFieldProperty(ByVal FieldName As String, ByVal FieldProperty As String) As String

Async Version
Public Function GetFieldProperty(ByVal FieldName As String, ByVal FieldProperty As String) As Task(Of String)
Public Function GetFieldProperty(ByVal FieldName As String, ByVal FieldProperty As String, cancellationToken As CancellationToken) As Task(Of String)

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 Component)

Returns the value of a page property.

Syntax

• C#
• VB.NET

public string GetPageProperty(string pageProperty);

Async Version
public async Task<string> GetPageProperty(string pageProperty);
public async Task<string> GetPageProperty(string pageProperty, CancellationToken cancellationToken);

Public Function GetPageProperty(ByVal PageProperty As String) As String

Async Version
Public Function GetPageProperty(ByVal PageProperty As String) As Task(Of String)
Public Function GetPageProperty(ByVal PageProperty As String, cancellationToken As CancellationToken) As Task(Of String)

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 Component)

Removes an attachment from the document.

Syntax

• C#
• VB.NET

public void RemoveAttachment(int index);

Async Version
public async Task RemoveAttachment(int index);
public async Task RemoveAttachment(int index, CancellationToken cancellationToken);

Public Sub RemoveAttachment(ByVal Index As Integer)

Async Version
Public Sub RemoveAttachment(ByVal Index As Integer) As Task
Public Sub RemoveAttachment(ByVal Index As Integer, cancellationToken As CancellationToken) As Task

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 Component)

Resets the component.

Syntax

• C#
• VB.NET

public void Reset();

Async Version
public async Task Reset();
public async Task Reset(CancellationToken cancellationToken);

Public Sub Reset()

Async Version
Public Sub Reset() As Task
Public Sub Reset(cancellationToken As CancellationToken) As Task

Remarks

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

SaveStyle Method (PDFGen Component)

Saves the current style parameters.

Syntax

• C#
• VB.NET

public void SaveStyle(string name);

Async Version
public async Task SaveStyle(string name);
public async Task SaveStyle(string name, CancellationToken cancellationToken);

Public Sub SaveStyle(ByVal Name As String)

Async Version
Public Sub SaveStyle(ByVal Name As String) As Task
Public Sub SaveStyle(ByVal Name As String, cancellationToken As CancellationToken) As Task

Remarks

This method is currently unsupported.

Scroll Method (PDFGen Component)

Scrolls down the page by the given number of points.

Syntax

• C#
• VB.NET

public void Scroll(string height);

Async Version
public async Task Scroll(string height);
public async Task Scroll(string height, CancellationToken cancellationToken);

Public Sub Scroll(ByVal Height As String)

Async Version
Public Sub Scroll(ByVal Height As String) As Task
Public Sub Scroll(ByVal Height As String, cancellationToken As CancellationToken) As Task

Remarks

This method is currently unsupported.

SetAlignment Method (PDFGen Component)

Sets the alignment for subsequent text insertion operations.

Syntax

• C#
• VB.NET

public void SetAlignment(int horizontalAlignment, int verticalAlignment, bool wrapLines);

Async Version
public async Task SetAlignment(int horizontalAlignment, int verticalAlignment, bool wrapLines);
public async Task SetAlignment(int horizontalAlignment, int verticalAlignment, bool wrapLines, CancellationToken cancellationToken);

Public Sub SetAlignment(ByVal HorizontalAlignment As Integer, ByVal VerticalAlignment As Integer, ByVal WrapLines As Boolean)

Async Version
Public Sub SetAlignment(ByVal HorizontalAlignment As Integer, ByVal VerticalAlignment As Integer, ByVal WrapLines As Boolean) As Task
Public Sub SetAlignment(ByVal HorizontalAlignment As Integer, ByVal VerticalAlignment As Integer, ByVal WrapLines As Boolean, cancellationToken As CancellationToken) As Task

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 Component)

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

Syntax

• C#
• VB.NET

public void SetBrush(string color, string opacity);

Async Version
public async Task SetBrush(string color, string opacity);
public async Task SetBrush(string color, string opacity, CancellationToken cancellationToken);

Public Sub SetBrush(ByVal Color As String, ByVal Opacity As String)

Async Version
Public Sub SetBrush(ByVal Color As String, ByVal Opacity As String) As Task
Public Sub SetBrush(ByVal Color As String, ByVal Opacity As String, cancellationToken As CancellationToken) As Task

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 Component)

Sets the value of a document property.

Syntax

• C#
• VB.NET

public void SetDocumentProperty(string documentProperty, string value);

Async Version
public async Task SetDocumentProperty(string documentProperty, string value);
public async Task SetDocumentProperty(string documentProperty, string value, CancellationToken cancellationToken);

Public Sub SetDocumentProperty(ByVal DocumentProperty As String, ByVal Value As String)

Async Version
Public Sub SetDocumentProperty(ByVal DocumentProperty As String, ByVal Value As String) As Task
Public Sub SetDocumentProperty(ByVal DocumentProperty As String, ByVal Value As String, cancellationToken As CancellationToken) As Task

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 Component)

Sets the value of a field property.

Syntax

• C#
• VB.NET

public void SetFieldProperty(string fieldName, string fieldProperty, string value);

Async Version
public async Task SetFieldProperty(string fieldName, string fieldProperty, string value);
public async Task SetFieldProperty(string fieldName, string fieldProperty, string value, CancellationToken cancellationToken);

Public Sub SetFieldProperty(ByVal FieldName As String, ByVal FieldProperty As String, ByVal Value As String)

Async Version
Public Sub SetFieldProperty(ByVal FieldName As String, ByVal FieldProperty As String, ByVal Value As String) As Task
Public Sub SetFieldProperty(ByVal FieldName As String, ByVal FieldProperty As String, ByVal Value As String, cancellationToken As CancellationToken) As Task

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 Component)

Sets the font properties to be applied to text.

Syntax

• C#
• VB.NET

public void SetFont(string name, string size, string style, string color);

Async Version
public async Task SetFont(string name, string size, string style, string color);
public async Task SetFont(string name, string size, string style, string color, CancellationToken cancellationToken);

Public Sub SetFont(ByVal Name As String, ByVal Size As String, ByVal Style As String, ByVal Color As String)

Async Version
Public Sub SetFont(ByVal Name As String, ByVal Size As String, ByVal Style As String, ByVal Color As String) As Task
Public Sub SetFont(ByVal Name As String, ByVal Size As String, ByVal Style As String, ByVal Color As String, cancellationToken As CancellationToken) As Task

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

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 Component)

Sets the layout for new pages.

Syntax

• C#
• VB.NET

public void SetLayout(string size, int columns);

Async Version
public async Task SetLayout(string size, int columns);
public async Task SetLayout(string size, int columns, CancellationToken cancellationToken);

Public Sub SetLayout(ByVal Size As String, ByVal Columns As Integer)

Async Version
Public Sub SetLayout(ByVal Size As String, ByVal Columns As Integer) As Task
Public Sub SetLayout(ByVal Size As String, ByVal Columns As Integer, cancellationToken As CancellationToken) As Task

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 Component)

Sets the margin for a typical element.

Syntax

• C#
• VB.NET

public void SetMargin(int marginType, string value);

Async Version
public async Task SetMargin(int marginType, string value);
public async Task SetMargin(int marginType, string value, CancellationToken cancellationToken);

Public Sub SetMargin(ByVal MarginType As Integer, ByVal Value As String)

Async Version
Public Sub SetMargin(ByVal MarginType As Integer, ByVal Value As String) As Task
Public Sub SetMargin(ByVal MarginType As Integer, ByVal Value As String, cancellationToken As CancellationToken) As Task

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 Component)

Sets the stream to write the processed document to.

Syntax

• C#
• VB.NET

public void SetOutputStream(System.IO.Stream outputStream);

Async Version
public async Task SetOutputStream(System.IO.Stream outputStream);
public async Task SetOutputStream(System.IO.Stream outputStream, CancellationToken cancellationToken);

Public Sub SetOutputStream(ByVal OutputStream As System.IO.Stream)

Async Version
Public Sub SetOutputStream(ByVal OutputStream As System.IO.Stream) As Task
Public Sub SetOutputStream(ByVal OutputStream As System.IO.Stream, cancellationToken As CancellationToken) As Task

Remarks

This method is used to set the stream to which the component will write the resulting PDF document. If an output stream is set before the component attempts to perform operations on the document, the component 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 Component)

Sets the value of a page property.

Syntax

• C#
• VB.NET

public void SetPageProperty(string pageProperty, string value);

Async Version
public async Task SetPageProperty(string pageProperty, string value);
public async Task SetPageProperty(string pageProperty, string value, CancellationToken cancellationToken);

Public Sub SetPageProperty(ByVal PageProperty As String, ByVal Value As String)

Async Version
Public Sub SetPageProperty(ByVal PageProperty As String, ByVal Value As String) As Task
Public Sub SetPageProperty(ByVal PageProperty As String, ByVal Value As String, cancellationToken As CancellationToken) As Task

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 Component)

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

Syntax

• C#
• VB.NET

public void SetPen(string thickness, string style, string color, string opacity);

Async Version
public async Task SetPen(string thickness, string style, string color, string opacity);
public async Task SetPen(string thickness, string style, string color, string opacity, CancellationToken cancellationToken);

Public Sub SetPen(ByVal Thickness As String, ByVal Style As String, ByVal Color As String, ByVal Opacity As String)

Async Version
Public Sub SetPen(ByVal Thickness As String, ByVal Style As String, ByVal Color As String, ByVal Opacity As String) As Task
Public Sub SetPen(ByVal Thickness As String, ByVal Style As String, ByVal Color As String, ByVal Opacity As String, cancellationToken As CancellationToken) As Task

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 Component)

Loads a previously saved style.

Syntax

• C#
• VB.NET

public void SetStyle(string name);

Async Version
public async Task SetStyle(string name);
public async Task SetStyle(string name, CancellationToken cancellationToken);

Public Sub SetStyle(ByVal Name As String)

Async Version
Public Sub SetStyle(ByVal Name As String) As Task
Public Sub SetStyle(ByVal Name As String, cancellationToken As CancellationToken) As Task

Remarks

This method is currently unsupported.

StartComboBox Method (PDFGen Component)

Begins a new combo box field for editing.

Syntax

• C#
• VB.NET

public void StartComboBox(string name, string width);

Async Version
public async Task StartComboBox(string name, string width);
public async Task StartComboBox(string name, string width, CancellationToken cancellationToken);

Public Sub StartComboBox(ByVal Name As String, ByVal Width As String)

Async Version
Public Sub StartComboBox(ByVal Name As String, ByVal Width As String) As Task
Public Sub StartComboBox(ByVal Name As String, ByVal Width As String, cancellationToken As CancellationToken) As Task

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 Component)

Begins a new logical section.

Syntax

• C#
• VB.NET

public void StartContent(int contentType, string name);

Async Version
public async Task StartContent(int contentType, string name);
public async Task StartContent(int contentType, string name, CancellationToken cancellationToken);

Public Sub StartContent(ByVal ContentType As Integer, ByVal Name As String)

Async Version
Public Sub StartContent(ByVal ContentType As Integer, ByVal Name As String) As Task
Public Sub StartContent(ByVal ContentType As Integer, ByVal Name As String, cancellationToken As CancellationToken) As Task

Remarks

This method is currently unsupported.

StartDrawing Method (PDFGen Component)

Initiates a new drawing canvas of the given dimensions.

Syntax

• C#
• VB.NET

public void StartDrawing(string width, string height);

Async Version
public async Task StartDrawing(string width, string height);
public async Task StartDrawing(string width, string height, CancellationToken cancellationToken);

Public Sub StartDrawing(ByVal Width As String, ByVal Height As String)

Async Version
Public Sub StartDrawing(ByVal Width As String, ByVal Height As String) As Task
Public Sub StartDrawing(ByVal Width As String, ByVal Height As String, cancellationToken As CancellationToken) As Task

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 component.

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

StartEditing Method (PDFGen Component)

Initiates a new text canvas for editing.

Syntax

• C#
• VB.NET

public void StartEditing(string maxWidth, string maxHeight);

Async Version
public async Task StartEditing(string maxWidth, string maxHeight);
public async Task StartEditing(string maxWidth, string maxHeight, CancellationToken cancellationToken);

Public Sub StartEditing(ByVal MaxWidth As String, ByVal MaxHeight As String)

Async Version
Public Sub StartEditing(ByVal MaxWidth As String, ByVal MaxHeight As String) As Task
Public Sub StartEditing(ByVal MaxWidth As String, ByVal MaxHeight As String, cancellationToken As CancellationToken) As Task

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 component.

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

StartForm Method (PDFGen Component)

Begins a new form.

Syntax

• C#
• VB.NET

public void StartForm(string submitURL);

Async Version
public async Task StartForm(string submitURL);
public async Task StartForm(string submitURL, CancellationToken cancellationToken);

Public Sub StartForm(ByVal SubmitURL As String)

Async Version
Public Sub StartForm(ByVal SubmitURL As String) As Task
Public Sub StartForm(ByVal SubmitURL As String, cancellationToken As CancellationToken) As Task

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 Component)

Begins a new list for editing.

Syntax

• C#
• VB.NET

public void StartList(int marker);

Async Version
public async Task StartList(int marker);
public async Task StartList(int marker, CancellationToken cancellationToken);

Public Sub StartList(ByVal Marker As Integer)

Async Version
Public Sub StartList(ByVal Marker As Integer) As Task
Public Sub StartList(ByVal Marker As Integer, cancellationToken As CancellationToken) As Task

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: