GemBox.Pdf

Represents a base class for the actions.

PDF Specification ISO 32000-1:2008, section '12.6 Actions'

Gets the type of this action.

The type of this action. PDF Specification ISO 32000-1:2008, section '12.6.4 Action Types'

Represents a collection of s. This collection is implemented as singly linked list and therefore methods that use random access (index) are an O(n) operations, where n is .

PDF Specification ISO 32000-1:2008, section '12.6 Actions'

Adds a new with the explicit destination to the .

The explicit destination that shall be displayed when the action is executed. A new with the explicit destination added to the .

Adds a new with the named destination to the .

The named destination that shall be displayed when the action is executed. A new with the named destination added to the .

Adds a new with the explicit destination to the . represent the following values depending on the parameter: , , and . , and . and . and . and None.

The page that shall be displayed when this action is executed. Type of the view. The parameters of the view. A new with the explicit destination added to the .

Adds a new to the .

The application that shall be launched or the document that shall be opened or printed. A new added to the . is or .

Adds a new to the .

The uniform resource identifier to resolve, encoded in 7-bit ASCII. A new added to the . is or . The following example shows how you can add a web link annotation over text.


// Create the formatted text.
using var formattedText = new PdfFormattedText();
formattedText.Color = PdfColors.Blue;
formattedText.Underline = new PdfTextDecoration(PdfTextDecorationStyle.Single);
formattedText.AppendLine("Hello World");

// Draw the text.
var origin = new PdfPoint(100, page.CropBox.Top - 100 - formattedText.Height);
page.Content.DrawText(formattedText, origin);

// Add the web link annotation.
var link = page.Annotations.AddLink(origin.X, origin.Y, formattedText.Width, formattedText.Height);
link.Actions.AddOpenWebLink("https://www.gemboxsoftware.com/");

Adds a new with the Web server script's URL to the .

The uniform resource locator (URL) of the script at the Web server that will process the submission. A new with the Web server script's URL added to the .

Adds a new to the .

A new added to the .

Adds a new with the import data file path to the .

The path of a file from which to import the data. A new with the import data file path added to the .

Adds a new with the JavaScript script to be executed to the .

The JavaScript script to be executed. A new with the JavaScript script to be executed added to the . is or .

Returns an enumerator that iterates through the .

A for the .

Enumerates the elements of a .

Gets the element at the current position of the enumerator.

The element in the at the current position of the enumerator.

Advances the enumerator to the next element of the .

if the enumerator was successfully advanced to the next element; if the enumerator has passed the end of the collection. The collection was modified after the enumerator was created.

Releases all resources used by the .

Represents types of the s.

PDF Specification ISO 32000-1:2008, section '12.6.4 Action Types'

Action is unknown and currently not supported.

Action is a that goes to a destination in the current document. See 12.6.4.2, "Go-To Actions".

Action is a that launches an application, usually to open a file. See 12.6.4.5, "Launch Actions".

Action that begins reading an article thread. See 12.6.4.6, "Thread Actions".

Action is a that resolves a uniform resource identifier. See 12.6.4.7, "URI Actions".

(PDF 1.2; deprecated in PDF 2.0) Action that plays a sound. See 12.6.4.8, "Sound Actions".

(PDF 1.2) Action that sets an annotation's Hidden flag. See 12.6.4.10, "Hide Actions".

(PDF 1.2) Action that executes a predefined action. See 12.6.4.11, "Named Actions".

(PDF 1.2) Action is a that sends data to a uniform resource locator. See 12.7.5.2, "Submit-Form Action".

(PDF 1.2) Action is a that sets fields to their default values. See 12.7.5.3, "Reset-Form Action".

(PDF 1.2) Action is a that imports field values from a file. See 12.7.5.4, "Import-Data Action".

(PDF 1.5) Action that sets the states of optional content groups. See 12.6.4.12, "Set-OCG-State Actions".

(PDF 1.6) Action that sets the current view of a 3D annotation. See 12.6.4.15, "Go-To-3D-View Actions".

(PDF 1.3) Action is a that executes a JavaScript script. See 12.6.4.16, "JavaScript Actions".

(PDF 2.0; RichMedia annotation only) Action that specifies a command to be sent to the annotation's handler.

A go-to action changes the view to a specified destination (page, location, and magnification factor).

Specifying a go-to action in the A entry of a link annotation or outline item has the same effect as specifying the destination directly with the Dest entry. PDF Specification ISO 32000-1:2008, section '12.6.4.2 Go-To Actions'

Gets the value.

The value.

(Required) The destination to jump to (see 12.3.2, "Destinations").

The destination to jump to. Value is . PDF Specification ISO 32000-1:2008, section '12.3.2 Destinations'

(Required) The named destination to jump to (see 12.3.2.3, "Named Destinations").

The named destination to jump to. Value is . PDF Specification ISO 32000-1:2008, section '12.3.2.3 Named Destinations'

Sets the explicit destination to jump to (see 12.3.2.2, "Explicit Destinations"). represent the following values depending on the parameter: , , and . , and . and . and . and None.

The page to jump to. Type of the view. The parameters of the view. The explicit destination to jump to. PDF Specification ISO 32000-1:2008, section '12.3.2.2 Explicit Destinations'

A launches an application or opens or prints a document.

PDF Specification ISO 32000-1:2008, section '12.6.4.5 Launch Actions'

Gets the value.

The value.

The application that shall be launched or the document that shall be opened or printed.

The application that shall be launched or the document that shall be opened or printed. Value is or . PDF Specification ISO 32000-1:2008, section '12.6.4.5 Launch Actions'

A uniform resource identifier (URI) is a string that identifies (resolves to) a resource on the Internet—typically a file that is the destination of a hypertext link, although it may also resolve to a query or other entity. URIs are described in Internet RFC 2396, Uniform Resource Identifiers (URI): Generic Syntax. A causes a URI to be resolved.

PDF Specification ISO 32000-1:2008, section '12.6.4.7 URI Actions'

Gets the value.

The value.

(Required) The uniform resource identifier to resolve, encoded in 7-bit ASCII.

The uniform resource identifier to resolve, encoded in 7-bit ASCII. Value is or . PDF Specification ISO 32000-1:2008, section '12.6.4.7 URI Actions'

Upon invocation of a JavaScript action, a conforming processor shall execute a script that is written in the JavaScript programming language.

PDF Specification ISO 32000-1:2008, section '12.6.4.16 JavaScript Actions'

Gets the value.

The value.

(Required) A text string or text stream containing the JavaScript script to be executed. or Unicode encoding (the latter identified by the Unicode prefix U+FEFF) shall be used to encode the contents of the string or stream.

A text string or text stream containing the JavaScript script to be executed. Value is or . PDF Specification ISO 32000-1:2008, section '12.6.4.16 JavaScript Actions'

An annotation associates an object such as a note, link or rich media with a location on a page of a PDF document, or provides a way to interact with the user by means of the mouse and keyboard.

PDF Specification ISO 32000-1:2008, section '12.5 Annotations'

Gets the type of the annotation.

The type of the annotation. PDF Specification ISO 32000-1:2008, section '12.5.6 Annotation Types'

(Required) The annotation bounds, defining the location and the size of the annotation on the page in default user space units.

The annotation bounds, defining the location and the size of the annotation on the page in default user space units. Value is . PDF Specification ISO 32000-1:2008, section '12.5.2 Annotation Dictionaries'

Sets the .

The left X coordinate of the . The bottom Y coordinate of the . The right X coordinate of the . The top Y coordinate of the . , , or is either , or .

Sets the size of the .

The width of the . The height of the . or is either , or . or is less than zero.

Gets the page with which this annotation is associated.

The page with which this annotation is associated. PDF Specification ISO 32000-1:2008, section '12.5.2 Annotation Dictionaries'

(PDF 1.4) If set, do not allow the annotation to be deleted or its properties (including position and size) to be modified by the user. However, this flag does not restrict changes to the annotation's contents, such as the value of a form field.

If set, do not allow the annotation to be deleted or its properties (including position and size) to be modified by the user. PDF Specification ISO 32000-1:2008, section '12.5.3 Annotation Flags'

(Optional; PDF 2.0) An array of one or more s which denote the associated files for this .

An array of one or more s which denote the associated files for this . Associated Files example

Gets the appearance settings for this .

The appearance settings for this .

Represents a collection of s.

PDF Specification ISO 32000-1:2008, section '12.5 Annotations'

Adds a to the . The whose size is 24 pt x 24 pt is used for an appearance of a newly added .

The lower-left horizontal coordinate of the bounds specified in default user space units. The lower-left vertical coordinate of the bounds specified in default user space units. A new added to the .

Adds a to the .

The lower-left horizontal coordinate of the bounds specified in default user space units. The lower-left vertical coordinate of the bounds specified in default user space units. The width of the bounds specified in default user space units. The height of the bounds specified in default user space units. A new added to the . The following example shows how you can add a web link annotation over text.


// Create the formatted text.
using var formattedText = new PdfFormattedText();
formattedText.Color = PdfColors.Blue;
formattedText.Underline = new PdfTextDecoration(PdfTextDecorationStyle.Single);
formattedText.AppendLine("Hello World");

// Draw the text.
var origin = new PdfPoint(100, page.CropBox.Top - 100 - formattedText.Height);
page.Content.DrawText(formattedText, origin);

// Add the web link annotation.
var link = page.Annotations.AddLink(origin.X, origin.Y, formattedText.Width, formattedText.Height);
link.Actions.AddOpenWebLink("https://www.gemboxsoftware.com/");

Adds a text comment to the .

The lower-left horizontal coordinate of the text comment bounds specified in default user space units. The lower-left vertical coordinate of the text comment bounds specified in default user space units. The width of the text comment bounds specified in default user space units. The height of the text comment bounds specified in default user space units. A new text comment added to the .

Adds a text box to the .

The lower-left horizontal coordinate of the text box bounds specified in default user space units. The lower-left vertical coordinate of the text box bounds specified in default user space units. The width of the text box bounds specified in default user space units. The height of the text box bounds specified in default user space units. A new text box added to the .

Adds a rectangular to the .

The lower-left horizontal coordinate of the rectangular bounds specified in default user space units. The lower-left vertical coordinate of the rectangular bounds specified in default user space units. The width of the rectangular bounds specified in default user space units. The height of the rectangular bounds specified in default user space units. A new rectangular added to the .

Adds a rectangular to the .

Identification of the user who added the rectangular . The lower-left horizontal coordinate of the rectangular bounds specified in default user space units. The lower-left vertical coordinate of the rectangular bounds specified in default user space units. The upper-right horizontal coordinate of the rectangular bounds specified in default user space units. The upper-right vertical coordinate of the rectangular bounds specified in default user space units. A new rectangular added to the .

Adds an oval to the .

The lower-left horizontal coordinate of the oval bounds specified in default user space units. The lower-left vertical coordinate of the oval bounds specified in default user space units. The width of the oval bounds specified in default user space units. The height of the oval bounds specified in default user space units. A new oval added to the .

Adds an oval to the .

Identification of the user who added the oval . The lower-left horizontal coordinate of the oval bounds specified in default user space units. The lower-left vertical coordinate of the oval bounds specified in default user space units. The upper-right horizontal coordinate of the oval bounds specified in default user space units. The upper-right vertical coordinate of the oval bounds specified in default user space units. A new oval added to the .

Adds a highlight to the .

The lower-left horizontal coordinate of the highlight bounds specified in default user space units. The lower-left vertical coordinate of the highlight bounds specified in default user space units. The width of the highlight bounds specified in default user space units. The height of the highlight bounds specified in default user space units. A new highlight added to the .

Adds a highlight to the .

The bounds of the highlight specified in default user space units. A new highlight added to the .

Adds an underline to the .

The lower-left horizontal coordinate of the underline bounds specified in default user space units. The lower-left vertical coordinate of the underline bounds specified in default user space units. The width of the underline bounds specified in default user space units. The height of the underline bounds specified in default user space units. A new underline added to the .

Adds an underline to the .

The bounds of the underline specified in default user space units. A new underline added to the .

Adds a strikeout to the .

The lower-left horizontal coordinate of the strikeout bounds specified in default user space units. The lower-left vertical coordinate of the strikeout bounds specified in default user space units. The width of the strikeout bounds specified in default user space units. The height of the strikeout bounds specified in default user space units. A new strikeout added to the .

Adds a strikeout to the .

The bounds of the strikeout specified in default user space units. A new strikeout added to the .

Adds a to the .

Adds a to the with the specified stamp appearance icon.

The lower-left horizontal coordinate of the bounds specified in default user space units. The lower-left vertical coordinate of the bounds specified in default user space units. The width of the bounds specified in default user space units or non-positive value to use the default width. The height of the bounds specified in default user space units or non-positive value to use the default height. The icon used in displaying the . A new added to the .

Adds a to the .

Adds a to the with the associated file created from the specified with an empty . The whose size is 7 pt x 17 pt is used for an appearance of a newly added .

Adds a to the with the associated file copied from the resource specified by the . The whose size is 7 pt x 17 pt is used for an appearance of a newly added .

The lower-left horizontal coordinate of the bounds specified in default user space units. The lower-left vertical coordinate of the bounds specified in default user space units. The location of the resource copied to the file associated with a newly added . This value is also used to resolve the of the associated file. A new added to the . is or . File Attachment Annotations example

Adds a to the .


// Add and apply a redaction annotation 100 points from the left and top edge of the page.
var redaction = page.Annotations.AddRedaction(100, page.CropBox.Top - 300, 200, 200);
redaction.Apply();

Performs the Content removal phase of the redaction process after which the content in the area specified (either via or ) by all s contained in this is removed. In the removed content's place, some marking appears to indicate the area has been redacted as specified by the , , and related properties. Also, all s (and their associated pop-up annotations) are removed from this . If a portion of a content (either text, path, image, or form) is contained in a redaction region, that portion of the content is destroyed; clipping or image masks are not used to hide that content.

PDF Specification ISO 32000-1:2008, section '12.5.6.23 Redaction Annotations'

Represents types of the s.

PDF Specification ISO 32000-1:2008, section '12.5.6 Annotation Types'

The unknown annotation.

The . Markup: Yes.

PDF Specification ISO 32000-1:2008, section '12.5.6.4 Text Annotations'

The . Markup: No.

PDF Specification ISO 32000-1:2008, section '12.5.6.5 Link Annotations'

(PDF 1.3) The . Markup: Yes.

PDF Specification ISO 32000-1:2008, section '12.5.6.6 Free Text Annotations'

(PDF 1.3) Line annotation. Markup: Yes.

PDF Specification ISO 32000-1:2008, section '12.5.6.7 Line Annotations'

(PDF 1.3) The . Markup: Yes.

PDF Specification ISO 32000-1:2008, section '12.5.6.8 Square and Circle Annotations'

(PDF 1.3) The . Markup: Yes.

PDF Specification ISO 32000-1:2008, section '12.5.6.8 Square and Circle Annotations'

(PDF 1.5) Polygon annotation. Markup: Yes.

PDF Specification ISO 32000-1:2008, section '12.5.6.9 Polygon and Polyline Annotations'

(PDF 1.5) Polyline annotation. Markup: Yes.

PDF Specification ISO 32000-1:2008, section '12.5.6.9 Polygon and Polyline Annotations'

(PDF 1.3) Highlight . Markup: Yes.

PDF Specification ISO 32000-1:2008, section '12.5.6.10 Text Markup Annotations'

(PDF 1.3) Underline . Markup: Yes.

PDF Specification ISO 32000-1:2008, section '12.5.6.10 Text Markup Annotations'

(PDF 1.4) Squiggly-underline . Markup: Yes.

PDF Specification ISO 32000-1:2008, section '12.5.6.10 Text Markup Annotations'

(PDF 1.3) Strikeout . Markup: Yes.

PDF Specification ISO 32000-1:2008, section '12.5.6.10 Text Markup Annotations'

(PDF 1.5) CThe . Markup: Yes.

PDF Specification ISO 32000-1:2008, section '12.5.6.11 Caret Annotations'

(PDF 1.3) The . Markup: Yes.

PDF Specification ISO 32000-1:2008, section '12.5.6.12 Rubber Stamp Annotations'

(PDF 1.3) The . Markup: Yes.

PDF Specification ISO 32000-1:2008, section '12.5.6.13 Ink Annotations'

(PDF 1.3) Pop-up annotation. Markup: No.

PDF Specification ISO 32000-1:2008, section '12.5.6.14 Pop-up Annotations'

(PDF 1.3) The . Markup: Yes.

PDF Specification ISO 32000-1:2008, section '12.5.6.15 File Attachment Annotations'

(PDF 1.2; deprecated in PDF 2.0) Sound annotation. Markup: Yes.

PDF Specification ISO 32000-1:2008, section '12.5.6.16 Sound Annotations'

(PDF 1.2; deprecated in PDF 2.0) Movie annotation. Markup: No.

PDF Specification ISO 32000-1:2008, section '12.5.6.17 Movie Annotations'

(PDF 1.2) The . Markup: No.

PDF Specification ISO 32000-1:2008, section '12.5.6.19 Widget Annotations'

(PDF 1.5) Screen annotation. Markup: No.

PDF Specification ISO 32000-1:2008, section '12.5.6.18 Screen Annotations'

(PDF 1.4) Printer's mark annotation. Markup: No.

PDF Specification ISO 32000-1:2008, section '12.5.6.20 Printer’s Mark Annotations'

(PDF 1.3) Trap network annotation. Markup: No.

PDF Specification ISO 32000-1:2008, section '12.5.6.21 Trap Network Annotations'

(PDF 1.6) Watermark annotation. Markup: No.

PDF Specification ISO 32000-1:2008, section '12.5.6.22 Watermark Annotations'

(PDF 1.6) 3D annotation. Markup: No.

PDF Specification ISO 32000-1:2008, section '13.6.2 3D Annotations'

(PDF 1.7) The . Markup: Yes.

PDF Specification ISO 32000-1:2008, section '12.5.6.23 Redaction Annotations'

(PDF 2.0) Projection annotation. Markup: Yes.

(PDF 2.0) RichMedia annotation. Markup: No.

Represents an appearance settings for a .

(Required if the appearance dictionary AP contains one or more subdictionaries; PDF 1.2) The annotation's appearance state, which selects the applicable appearance stream from an appearance subdictionary (see Section 12.5.5, "Appearance Streams").

The annotation's appearance state, which selects the applicable appearance stream from an appearance subdictionary. PDF Specification ISO 32000-1:2008, section '12.5.2 Annotation Dictionaries'

Gets a collection of appearance states and the associated appearance forms for the specified appearance trigger.

The appearance trigger for which to get a collection of appearance states and the associated appearance forms. A collection of appearance states and the associated appearance forms for the specified appearance trigger. PDF Specification ISO 32000-1:2008, section '12.5.5 Appearance Streams'

Gets the appearance form for the specified appearance trigger and appearance state.

The appearance trigger for which to get the appearance form. The appearance state for which to get the appearance form. The appearance form for the specified appearance trigger and appearance state. PDF Specification ISO 32000-1:2008, section '12.5.5 Appearance Streams'

Gets the appearance form for the appearance trigger and the current appearance .

The appearance form for the appearance trigger and the current appearance . PDF Specification ISO 32000-1:2008, section '12.5.5 Appearance Streams'

Sets a collection of appearance states and the associated appearance forms for the specified appearance trigger.

The appearance trigger for which to set a collection of appearance states and the associated appearance forms. A collection of appearance states and the associated appearance forms to set for the specified appearance trigger.

Sets the appearance form for the specified appearance trigger and appearance state.

The appearance trigger for which to set the appearance form. The appearance state for which to set the appearance form. The appearance form to set for the specified appearance trigger and appearance state.

Sets the appearance form for the appearance trigger and the current appearance .

The appearance form to set for the appearance trigger and the current appearance .

Begins initialization of the . Call to end the initialization and update the appearance. If is called on a that is already being initialized, the second and subsequent calls are ignored.

GemBox.Pdf detects the first change to and sets the as the current changing appearance of the . The remains the current changing appearance of the until: The is called on of the current changing appearance of the . Another is changed, thus implicitly updating the current changing appearance and setting the newly changed appearance as the current changing appearance of the . GemBox.Pdf determines that the current changing appearance should be updated such as when saving a to a file or cloning a or a . To override this behavior, call method before and method after initializing the to take control of when the changed appearance is updated.

Ends initialization of the by updating the changed appearance. This method will be ignored if called on a that is not being initialized.

Forces an update of the appearance.

Represents an annotation's appearance state, which selects the applicable appearance stream from an appearance subdictionary (see Section 12.5.5, "Appearance Streams").

Initializes a new instance of the structure from the specified value.

The value. is .

Returns a that represents this instance.

A that represents this instance.

Determines whether the is equal to this instance.

The other appearance state to compare with this appearance state instance. if the is equal to this instance; otherwise, .

Determines whether the specified is equal to this instance.

The to compare with this appearance state instance. if the specified is a and is equal to this instance; otherwise, .

Returns a hash code for this instance.

An integer value that specifies a hash value for this instance.

Determines whether and s are equal.

The first appearance state. The second appearance state. if and appearance states are equal; otherwise, .

Determines whether and s are not equal.

The first appearance state. The second appearance state. if and appearance states are not equal; otherwise, .

Represents an event that triggers the showing of a particular .

PDF Specification ISO 32000-1:2008, section '12.5.5 Appearance Streams'

The normal appearance shall be used when the annotation is not interacting with the user. This appearance is also used for printing the annotation.

The rollover appearance shall be used when the user moves the cursor into the annotation's active area without pressing the mouse button.

The down appearance shall be used when the mouse button is pressed or held down within the annotation's active area.

Represents the style of the annotation's border.

PDF Specification ISO 32000-1:2008, section '12.5.4 Border Styles'

The border style is unknown.

A solid rectangle surrounding the annotation.

A dashed rectangle surrounding the annotation.

A simulated embossed rectangle that appears to be raised above the surface of the page.

A simulated engraved rectangle that appears to be recessed below the surface of the page.

A single line along the bottom of the annotation rectangle.

A caret annotation (PDF 1.5) is a visual symbol that indicates the presence of text edits.

PDF Specification ISO 32000-1:2008, section '12.5.6.11 Caret Annotations'

Gets the value.

The value.

Gets the appearance settings for this .

The appearance settings for this .

(Optional) Text that shall be displayed for the annotation.

Text that shall be displayed for the annotation. PDF Specification ISO 32000-1:2008, section '12.5.2 Annotation Dictionaries' PDF Specification ISO 32000-1:2008, section '12.5.6.2 Markup Annotations'

>A name that shall describe the intent of the . The following values shall be valid: and .

A name describing the intent of the . Value is not or . PDF Specification ISO 32000-1:2008, section '12.5.6.2 Markup Annotations'

(Optional; PDF 1.5) A set of four numbers that shall describe the numerical differences between two rectangles: the of the annotation and the actual boundaries of the underlying caret. Such a difference can occur when a paragraph symbol specified by Sy is displayed along with the caret.. The four numbers correspond to the differences in default user space between the left, top, right, and bottom coordinates of and those of the caret, respectively. Each value shall be greater than or equal to 0. The sum of the top and bottom differences shall be less than the height of , and the sum of the left and right differences shall be less than the width of .

A set of four numbers that shall describe the numerical differences between two rectangles: the of the annotation and the actual boundaries of the underlying caret. All padding values must be greater than or equal to 0, the sum of the and values must be less than the of the , and the sum of the and values must be less than the of the . PDF Specification ISO 32000-1:2008, section '12.5.6.11 Caret Annotations'

Represents an appearance settings for a .

PDF Specification ISO 32000-1:2008, section '12.5.6.11 Caret Annotations'

Gets or sets the color.

The color. The value's is not device color space (, , or ).

Gets or sets the opacity. Default value: 1.0.

The opacity.

A file attachment annotation (PDF 1.3) contains a reference to a file, which typically shall be embedded in the PDF file (see 7.11.4, "Embedded File Streams").

PDF Specification ISO 32000-1:2008, section '12.5.6.15 File Attachment Annotations' File Attachment Annotations example

Gets the value.

The value.

Gets the appearance settings for this .

The appearance settings for this .

Gets or sets the description.

The description. File Attachment Annotations example

(Required) The file associated with this annotation. If this property returns , then use the property because the associated file is specified as a file specification string.

The file associated with this annotation. PDF Specification ISO 32000-1:2008, section '12.5.6.15 File Attachment Annotations' File Attachment Annotations example

Sets the file associated with this annotation.

The name of the file associated with this annotation. A newly created with the specified name associated with this annotation. is or . PDF Specification ISO 32000-1:2008, section '12.5.6.15 File Attachment Annotations'

(Required) The path of the file associated with this annotation.

The path of the file associated with this annotation. Value is or . PDF Specification ISO 32000-1:2008, section '12.5.6.15 File Attachment Annotations'

Represents an appearance settings for a .

PDF Specification ISO 32000-1:2008, section '12.5.6.15 File Attachment Annotations' File Attachment Annotations example

(Optional) The icon that shall be used in displaying the . Default value: .

The icon that shall be used in displaying the . Value of enumeration is not supported in the requested operation. PDF Specification ISO 32000-1:2008, section '12.5.6.15 File Attachment Annotations' File Attachment Annotations example

Gets or sets the color.

The color. The value's is not device color space (, , or ).

Gets or sets the opacity. Default value: 1.0.

The opacity.

The file attachment icon that shall be used in displaying the .

PDF Specification ISO 32000-1:2008, section '12.5.6.15 File Attachment Annotations' File Attachment Annotations example

Icon is unknown and currently not supported.

The Graph icon. Size: 20 pt x 20 pt.

The Paperclip icon. Size: 7 pt x 17 pt.

The Attachment (push pin) icon. Size: 14 pt x 20 pt.

The Tag icon. Size: 20 pt x 16 pt.

A free text annotation (PDF 1.3) displays text directly on the page. Unlike an ordinary , a free text annotation has no open or closed state; instead of being displayed in a pop-up window, the text shall be always visible.

PDF Specification ISO 32000-1:2008, section '12.5.6.6 Free Text Annotations'

Gets the value.

The value.

Gets the appearance settings for this .

The appearance settings for this .

(Optional) Text that shall be displayed for the annotation.

Text that shall be displayed for the annotation. PDF Specification ISO 32000-1:2008, section '12.5.2 Annotation Dictionaries' PDF Specification ISO 32000-1:2008, section '12.5.6.2 Markup Annotations'

Sets the formatted text that shall be used to generate the appearance of the annotation and forces an update of the appearance.

The formatted text that shall be used to generate the appearance of the annotation.

(Optional; PDF 1.6) A name describing the intent of the . The following values shall be valid: , , and .

A name describing the intent of the . Value is not , , or . PDF Specification ISO 32000-1:2008, section '12.5.6.6 Free Text Annotations' PDF Specification ISO 32000-1:2008, section '12.5.6.2 Markup Annotations'

(Optional; PDF 1.6) A set of four numbers describing the numerical differences between two rectangles: the of the annotation and a rectangle contained within that rectangle. The inner rectangle is where the annotation's text should be displayed. Any border styles and/or border effects shall be applied to the border of the inner rectangle. The four numbers correspond to the differences in default user space between the left, top, right, and bottom coordinates of and those of the inner rectangle, respectively. Each value shall be greater than or equal to 0. The sum of the top and bottom differences shall be less than the height of , and the sum of the left and right differences shall be less than the width of .

A set of four numbers describing the numerical differences between two rectangles: the of the annotation and a rectangle contained within that rectangle. All padding values must be greater than or equal to 0, the sum of the and values must be less than the of the , and the sum of the and values must be less than the of the . PDF Specification ISO 32000-1:2008, section '12.5.6.6 Free Text Annotations'

Represents an appearance settings for a .

PDF Specification ISO 32000-1:2008, section '12.5.6.6 Free Text Annotations'

Gets or sets the border thickness of the free text annotation's appearance.

The border thickness of the free text annotation's appearance. Value is less than 0. Value is either , or . PDF Specification ISO 32000-1:2008, section '12.5.6.6 Free Text Annotations'

Gets or sets the border style of the free text annotation's appearance.

The border style of the free text annotation's appearance. Value of enumeration is not supported in the requested operation. PDF Specification ISO 32000-1:2008, section '12.5.6.6 Free Text Annotations'

Gets or sets the border dash pattern of the free text annotation's appearance.

The border dash pattern of the free text annotation's appearance. PDF Specification ISO 32000-1:2008, section '12.5.6.6 Free Text Annotations'

Gets or sets the border color of the free text annotation's appearance.

The border color of the free text annotation's appearance. PDF Specification ISO 32000-1:2008, section '12.5.6.6 Free Text Annotations'

Gets or sets the opacity of the free text annotation's appearance. Default value: 1.0.

The opacity of the free text annotation's appearance.

Gets or sets the fill color of the free text annotation's appearance.

The fill color of the free text annotation's appearance. The value's is not device color space (, , or ).

Gets or sets the font color of the free text annotation's appearance text.

The font color of the free text annotation's appearance text.

Gets or sets the font size of the free text annotation's appearance text. A zero value for size means that the font shall be auto-sized: its size shall be computed as a function of the size of the annotation rectangle.

The font size of the free text annotation's appearance text. Value is either , or . Value is less than 0.

Gets or sets the font face of the free text annotation's appearance text.

The font face of the free text annotation's appearance text. Value is .

Gets or sets the text alignment of the free text annotation's appearance text.

The text alignment of the free text annotation's appearance text. , and alignments are supported for free text annotation's appearance text.

Gets or sets the underline text decoration of the free text annotation's appearance text.

The underline text decoration of the free text annotation's appearance text. The is not preserved in a PDF file when the is saved to a PDF file.

Gets or sets the strikethrough text decoration of the free text annotation's appearance text.

The strikethrough text decoration of the free text annotation's appearance text. The is not preserved in a PDF file when the is saved to a PDF file.

The annotation's highlighting mode, the visual effect that shall be used when the mouse button is pressed or held down inside its active area.

PDF Specification ISO 32000-1:2008, section '12.5.6.5 Link Annotations' PDF Specification ISO 32000-1:2008, section '12.5.6.19 Widget Annotations'

The highlighting mode is unknown.

No highlighting.

Invert the colors used to display the contents of the annotation rectangle.

Stroke the colors used to display the annotation border. That is, for each color channel in the color space used for display of the annotation value, color values shall be transformed by the function 𝑓(𝑥) = 1 – 𝑥 for display.

Display the annotation's down appearance, if any (see 12.5.5, "Appearance Streams"). If no down appearance is defined, the contents of the annotation rectangle shall be offset to appear as if it were being pushed below the surface of the page.

Same as (which is preferred).

A link annotation represents either a hypertext link to a destination elsewhere in the document (see 12.3.2, "Destinations") or an action to be performed (12.6, "Actions").

The following example shows how you can add a web link annotation over text.


// Create the formatted text.
using var formattedText = new PdfFormattedText();
formattedText.Color = PdfColors.Blue;
formattedText.Underline = new PdfTextDecoration(PdfTextDecorationStyle.Single);
formattedText.AppendLine("Hello World");

// Draw the text.
var origin = new PdfPoint(100, page.CropBox.Top - 100 - formattedText.Height);
page.Content.DrawText(formattedText, origin);

// Add the web link annotation.
var link = page.Annotations.AddLink(origin.X, origin.Y, formattedText.Width, formattedText.Height);
link.Actions.AddOpenWebLink("https://www.gemboxsoftware.com/");

PDF Specification ISO 32000-1:2008, section '12.5.6.5 Link Annotations'

Gets the value.

The value.

Gets the appearance settings for this .

The appearance settings for this .

(Optional; not permitted if an A entry is present) The destination that shall be displayed when the annotation is activated (see 12.3.2, "Destinations").

The destination that shall be displayed when the annotation is activated. PDF Specification ISO 32000-1:2008, section '12.5.6.5 Link Annotations'

(Optional; not permitted if an A entry is present) The named destination that shall be displayed when the annotation is activated (see 12.3.2.3, "Named Destinations").

The named destination that shall be displayed when the annotation is activated. PDF Specification ISO 32000-1:2008, section '12.5.6.5 Link Annotations'

Sets the explicit destination that shall be displayed when the annotation is activated (see 12.3.2.2, "Explicit Destinations"). represent the following values depending on the parameter: , , and . , and . and . and . and None.

The page that shall be displayed when the annotation is activated. Type of the view. The parameters of the view. The explicit destination that shall be displayed when the annotation is activated. PDF Specification ISO 32000-1:2008, section '12.5.6.5 Link Annotations'

(Optional; PDF 1.1) An action that shall be performed when the link annotation is activated (see 12.6, "Actions").

An action that shall be performed when the link annotation is activated. The following example shows how you can add a web link annotation over text.


// Create the formatted text.
using var formattedText = new PdfFormattedText();
formattedText.Color = PdfColors.Blue;
formattedText.Underline = new PdfTextDecoration(PdfTextDecorationStyle.Single);
formattedText.AppendLine("Hello World");

// Draw the text.
var origin = new PdfPoint(100, page.CropBox.Top - 100 - formattedText.Height);
page.Content.DrawText(formattedText, origin);

// Add the web link annotation.
var link = page.Annotations.AddLink(origin.X, origin.Y, formattedText.Width, formattedText.Height);
link.Actions.AddOpenWebLink("https://www.gemboxsoftware.com/");

PDF Specification ISO 32000-1:2008, section '12.5.6.5 Link Annotations'

(Optional; PDF 1.2) The annotation's highlighting mode, the visual effect that shall be used when the mouse button is pressed or held down inside its active area. Default value: .

The annotation's highlighting mode, the visual effect that shall be used when the mouse button is pressed or held down inside its active area. Value of enumeration is not supported in the requested operation. PDF Specification ISO 32000-1:2008, section '12.5.6.5 Link Annotations'

(Optional; PDF 1.6) An array of 8 × n numbers specifying the coordinates of n quadrilaterals in default user space that comprise the region in which the link should be activated. If this entry is not present or the conforming reader does not recognize it, the region specified by the entry should be used. shall be ignored if any coordinate in the array lies outside the region specified by .

An array of 8 × n numbers specifying the coordinates of n quadrilaterals in default user space that comprise the region in which the link should be activated. PDF Specification ISO 32000-1:2008, section '12.5.6.5 Link Annotations'

Represents an appearance settings for a .

PDF Specification ISO 32000-1:2008, section '12.5.6.5 Link Annotations'

Gets or sets the border thickness of the link annotation's appearance.

The border thickness of the link annotation's appearance. Value is less than 0. Value is either , or . PDF Specification ISO 32000-1:2008, section '12.5.6.5 Link Annotations'

Gets or sets the border style of the link annotation's appearance.

The border style of the link annotation's appearance. Value of enumeration is not supported in the requested operation. PDF Specification ISO 32000-1:2008, section '12.5.6.5 Link Annotations'

Gets or sets the border dash pattern of the link annotation's appearance.

The border dash pattern of the link annotation's appearance. PDF Specification ISO 32000-1:2008, section '12.5.6.5 Link Annotations'

Gets or sets the border color of the link annotation's appearance.

The border color of the link annotation's appearance. The value's is not device color space (, , or ). PDF Specification ISO 32000-1:2008, section '12.5.6.5 Link Annotations'

Represents a base class for markup annotations that used primarily to mark up PDF documents. These annotations have text that appears as part of the annotation and may be displayed in other ways by a conforming reader, such as in a Comments pane.

PDF Specification ISO 32000-1:2008, section '12.5.6.2 Markup Annotations'

(Optional; PDF 1.1) The text label that shall be displayed in the title bar of the annotation's pop-up window when open and active. This entry shall identify the user who added the annotation.

The text label that shall be displayed in the title bar of the annotation's pop-up window when open and active. PDF Specification ISO 32000-1:2008, section '12.5.6.2 Markup Annotations'

(Required if a entry is present, otherwise optional; PDF 1.5) A reference to the that this is "in reply to". Both s shall be on the same page of the document. The relationship between the two s shall be specified by the entry.

A reference to the that this is "in reply to". The is not on the same page of the document as this . PDF Specification ISO 32000-1:2008, section '12.5.6.2 Markup Annotations'

(Optional; meaningful only if is present; PDF 1.6) A name specifying the relationship (the "reply type") between this and the one specified by the property. Default value: .

A name specifying the relationship (the "reply type") between this and the one specified by the property. PDF Specification ISO 32000-1:2008, section '12.5.6.2 Markup Annotations'

(Optional; PDF 1.5) Text representing a short description of the subject being addressed by the annotation.

Text representing a short description of the subject being addressed by the annotation. PDF Specification ISO 32000-1:2008, section '12.5.6.2 Markup Annotations'

(Optional; PDF 1.6) A name describing the intent of the markup annotation. Intents allow conforming readers to distinguish between different uses and behaviors of a single markup annotation type. s (Table 174), line annotations (Table 175), polygon annotations (Table 178), and (PDF 1.7) polyline annotations (Table 178) have defined intents.

A name describing the intent of the markup annotation. PDF Specification ISO 32000-1:2008, section '12.5.6.2 Markup Annotations'

An enumeration describing the intent of the . Intents allow conforming readers to distinguish between different uses and behaviors of a single markup annotation type.

PDF Specification ISO 32000-1:2008, section '12.5.6.2 Markup Annotations' PDF Specification ISO 32000-1:2008, section '12.5.6.6 Free Text Annotations' PDF Specification ISO 32000-1:2008, section '12.5.6.7 Line Annotations' PDF Specification ISO 32000-1:2008, section '12.5.6.9 Polygon and Polyline Annotations'

Markup annotation intent is unknown or not supported.

The is intended to function as a plain free-text annotation. A plain free-text annotation is also known as a text box comment.

The is intended to function as a callout. The callout is associated with an area on the page through the callout line specified in the .

The is intended to function as a click-to-type or typewriter object and no callout line is drawn.

The line annotation is intended to function as a plain line annotation.

The line annotation is intended to function as an arrow.

The line annotation is intended to function as a dimension line.

The polygon annotation is intended to function as a plain polygon annotation.

The polygon annotation is intended to function as a cloud object.

(PDF 1.7) The polygon annotation is intended to function as a dimension polygon.

The polyline annotation is intended to function as a plain polyline annotation.

(PDF 1.7) The polyline annotation is intended to function as a dimension polyline.

The is intended to function as an underline.

This is a non-standard value used by Adobe.

The is intended to function as a plain cross-out annotation.

The is intended to function as a cross-out over the text that should be edited.

This is a non-standard value used by Adobe.

The is intended to function as a plain caret annotation.

The is intended to function as a caret next to the text that should be replaced.

This is a non-standard value used by Adobe.

(PDF 2.0) The appearance of this is a rubber stamp.

(PDF 2.0) The appearance of this has been taken from preexisting PDF content.

(PDF 2.0) The appearance of this is an Image.

An ink annotation (PDF 1.3) represents a freehand "scribble" composed of one or more disjoint paths.

PDF Specification ISO 32000-1:2008, section '12.5.6.13 Ink Annotations'

Gets the value.

The value.

Gets the appearance settings for this .

The appearance settings for this .

Gets the subpaths that this is made up of.

The subpaths that this is made up of.

Begin a new subpath.

The where the begins. A reference to this instance after the operation has completed. PDF Specification ISO 32000-1:2008, section '8.5.2 Path Construction Operators'

Begin a new subpath.

The X-coordinate value of where the begins. The Y-coordinate value of where the begins. A reference to this instance after the operation has completed. or is either , or . PDF Specification ISO 32000-1:2008, section '8.5.2 Path Construction Operators'

Adds a straight line to the end of the of the last in the .

The end point of the straight line segment. A reference to this instance after the operation has completed. The doesn't contain any . Use method before using the current method. PDF Specification ISO 32000-1:2008, section '8.5.2 Path Construction Operators'

Adds a straight line to the end of the of the last in the .

The X-coordinate value of the end point of the straight line segment. The Y-coordinate value of the end point of the straight line segment. A reference to this instance after the operation has completed. or is either , or . The doesn't contain any . Use method before using the current method. PDF Specification ISO 32000-1:2008, section '8.5.2 Path Construction Operators'

Adds a cubic Bézier curve to the end of the of the last in the .

The first control point of the curved line segment. The second control point of the curved line segment. The end point of the curved line segment. A reference to this instance after the operation has completed. The doesn't contain any . Use method before using the current method. PDF Specification ISO 32000-1:2008, section '8.5.2 Path Construction Operators' PDF Specification ISO 32000-1:2008, section '8.5.2.2 Cubic Bézier Curves'

Adds a cubic Bézier curve to the end of the of the last in the .

The X-coordinate value of the first control point of the curved line segment. The Y-coordinate value of the first control point of the curved line segment. The X-coordinate value of the second control point of the curved line segment. The Y-coordinate value of the second control point of the curved line segment. The X-coordinate value of the end point of the curved line segment. The Y-coordinate value of the end point of the curved line segment. A reference to this instance after the operation has completed. , , , , , or is either , or . The doesn't contain any . Use method before using the current method. PDF Specification ISO 32000-1:2008, section '8.5.2 Path Construction Operators' PDF Specification ISO 32000-1:2008, section '8.5.2.2 Cubic Bézier Curves'

Adds a elliptic arc to the end of the of the last in the . PDF doesn't natively support elliptic arcs so the arc is approximated with one to four Bézier curves.

The radii (half the width and half the height) of an oval whose perimeter is used to draw the angle. The destination point for the end of the arc. A value that indicates whether the arc is drawn in the clockwise (positive-angle) or counter clockwise (negative-angle) direction. to draw the arc greater than 180 degrees; otherwise, . The rotation angle of the oval that specifies the curve. The curvature of the arc can be rotated with this parameter. A reference to this instance after the operation has completed. PDF Specification ISO 32000-1:2008, section '8.5.2 Path Construction Operators' PDF Specification ISO 32000-1:2008, section '8.5.2.2 Cubic Bézier Curves'

Adds a elliptic arc to the end of the of the last in the . PDF doesn't natively support elliptic arcs so the arc is approximated with one to four Bézier curves.

The horizontal radius of an oval whose perimeter is used to draw the angle. The vertical radius of an oval whose perimeter is used to draw the angle. The X-coordinate value of the destination point for the end of the arc. The Y-coordinate value of the destination point for the end of the arc. A value that indicates whether the arc is drawn in the clockwise (positive-angle) or counter clockwise (negative-angle) direction. to draw the arc greater than 180 degrees; otherwise, . The rotation angle of the oval that specifies the curve. The curvature of the arc can be rotated with this parameter. A reference to this instance after the operation has completed. , , , or is either , or . or is less than zero. PDF Specification ISO 32000-1:2008, section '8.5.2 Path Construction Operators' PDF Specification ISO 32000-1:2008, section '8.5.2.2 Cubic Bézier Curves'

Represents an appearance settings for a .

PDF Specification ISO 32000-1:2008, section '12.5.6.13 Ink Annotations'

Gets or sets the thickness that shall be used in drawing the . Default value: 1.0.

The thickness that shall be used in drawing the . Value is less than 0. Value is either , or . PDF Specification ISO 32000-1:2008, section '12.5.6.13 Ink Annotations'

Gets or sets the color that shall be used in stroking the .

The color that shall be used in stroking the . The value's is not device color space (, , or ). PDF Specification ISO 32000-1:2008, section '12.5.6.13 Ink Annotations'

Gets or sets the opacity that shall be used in stroking the . Default value: 1.0.

The opacity that shall be used in stroking the .

A redaction annotation (PDF 1.7) identifies content that is intended to be removed from the document. The intent of redaction annotations is to enable the following process: Content identification. A user applies redact annotations that specify the pieces or regions of content that should be removed. Up until the next step is performed, the user can see, move and redefine these annotations. Content removal. The user instructs the viewer application to apply the redact annotations, after which the content in the area specified by the redact annotations is removed. In the removed content’s place, some marking appears to indicate the area has been redacted. Also, the redact annotations are removed from the PDF document.

The following example shows how you can redact content in a PDF file.


// Add and apply a redaction annotation 100 points from the left and top edge of the page.
var redaction = page.Annotations.AddRedaction(100, page.CropBox.Top - 300, 200, 200);
redaction.Apply();

PDF Specification ISO 32000-1:2008, section '12.5.6.23 Redaction Annotations'

Gets the value.

The value.

Gets the appearance settings for this .

The appearance settings for this .

(Optional)An array of 8 x n numbers specifying the coordinates of n quadrilaterals in default user space, as described in Table 179 for text markup annotations. If present, these quadrilaterals denote the content region that is intended to be removed. If this entry is not present, the entry denotes the content region that is intended to be removed.

An array of 8 x n numbers specifying the coordinates of n quadrilaterals in default user space, as described in Table 179 for text markup annotations. PDF Specification ISO 32000-1:2008, section '12.5.6.23 Redaction Annotations'

Performs the Content removal phase of the redaction process after which the content in the area specified (either via or ) by this is removed. In the removed content's place, some marking appears to indicate the area has been redacted as specified by the , , and related properties. Also, this (and its associated pop-up annotation) is removed from the parent . If a portion of a content (either text, path, image, or form) is contained in a redaction region, that portion of the content is destroyed; clipping or image masks are not used to hide that content.

The following example shows how you can redact content in a PDF file.


// Add and apply a redaction annotation 100 points from the left and top edge of the page.
var redaction = page.Annotations.AddRedaction(100, page.CropBox.Top - 300, 200, 200);
redaction.Apply();

PDF Specification ISO 32000-1:2008, section '12.5.6.23 Redaction Annotations'

Represents an appearance settings for a .

PDF Specification ISO 32000-1:2008, section '12.5.6.23 Redaction Annotations'

(Optional) Gets or sets the interior color with which to fill the redacted region after the affected content has been removed. If this entry is absent, the interior of the redaction region is left transparent. Default value: Black.

The interior color with which to fill the redacted region after the affected content has been removed. The value's is not . PDF Specification ISO 32000-1:2008, section '12.5.6.23 Redaction Annotations'

(Optional) Gets or sets a text string specifying the overlay text that should be drawn over the redacted region after the affected content has been removed. To not use Overlay Text, set this property to . Default value: .

A text string specifying the overlay text that should be drawn over the redacted region after the affected content has been removed. PDF Specification ISO 32000-1:2008, section '12.5.6.23 Redaction Annotations'

(Optional) If , then the text specified by should be repeated to fill the redacted region after the affected content has been removed. Default value: .

If , then the text specified by should be repeated to fill the redacted region after the affected content has been removed; otherwise, . PDF Specification ISO 32000-1:2008, section '12.5.6.23 Redaction Annotations'

(Required if is present, ignored otherwise) Gets or sets the font color of the overlay text when it is drawn after the affected content has been removed. Default value: .

The font color of the overlay text when it is drawn after the affected content has been removed. PDF Specification ISO 32000-1:2008, section '12.5.6.23 Redaction Annotations'

(Required if is present, ignored otherwise) Gets or sets the font size of the overlay text when it is drawn after the affected content has been removed. Set the to zero to Auto-Size text to fit redaction region. Default value: 0 (Auto-Size text to fit redaction region).

The font size of the overlay text when it is drawn after the affected content has been removed. Value is either , or . Value is less than 0. PDF Specification ISO 32000-1:2008, section '12.5.6.23 Redaction Annotations'

(Required if is present, ignored otherwise) Gets or sets the font face of the overlay text when it is drawn after the affected content has been removed. Default value: Helvetica.

The font face of the overlay text when it is drawn after the affected content has been removed. Value is . PDF Specification ISO 32000-1:2008, section '12.5.6.23 Redaction Annotations'

(Optional) Gets or sets the text alignment of the overlay text when it is drawn after the affected content has been removed. Default value: .

The text alignment of the overlay text when it is drawn after the affected content has been removed. , and alignments are supported for free text annotation's appearance text. PDF Specification ISO 32000-1:2008, section '12.5.6.23 Redaction Annotations'

Gets or sets the outline color of the redaction mark appearance. Default value: .

The outline color of the redaction mark appearance. The value's is not device color space (, , or ).

Gets or sets the fill color of the redaction mark appearance. Default value: .

The fill color of the redaction mark appearance. The value's is not device color space (, , or ).

Gets or sets the opacity of the redaction mark appearance. Default value: 1.0.

The opacity of the redaction mark appearance.

An enumeration specifying the relationship (the "reply type") between the and the one specified by its property.

PDF Specification ISO 32000-1:2008, section '12.5.6.2 Markup Annotations'

The unknown reply type.

The shall be considered a reply to the specified by . Conforming readers shall not display replies to an annotation individually but together in the form of threaded comments.

The shall be grouped with the specified by . In PDF 1.6, a set of annotations may be grouped so that they function as a single unit when a user interacts with them. The group consists of a primary annotation, which shall not have an entry, and one or more subordinate annotations, which shall have an entry that refers to the primary annotation and a entry whose value is . Some entries in the primary annotation are treated as "group attributes" that shall apply to the group as a whole; the corresponding entries in the subordinate annotations shall be ignored. Operations that manipulate any annotation in a group, such as movement, cut, and copy, shall be treated by conforming readers as acting on the entire group.

Represents a condition under which the content shall be scaled inside the available size.

PDF Specification ISO 32000-1:2008, Table 247 – Entries in an icon fit dictionary

Always scale.

Scale only when the content is bigger than the available size.

Scale only when the content is smaller than the available size.

Never scale.

Square and circle annotations (PDF 1.3) shall display, respectively, a rectangle or an ellipse on the page. When opened, they shall display a pop-up window containing the text of the associated note. The rectangle or ellipse shall be inscribed within the annotation rectangle defined by the annotation (see (see Table 168).

PDF Specification ISO 32000-1:2008, section '12.5.6.8 Square and Circle Annotations'

Gets the or value.

The or value.

Gets the appearance settings for this .

The appearance settings for this .

Gets or sets the description.

The description.

(Optional; PDF 1.5) A set of four numbers that shall describe the numerical differences between two rectangles: the Rect entry of the annotation and the actual boundaries of the underlying square or circle. Such a difference may occur in situations where a border effect (described by BE) causes the size of the Rect to increase beyond that of the square or circle.

The four numbers shall correspond to the differences in default user space between the left, top, right, and bottom coordinates of Rect and those of the square or circle, respectively. Each value shall be greater than or equal to 0. The sum of the top and bottom differences shall be less than the height of Rect, and the sum of the left and right differences shall be less than the width of Rect. Value is .

(Optional; PDF 1.5) A set of four numbers that shall describe the numerical differences between two rectangles: the of the annotation and the actual boundaries of the underlying square or circle. Such a difference may occur in situations where a border effect causes the size of the to increase beyond that of the square or circle. The four numbers correspond to the differences in default user space between the left, top, right, and bottom coordinates of and those of the square or circle, respectively. Each value shall be greater than or equal to 0. The sum of the top and bottom differences shall be less than the height of , and the sum of the left and right differences shall be less than the width of .

A set of four numbers that shall describe the numerical differences between two rectangles: the of the annotation and the actual boundaries of the underlying square or circle. All padding values must be greater than or equal to 0, the sum of the and values must be less than the of the , and the sum of the and values must be less than the of the . PDF Specification ISO 32000-1:2008, section '12.5.6.6 Free Text Annotations'

Represents an appearance settings for a .

PDF Specification ISO 32000-1:2008, section '12.5.6.8 Square and Circle Annotations'

Gets or sets the thickness of the square or circle to be stroked.

The thickness of the square or circle to be stroked. Value is less than 0. Value is either , or . PDF Specification ISO 32000-1:2008, section '12.5.6.8 Square and Circle Annotations'

Gets or sets the style of the square or circle to be stroked.

The style of the square or circle to be stroked. Value of enumeration is not supported in the requested operation. PDF Specification ISO 32000-1:2008, section '12.5.6.8 Square and Circle Annotations'

Gets or sets the dash pattern of the square or circle to be stroked.

The dash pattern of the square or circle to be stroked. PDF Specification ISO 32000-1:2008, section '12.5.6.8 Square and Circle Annotations'

Gets or sets the color of the square or circle to be stroked.

The color of the square or circle to be stroked. The value's is not device color space (, , or ). PDF Specification ISO 32000-1:2008, section '12.5.6.8 Square and Circle Annotations'

Gets or sets the opacity of the square or circle. Default value: 1.0.

The opacity of the square or circle.

Gets or sets the fill color of the square or circle.

The fill color of the square or circle. The value's is not device color space (, , or ). PDF Specification ISO 32000-1:2008, section '12.5.6.8 Square and Circle Annotations'

A rubber stamp annotation (PDF 1.3) displays text or graphics intended to look as if they were stamped on the page with a rubber stamp. When opened, it shall display a pop-up window containing the text of the associated note.

PDF Specification ISO 32000-1:2008, section '12.5.6.12 Rubber Stamp Annotations'

Gets the value.

The value.

Gets the appearance settings for this .

The appearance settings for this .

>(Optional; PDF 2.0) A name that shall describe the intent of the . The following values shall be valid: , , and . Default value: .

A name describing the intent of the . Value is not , , or . PDF Specification ISO 32000-1:2008, section '12.5.6.2 Markup Annotations'

Represents an appearance settings for a .

PDF Specification ISO 32000-1:2008, section '12.5.6.12 Rubber Stamp Annotations'

(Optional) The icon that shall be used in displaying the . Default value: .

The icon that shall be used in displaying the . PDF Specification ISO 32000-1:2008, section '12.5.6.12 Rubber Stamp Annotations'

Gets or sets the opacity. Default value: 1.0.

The opacity.

Gets or sets the time of stamping. Applicable for: , , , and . If , value is used.

The time of stamping.

Gets or sets the format string. Applicable for: , , , and . If , value "h:mm tt, MMM dd, yyyy" is used.

The format string.

Gets or sets the culture-specific formatting provider. Applicable for: , , , and . If , value is used.

The culture-specific formatting provider.

Gets or sets the name of the person or authority stamping the document. Applicable for: , , and . If , value is used.

The name of the person or authority stamping the document.

Gets or sets the format of the and label. Applicable for: , , and . If , value "By {0} at {1}" is used.

The format of the and label.

Gets or sets the organization name of the person or authority stamping the document. Applicable for: . If , value is used.

The organization name of the person or authority stamping the document.

The stamp icon that shall be used in displaying the .

PDF Specification ISO 32000-1:2008, section '12.5.6.12 Rubber Stamp Annotations'

Icon is unknown and currently not supported.

The Approved icon.

The Experimental icon.

The Not Approved icon.

The As Is icon.

The Expired icon.

The Not For Public Release icon.

The Confidential icon.

The Final icon.

The Sold icon.

The Departmental icon.

The For Comment icon.

The Top Secret icon.

The Draft icon.

The For Public Release icon.

The Standard Business Approved icon.

The Standard Business Not Approved icon.

The Standard Business Draft icon.

The Standard Business Final icon.

The Standard Business Completed icon.

The Standard Business Confidential icon.

The Standard Business For Public Release icon.

The Standard Business Not For Public Release icon.

The Standard Business For Comment icon.

The Standard Business Void icon.

The Standard Business Preliminary Results icon.

The Standard Business Information Only icon.

The Sign Here Witness icon.

The Sign Here Initial Here icon.

The Sign Here Sign Here icon.

The Sign Here Accepted icon.

The Sign Here Rejected icon.

The Dynamic Revised icon.

The Dynamic Reviewed icon.

The Dynamic Received icon.

The Dynamic Approved icon.

The Dynamic Confidential icon.

A text annotation represents a "sticky note" attached to a point in the PDF document. When closed, the annotation shall appear as an icon; when open, it shall display a pop-up window containing the text of the note in a font and size chosen by the conforming reader.

PDF Specification ISO 32000-1:2008, section '12.5.6.4 Text Annotations'

Gets the value.

The value.

Gets the appearance settings for this .

The appearance settings for this .

(Optional) Text that shall be displayed for the annotation.

Text that shall be displayed for the annotation. PDF Specification ISO 32000-1:2008, section '12.5.2 Annotation Dictionaries' PDF Specification ISO 32000-1:2008, section '12.5.6.2 Markup Annotations'

(Optional) A flag specifying whether the annotation shall initially be displayed open. Default value: (closed).

A flag specifying whether the annotation shall initially be displayed open. PDF Specification ISO 32000-1:2008, section '12.5.6.4 Text Annotations'

Represents an appearance settings for a .

PDF Specification ISO 32000-1:2008, section '12.5.6.4 Text Annotations'

(Optional) The icon that shall be used in displaying the . Default value: .

The icon that shall be used in displaying the . Value of enumeration is not supported in the requested operation. PDF Specification ISO 32000-1:2008, section '12.5.6.4 Text Annotations'

Gets or sets the color.

The color. The value's is not device color space (, , or ).

Gets or sets the opacity. Default value: 1.0.

The opacity.

The sticky note icon that shall be used in displaying the .

PDF Specification ISO 32000-1:2008, section '12.5.6.4 Text Annotations'

Icon is unknown and currently not supported.

The Checkmark icon. Size: 19 pt x 19 pt.

The Insert Text (checkmark) icon. Size: 20 pt x 20 pt.

The Circle icon. Size: 20 pt x 20 pt.

The Comment icon. Size: 24 pt x 24 pt.

The Cross icon. Size: 19 pt x 19 pt.

The Cross Hairs icon. Size: 20 pt x 20 pt.

The Help icon. Size: 20 pt x 20 pt.

The Insert Text icon. Size: 17 pt x 20 pt.

The Key icon. Size: 13 pt x 18 pt.

The New Paragraph icon. Size: 13 pt x 20 pt.

The Text Note icon. Size: 18 pt x 20 pt.

The Paragraph icon. Size: 20 pt x 20 pt.

The Right Arrow icon. Size: 20 pt x 20 pt.

The Right Pointer icon. Size: 20 pt x 17 pt.

The Star icon. Size: 20 pt x 19 pt.

The Up Arrow icon. Size: 17 pt x 20 pt.

The Up-Left Arrow icon. Size: 17 pt x 17 pt.

Text markup annotations shall appear as highlights, underlines, strikeouts (all PDF 1.3), or jagged ("squiggly") underlines (PDF 1.4) in the text of a document. When opened, they shall display a pop-up window containing the text of the associated note.

PDF Specification ISO 32000-1:2008, section '12.5.6.10 Text Markup Annotations'

Gets the , , , or value.

The , , , or value.

Gets the appearance settings for this .

The appearance settings for this .

(Optional) Text that shall be displayed for the annotation.

Text that shall be displayed for the annotation. PDF Specification ISO 32000-1:2008, section '12.5.2 Annotation Dictionaries' PDF Specification ISO 32000-1:2008, section '12.5.6.2 Markup Annotations'

>A name that shall describe the intent of the . The following values shall be valid: .

A name describing the intent of the . Value is not when the is or , or value another . PDF Specification ISO 32000-1:2008, section '12.5.6.2 Markup Annotations'

(Required) An array of 8 × n numbers specifying the coordinates of n quadrilaterals in default user space encompassing a word or group of contiguous words in the text underlying the annotation.

An array of 8 × n numbers specifying the coordinates of n quadrilaterals in default user space encompassing a word or group of contiguous words in the text underlying the annotation. PDF Specification ISO 32000-1:2008, section '12.5.6.10 Text Markup Annotations'

Represents an appearance settings for a .

PDF Specification ISO 32000-1:2008, section '12.5.6.10 Text Markup Annotations'

Gets or sets the color.

The color. The value's is not device color space (, , or ).

Gets or sets the opacity. Default value: 1.0.

The opacity.

Gets or sets the value indicating whether the underline style is squiggly or straight.

if the underline style is squiggly or if the underline style is straight; otherwise, if the is not an underline. Value is not and the is not an underline.

Represents a placement of the annotation appearance text relative to its icon.

PDF Specification ISO 32000-1:2008, Table 189 – Entries in an appearance characteristics dictionary

No icon; text only.

No text; icon only.

Text below the icon.

Text above the icon.

Text to the right of the icon.

Text to the left of the icon.

Text overlaid directly on the icon.

Contains methods that can be useful for users which are calling GemBox.Pdf component using COM interop.

Initializes a new instance of the class.

Sets the license (serial) key.

The serial key. You should call this method before using any other class from GemBox.Pdf assembly. Key can only be set once (if you try to set another key, exception will be thrown). The best place to call this method is from static constructor of your application's main class. Valid serial key has multiple groups of alphanumeric characters, separated with dashes. To use the assembly in free limited mode, use FREE-LIMITED-KEY as . For more information about GemBox.Pdf evaluation and licensing, see evaluation and licensing.

Loads a PDF document from a file with the specified path and with the options.

The path to a file from which to load a PDF document. A loaded PDF document. is . PDF file is encrypted and the password is required to load a PDF document. Use method and provide a valid . File Structure

Loads a PDF document from a file with the specified path and with the specified options.

The path to a file from which to load a PDF document. The options used for loading a from a PDF file. A loaded PDF document. is or is . PDF file is encrypted and the is invalid. File Structure

Saves the entire PDF document to a file with the specified path. Use to specify options used for saving the to a PDF file.

The PdfDocument instance which to save. The path to a file to which to save a PDF document. is . File Structure

Gets all fields from the PDF document's interactive form.

The PdfDocument instance from which to retrieve the PdfField elements. Array of interactive form fields.

Contains diagnostic information and licensing members for GemBox.Pdf assembly.

Gets the GemBox.Pdf assembly title.

The GemBox.Pdf assembly title.

Gets the GemBox.Pdf assembly version.

The GemBox.Pdf assembly version.

Occurs when GemBox.Pdf assembly is used with FREE-LIMITED-KEY license key and free limit is reached.

Sets the license (serial) key.

The serial key. You should call this method before using any other class from GemBox.Pdf assembly. Key can only be set once (if you try to set another key, it will be ignored). The best place to call this method is from static constructor of your application's main class. Valid serial key has multiple groups of alphanumeric characters, separated with dashes. To use the assembly in free limited mode, use FREE-LIMITED-KEY as . For more information about GemBox.Pdf evaluation and licensing, see evaluation and licensing.

Represents a color system of a PDF content.

Colors example PDF Specification ISO 32000-1:2008, section '8.6 Color Spaces'

Gets the single instance of the color space.

The single instance of the color space. PDF Specification ISO 32000-1:2008, section '8.6.4.2 DeviceGray Color Space'

Gets the single instance of the color space.

The single instance of the color space. PDF Specification ISO 32000-1:2008, section '8.6.4.3 DeviceRGB Color Space'

Gets the single instance of the color space.

The single instance of the color space. PDF Specification ISO 32000-1:2008, section '8.6.4.4 DeviceCMYK Color Space'

Gets the single instance of the color space used with colored tiling patterns.

The single instance of the color space used with colored tiling patterns. PDF Specification ISO 32000-1:2008, section '8.6.6.2 Pattern Color Spaces'

Gets the type of the color space.

The type of the color space.

Gets the number of color components in the color space.

The number of color components in the color space.

Gets or creates a from the specified whose first element is a object identifying the color space family. The remaining elements, if any, are parameters that further characterize the color space; their number and types vary according to the particular .

A whose first element is a object identifying the color space family. The remaining elements, if any, are parameters that further characterize the color space; their number and types vary according to the particular . An instance of a or . is . If was already created from the same , that instance is returned. This method provides a way to create s that are currently not available in GemBox.Pdf (such as , , , , , , and ). s available in GemBox.Pdf are accessible via , , , and properties.

Returns a that represents this instance.

A that represents this instance. This method should be used primarily for debugging purposes and should be considered volatile (format of its return value might change in future versions).

Determines whether the specified is equal to this instance.

The to compare with this color space instance. if the specified is equal to this instance; otherwise, .

Returns a hash code for this instance.

An integer value that specifies a hash value for this instance.

Represents an enumeration of color space families of a PDF content.

Colors example

(PDF 1.1) The device color space that controls the intensity of achromatic light, on a scale from black to white. This color space is a singleton available via property.

(PDF 1.1) The device color space that controls the intensities of red, green, and blue light, the three additive primary colors used in displays. This color space is a singleton available via property.

(PDF 1.1) The device color space that controls the concentrations of cyan, magenta, yellow, and black inks, the four subtractive process colors used in printing. This color space is a singleton available via property.

(PDF 1.1) A special case of a single-component CIE-based color space, known as a CIE-based A color space. This color space can currently be created only with method from [/CalGray dictionary].

(PDF 1.1) A CIE-based ABC color space with only one transformation stage instead of two. This color space can currently be created only with method from [/CalRGB dictionary].

(PDF 1.1) A CIE-based ABC color space with two transformation stages. This color space can currently be created only with method from [/Lab dictionary].

(PDF 1.3) A CIE-based color space based on a cross-platform color profile as defined by the International Color Consortium (ICC). This color space can currently be created only with method from [/ICCBased stream].

(PDF 1.1) A special color space that allows a PDF content stream to use small integers as indices into a color map or color table of arbitrary colors in some other space. This color space can currently be created only with method from [/Indexed base hival lookup].

(PDF 1.2) A special color space that enables a PDF content stream to paint an area with a rather than a single color. For colored tiling patterns, this color space is a singleton available via property. For uncolored tiling patterns, this color space can currently be created only with method from [/Pattern underlying-color-space-name-or-array].

(PDF 1.2) A special color space that provides a means for specifying the use of additional colorants or for isolating the control of individual color components of a device color space for a subtractive device. This color space can currently be created only with method from [/Separation name alternateSpace tintTransform].

(PDF 1.3) A special color space that can contain an arbitrary number of color components. This color space can currently be created only with method from [/DeviceN names alternateSpace tintTransform (attributes)].

Represents an x- and y-coordinate pair in two-dimensional PDF space. The positive x axis extends horizontally to the right and the positive y axis vertically upward, as in standard mathematical practice.

The user space coordinate system shall be initialized to a default state for each page of a document. The property in the shall specify the rectangle of user space corresponding to the visible area of the intended output medium (display window or printed page). The positive x axis extends horizontally to the right and the positive y axis vertically upward, as in standard mathematical practice (subject to alteration by the property in the ). The length of a unit along both the x and y axes is set by the property (PDF 1.6) in the (see Table 30). The default value of is 1/72 inch (1 point). This coordinate system is called default user space. PDF Specification ISO 32000-1:2008, section '8.3 Coordinate Systems'

Gets the X-coordinate value of this structure.

The X-coordinate value of this structure.

Gets the Y-coordinate value of this structure.

The Y-coordinate value of this structure.

Initializes a new instance of the structure that contains the specified coordinates.

The x-coordinate of the new structure. The y-coordinate of the new structure. or is either , or .

Returns a that represents this instance using the specified format and format provider.

The format to use or to use the default format. The provider to use to format the value or to obtain the numeric format information from the current locale setting of the operating system. A that represents this instance using the specified format and format provider. This method should be used primarily for debugging purposes and should be considered volatile (format of its return value might change in future versions).

Returns a that represents this instance.

A that represents this instance. This method should be used primarily for debugging purposes and should be considered volatile (format of its return value might change in future versions).

Determines whether the is equal to this instance.

The other point to compare with this point instance. if the is equal to this instance; otherwise, .

Determines whether the specified is equal to this instance.

The to compare with this point instance. if the specified is a and is equal to this instance; otherwise, .

Returns a hash code for this instance.

An integer value that specifies a hash value for this instance.

Determines whether and s are equal.

The first point. The second point. if and points are equal; otherwise, .

Determines whether and s are not equal.

The first point. The second point. if and points are not equal; otherwise, .

Represents the size of an object.

Gets the width.

The width.

Gets the height.

The height.

Initializes a new instance of the structure that contains the specified and .

The width of the new structure. The height of the new structure. or is either , or . or is less than zero.

Returns a that represents this instance.

A that represents this instance. This method should be used primarily for debugging purposes and should be considered volatile (format of its return value might change in future versions).

Determines whether the is equal to this instance.

The other size to compare with this size instance. if the is equal to this instance; otherwise, .

Determines whether the specified is equal to this instance.

The to compare with this size instance. if the specified is a and is equal to this instance; otherwise, .

Returns a hash code for this instance.

An integer value that specifies a hash value for this instance.

Determines whether and s are equal.

The first size. The second size. if and sizes are equal; otherwise, .

Determines whether and s are not equal.

The first size. The second size. if and sizes are not equal; otherwise, .

Represents a quadrilateral - a polygon with four edges (sides) and four vertices (corners).

Quadrilateral

Initializes a new instance of the structure.

The first point of the quadrilateral. The second point of the quadrilateral. The third point of the quadrilateral. The fourth point of the quadrilateral.

Initializes a new instance of the structure from the sides of the quadrilateral.

The x-axis value of the left side of the quadrilateral that specifies the -coordinate value of the and of the quadrilateral. The y-axis value of the bottom of the quadrilateral that specifies the -coordinate value of the and of the quadrilateral. The x-axis value of the right side of the quadrilateral that specifies the -coordinate value of the and of the quadrilateral. The y-axis position of the top of the quadrilateral that specifies the -coordinate value of the and of the quadrilateral. , , or is either , or .

Gets the first point of the quadrilateral.

The first point of the quadrilateral.

Gets the second point of the quadrilateral.

The second point of the quadrilateral.

Gets the third point of the quadrilateral.

The third point of the quadrilateral.

Gets the fourth point of the quadrilateral.

The fourth point of the quadrilateral.

Gets the x-axis value of the left side of the quadrilateral.

The x-axis value of the left side of the quadrilateral.

Gets the y-axis value of the bottom of the quadrilateral.

The y-axis value of the bottom of the quadrilateral.

Gets the x-axis value of the right side of the quadrilateral.

The x-axis value of the right side of the quadrilateral.

Gets the y-axis position of the top of the quadrilateral.

The y-axis position of the top of the quadrilateral.

Returns a that represents this instance.

A that represents this instance. This method should be used primarily for debugging purposes and should be considered volatile (format of its return value might change in future versions).

Determines whether the is equal to this instance.

The other quadrilateral to compare with this quadrilateral instance. if the is equal to this instance; otherwise, .

Determines whether the specified is equal to this instance.

The to compare with this quadrilateral instance. if the specified is a and is equal to this instance; otherwise, .

Returns a hash code for this instance.

An integer value that specifies a hash value for this instance.

Determines whether and s are equal.

The first quadrilateral. The second quadrilateral. if and quadrilaterals are equal; otherwise, .

Determines whether and s are not equal.

The first quadrilateral. The second quadrilateral. if and quadrilaterals are not equal; otherwise, .

Represents a 3x3 affine transformation matrix used for transformations in PDF 2-D space.

Gets an identity .

An identity matrix.

Initializes a new instance of the structure.

The value of the first row and first column of the new structure. The value of the first row and second column of the new structure. The value of the second row and first column of the new structure. The value of the second row and second column of the new structure. The value of the third row and first column of the new structure. The value of the third row and second column of the new structure.

Gets the value of the first row and first column of this structure. The default value is 1.

The value of the first row and first column of this .

Gets the value of the first row and second column of this structure. The default value is 0.

The value of the first row and second column of this .

Gets the value of the second row and first column of this structure. The default value is 1.

The value of the second row and first column of this .

Gets the value of the second row and second column of this structure. The default value is 1.

The value of the second row and second column of this .

Gets the value of the third row and first column of this structure. The default value is 0.

The value of the third row and first column of this .

Gets the value of the third row and second column of this structure. The default value is 0.

The value of the third row and second column of this .

Gets a value that indicates whether this structure is an identity matrix.

if the structure is an identity matrix; otherwise, . The default is .

Prepends a translation of the specified offsets to this structure.

The amount to offset this along the x-axis. The amount to offset this along the y-axis.

Prepends a rotation of the specified angle at the specified point to this structure.

The rotation angle, in degrees, of counter clockwise rotation. The x-coordinate of the rotation center. The y-coordinate of the rotation center.

Prepends the specified scale about the specified point of this .

The x-axis scale factor. The y-axis scale factor. The x-coordinate of the point about which the scale operation is performed. The y-coordinate of the point about which the scale operation is performed.

Creates a translation with the specified offsets.

The amount to offset along the x-axis. The amount to offset along the y-axis. A translation with the specified offsets.

Transforms the specified by this .

The point to transform. The transformed .

Transforms the specified by this .

The quadrilateral to transform. This method passes instance by-reference because it is transformed in-place to avoid excessive by-value copying.

Inverts this structure.

if this structure was inverted; otherwise, if this structure is not invertible.

Returns a that represents this instance.

A that represents this instance. This method should be used primarily for debugging purposes and should be considered volatile (format of its return value might change in future versions).

Determines whether the is equal to this instance.

The other matrix to compare with this matrix instance. if the is equal to this instance; otherwise, .

Determines whether the specified is equal to this instance.

The to compare with this matrix instance. if the specified is a and is equal to this instance; otherwise, .

Returns a hash code for this instance.

An integer value that specifies a hash value for this instance.

Premultiplies the representing the additional transformation with the representing the existing transformation, thus producing the representing the combined transformation.

The additional transformation. The existing transformation. The combined transformation composed of the and the .

Premultiplies the representing the additional transformation with the representing the existing transformation, thus producing the representing the combined transformation.

The additional transformation. The existing transformation. The combined transformation composed of the and the .

Determines whether and s are equal.

The first matrix. The second matrix. if and matrices are equal; otherwise, .

Determines whether and s are not equal.

The first matrix. The second matrix. if and matrices are not equal; otherwise, .

Represents a geometrical PDF content composed of lines and curves.

Shapes (Paths) example PDF Specification ISO 32000-1:2008, section '8.5 Path Construction and Painting'

Gets the subpaths that this is made up of.

The subpaths that this is made up of.

Gets the value.

The value.

Gets the upright bounds of the .

The upright bounds of the . This member, although exposed as a property for easier debugging, performs complex calculations, so instead of accessing it frequently, cache its result instead.

Begin a new subpath.

The where the begins. A reference to this instance after the operation has completed. PDF Specification ISO 32000-1:2008, section '8.5.2 Path Construction Operators'

Begin a new subpath.

Begin a new, optionally closed, subpath.

The where the begins. A value that specifies whether the 's first and last s are connected. A reference to this instance after the operation has completed. PDF Specification ISO 32000-1:2008, section '8.5.2 Path Construction Operators'

Begin a new, optionally closed, subpath.

The X-coordinate value of where the begins. The Y-coordinate value of where the begins. A value that specifies whether the 's first and last s are connected. A reference to this instance after the operation has completed. or is either , or . PDF Specification ISO 32000-1:2008, section '8.5.2 Path Construction Operators'

Adds a straight line to the end of the of the last in the .

Adds a cubic Bézier curve to the end of the of the last in the .

Adds a elliptic arc to the end of the of the last in the . PDF doesn't natively support elliptic arcs so the arc is approximated with one to four Bézier curves.

Closes the last in the .

A reference to this instance after the operation has completed. The doesn't contain any . Use method before using the current method. PDF Specification ISO 32000-1:2008, section '8.5.2 Path Construction Operators'

Adds a rectangle (a closed ) to the end of the .

The where the rectangle (a closed ) begins. The size of the rectangle (a closed ). A reference to this instance after the operation has completed. PDF Specification ISO 32000-1:2008, section '8.5.2 Path Construction Operators'

Adds a rectangle (a closed ) to the end of the .

The X-coordinate value of where the rectangle (a closed ) begins. The Y-coordinate value of where the rectangle (a closed ) begins. The width of the rectangle (a closed ). The height of the rectangle (a closed ). A reference to this instance after the operation has completed. , , , or is either , or . or is less than zero. PDF Specification ISO 32000-1:2008, section '8.5.2 Path Construction Operators'

Adds an ellipse (a closed ) to the end of the . PDF doesn't natively support elliptic arcs so the ellipse is approximated with four Bézier curves.

The location of the center of the ellipse. The horizontal radius of the ellipse. A reference to this instance after the operation has completed. PDF Specification ISO 32000-1:2008, section '8.5.2 Path Construction Operators' PDF Specification ISO 32000-1:2008, section '8.5.2.2 Cubic Bézier Curves'

Adds an ellipse (a closed ) to the end of the . PDF doesn't natively support elliptic arcs so the ellipse is approximated with four Bézier curves.

The X-coordinate value of the center of the ellipse. The Y-coordinate value of the center of the ellipse. The horizontal radius of the ellipse. The vertical radius of the ellipse. A reference to this instance after the operation has completed. , , , or is either , or . or is less than zero. PDF Specification ISO 32000-1:2008, section '8.5.2 Path Construction Operators' PDF Specification ISO 32000-1:2008, section '8.5.2.2 Cubic Bézier Curves'

Represents a subsection of a path comprising a sequence of connected segments.

Shapes (Paths) example PDF Specification ISO 32000-1:2008, section '8.5 Path Construction and Painting'

Gets the line segments that this is made up of.

The line segments that this is made up of.

Gets or sets the where the begins.

The where the begins.

Gets or sets a value that specifies whether this 's first and last s are connected.

if this 's first and last s are connected; otherwise, .

Creates a new that is a copy of the current .

A new that is a copy of this .

Represents a collection of s.

Shapes (Paths) example PDF Specification ISO 32000-1:2008, section '8.5 Path Construction and Painting'

Gets the number of s contained in the .

The number of s contained in the .

Gets or sets the at the specified index.

The at the specified index. The zero-based index of the to get or set. The at the specified index. is less than 0 or is equal to or greater than . is . is already contained in some . Use to create a copy that is not contained in any .

Adds a to the end of the .

The to be added to the end of the . is . is already contained in some . Use to create a copy that is not contained in any .

Inserts a into the at the specified index.

The zero-based index at which should be inserted. The to insert. is less than 0 or is greater than . is . is already contained in some . Use to create a copy that is not contained in any .

Removes the at the specified index of the .

The zero-based index of the to remove. is less than 0 or is equal to or greater than .

Removes a specific from the .

The to remove from the . if is successfully removed; otherwise, . This method also returns if was not found in the .

Removes all s from the .

Determines whether a is in the .

The to locate in the . if is found in the ; otherwise, .

Searches for the specified and returns the zero-based index of the first occurrence within the entire .

The to locate in the . The zero-based index of the first occurrence of within the entire , if found; otherwise, –1.

Copies the entire to a compatible one-dimensional array, starting at the specified index of the target array.

The one-dimensional that is the destination of the s copied from . The must have zero-based indexing. The zero-based index in at which copying begins. is . is less than 0 or greater than 's . The number of s in the source is greater than the available space from to the end of the destination .

Returns an enumerator that iterates through the .

An for the .

Transforms the , , , and of all s and s contained in the .

The transform to apply to all the points in the .

Represents a segment of a .

Shapes (Paths) example PDF Specification ISO 32000-1:2008, section '8.5 Path Construction and Painting'

Gets the end point of the line segment.

The end point of the line segment.

Initializes a new instance of the straight line segment.

The end point of the straight line segment.

Initializes a new instance of the curved line segment (cubic Bézier curve).

The first control point of the curved line segment. The second control point of the curved line segment. The end point of the curved line segment. PDF Specification ISO 32000-1:2008, section '8.5.2.2 Cubic Bézier Curves'

Gets the first control point of the curved line segment (cubic Bézier curve).

The first control point of the curved line segment.

Gets the second control point of the curved line segment (cubic Bézier curve).

The second control point of the curved line segment.

Gets a value indicating whether this is a straight line segment.

if this is a straight line segment; otherwise, .

Gets a value indicating whether this is a curved line segment (cubic Bézier curve).

if this is a curved line segment; otherwise, . PDF Specification ISO 32000-1:2008, section '8.5.2.2 Cubic Bézier Curves'

Returns a that represents this instance.

A that represents this instance. This method should be used primarily for debugging purposes and should be considered volatile (format of its return value might change in future versions).

Determines whether the is equal to this instance.

The other line segment to compare with this line segment instance. if the is equal to this instance; otherwise, .

Determines whether the specified is equal to this instance.

The to compare with this line segment instance. if the specified is a and is equal to this instance; otherwise, .

Returns a hash code for this instance.

An integer value that specifies a hash value for this instance.

Determines whether and s are equal.

The first line segment. The second line segment. if and line segments are equal; otherwise, .

Determines whether and s are not equal.

The first line segment. The second line segment. if and line segments are not equal; otherwise, .

Represents a group of PDF content elements that are independent from the rest of the surrounding elements.

Content Streams and Resources Content Groups example Reading example PDF Specification ISO 32000-1:2008, section '8.4.2 Graphics State Stack'

Gets the value.

The value.

Gets the upright bounds of the .

The upright bounds of the . This member, although exposed as a property for easier debugging, performs complex calculations, so instead of accessing it frequently, cache its result instead.

Gets the content elements such as text, paths and external objects (images and forms) contained directly in this group.

The content elements such as text, paths and external objects (images and forms) contained directly in this group.

Gets the snapshot of text contained in this using the text options.

The snapshot of text contained in this extracted using the text options. The is a snapshot and if the underlying PDF content is changed, that change won't be visible in the , instead should be retrieved again to get the actual snapshot.

Gets the snapshot of text contained in this using the specified text options.

The options used for extracting text from this . The snapshot of text contained in this extracted using the specified text options. is . The is a snapshot and if the underlying PDF content is changed, that change won't be visible in the , instead should be retrieved again to get the actual snapshot.

Draws formatted text at the specified location.

The formatted text to be drawn. The location of the bottom-left corner of the . is . The following example shows how you can write rich text to a specific point on a page.


using var formattedText = new PdfFormattedText();
// All text appended next uses the specified font family and size.
formattedText.FontFamily = new PdfFontFamily("Times New Roman");
formattedText.FontSize = 24;
formattedText.AppendLine("Hello World");

// Draw the text to the page, with its top-left corner at 100 points
// from the left and top edge of the page.
var origin = new PdfPoint(100, page.CropBox.Top - 100 - formattedText.Height);
page.Content.DrawText(formattedText, origin);

Writing example

Draws formatted text with the specified transformation.

The formatted text to be drawn. The transformation from the new (transformed) coordinate system to the original (untransformed) coordinate system. is . The following example shows how you can draw rich text with a transformation applied to it.


using var formattedText = new PdfFormattedText();
formattedText.FontSize = 16;
formattedText.Append("Hello World");

// Draw the text rotated 45 degrees counterclockwise, positioned
// 100 points from the left and top edge of the page.
var transform = PdfMatrix.Identity;
transform.Translate(100, page.CropBox.Top - 100);
transform.Rotate(45);
page.Content.DrawText(formattedText, transform);

Text transformations example

Draws formatted text line at the specified location.

The formatted text line to be drawn. The location of the bottom-left corner of the . is . The following example shows how you can format and draw individual lines of rich text, giving you full control over the placement of each line.


using var formattedText = new PdfFormattedText();
formattedText.FontSize = 12;
formattedText.Append("GemBox.Pdf is a .NET library for PDF files.");

// Format the first line to fit within 200 points and draw it.
var line = formattedText.FormatLine(0, 200);
var origin = new PdfPoint(100, page.CropBox.Top - 100 - line.Height);
page.Content.DrawText(line, origin);

Draws image at the specified location.

The image to be drawn. The location of the bottom-left corner of the . is . Import Images example

Draws image at the specified location and of the specified size.

The image to be drawn. The location of the bottom-left corner of the . The size of the . is . Import Images example

Draws image with the specified transformation.

The image to be drawn. The transformation from the new (transformed) coordinate system to the original (untransformed) coordinate system. is . Image transformations example

Draws the annotation.

The annotation to be drawn. is .

Draws the annotation with the specified transformation.

The annotation to be drawn. The transformation from the new (transformed) coordinate system to the original (untransformed) coordinate system. is .

Returns a Unicode text contained in this .

A Unicode text contained in this . Content Streams and Resources Reading example

Represents a color of a PDF content.

Colors example

Creates a new structure in color space by using the specified value.

The gray value in range from 0 to 1. A new structure in color space created by using the specified value. is either , or .

Creates a new structure in color space by using the specified , and values.

The red value in range from 0 to 1. The green value in range from 0 to 1. The blue value in range from 0 to 1. A new structure in color space created by using the specified , and values. , , or is either , or .

Creates a new structure in color space by using the specified , , and values.

The cyan value in range from 0 to 1. The magenta value in range from 0 to 1. The yellow value in range from 0 to 1. The black value in range from 0 to 1. A new structure in color space created by using the specified , , and values. , , , or is either , or .

Creates a new structure in color space by using the specified colored tiling .

The pattern. A new structure in color space created by using the specified colored tiling . is . is uncolored.

Creates a new structure in color space by using the specified uncolored tiling and colorant values.

The color space. The pattern. The colorant values. A new structure in color space created by using the specified uncolored tiling and colorant values. or or is . 's is not or is colored or invalid number of specified or any element of the array is either , or .

Creates a new structure in color space by using the specified uncolored tiling and .

The pattern. The color. A new structure in color space created by using the specified uncolored tiling and color. is . 's is or is colored.

Initializes a new instance of the structure using the specified color space and a single colorant value.

The color space whose whose is not and is 1. The single colorant value. is . 's is or 's is not 1 or is either , or .

Initializes a new instance of the structure using the specified color space and three colorant values.

The color space whose whose is not and is 3. The first colorant value. The second colorant value. The third colorant value. is . 's is or 's is not 3 or , , or is either , or .

Initializes a new instance of the structure using the specified color space and four colorant values.

The color space whose whose is not and is 4. The first colorant value. The second colorant value. The third colorant value. The fourth colorant value. is . 's is or 's is not 4 or , , , or is either , or .

Initializes a new instance of the structure using the specified color space and colorant values.

The color space whose whose is not and is equal to the number of . The colorant values. or is . 's is or 's is not equal to the number of or or any element of the array is either , or .

Gets the color space in which the current color is defined.

The color space in which the current color is defined. Colors example

Gets the intensity of the colorant at the specified index.

The intensity of the colorant at the specified index. The zero-based index of the colorant. The intensity of the colorant at the specified index. is less than zero or greater than or equal to ..

Gets the pattern or .

The pattern or . Patterns example

Gets the , and values of this .

The red value in range from 0 to 1 or . The green value in range from 0 to 1 or . The blue value in range from 0 to 1 or . if the color can be represented with red, green and blue values; otherwise, .

Returns a that represents this instance using the specified format and format provider.

Returns a that represents this instance.

A that represents this instance. This method should be used primarily for debugging purposes and should be considered volatile (format of its return value might change in future versions).

Determines whether the is equal to this instance.

The other color to compare with this color instance. if the is equal to this instance; otherwise, .

Determines whether the specified is equal to this instance.

The to compare with this color instance. if the specified is a and is equal to this instance; otherwise, .

Returns a hash code for this instance.

An integer value that specifies a hash value for this instance.

Determines whether and s are equal.

The first color. The second color. if and colors are equal; otherwise, .

Determines whether and s are not equal.

The first color. The second color. if and colors are not equal; otherwise, .

The line dash pattern controls the pattern of dashes and gaps used to stroke paths.

PDF Specification ISO 32000-1:2008, section '8.4.3.6 Line Dash Pattern'

Gets the numbers that specify the lengths of alternating dashes and gaps expressed in user space units; the numbers shall be nonnegative and not all zero.

The numbers that specify the lengths of alternating dashes and gaps expressed in user space units.

Gets the distance into the dash pattern at which to start the dash expressed in user space units.

The distance into the dash pattern at which to start the dash expressed in user space units.

Initializes a new instance of the structure.

The distance into the dash pattern at which to start the dash expressed in user space units. The numbers that specify the lengths of alternating dashes and gaps expressed in user space units; the numbers shall be nonnegative and not all zero. Line dash pattern's is negative or not zero if no dashes/gaps are specified. Line dash pattern's dash/gap is negative or dashes/gaps are all zero or or any element of is either , or .

Returns a that represents this instance.

A that represents this instance. This method should be used primarily for debugging purposes and should be considered volatile (format of its return value might change in future versions).

Determines whether the is equal to this instance.

The other line dash pattern to compare with this line dash pattern instance. if the is equal to this instance; otherwise, .

Determines whether the specified is equal to this instance.

The to compare with this line dash pattern instance. if the specified is a and is equal to this instance; otherwise, .

Returns a hash code for this instance.

An integer value that specifies a hash value for this instance.

Determines whether and s are equal.

The first line dash pattern. The second line dash pattern. if and line dash patterns are equal; otherwise, .

Determines whether and s are not equal.

The first line dash pattern. The second line dash pattern. if and line dash patterns are not equal; otherwise, .

Represents a text decoration, which is a visual ornamentation that is added to text (such as an underline).

Gets the text decoration style.

The text decoration style.

Gets a value indicating whether there shall be no text decoration across any space character (breaking or non-breaking).

if there shall be no text decoration across any space character (breaking or non-breaking); otherwise, .

Gets the text decoration thickness relative to the font's recommended thickness.

The text decoration thickness relative to the font's recommended thickness.

Gets the text decoration color.

The text decoration color. If the is , the text decoration color matches the text color to which it is applied. The doesn't affect the underline span calculation.

Gets the text decoration opacity.

The text decoration opacity. If the is , the text decoration opacity matches the text opacity to which it is applied. The doesn't affect the underline span calculation.

Gets the text decoration dash pattern.

The text decoration dash pattern. PDF Specification ISO 32000-1:2008, section '8.4.3.6 Line Dash Pattern'

Initializes a new instance of the class.

The text decoration style. if there shall be no text decoration across any space character (breaking or non-breaking); otherwise, . The text decoration thickness relative to the font's recommended thickness. The text decoration color. If the is , the text decoration color matches the text color to which it is applied. The text decoration opacity. If the is , the text decoration opacity matches the text opacity to which it is applied. The text decoration dash pattern. The default value is equal to the . is not greater than zero or is not and is not between 0 and 1 inclusive. The is not and its is not device color space (, , or ).

Returns a that represents this instance.

A that represents this instance. This method should be used primarily for debugging purposes and should be considered volatile (format of its return value might change in future versions).

Represents a property list associated with a . Use on the to get the underlying that contains the actual properties.

Marked Content example PDF Specification ISO 32000-1:2008, section '14.6 Marked Content'

Gets or creates a from the specified that represents a property list as specified in PDF Specification ISO 32000-1:2008, section '14.6.2 Property Lists'.

A that represents a property list as specified in PDF Specification ISO 32000-1:2008, section '14.6.2 Property Lists'. An instance of a . is . If was already created from the same , that instance is returned. This method provides a way to create various which are currently not available in GemBox.Pdf.

Represents the role or significance of the marked-content element. All tags shall be registered with Adobe Systems (see Annex E) to avoid conflicts between different applications marking the same content stream.

Marked Content example PDF Specification ISO 32000-1:2008, section '14.6 Marked Content'

Initializes a new instance of the structure from the specified value.

The value. Value of enumeration is not supported in the requested operation.

Initializes a new instance of the structure from the specified value.

The value. is .

Gets the role of the marked-content tag as specified in the various parts of PDF Specification ISO 32000-1:2008 or if the role is unknown.

The role of the marked-content tag as specified in the various parts of PDF Specification ISO 32000-1:2008 or if the role is unknown.

Returns a that represents this instance.

A that represents this instance.

Determines whether the is equal to this instance.

The other marked content tag to compare with this marked content tag instance. if the is equal to this instance; otherwise, .

Determines whether the specified is equal to this instance.

The to compare with this marked content tag instance. if the specified is a and is equal to this instance; otherwise, .

Returns a hash code for this instance.

An integer value that specifies a hash value for this instance.

Determines whether and s are equal.

The first marked content tag. The second marked content tag. if and marked content tags are equal; otherwise, .

Determines whether and s are not equal.

The first marked content tag. The second marked content tag. if and marked content tags are not equal; otherwise, .

Represents the role of the marked-content tag as specified in the various parts of PDF Specification ISO 32000-1:2008.

Marked Content example PDF Specification ISO 32000-1:2008, section '14.6 Marked Content'

Role is unknown.

Sections of content in a content stream (including a page's stream, a form's stream or pattern's stream, glyph descriptions a Type 3 font as specified by its CharProcs entry, or an annotation's appearance) may be made optional by enclosing them between the marked-content operators BDC and EMC (see 14.6, "Marked Content") with a marked-content tag of .

PDF Specification ISO 32000-1:2008, section '8.11.3.2 Optional Content in Content Streams'

An artifact shall be explicitly distinguished from real content by enclosing it in a marked-content sequence with the tag .

PDF Specification ISO 32000-1:2008, section '14.8.2.2.2 Specification of Artifacts'

In some situations, conforming writer may be unable to determine correct page content order for part of a document's contents. In such cases, tag suspects (PDF 1.6) can be used. The conforming writer shall identify suspect content by using marked content (see 14.6, "Marked Content") with a tag of . The marked content shall have a properties dictionary with an entry whose name is and whose value is Ordering, which indicates that the ordering of the enclosed marked content does not meet Tagged PDF specifications. This can occur, for example, if content was extracted from another application, or if there are ambiguities or missing information in text output.

PDF Specification ISO 32000-1:2008, section '14.8.2.3 Page Content Order'

The marked-content tag informs the conforming reader that show strings within a marked-content sequence contain characters in the reverse of page content order. If the sequence encompasses multiple show strings, only the individual characters within each string shall be reversed; the strings themselves shall be in natural reading order.

PDF Specification ISO 32000-1:2008, section '14.8.2.3.3 Reverse-Order Show Strings'

Marked-content sequences having the tag are also used to carry certain accessibility properties (Alt, ActualText, Lang, and E; see 14.9, "Accessibility Support"). Such sequences lack an MCID property and are not associated with any structure element. This use of the marked-content tag is distinct from its use as a structure type.

PDF Specification ISO 32000-1:2008, section '14.8.4.4 Inline-Level Structure Elements' PDF Specification ISO 32000-1:2008, section '14.8.5 Standard Structure Attributes' PDF Specification ISO 32000-1:2008, section '14.9.2 Natural Language Specification' PDF Specification ISO 32000-1:2008, section '14.9.3 Alternate Descriptions' PDF Specification ISO 32000-1:2008, section '14.9.4 Replacement Text' PDF Specification ISO 32000-1:2008, section '14.9.5 Expansion of Abbreviations and Acronyms'

In Tagged PDF, all marked clipping sequences shall carry the marked-content tag .

PDF Specification ISO 32000-1:2008, section '14.8.4.5 Illustration Elements'

One or more files may be associated with sections of content in a content stream by enclosing those sections between the marked content operators BDC and EMC (see 14.6, "Marked Content") with a marked content tag of .

Represents types of the s.

Marked Content example PDF Specification ISO 32000-1:2008, section '14.6 Marked Content'

The mark represents the start of the marked-content sequence.

The mark represents the end of the marked-content sequence.

The mark represents single marked-content point.

Patterns come in two varieties: Tiling patterns consist of a small graphical figure (called a pattern cell) that is replicated at fixed horizontal and vertical intervals to fill the area to be painted. The graphics objects to use for tiling shall be described by a content stream. Shading patterns define a gradient fill that produces a smooth transition between colors across the area. The color to use shall be specified as a function of position using any of a variety of methods.

Patterns example PDF Specification ISO 32000-1:2008, section '8.7 Patterns'

(Required) A code identifying the type of pattern that this describes.

A code identifying the type of pattern that this describes. PDF Specification ISO 32000-1:2008, section '8.7 Patterns'

Gets a value indicating whether the is colored.

if the is colored; otherwise, .

(Optional) An array of six numbers specifying the pattern matrix (see 8.7.2, "General Properties of Patterns"). Default value: the identity matrix [1 0 0 1 0 0].

An array of six numbers specifying the pattern matrix. PDF Specification ISO 32000-1:2008, section '8.7 Patterns'

Represents types of the s.

The is a . Tiling patterns consist of a small graphical figure (called a pattern cell) that is replicated at fixed horizontal and vertical intervals to fill the area to be painted. The graphics objects to use for tiling shall be described by a content stream.

The is a . Shading patterns define a gradient fill that produces a smooth transition between colors across the area. The color to use shall be specified as a function of position using any of a variety of methods.

Shading patterns (PDF 1.3) provide a smooth transition between colors across an area to be painted, independent of the resolution of any particular output device and without specifying the number of steps in the color transition.

Shadings example PDF Specification ISO 32000-1:2008, section '8.7.4 Shading Patterns'

Initializes a new instance of the class.

The associated with the . The shading. or is . If is associated with another , this constructor will automatically clone it and associate the clone with the current .

(Required) A shading object defining the shading pattern's gradient fill.

A shading object defining the shading pattern's gradient fill. Value is . If value that is being set is associated with another , this property setter will automatically clone it and associate the clone with the current . PDF Specification ISO 32000-1:2008, section '8.7.4 Shading Patterns'

A tiling pattern consists of a small graphical figure called a pattern cell. Painting with the pattern replicates the cell at fixed horizontal and vertical intervals to fill an area. The effect is as if the figure were painted on the surface of a clear glass tile, identical copies of which were then laid down in an array covering the area and trimmed to its boundaries. This process is called tiling the area.

Patterns example PDF Specification ISO 32000-1:2008, section '8.7.3 Tiling Patterns'

Initializes a new instance of the class.

The associated with the . The size of the cell. is . 's or is zero.

Initializes a new instance of the class.

The associated with the . Determines how the color of the pattern cell shall be specified: for Colored tiling pattern or for Uncolored tiling pattern. A code that controls adjustments to the spacing of tiles relative to the device pixel grid. The bounding box of the cell whose coordinates are in the pattern coordinate system. This bounding box shall be used to clip the pattern cell. The desired horizontal spacing between pattern cells, measured in the pattern coordinate system. may differ from the width of the pattern cell implied by the . This allows tiling with irregularly shaped figures. may be either positive or negative but shall not be zero. The desired vertical spacing between pattern cells, measured in the pattern coordinate system. may differ from the height of the pattern cell implied by the . This allows tiling with irregularly shaped figures. may be either positive or negative but shall not be zero. or is . or is either zero, , or .

Gets the content of this tiling pattern.

The content of this tiling pattern. Content Streams and Resources Content Streams and Resources example PDF Specification ISO 32000-1:2008, section '8.7.3 Tiling Patterns'

(Required) A value that determines how the color of the pattern cell shall be specified: for Colored tiling pattern. The pattern's content stream shall specify the colors used to paint the pattern cell. When the content stream begins execution, the current color is the one that was initially in effect in the pattern’s parent content stream. This is similar to the definition of the pattern matrix; see 8.7.2, "General Properties of Patterns". for Uncolored tiling pattern. The pattern's content stream shall not specify any color information. Instead, the entire pattern cell is painted with a separately specified color each time the pattern is used. Essentially, the content stream describes a stencil through which the current color shall be poured. The content stream shall not invoke operators that specify colors or other color-related parameters in the graphics state; otherwise, an error occurs (see 8.6.8, "Color Operators"). The content stream may paint an image mask, however, since it does not specify any color information (see 8.9.6.2, "Stencil Masking").

A value that determines how the color of the pattern cell shall be specified. PDF Specification ISO 32000-1:2008, section '8.7.3 Tiling Patterns'

(Required) An array of four numbers in the pattern coordinate system giving the coordinates of the left, bottom, right, and top edges, respectively, of the pattern cell's bounding box. These boundaries shall be used to clip the pattern cell.

An array of four numbers in the pattern coordinate system giving the coordinates of the left, bottom, right, and top edges, respectively, of the pattern cell's bounding box. PDF Specification ISO 32000-1:2008, section '8.7.3 Tiling Patterns'

Sets the .

The left X coordinate of the . The bottom Y coordinate of the . The right X coordinate of the . The top Y coordinate of the .

(Required) The desired horizontal spacing between pattern cells, measured in the pattern coordinate system. and may differ from the dimensions of the pattern cell implied by the entry. This allows tiling with irregularly shaped figures. and may be either positive or negative but shall not be zero.

The desired horizontal spacing between pattern cells, measured in the pattern coordinate system. Value is either zero, , or . PDF Specification ISO 32000-1:2008, section '8.7.3 Tiling Patterns'

(Required) The desired vertical spacing between pattern cells, measured in the pattern coordinate system. and may differ from the dimensions of the pattern cell implied by the entry. This allows tiling with irregularly shaped figures. and may be either positive or negative but shall not be zero.

The desired vertical spacing between pattern cells, measured in the pattern coordinate system. Value is either zero, , or . PDF Specification ISO 32000-1:2008, section '8.7.3 Tiling Patterns'

Type 2 (axial) shadings define a color blend that varies along a linear axis between two endpoints and extends indefinitely perpendicular to that axis. The shading may optionally be extended beyond either or both endpoints by continuing the boundary colors indefinitely.

PDF Specification ISO 32000-1:2008, section '8.7.4.5.3 Type 2 (Axial) Shadings'

Initializes a new instance of the class that has the specified , and, optionally, . The property should be set subsequently.

Initializes a new instance of the class that has the specified , and shading colors. Two are converted to a and more than two are converted to a (stitching two or more s) that is then set to the . The is set from the of the first and the last .

The starting coordinates of the axis, expressed in the shading's target coordinate space. The ending coordinates of the axis, expressed in the shading's target coordinate space. The s to set on this shading. is . count is less than 2 or space of any is not equal to the or of any is not greater than the of all previous s. Interpolation via the entry is invalid in an color space, which is quantized and therefore inappropriate for calculations that assume a continuous range of colors.

Initializes a new instance of the class that has the specified , and two shading colors. Colors and are converted to a that is then set to the .

The starting coordinates of the axis, expressed in the shading's target coordinate space. The ending coordinates of the axis, expressed in the shading's target coordinate space. The shading color at the starting coordinates of the axis. The shading color at the ending coordinates of the axis. Color of and are not equal. Interpolation via the entry is invalid in an color space, which is quantized and therefore inappropriate for calculations that assume a continuous range of colors.

Gets the value.

The value.

(Required) The starting coordinates of the axis, expressed in the shading's target coordinate space.

The starting coordinates of the axis, expressed in the shading's target coordinate space. PDF Specification ISO 32000-1:2008, section '8.7.4.5.3 Type 2 (Axial) Shadings'

(Required) The ending coordinates of the axis, expressed in the shading's target coordinate space.

The ending coordinates of the axis, expressed in the shading's target coordinate space. PDF Specification ISO 32000-1:2008, section '8.7.4.5.3 Type 2 (Axial) Shadings'

(Optional) A specifying the limiting values of a parametric variable t. The variable is considered to vary linearly between these two values as the color gradient varies between the starting and ending points of the axis. The variable t becomes the input argument to the color function(s). Default value: [0, 1].

A specifying the limiting values of a parametric variable t. PDF Specification ISO 32000-1:2008, section '8.7.4.5.3 Type 2 (Axial) Shadings'

(Required) A 1-in, n-out function or an array of n 1-in, 1-out functions (where n is the number of color components in the shading dictionary's color space). The function(s) shall be called with values of the parametric variable t in the domain defined by the entry. Each function's domain shall be a superset of that of the shading dictionary. If the value returned by the function for a given color component is out of range, it shall be adjusted to the nearest valid value. Use the method to create an interpolation function from two or more s.

A 1-in, n-out function or an array of n 1-in, 1-out functions. Value is or empty or any of its elements is . The number of functions is not 1 and is not equal to the . or the function's input dimensionality is invalid (the 's should be 1) or the function's output dimensionality is invalid (if the number of functions is 1, then it should be equal to the .; otherwise, it should be 1) for any function contained in the list. Interpolation via the entry is invalid in an color space, which is quantized and therefore inappropriate for calculations that assume a continuous range of colors. PDF Specification ISO 32000-1:2008, section '8.7.4.5.3 Type 2 (Axial) Shadings'

(Optional) A boolean value specifying whether to extend the shading beyond the starting point of the axis. Default value: .

A boolean value specifying whether to extend the shading beyond the starting point of the axis. PDF Specification ISO 32000-1:2008, section '8.7.4.5.3 Type 2 (Axial) Shadings'

(Optional) A boolean value specifying whether to extend the shading beyond the ending point of the axis. Default value: .

A boolean value specifying whether to extend the shading beyond the ending point of the axis. PDF Specification ISO 32000-1:2008, section '8.7.4.5.3 Type 2 (Axial) Shadings'

Type 6 shadings (Coons patch meshes) are constructed from one or more color patches, each bounded by four cubic Bézier curves.

PDF Specification ISO 32000-1:2008, section '8.7.4.5.7 Type 6 Shadings (Coons Patch Meshes)'

Initializes a new instance of the class with an optional . The overload must be used to populate a mesh with a new patch, unconnected to any other. Subsequent, connected, patches can be added with the overload. If the parameter is omitted or is , then the constructor should be used for creating vertices; otherwise, the constructor should be used. You can use the method to create an interpolation function from two or more s. The method must be used after the mesh is populated to resolve the values of the , , , and entries and to serialize the mesh data to the underlying stream.

The optional value of the entry. The color space in which color values shall be expressed. If omitted, the is used.

Initializes a new instance of the class that has the specified mesh data serialization settings and, optionally, . The overload must be used to populate a mesh with a new patch, unconnected to any other. Subsequent, connected, patches can be added with the overload. If the parameter is omitted or is , then the constructor should be used for creating vertices; otherwise, the constructor should be used. You can use the method to create an interpolation function from two or more s. The entry is set based on the , , and ranges of valid color component values specified by the 's domain or . The for color components can be subsequently updated (it starts with a at index 2 in the entry).

The number of bits used to represent each geometric coordinate. The value shall be 1, 2, 4, 8, 12, 16, 24, or 32. The number of bits used to represent each color component. The value shall be 1, 2, 4, 8, 12, or 16. The number of bits used to represent the edge flag for each patch. The value of shall be 2, 4, or 8, but only the least significant 2 bits in each flag value shall be used. A specifying how to map horizontal component of patch coordinates into the appropriate range of values. A specifying how to map vertical component of patch coordinates into the appropriate range of values. The optional value of the entry. The color space in which color values shall be expressed. If omitted, the is used. is not 1, 2, 4, 8, 12, 16, 24, or 32. is not 1, 2, 4, 8, 12, or 16. is not 2, 4, or 8.

Gets the value.

The value.

(Required) The number of bits used to represent the edge flag for each patch. The value of shall be 2, 4, or 8, but only the least significant 2 bits in each flag value shall be used. The value for the edge flag shall be 0, 1, 2, or 3.

The number of bits used to represent the edge flag for each patch. Argument must be one of the following values: 2, 4, or 8. PDF Specification ISO 32000-1:2008, section '8.7.4.5.7 Type 6 Shadings (Coons Patch Meshes)'

Populates a mesh with a new patch, unconnected to any other.

The first (corner) vertex of a new patch. The coordinates of the first control point of a cubic Bézier curve that connects and . The coordinates of the second control point of a cubic Bézier curve that connects and . The second (corner) vertex of a new patch. The coordinates of the first control point of a cubic Bézier curve that connects and . The coordinates of the second control point of a cubic Bézier curve that connects and . The third (corner) vertex of a new patch. The coordinates of the second control point of a cubic Bézier curve that connects and . The coordinates of the first control point of a cubic Bézier curve that connects and . The fourth (corner) vertex of a new patch. The coordinates of the second control point of a cubic Bézier curve that connects and . The coordinates of the first control point of a cubic Bézier curve that connects and . The entry is set and the property of , , , or is or the entry is not set and the property of , , , or is . The of the of , , , or is not equal to the shading's .

Populates a mesh with a subsequent, connected, patch. If the is , then the edge between the second () and the third () (corner) vertex of the previous patch is shared with a subsequent, connected, patch as an edge between its first () and second () (corner) vertex. If the is , then the edge between the third () and the fourth () (corner) vertex of the previous patch is shared with a subsequent, connected, patch as an edge between its first () and second () (corner) vertex. If the is , then the edge between the fourth () and the first () (corner) vertex of the previous patch is shared with a subsequent, connected, patch as an edge between its first () and second () (corner) vertex.

The flag specifying the edge of the previous patch that is shared with a subsequent, connected, patch. The coordinates of the first control point of a cubic Bézier curve that connects and . The coordinates of the second control point of a cubic Bézier curve that connects and . The third (corner) vertex of a new patch. The coordinates of the second control point of a cubic Bézier curve that connects and . The coordinates of the first control point of a cubic Bézier curve that connects and . The fourth (corner) vertex of a new patch. The coordinates of the second control point of a cubic Bézier curve that connects and . The coordinates of the first control point of a cubic Bézier curve that connects and . must be , , or . The entry is set and the property of or is or the entry is not set and the property of or is . The of the of or is not equal to the shading's . This overload cannot be used on an empty mesh. Use the before.

Packs the mesh data to the underlying and, optionally, sets or adjusts the mesh data serialization settings (, , , and entries) to the most appropriate values to achieve the best sampled mesh data compaction and resolution, based on the mesh data.

to set or adjust the mesh data serialization settings (, , , and entries) to the most appropriate values to achieve the best sampled mesh data compaction and resolution, based on the mesh data; otherwise, . A reference to this instance after the packing operation has completed. Some of the s in the entry are too narrow to encode the mesh data. Extend the bounds of those s or use the method with a parameter set to .

Returns an enumerator that iterates es contained in this .

A for the . The is empty. Use the overload to add a .

Enumerates the es of a .

Gets the at the current position of the enumerator.

The in the at the current position of the enumerator.

Advances the enumerator to the next of the .

if the enumerator was successfully advanced to the next ; if the enumerator has passed the end of the mesh. The shading mesh data was modified after the enumerator was created. The shading mesh starts with a patch that shares an edge with a previous, non-existing, patch. Shading mesh contains an invalid value. Supported values are: , , , and .

Releases all resources used by the .

Type 4 shadings (free-form Gouraud-shaded triangle meshes) are commonly used to represent complex colored and shaded three-dimensional shapes. The area to be shaded is defined by a path composed entirely of triangles. The color at each vertex of the triangles is specified, and a technique known as Gouraud interpolation is used to color the interiors.

PDF Specification ISO 32000-1:2008, section '8.7.4.5.5 Type 4 Shadings (Free-Form Gouraud-Shaded Triangle Meshes)'

Initializes a new instance of the class with an optional . The overload must be used to populate a mesh with a new triangle, unconnected to any other. Subsequent, connected, triangles can be added with the overload. If the parameter is omitted or is , then the constructor should be used for creating vertices; otherwise, the constructor should be used. You can use the method to create an interpolation function from two or more s. The method must be used after the mesh is populated to resolve the values of the , , , and entries and to serialize the mesh data to the underlying stream.

The optional value of the entry. The color space in which color values shall be expressed. If omitted, the is used.

Initializes a new instance of the class that has the specified mesh data serialization settings and, optionally, . The overload must be used to populate a mesh with a new triangle, unconnected to any other. Subsequent, connected, triangles can be added with the overload. If the parameter is omitted or is , then the constructor should be used for creating vertices; otherwise, the constructor should be used. You can use the method to create an interpolation function from two or more s. The entry is set based on the , , and ranges of valid color component values specified by the 's domain or . The for color components can be subsequently updated (it starts with a at index 2 in the entry).

The number of bits used to represent each vertex coordinate. The value shall be 1, 2, 4, 8, 12, 16, 24, or 32. The number of bits used to represent each color component. The value shall be 1, 2, 4, 8, 12, or 16. The number of bits used to represent the edge flag for each vertex. The value of shall be 2, 4, or 8, but only the least significant 2 bits in each flag value shall be used. A specifying how to map horizontal component of vertex coordinates into the appropriate range of values. A specifying how to map vertical component of vertex coordinates into the appropriate range of values. The optional value of the entry. The color space in which color values shall be expressed. If omitted, the is used. is not 1, 2, 4, 8, 12, 16, 24, or 32. is not 1, 2, 4, 8, 12, or 16. is not 2, 4, or 8.

Gets the value.

The value.

(Required) The number of bits used to represent the edge flag for each vertex. The value of shall be 2, 4, or 8, but only the least significant 2 bits in each flag value shall be used. The value for the edge flag shall be 0, 1, or 2.

The number of bits used to represent the edge flag for each vertex. Argument must be one of the following values: 2, 4, or 8. PDF Specification ISO 32000-1:2008, section '8.7.4.5.5 Type 4 Shadings (Free-Form Gouraud-Shaded Triangle Meshes)'

Populates a mesh with a new triangle, unconnected to any other.

The first vertex of a new triangle. The second vertex of a new triangle. The third vertex of a new triangle. The entry is set and the property of , , or is or the entry is not set and the property of , , or is . The of the of , , or is not equal to the shading's .

Populates a mesh with a subsequent, connected, triangle. If the is , then the edge between the second () and the third () vertex of the previous triangle is shared with a subsequent, connected, triangle as an edge between its first () and second () vertex. If the is , then the edge between the first () and the third () vertex of the previous triangle is shared with a subsequent, connected, triangle as an edge between its first () and second () vertex.

The flag specifying the edge of the previous triangle that is shared with a subsequent, connected, triangle. The third vertex of a subsequent, connected, triangle. The must be or . The entry is set and the property of is or the entry is not set and the property of is . The of the of is not equal to the shading's . This overload cannot be used on an empty mesh. Use the overload before.

Returns an enumerator that iterates s contained in this .

A for the . The is empty. Use the overload to add a .

Enumerates the s of a .

Gets the at the current position of the enumerator.

The in the at the current position of the enumerator.

Advances the enumerator to the next of the .

if the enumerator was successfully advanced to the next ; if the enumerator has passed the end of the mesh. The shading mesh data was modified after the enumerator was created. The shading mesh starts with a triangle that shares an edge with a previous, non-existing, triangle. Shading mesh contains an invalid value. Supported values are: , , and .

Releases all resources used by the .

In Type 1 (function-based) shadings, the color at every point in the domain is defined by a specified mathematical function. The function need not be smooth or continuous. This type is the most general of the available shading types and is useful for shadings that cannot be adequately described with any of the other types.

PDF Specification ISO 32000-1:2008, section '8.7.4.5.2 Type 1 (Function-Based) Shadings'

Initializes a new instance of the class. The and are set from the 's . Use the method afterwards if and do not correspond to the shading's target coordinate space.

A 2-in, n-out function (where n is the number of color components in the shading dictionary's color space). The color space in which color values shall be expressed. If omitted, the is used. is . The 's input dimensionality is invalid (the 's should be 2) or the 's output dimensionality is invalid (should be equal to the .). Interpolation via the entry is invalid in an color space, which is quantized and therefore inappropriate for calculations that assume a continuous range of colors.

Initializes a new instance of the class. The and are set as a subset of the of all s contained in the list. Use the method afterwards if and do not correspond to the shading's target coordinate space.

An array of n 2-in, 1-out functions (where n is the number of color components in the shading dictionary's color space). The color space in which color values shall be expressed. If omitted, the is used. is or empty or any of its elements is . The 's count is not equal to the . or the function's input dimensionality is invalid (the 's should be 2) or the function's output dimensionality is invalid (should be 1) for any contained in the list. Interpolation via the entry is invalid in an color space, which is quantized and therefore inappropriate for calculations that assume a continuous range of colors.

Gets the value.

The value.

A specifying the horizontal component of the rectangular domain of coordinates over which the color function(s) are defined. Default value: [0, 1].

A specifying the horizontal component of the rectangular domain of coordinates over which the color function(s) are defined. PDF Specification ISO 32000-1:2008, section '8.7.4.5.2 Type 1 (Function-Based) Shadings'

A specifying the vertical component of the rectangular domain of coordinates over which the color function(s) are defined. Default value: [0, 1].

A specifying the vertical component of the rectangular domain of coordinates over which the color function(s) are defined. PDF Specification ISO 32000-1:2008, section '8.7.4.5.2 Type 1 (Function-Based) Shadings'

(Optional) An array of six numbers specifying a transformation matrix mapping the coordinate space specified by and entries into the shading's target coordinate space. To map the domain rectangle [{0, 1}, {0, 1}] to a 1-inch square with lower-left corner at coordinates (100, 100) in default user space, the value would be [72 0 0 72 100 100]. Default value: the matrix [1 0 0 1 0 0].

An array of six numbers specifying a transformation matrix mapping the coordinate space specified by and entries into the shading's target coordinate space. PDF Specification ISO 32000-1:2008, section '8.7.4.5.2 Type 1 (Function-Based) Shadings'

Sets the to a a that transforms the rectangle specified by and entries to the rectangle specified by and parameters. This method is useful if the shading's and doesn't correspond to the shading's target coordinate space.

The point in the shading's target coordinate space to which the point (., .) is mapped to. The area in the shading's target coordinate space to which the area [. - ., . - .] is mapped to. A reference to this instance after the setting the has completed.

(Required) A 2-in, n-out function or an array of n 2-in, 1-out functions (where n is the number of color components in the shading dictionary's color space). Each function's domain shall be a superset of that of the shading dictionary. If the value returned by the function for a given color component is out of range, it shall be adjusted to the nearest valid value.

A 2-in, n-out function or an array of n 2-in, 1-out functions. Value is or empty or any of its elements is . The number of functions is not 1 and is not equal to the . or the function's input dimensionality is invalid (the 's should be 2) or the function's output dimensionality is invalid (if the number of functions is 1, then it should be equal to the .; otherwise, it should be 1) for any function contained in the list. Interpolation via the entry is invalid in an color space, which is quantized and therefore inappropriate for calculations that assume a continuous range of colors. PDF Specification ISO 32000-1:2008, section '8.7.4.5.2 Type 1 (Function-Based) Shadings'

Type 5 shadings (lattice-form Gouraud-shaded triangle meshes) are similar to type 4, but instead of using free-form geometry, their vertices are arranged in a pseudorectangular lattice, which is topologically equivalent to a rectangular grid. The vertices are organized into rows, which need not be geometrically linear.

PDF Specification ISO 32000-1:2008, section '8.7.4.5.6 Type 5 Shadings (Lattice-Form Gouraud-Shaded Triangle Meshes)'

Initializes a new instance of the class with the specified number of vertices in each row of the lattice and an optional . The method must be used to populate a mesh with vertices in each row of the lattice. If the parameter is omitted or is , then the constructor should be used for creating vertices; otherwise, the constructor should be used. You can use the method to create an interpolation function from two or more s. The method must be used after the mesh is populated to resolve the values of the , , and entries and to serialize the mesh data to the underlying stream.

Initializes a new instance of the class that has the specified number of vertices in each row of the lattice, mesh data serialization settings and, optionally, . The method must be used to populate a mesh with vertices in each row of the lattice. If the parameter is omitted or is , then the constructor should be used for creating vertices; otherwise, the constructor should be used. You can use the method to create an interpolation function from two or more s. The entry is set based on the , , and ranges of valid color component values specified by the 's domain or . The for color components can be subsequently updated (it starts with a at index 2 in the entry).

The number of vertices in each row of the lattice; the value shall be greater than or equal to 2. The number of rows need not be specified, but the number of added vertices should be such that the lattice contains at least 2 rows (the number of added vertices should be at least 2 * and should be a multiple of ). The number of bits used to represent each vertex coordinate. The value shall be 1, 2, 4, 8, 12, 16, 24, or 32. The number of bits used to represent each color component. The value shall be 1, 2, 4, 8, 12, or 16. A specifying how to map horizontal component of vertex coordinates into the appropriate range of values. A specifying how to map vertical component of vertex coordinates into the appropriate range of values. The optional value of the entry. The color space in which color values shall be expressed. If omitted, the is used. The must greater than or equal to 2. is not 1, 2, 4, 8, 12, 16, 24, or 32. is not 1, 2, 4, 8, 12, or 16.

Gets the value.

The value.

(Required) The number of vertices in each row of the lattice; the value shall be greater than or equal to 2. The number of rows need not be specified, but the number of added vertices should be such that the lattice contains at least 2 rows (the number of added vertices should be at least 2 * and should be a multiple of ).

The number of vertices in each row of the lattice. Value must be greater than or equal to 2. PDF Specification ISO 32000-1:2008, section '8.7.4.5.6 Type 5 Shadings (Lattice-Form Gouraud-Shaded Triangle Meshes)'

Populates a mesh with a vertex. This method should be called number of times for each row of the lattice and the lattice should contain at least 2 rows.

The vertex. The entry is set and the property of is or the entry is not set and the property of is . The of the of is not equal to the shading's .

Packs the mesh data to the underlying and, optionally, sets or adjusts the mesh data serialization settings (, , and entries) to the most appropriate values to achieve the best sampled mesh data compaction and resolution, based on the mesh data.

to set or adjust the mesh data serialization settings (, , and entries) to the most appropriate values to achieve the best sampled mesh data compaction and resolution, based on the mesh data; otherwise, . A reference to this instance after the packing operation has completed. Some of the s in the entry are too narrow to encode the mesh data. Extend the bounds of those s or use the method with a parameter set to .

Returns an enumerator that iterates s contained in this .

A for the . The contains less than two vertices per row. The contains less than two rows of vertices. The contains an insufficient number of vertices to form a complete lattice. Each row of a complete lattice must contain the same number of vertices (at least two) and there must be at least two rows.

Enumerates the s of a .

Gets the at the current position of the enumerator.

The in the at the current position of the enumerator.

Advances the enumerator to the next of the .

if the enumerator was successfully advanced to the next ; if the enumerator has passed the end of the mesh. The shading mesh data was modified after the enumerator was created.

Releases all resources used by the .

Represents a color patch contained in a or bounded by four cubic Bézier curves and with four implicit (in ) or explicit (in ) "internal" control points. does not contain a public constructor. The only way to access instances is by enumerating or .

PDF Specification ISO 32000-1:2008, section '8.7.4.5.7 Type 6 Shadings (Coons Patch Meshes)' PDF Specification ISO 32000-1:2008, section '8.7.4.5.8 Type 7 Shadings (Tensor-Product Patch Meshes)'

Gets the edge of the previous patch that is shared with this .

The edge of the previous patch that is shared with this .

Gets the first (corner) vertex of this .

The first (corner) vertex of this . The entry is set and the property of the value is or the entry is not set and the property of the value is . The of the of the value is not equal to the shading's .

Gets the first control point of a cubic Bézier curve that connects and of this .

The first control point of a cubic Bézier curve that connects and of this .

Gets the second control point of a cubic Bézier curve that connects and of this .

The second control point of a cubic Bézier curve that connects and of this .

Gets the second (corner) vertex of this .

The second (corner) vertex of this . The entry is set and the property of the value is or the entry is not set and the property of the value is . The of the of the value is not equal to the shading's .

Gets the first control point of a cubic Bézier curve that connects and of this .

The first control point of a cubic Bézier curve that connects and of this .

Gets the second control point of a cubic Bézier curve that connects and of this .

The second control point of a cubic Bézier curve that connects and of this .

Gets the third (corner) vertex of this .

The third (corner) vertex of this . The entry is set and the property of the value is or the entry is not set and the property of the value is . The of the of the value is not equal to the shading's .

Gets the second control point of a cubic Bézier curve that connects and of this .

The second control point of a cubic Bézier curve that connects and of this .

Gets the first control point of a cubic Bézier curve that connects and of this .

The first control point of a cubic Bézier curve that connects and of this .

Gets the fourth (corner) vertex of this .

The fourth (corner) vertex of this . The entry is set and the property of the value is or the entry is not set and the property of the value is . The of the of the value is not equal to the shading's .

Gets the second control point of a cubic Bézier curve that connects and of this .

The second control point of a cubic Bézier curve that connects and of this .

Gets the first control point of a cubic Bézier curve that connects and of this .

The first control point of a cubic Bézier curve that connects and of this .

Gets (for ) or calculates (for ) the first interior control point of this .

The first interior control point of this . The interior control point can be set only if a patch is contained in .

Gets (for ) or calculates (for ) the second interior control point of this .

The second interior control point of this . The interior control point can be set only if a patch is contained in .

Gets (for ) or calculates (for ) the third interior control point of this .

The third interior control point of this . The interior control point can be set only if a patch is contained in .

Gets (for ) or calculates (for ) the fourth interior control point of this .

The fourth interior control point of this . The interior control point can be set only if a patch is contained in .

Returns a that represents this instance.

A that represents this instance. This method should be used primarily for debugging purposes and should be considered volatile (format of its return value might change in future versions).

Represents a base class for mesh-based shadings , , , and .

PDF Specification ISO 32000-1:2008, section '8.7.4.5.5 Type 4 Shadings (Free-Form Gouraud-Shaded Triangle Meshes)' PDF Specification ISO 32000-1:2008, section '8.7.4.5.6 Type 5 Shadings (Lattice-Form Gouraud-Shaded Triangle Meshes)' PDF Specification ISO 32000-1:2008, section '8.7.4.5.7 Type 6 Shadings (Coons Patch Meshes)' PDF Specification ISO 32000-1:2008, section '8.7.4.5.8 Type 7 Shadings (Tensor-Product Patch Meshes)'

(Required) The number of bits used to represent each vertex or geometric coordinate. The value shall be 1, 2, 4, 8, 12, 16, 24, or 32.

The number of bits used to represent each vertex or geometric coordinate. Argument must be one of the following values: 1, 2, 4, 8, 12, 16, 24, or 32. PDF Specification ISO 32000-1:2008, section '8.7.4.5.5 Type 4 Shadings (Free-Form Gouraud-Shaded Triangle Meshes)' PDF Specification ISO 32000-1:2008, section '8.7.4.5.6 Type 5 Shadings (Lattice-Form Gouraud-Shaded Triangle Meshes)' PDF Specification ISO 32000-1:2008, section '8.7.4.5.7 Type 6 Shadings (Coons Patch Meshes)'

(Required) The number of bits used to represent each color component. The value shall be 1, 2, 4, 8, 12, or 16.

The number of bits used to represent each color component. Argument must be one of the following values: 1, 2, 4, 8, 12, or 16. PDF Specification ISO 32000-1:2008, section '8.7.4.5.5 Type 4 Shadings (Free-Form Gouraud-Shaded Triangle Meshes)' PDF Specification ISO 32000-1:2008, section '8.7.4.5.6 Type 5 Shadings (Lattice-Form Gouraud-Shaded Triangle Meshes)' PDF Specification ISO 32000-1:2008, section '8.7.4.5.7 Type 6 Shadings (Coons Patch Meshes)'

(Required) A collection of s specifying how to map vertex or geometric coordinates and color components into the appropriate ranges of values. The decoding method is similar to that used in image dictionaries (see 8.9.5.2, "Decode Arrays"). The ranges shall be specified as follows: [(xmin xmax) (ymin ymax) (c1,min c1,max) … (cn,min cn,max)] Only one pair of c values shall be specified if a entry is present.

A collection of s specifying how to map vertex or geometric coordinates and color components into the appropriate ranges of values. Value is . The number of s is invalid. It must be 2 + . if the is or 3 otherwise. PDF Specification ISO 32000-1:2008, section '8.7.4.5.5 Type 4 Shadings (Free-Form Gouraud-Shaded Triangle Meshes)' PDF Specification ISO 32000-1:2008, section '8.7.4.5.6 Type 5 Shadings (Lattice-Form Gouraud-Shaded Triangle Meshes)' PDF Specification ISO 32000-1:2008, section '8.7.4.5.7 Type 6 Shadings (Coons Patch Meshes)'

(Optional) A 1-in, n-out function or an array of n 1-in, 1-out functions (where n is the number of color components in the shading dictionary's color space). If this entry is present, the color data for each vertex shall be specified by a single parametric variable rather than by n separate color components. The designated function(s) shall be called with each interpolated value of the parametric variable to determine the actual color at each point. Each input value shall be forced into the range interval specified for the corresponding color component in the shading dictionary's array. Each function's domain shall be a superset of that interval. If the value returned by the function for a given color component is out of range, it shall be adjusted to the nearest valid value. This entry shall not be used with an color space. Use the method to create an interpolation function from two or more s.

A 1-in, n-out function or an array of n 1-in, 1-out functions. The color components part of the entry is automatically updated to the appropriate ranges of values. Value is empty or any of its elements is . The number of functions is not 1 and is not equal to the . or the function's input dimensionality is invalid (the 's should be 1) or the function's output dimensionality is invalid (if the number of functions is 1, then it should be equal to the .; otherwise, it should be 1) for any function contained in the list. Interpolation via the entry is invalid in an color space, which is quantized and therefore inappropriate for calculations that assume a continuous range of colors. The can be set only to an empty . PDF Specification ISO 32000-1:2008, section '8.7.4.5.5 Type 4 Shadings (Free-Form Gouraud-Shaded Triangle Meshes)' PDF Specification ISO 32000-1:2008, section '8.7.4.5.6 Type 5 Shadings (Lattice-Form Gouraud-Shaded Triangle Meshes)' PDF Specification ISO 32000-1:2008, section '8.7.4.5.7 Type 6 Shadings (Coons Patch Meshes)'

Represents an edge of the previous or that is shared with the current triangle or patch.

For : a is a new in a mesh and is unconnected to any other triangle. For and : a is a new in a mesh and is unconnected to any other patch.

For : the edge between the second () and the third () vertex of the previous triangle is shared with a subsequent, connected, triangle as an edge between its first () and second () vertex. For and : the edge between the second () and the third () (corner) vertex of the previous patch is shared with a subsequent, connected, patch as an edge between its first () and second () (corner) vertex.

For : the edge between the first () and the third () vertex of the previous triangle is shared with a subsequent, connected, triangle as an edge between its first () and second () vertex. For and : the edge between the third () and the fourth () (corner) vertex of the previous patch is shared with a subsequent, connected, patch as an edge between its first () and second () (corner) vertex.

For : not applicable. For and : the edge between the fourth () and the first () (corner) vertex of the previous patch is shared with a subsequent, connected, patch as an edge between its first () and second () (corner) vertex.

Represents a triangle contained in a or . does not contain a public constructor. The only way to access instances is by enumerating or .

Gets the edge of the previous triangle that is shared with this .

The edge of the previous triangle that is shared with this .

Gets the first vertex of this .

The first vertex of this . The entry is set and the property of the value is or the entry is not set and the property of the value is . The of the of the value is not equal to the shading's .

Gets the second vertex of this .

The second vertex of this . The entry is set and the property of the value is or the entry is not set and the property of the value is . The of the of the value is not equal to the shading's .

Gets the third vertex of this .

The third vertex of this . The entry is set and the property of the value is or the entry is not set and the property of the value is . The of the of the value is not equal to the shading's .

Returns a that represents this instance.

A that represents this instance. This method should be used primarily for debugging purposes and should be considered volatile (format of its return value might change in future versions).

Represents an explicitly colored (corner) point of a or a .

Initializes a new instance of the structure that contains the specified coordinates and color. This constructor should be used only if the entry is not set. If the entry is set then use the constructor.

The coordinates of this . The color of this .

The X-coordinate value of this . The Y-coordinate value of this . The color of this . The or is either , or .

Initializes a new instance of the structure that contains the specified coordinates and color parametric variable. This constructor should be used only if the entry is set. If the entry is not set then use the constructor.

The coordinates of this . The color parametric variable of this . The is either , or .

The X-coordinate value of this . The Y-coordinate value of this . The color parametric variable of this . The , or is either , or .

Gets the coordinates of this .

The coordinates of this .

Gets a value indicating whether this specifies a color parametric variable or a color.

if this specifies a color parametric variable; otherwise, if it specifies a color.

Gets the color of this .

The color of this . The property is not applicable because the entry is set on a shading (the property returns ). Use the property instead.

Gets the color parametric variable of this .

The color parametric variable of this . The property is not applicable because the entry is not set on a shading (the property returns ). Use the property instead. The value is either , or .

Returns a that represents this instance using the specified format and format provider.

Returns a that represents this instance.

A that represents this instance. This method should be used primarily for debugging purposes and should be considered volatile (format of its return value might change in future versions).

Determines whether the is equal to this instance.

The other mesh vertex to compare with this mesh vertex instance. if the is equal to this instance; otherwise, .

Determines whether the specified is equal to this instance.

The to compare with this mesh vertex instance. if the specified is a and is equal to this instance; otherwise, .

Returns a hash code for this instance.

An integer value that specifies a hash value for this instance.

Determines whether and instances are equal.

The first mesh vertex. The second mesh vertex. if and mesh vertices are equal; otherwise, .

Determines whether and instances are not equal.

The first mesh vertex. The second mesh vertex. if and mesh vertices are not equal; otherwise, .

Type 3 (radial) shadings define a color blend that varies between two circles. Shadings of this type are commonly used to depict three-dimensional spheres and cones.

PDF Specification ISO 32000-1:2008, section '8.7.4.5.4 Type 3 (Radial) Shadings'

Initializes a new instance of the class that has the specified , , , and, optionally, . The property should be set subsequently.

The center of the starting circle, expressed in the shading's target coordinate space. The radius of the starting circle, expressed in the shading's target coordinate space. The radius shall be greater than or equal to 0. If radius is 0, the circle shall be treated as a point; if both and are 0, nothing shall be painted. The center of the ending circle, expressed in the shading's target coordinate space. The radius of the ending circle, expressed in the shading's target coordinate space. The radius shall be greater than or equal to 0. If radius is 0, the circle shall be treated as a point; if both and are 0, nothing shall be painted. The color space in which color values shall be expressed. If omitted, the is used. or is negative.

Initializes a new instance of the class that has the specified , , , and shading colors. Two are converted to a and more than two are converted to a (stitching two or more s) that is then set to the . The is set from the of the first and the last .

The center of the starting circle, expressed in the shading's target coordinate space. The radius of the starting circle, expressed in the shading's target coordinate space. The radius shall be greater than or equal to 0. If radius is 0, the circle shall be treated as a point; if both and are 0, nothing shall be painted. The center of the ending circle, expressed in the shading's target coordinate space. The radius of the ending circle, expressed in the shading's target coordinate space. The radius shall be greater than or equal to 0. If radius is 0, the circle shall be treated as a point; if both and are 0, nothing shall be painted. The s to set on this shading. or is negative. is . count is less than 2 or space of any is not equal to the or of any is not greater than the of all previous s. Interpolation via the entry is invalid in an color space, which is quantized and therefore inappropriate for calculations that assume a continuous range of colors.

Initializes a new instance of the class that has the specified , , , and two shading colors. Colors and are converted to a that is then set to the .

The center of the starting circle, expressed in the shading's target coordinate space. The radius of the starting circle, expressed in the shading's target coordinate space. The radius shall be greater than or equal to 0. If radius is 0, the circle shall be treated as a point; if both and are 0, nothing shall be painted. The center of the ending circle, expressed in the shading's target coordinate space. The radius of the ending circle, expressed in the shading's target coordinate space. The radius shall be greater than or equal to 0. If radius is 0, the circle shall be treated as a point; if both and are 0, nothing shall be painted. The shading color at the center of the starting circle. The shading color at the center of the ending circle. or is negative. Color of and are not equal. Interpolation via the entry is invalid in an color space, which is quantized and therefore inappropriate for calculations that assume a continuous range of colors.

Gets the value.

The value.

(Required) The center of the starting circle, expressed in the shading's target coordinate space.

The center of the starting circle, expressed in the shading's target coordinate space. PDF Specification ISO 32000-1:2008, section '8.7.4.5.4 Type 3 (Radial) Shadings'

(Required) The radius of the starting circle, expressed in the shading's target coordinate space. The radius shall be greater than or equal to 0. If radius is 0, the circle shall be treated as a point; if both and are 0, nothing shall be painted.

The radius of the starting circle, expressed in the shading's target coordinate space. The property value must be greater than or equal to zero. PDF Specification ISO 32000-1:2008, section '8.7.4.5.4 Type 3 (Radial) Shadings'

(Required) The center of the ending circle, expressed in the shading's target coordinate space.

The center of the ending circle, expressed in the shading's target coordinate space. PDF Specification ISO 32000-1:2008, section '8.7.4.5.4 Type 3 (Radial) Shadings'

(Required) The radius of the ending circle, expressed in the shading's target coordinate space. The radius shall be greater than or equal to 0. If radius is 0, the circle shall be treated as a point; if both and are 0, nothing shall be painted.

The radius of the ending circle, expressed in the shading's target coordinate space. The property value must be greater than or equal to zero. PDF Specification ISO 32000-1:2008, section '8.7.4.5.4 Type 3 (Radial) Shadings'

(Optional) A specifying the limiting values of a parametric variable t. The variable is considered to vary linearly between these two values as the color gradient varies between the starting and ending circles. The variable t becomes the input argument to the color function(s). Default value: [0, 1].

A specifying the limiting values of a parametric variable t. PDF Specification ISO 32000-1:2008, section '8.7.4.5.4 Type 3 (Radial) Shadings'

(Optional) A boolean value specifying whether to extend the shading beyond the starting circle. Default value: .

A boolean value specifying whether to extend the shading beyond the starting circle. PDF Specification ISO 32000-1:2008, section '8.7.4.5.4 Type 3 (Radial) Shadings'

(Optional) A boolean value specifying whether to extend the shading beyond the ending circle. Default value: .

A boolean value specifying whether to extend the shading beyond the ending circle. PDF Specification ISO 32000-1:2008, section '8.7.4.5.4 Type 3 (Radial) Shadings'

A shading dictionary specifies details of a particular gradient fill, including the type of shading to be used, the geometry of the area to be shaded, and the geometry of the gradient fill.

Various shading types are available, depending on the value of the entry: : Function-based shadings (type 1) define the color of every point in the domain using a mathematical function (not necessarily smooth or continuous). : Axial shadings (type 2) define a color blend along a line between two points, optionally extended beyond the boundary points by continuing the boundary colors. : Radial shadings (type 3) define a blend between two circles, optionally extended beyond the boundary circles by continuing the boundary colors. This type of shading is commonly used to represent three-dimensional spheres and cones. : Free-form Gouraud-shaded triangle meshes (type 4) define a common construct used by many three-dimensional applications to represent complex colored and shaded shapes. Vertices are specified in free-form geometry. : Lattice-form Gouraud-shaded triangle meshes (type 5) are based on the same geometrical construct as type 4 but with vertices specified as a pseudorectangular lattice. : Coons patch meshes (type 6) construct a shading from one or more color patches, each bounded by four cubic Bézier curves. : Tensor-product patch meshes (type 7) are similar to type 6 but with additional control points in each patch, affording greater control over color mapping. Shadings example PDF Specification ISO 32000-1:2008, section '8.7.4.3 Shading Dictionaries'

(Required) The shading type.

The shading type. PDF Specification ISO 32000-1:2008, section '8.7.4.3 Shading Dictionaries'

(Required) The color space in which color values shall be expressed. This may be any device, CIE-based, or special color space except a space. See 8.7.4.4, "Color Space: Special Considerations" for further information.

The color space in which color values shall be expressed. PDF Specification ISO 32000-1:2008, section '8.7.4.3 Shading Dictionaries'

(Optional) A color appropriate to the color space, specifying a single background color. If present, this color shall be used, before any painting operation involving the shading, to fill those portions of the area to be painted that lie outside the bounds of the shading object. In the opaque imaging model, the effect is as if the painting operation were performed twice: first with the background color and then with the shading. The background color is applied only when the shading is used as part of a shading pattern, not when it is painted directly with the sh operator.

A color appropriate to the color space, specifying a single background color. Shading background color space is not the same as the shading color space. PDF Specification ISO 32000-1:2008, section '8.7.4.3 Shading Dictionaries'

(Optional) A rectangle giving the left, bottom, right, and top coordinates, respectively, of the shading's bounding box. The coordinates shall be interpreted in the shading's target coordinate space. If present, this bounding box shall be applied as a temporary clipping boundary when the shading is painted, in addition to the current clipping path and any other clipping boundaries in effect at that time.

An rectangle giving the left, bottom, right, and top coordinates, respectively, of the shading's bounding box. PDF Specification ISO 32000-1:2008, section '8.7.4.3 Shading Dictionaries'

Sets the .

The left X coordinate of the . The bottom Y coordinate of the . The right X coordinate of the . The top Y coordinate of the .

(Optional) A flag indicating whether to filter the shading function to prevent aliasing artifacts. The shading operators sample shading functions at a rate determined by the resolution of the output device. Aliasing can occur if the function is not smooth—that is, if it has a high spatial frequency relative to the sampling rate. Anti-aliasing can be computationally expensive and is usually unnecessary, since most shading functions are smooth enough or are sampled at a high enough frequency to avoid aliasing effects. Anti-aliasing may not be implemented on some output devices, in which case this flag is ignored. Default value: .

PDF Specification ISO 32000-1:2008, section '8.7.4.3 Shading Dictionaries'

Gets or creates a from the specified that represents a shading as specified in PDF Specification ISO 32000-1:2008, section '8.7.4.3 Shading Dictionaries'.

A that represents a shading as specified in PDF Specification ISO 32000-1:2008, section '8.7.4.3 Shading Dictionaries'. An instance of a or . is . If was already created from the same , that instance is returned. This method provided a way to create various s which were previously not available in GemBox.Pdf, but now all s are supported so this method is obsolete and the constructor of the appropriate -derived class should be used instead.

Creates an interpolation function from the specified list of s. Two create a and more than two create a (stitching two or more s). The function's is set from the of the first and the last .

The s for which to create an interpolation function. is . count is less than 2 or spaces of s are not equal or of any is not greater than the of all previous s.

Describes the location and color of a transition point in a shading. Use this structure to describe the colors in a or . Two s are converted to a and more than two are converted to a (stitching two or more s) that is then set to the or the .

Gets the color.

The color.

Gets the location of the shading color within the shading vector.

The relative location of this shading color along the shading vector. A value of 0.0 specifies that the color is positioned at the beginning of the shading vector, while a value of 1.0 specifies that the color is positioned at the end of the shading vector.

Initializes a new instance of the structure with the specified color and offset.

The color value. The location in the shading where the shading color is placed.

Returns a that represents this instance.

A that represents this instance. This method should be used primarily for debugging purposes and should be considered volatile (format of its return value might change in future versions).

Determines whether the is equal to this instance.

The other shading color to compare with this shading color instance. if the is equal to this instance; otherwise, .

Determines whether the specified is equal to this instance.

The to compare with this shading color instance. if the specified is a and is equal to this instance; otherwise, .

Returns a hash code for this instance.

An integer value that specifies a hash value for this instance.

Determines whether and s are equal.

The first shading color. The second shading color. if and shading colors are equal; otherwise, .

Determines whether and s are not equal.

The first shading color. The second shading color. if and shading colors are not equal; otherwise, .

Represents types of the s.

The is a . In Type 1 (function-based) shadings, the color at every point in the domain is defined by a specified mathematical function.

The is a . Type 2 (axial) shadings define a color blend that varies along a linear axis between two endpoints and extends indefinitely perpendicular to that axis.

The is a . Type 3 (radial) shadings define a color blend that varies between two circles.

The is a . Type 4 shadings (free-form Gouraud-shaded triangle meshes) are commonly used to represent complex colored and shaded three-dimensional shapes. The area to be shaded is defined by a path composed entirely of triangles. The color at each vertex of the triangles is specified, and a technique known as Gouraud interpolation is used to color the interiors.

The is a . Type 5 shadings (lattice-form Gouraud-shaded triangle meshes) are similar to type 4, but instead of using free-form geometry, their vertices are arranged in a pseudorectangular lattice, which is topologically equivalent to a rectangular grid.

The is a . Type 6 shadings (Coons patch meshes) are constructed from one or more color patches, each bounded by four cubic Bézier curves.

The is a . Type 7 shadings (tensor-product patch meshes) are identical to type 6, except that they are based on a bicubic tensor-product patch defined by 16 control points instead of the 12 control points that define a Coons patch.

Type 7 shadings (tensor-product patch meshes) are identical to type 6, except that they are based on a bicubic tensor-product patch defined by 16 control points instead of the 12 control points that define a Coons patch.

PDF Specification ISO 32000-1:2008, section '8.7.4.5.8 Type 7 Shadings (Tensor-Product Patch Meshes)'

The optional value of the entry. The color space in which color values shall be expressed. If omitted, the is used.

Gets the value.

The value.

Populates a mesh with a new patch, unconnected to any other.

The first (corner) vertex of a new patch. The coordinates of the first control point of a cubic Bézier curve that connects and . The coordinates of the second control point of a cubic Bézier curve that connects and . The second (corner) vertex of a new patch. The coordinates of the first control point of a cubic Bézier curve that connects and . The coordinates of the second control point of a cubic Bézier curve that connects and . The third (corner) vertex of a new patch. The coordinates of the second control point of a cubic Bézier curve that connects and . The coordinates of the first control point of a cubic Bézier curve that connects and . The fourth (corner) vertex of a new patch. The coordinates of the second control point of a cubic Bézier curve that connects and . The coordinates of the first control point of a cubic Bézier curve that connects and . The optional coordinates of the first interior control point. If not specified, it is calculated. The optional coordinates of the second interior control point. If not specified, it is calculated. The optional coordinates of the third interior control point. If not specified, it is calculated. The optional coordinates of the fourth interior control point. If not specified, it is calculated. The entry is set and the property of , , , or is or the entry is not set and the property of , , , or is . The of the of , , , or is not equal to the shading's .

The flag specifying the edge of the previous patch that is shared with a subsequent, connected, patch. The coordinates of the first control point of a cubic Bézier curve that connects and . The coordinates of the second control point of a cubic Bézier curve that connects and . The third (corner) vertex of a new patch. The coordinates of the second control point of a cubic Bézier curve that connects and . The coordinates of the first control point of a cubic Bézier curve that connects and . The fourth (corner) vertex of a new patch. The coordinates of the second control point of a cubic Bézier curve that connects and . The coordinates of the first control point of a cubic Bézier curve that connects and . The optional coordinates of the first interior control point. If not specified, it is calculated. The optional coordinates of the second interior control point. If not specified, it is calculated. The optional coordinates of the third interior control point. If not specified, it is calculated. The optional coordinates of the fourth interior control point. If not specified, it is calculated. must be , , or . The entry is set and the property of or is or the entry is not set and the property of or is . The of the of or is not equal to the shading's . This overload cannot be used on an empty mesh. Use the before.

Returns an enumerator that iterates es contained in this .

A for the . The is empty. Use the overload to add a .

Enumerates the es of a .

Gets the at the current position of the enumerator.

The in the at the current position of the enumerator.

Advances the enumerator to the next of the .

Releases all resources used by the .

Represents one of the standard blend modes listed in Table 136 — Standard separable blend modes and Table 137 — Standard non-separable blend modes which is a function of both the 's color and the backdrop color used to compute the color at each point during the compositing of a with its backdrop.

The blend mode shall determine how colors interact; different blend modes may be used to achieve a variety of useful effects. A single blend mode shall be in effect for compositing all of a given , but different blend modes may be applied to different s. PDF Specification ISO 32000-1:2008, section '11.3.5 Blend Mode'

The unrecognized blend mode.

Selects the source color, ignoring the backdrop.

(Deprecated in PDF 2.0) Same as . This mode was introduced in an earlier PDF version and shall not be used by PDF writers.

Multiplies the backdrop and source color values. The result color is always at least as dark as either of the two constituent colors. When working with additive colors, multiplying any color with black produces black while multiplying with white leaves the original color unchanged. For subtractive colors, the maximum tint value used for all colorants of the color space acts as black does for additive spaces. Painting successive overlapping objects with a color other than black or white produces progressively darker colors.

Multiplies the complements of the backdrop and source color values, then complements the result. The result color is always at least as light as either of the two constituent colors. When working with additive colors, screening any color with white produces white while screening with black leaves the original color unchanged. For subtractive colors, the maximum tint value of all colorants of the color space acts as black does for additive spaces. The effect is similar to projecting multiple photographic slides simultaneously onto a single screen.

Selects the darker of the backdrop and source colors. The backdrop is replaced with the source where the source is darker; otherwise, it is left unchanged.

Selects the lighter of the backdrop and source colors. The backdrop is replaced with the source where the source is lighter; otherwise, it is left unchanged.

Brightens the backdrop color to reflect the source colour. Painting with black produces no change.

Darkens the backdrop color to reflect the source colour. Painting with white produces no change.

Multiplies or screens the colors, depending on the source color value. The effect is similar to shining a harsh spotlight on the backdrop.

Darkens or lightens the colors, depending on the source color value. The effect is similar to shining a diffused spotlight on the backdrop.

Multiplies or screens the colors, depending on the backdrop color value. Source colors overlay the backdrop while preserving its highlights and shadows. The backdrop color is not replaced but is mixed with the source color to reflect the lightness or darkness of the backdrop.

Subtracts the darker of the two constituent colors from the lighter color: Painting with white inverts the backdrop color; painting with black produces no change. For subtractive colors, the maximum tint value for all colorants of the color space acts as black does for additive spaces. This blend mode is not white-preserving.

Produces an effect similar to that of the mode but lower in contrast. Painting with white inverts the backdrop color; painting with black produces no change. For subtractive colors, the maximum tint value for all colorants of the color space acts as black does for additive spaces. This blend mode is not white-preserving.

Creates a color with the hue of the source color and the saturation and luminosity of the backdrop color. This blend mode is non-separable.

Creates a color with the saturation of the source color and the hue and luminosity of the backdrop color. Painting with this mode in an area of the backdrop that is a pure gray (no saturation) produces no change. This blend mode is non-separable.

Creates a color with the hue and saturation of the source color and the luminosity of the backdrop color. This preserves the gray levels of the backdrop and is useful for coloring monochrome images or tinting color images. This blend mode is non-separable.

Creates a color with the luminosity of the source color and the hue and saturation of the backdrop color. This produces an inverse effect to that of the mode. This blend mode is non-separable.

Represents formatting properties that affect the clipping of PDF textual or geometrical content.

The is always applicable to , is applicable to and if is , and is not applicable to any other . If the is not applicable, then clip-related graphics state parameters won't be written when writing the associated to the underlying content stream. Clipping example

Gets or sets a value indicating whether the current PDF textual or geometrical content is part of the clipping area. Initial value: .

if the current PDF textual or geometrical content is part of the clipping area; otherwise, . PDF Specification ISO 32000-1:2008, section '8.5.4 Clipping Path Operators' PDF Specification ISO 32000-1:2008, section '9.3.6 Text Rendering Mode'

Gets or sets the rule used to specify the interior of the PDF geometrical content that is part of the clipping area. Initial value: .

The rule used to specify the interior of the PDF geometrical content that is part of the clipping area. This property can be set only to . All other return the initial value (). PDF Specification ISO 32000-1:2008, section '8.5.4 Clipping Path Operators' PDF Specification ISO 32000-1:2008, section '9.3.6 Text Rendering Mode'

Represents a set of predefined s.

Colors example

Gets the Black color in color space.

Gets the Gray color in color space.

Gets the White color in color space.

Gets the Red color in color space.

Gets the Green color in color space.

Gets the Blue color in color space.

Gets the Cyan color in color space.

Gets the Magenta color in color space.

Gets the Yellow color in color space.

Represents a PDF content.

Content Streams and Resources Content Streams and Resources example PDF Specification ISO 32000-1:2008, section '7.8 Content Streams and Resources'

Begins editing of the . Calling is optional when working with and , but it is required for any other that you intend to modify. Call to commit the edited content and all resources (fonts, images, etc.) used by the edited content to the underlying content stream and the associated resource dictionary or to discard the changes and roll back to content specified in the underlying content stream. This method will be ignored if called on a that is already being edited or is 's .

The content is not editable. To edit 's content, use property. Calling is optional for because GemBox.Pdf detects the first change to and implicitly calls which sets the as the current editing page of the . The remains the current editing page of the until: The or method is called on of the current editing page of the . The of another is edited, thus implicitly calling on of the current editing page and on of the newly edited page which sets it as the current editing page of the . The GemBox.Pdf determines that content of the current editing page should be committed to the underlying content stream such as when saving a to a file or cloning a or a . To override this behavior, call method before and method after editing the to take control of when the edited content is committed to the underlying content stream. Content Streams and Resources example

Ends editing of the by committing the edited content and all resources (fonts, images, etc.) used by the edited content to the underlying content stream and the associated resource dictionary. Calling is optional when working with and , but it is required for any other that you intend to modify. This method will be ignored if called on a that is not being edited or is 's .

If set to , forces the committing of the, potentially unchanged, content and all resources (fonts, images, etc.) used by the content to the underlying content stream and the associated resource dictionary. Content Streams and Resources example

Cancels editing of the by discarding changes since the last call and rolling back to content specified in the underlying content stream. This method will be ignored if called on a that is not being edited or is 's .

Content Streams and Resources example

Returns a Unicode text contained in this .

A Unicode text contained in this . Content Streams and Resources Reading example

Represents a glyph contained in a .

Gets the bounds of the glyph () in the context of its container.

The bounds of the glyph () in the context of its container. This member, although exposed as a property for easier debugging, performs complex calculations, so instead of accessing it frequently, cache its result instead.

Returns a Unicode text contained in this glyph ().

A Unicode text contained in this glyph ().

Represents a base class for a PDF content element.

Gets the type of the PDF content element.

The type of the PDF content element.

Gets the that the belongs to.

A reference to the that the belongs to, or if the is not contained in any .

Gets the previous in the .

A reference to the previous in the , or if the current is the first element () of the .

Gets the next in the .

A reference to the next in the , or if the current is the last element () of the .

Represents a collection of s.

Collection is implemented as doubly linked list.

Gets the number of s contained in the .

The number of s contained in the .

Gets the whose is this .

The whose is this .

Gets the first of the .

The first of the .

Gets the last of the .

The last of the .

Adds the specified at the end of the .

The to add at the end of the . is . already belongs to a or to a different than the current . Use method instead.

Adds the specified after the specified existing in the .

The after which to insert . The to add to the . or is . does not belong to the current or already belongs to a or to a different than the current . Use method instead.

Adds the specified at the start of the .

The to add at the start of the . is . already belongs to a or to a different than the current . Use method instead.

Adds the specified before the specified existing in the .

The before which to insert . The to add to the . or is . does not belong to the current or already belongs to a or to a different than the current . Use method instead.

Adds the that represents the start of the marked-content sequence. Use of the returned to set the marked content properties. This method should be followed by the method and s that these methods return limit the added marked-content sequence.

The marked content tag. The optional element of this before which to insert the . If , the is added at the end of the . The added to the . The is not contained in the current . Marked Content example PDF Specification ISO 32000-1:2008, section '14.6 Marked Content'

Adds the that represents single marked-content point. Use of the returned to set the marked content properties.

Adds the that represents the end of the marked-content sequence. This method should be preceded by the method and s that these methods return limit the added marked-content sequence.

The optional element of this before which to insert the . If , the is added at the end of the . The added to the . The is not contained in the current . Marked Content example PDF Specification ISO 32000-1:2008, section '14.6 Marked Content'

Adds the that represents a group of PDF content elements that are independent from the rest of the surrounding elements. Use of the returned to position or transform the .

The optional element of this before which to insert the . If , the is added at the end of the . The added to the . The is not contained in the current . Content Groups example PDF Specification ISO 32000-1:2008, section '8.4.2 Graphics State Stack'

Adds the that represents a textual PDF content (a sequence of glyphs from the specified font of the specified size). Use of the returned to position or transform the . Note that the might not contain all the necessary information to correctly position, render and/or convert to Unicode all characters of the so use this method at your own risk. The preferred way to add a text is by using type and methods.

The sequence of character codes, with optionally individually positioned glyphs, that represent a -encoded text contained in the added element. The font. The size. The optional element of this before which to insert the . If , the is added at the end of the . The added to the . The is not contained in the current or is empty or is either , or . The is . If the is associated with another , this method will automatically clone it and associate the clone with the current . PDF Specification ISO 32000-1:2008, section '9.4 Text Objects'

Adds the that represents a geometrical PDF content composed of lines and curves. Use methods , , and of the returned to define the geometrical content.

The optional element of this before which to insert the . If , the is added at the end of the . The added to the . The is not contained in the current . Shapes (Paths) example PDF Specification ISO 32000-1:2008, section '8.5 Path Construction and Painting'

Adds the that represents a PDF content that is a rectangular array of sample values, each representing a color. Use of the returned to position or transform the . The preferred way to add an image is by using methods.

The image. The optional element of this before which to insert the . If , the is added at the end of the . The added to the . The is not contained in the current . The is . If is associated with another , this method will automatically clone it and associate the clone with the current . PDF Specification ISO 32000-1:2008, section '8.9 Images'

Adds the that represents a PDF content that is a self-contained description of any sequence of s. Use of the returned to position or transform the .

The form. The optional element of this before which to insert the . If , the is added at the end of the . The added to the . The is not contained in the current . The is . If is associated with another , this method will automatically clone it and associate the clone with the current . Form XObjects example PDF Specification ISO 32000-1:2008, section '8.10 Form XObjects'

Adds the that represents a PDF content that is a smooth transition between colors.

The shading. The optional element of this before which to insert the . If , the is added at the end of the . The added to the . The is not contained in the current . The is . If is associated with another , this method will automatically clone it and associate the clone with the current . Shadings example PDF Specification ISO 32000-1:2008, section '8.7.4 Shading Patterns'

Adds a clone of the specified to the .

The element whose clone is added to this . The optional element of this before which to insert the clone of the . If , the clone of the is added at the end of the . The clone of the specified added to the . The is not contained in the current . The is .

Adds a clone of the specified to the .

The type of the PDF content element. The element whose clone is added to this . The optional element of this before which to insert the clone of the . If , the clone of the is added at the end of the . The clone of the specified added to the . The is not contained in the current . The is .

Removes the from the .

The to remove from the . if is successfully removed; otherwise, . This method also returns if was not found in the .

Removes the at the end of the .

The is empty.

Removes the at the start of the .

The is empty.

Removes all s from the .

Determines whether a is in the .

The to locate in the . if is found in the ; otherwise, .

Copies the entire to a compatible one-dimensional array, starting at the specified index of the target array.

Returns an enumerator that iterates through the .

A for the .

Gets all s underneath this using the as the initial transformation and flattening elements as specified by the static property.

All s underneath this .

Gets all s underneath this using the as the initial transformation and flattening elements as specified by the parameter.

If set to , also gets all s underneath elements, recursively. All s underneath this .

Gets all s underneath this using the specified as the initial transformation and flattening elements as specified by the static property.

The initial transformation from the new (transformed) coordinate system to the default (untransformed) coordinate system. All s underneath this .

Gets all s underneath this using the specified as the initial transformation and flattening elements as specified by the parameter.

The initial transformation from the new (transformed) coordinate system to the default (untransformed) coordinate system. If set to , also gets all s underneath elements, recursively. All s underneath this .

Groups the specified range of s into a new whose elements are independent from the rest of the surrounding elements. All s between the and the (inclusive) of this are moved a new that replaces the in this . Use of the returned to position or transform the .

The element of this that represents the first element of a newly added . The element of this that represents the last element of a newly added . A new that replaced the in this . The or is . The or is not contained in the current . PDF Specification ISO 32000-1:2008, section '8.4.2 Graphics State Stack'

Enumerates the s of a .

Gets the at the current position of the enumerator.

The in the at the current position of the enumerator.

Advances the enumerator to the next of the .

if the enumerator was successfully advanced to the next ; if the enumerator has passed the end of the collection. The collection was modified after the enumerator was created.

Releases all resources used by the .

Represents all s underneath the .

Gets or sets the default value of the parameter flattenForms from method overloads and when using method overloads or . Default value is to maintain backward-compatible behavior (old behavior). Set this property to to also get all s underneath elements, recursively, (new behavior) while continuing to use existing method overloads or .

The default value of the parameter flattenForms from method overloads and when using method overloads or .

Removes all the s that match the conditions defined by the specified predicate. The transformation from the new (transformed) coordinate system to the default (untransformed) coordinate system is used in the logic of the predicate function.

A function that defines the conditions of the s to remove; the second parameter of the function represents the transformation from the new (transformed) coordinate system to the default (untransformed) coordinate system. If set to , removes emptied s and s. The number of elements removed. is .

Removes all the s that match the conditions defined by the specified predicate.

A function that defines the conditions of the s to remove. If set to , removes emptied s and s. The number of elements removed. is .

Returns an enumerator that iterates through all s underneath the .

A for the .

Enumerates the s underneath a .

Gets the at the current position of the enumerator.

The underneath the at the current position of the enumerator.

Gets the transformation from the new (transformed) coordinate system to the default (untransformed) coordinate system.

The transformation from the new (transformed) coordinate system to the default (untransformed) coordinate system.

Advances the enumerator to the next underneath the .

if the enumerator was successfully advanced to the next ; if the enumerator has passed the end of the collection. The collection was modified after the enumerator was created.

Releases all resources used by the .

Represents types of the s.

Content is a .

Represents a group of formatting properties applied to a PDF content.

Content Formatting example PDF Specification ISO 32000-1:2008, section '8.4 Graphics State'

Gets or sets the formatting properties related to painting an area (filling).

The formatting properties related to painting an area (filling). When setting a value, instance of a won't actually be stored in the associated , but the data to which the instance points to will be copied. This enables easy copying of a set of formatting properties from one to another. If value that is being set comes from a that is contained in another , this property setter will automatically clone all s (s, s, and s) contained in the and associate the clones with the current . The is always applicable to , is applicable to and if is , and is not applicable to any other . The is, additionally, applicable to and . If the is not applicable, then fill-related graphics state parameters won't be written when writing the associated to the underlying content stream. Filling example PDF Specification ISO 32000-1:2008, section '8.4 Graphics State'

Gets or sets the formatting properties related to drawing a line (stroking).

The formatting properties related to drawing a line (stroking). When setting a value, instance of a won't actually be stored in the associated , but the data to which the instance points to will be copied. This enables easy copying of a set of formatting properties from one to another. If value that is being set comes from a that is contained in another , this property setter will automatically clone all s (s, s, and s) contained in the and associate the clones with the current . The is always applicable to , is applicable to and if is , and is not applicable to any other . If the is not applicable, then stroke-related graphics state parameters won't be written when writing the associated to the underlying content stream. Stroking example PDF Specification ISO 32000-1:2008, section '8.4 Graphics State'

Gets or sets the formatting properties related to clipping an area.

The formatting properties related to clipping an area. The is always applicable to , is applicable to and if is , and is not applicable to any other . If the is not applicable, then clip-related graphics state parameters won't be written when writing the associated to the underlying content stream. Clipping example

Gets or sets the text-related formatting properties.

The text-related formatting properties. When setting a value, instance of a won't actually be stored in the associated , but the data to which the instance points to will be copied. This enables easy copying of a set of formatting properties from one to another. Also, when setting a value on a , the actual font and size (retrieved with method) remain unchanged because new font might not contain all the necessary information to correctly position, render and/or convert to Unicode all characters of the . As a workaround, set font and size directly by using method. If value that is being set comes from a that is contained in another , this property setter will automatically clone all s (s) contained in the and associate the clones with the current . The is applicable to and , and is not applicable to any other . If the is not applicable, then text-related graphics state parameters won't be written when writing the associated to the underlying content stream.

Gets or sets the device-independent formatting properties.

The device-independent formatting properties.

Represents a mark used to distinguish the part of the PDF content.

Marked Content example PDF Specification ISO 32000-1:2008, section '14.6 Marked Content'

Gets the value.

The value.

Gets the type of the content mark.

The type of the content mark.

Gets or sets the marked content tag. The of the mark is retrieved from and set to the associated mark.

The marked content tag.

Gets or sets the marked content properties. The of the mark is retrieved from and set to the associated mark. Use on the returned to get the underlying that contains the actual properties. If value doesn't contain any , it is set as a read-only when reading/writing the from/to the underlying content stream and when setting the to a new value. This is required to correctly detect content changes. Use method to get that you want to edit.

The marked content properties. If value that is being set is associated with another , this property setter will automatically clone it and associate the clone with the current .

Gets the marked content properties that can edited. The of the mark is retrieved from the associated mark. Use on the returned to get the underlying that contains the actual editable properties. Use this method only if you want to edit ; otherwise, use .

The marked content properties that can edited.

(Optional; PDF 2.0) An array of one or more s which denote the associated files for content marked with this .

An array of one or more s which denote the associated files for content marked with this . Associated Files example

Returns a that represents this instance.

A that represents this instance. This method should be used primarily for debugging purposes and should be considered volatile (format of its return value might change in future versions).

Represents a base class for a that is a PDF content stream resource.

PDF Specification ISO 32000-1:2008, section '7.8.3 Resource Dictionaries'

Gets the associated with this or if no is associated with this .

The associated with this or if no is associated with this .

Represents as a sequence of glyphs (s).

A retrieved from the property is valid as long as the information on which it depends is not modified on the element. The information on which it depends is: , and -related members , , , and . This type is a higher-level counterpart of the .

Gets the number of glyphs (s) in the .

The number of glyphs (s) in the . The property returns the number of glyphs (s) in this instance, not the number of Unicode characters. The reason is that a single glyph () might represent more than one Unicode character. Use the to work with Unicode characters.

Gets the glyph () at a specified position in the .

A position in the . The glyph () at position . is greater than or equal to the length of this or less than zero.

Retrieves an enumerator that can iterate through the individual glyphs (s) in this .

An enumerator.

Returns a Unicode text contained in this .

A Unicode text contained in this .

Supports iterating over a and reading its individual glyphs (s).

Gets the currently referenced glyph () in the enumerated by this .

The glyph () currently referenced by this .

Advances the to the next glyph () of the .

if the was successfully advanced to the next glyph (); if the has passed the end of the . The was modified after the was created.

Releases all resources used by the .

Represents a device independent format of a PDF content.

(PDF 1.4) Gets or sets the to be used in the transparent imaging model (see 11.3.5, "Blend Mode" and 11.6.3, "Specifying Blending Colour Space and Blend Mode"). Initial value: .

The to be used in the transparent imaging model. A conforming reader shall implicitly reset this parameter to its initial value at the beginning of execution of a transparency group XObject (see 11.6.6, "Transparency Group XObjects"). PDF Specification ISO 32000-1:2008, section '8.4 Graphics State' PDF Specification ISO 32000-1:2008, section '11.3.5 Blend Mode'

An external object (commonly called an XObject) is a graphics object whose contents are defined by a self-contained stream, separate from the content stream in which it is used. There are three types of external objects: An image XObject (8.9.5, "Image Dictionaries") represents a sampled visual image such as a photograph. A form XObject (8.10, "Form XObjects") is a self-contained description of an arbitrary sequence of graphics objects. A PostScript XObject (8.8.2, "PostScript XObjects") contains a fragment of code expressed in the PostScript page description language. PostScript XObjects should not be used.

PDF Specification ISO 32000-1:2008, section '8.8 External Objects'

(Optional; PDF 2.0) An array of one or more s which denote the associated files for this or .

An array of one or more s which denote the associated files for this or . Associated Files example

Represents formatting properties that affect filling of PDF textual or geometrical content.

The is always applicable to , is applicable to and if is , and is not applicable to any other . The is, additionally, applicable to and . If the is not applicable, then fill-related graphics state parameters won't be written when writing the associated to the underlying content stream. Filling example PDF Specification ISO 32000-1:2008, section '8.4 Graphics State'

Gets or sets a value indicating whether the current PDF textual or geometrical content is filled. Initial value: for ; otherwise, .

if the current PDF textual or geometrical content is filled; otherwise, . PDF Specification ISO 32000-1:2008, section '8.5.3 Path-Painting Operators' PDF Specification ISO 32000-1:2008, section '9.3.6 Text Rendering Mode'

Gets or sets the fill color. Initial value: .

The fill color. If or of a value that is being set is associated with another , this property setter will automatically clone it and associate the clone with the current . Filling example PDF Specification ISO 32000-1:2008, section '8.4 Graphics State'

Gets or sets the fill opacity. Initial value: 1.0.

The fill opacity. Value is not between 0 and 1 (inclusive). A value of 1 specifies that the fill is completely opaque; a value of 0 specifies that it is completely transparent. Filling example PDF Specification ISO 32000-1:2008, section '8.4 Graphics State'

Gets or sets the rule used to specify the interior of the PDF textual or geometrical content that is filled. Initial value: .

The rule used to specify the interior of the PDF textual or geometrical content that is filled. Value is not between and . PDF Specification ISO 32000-1:2008, section '8.5.3 Path-Painting Operators' PDF Specification ISO 32000-1:2008, section '9.3.6 Text Rendering Mode'

Represents a rule used to specify the interior of the PDF textual or geometrical content that is filled or is part of the clipping area.

Rule that determines whether a point is in the interior of the PDF textual or geometrical content by drawing a ray from that point to infinity in any direction and then examining the places where an outline of the PDF textual or geometrical content crosses the ray. Starting with a count of zero, add one each time an outline crosses the ray from left to right and subtract one each time a PDF textual or geometrical content outline crosses the ray from right to left. After counting the crossings, if the result is zero then the point is outside the PDF textual or geometrical content. Otherwise, it is inside.

Rule that determines whether a point is in the interior of the PDF textual or geometrical content by drawing a ray from that point to infinity in any direction and counting the number of outlines within the given PDF textual or geometrical content that the ray crosses. If this number is odd, the point is inside; if even, the point is outside.

Represents a combination of a and size used for drawing character glyphs.

The following example shows how you can use PdfFont to write rich text to a specific point on a page.


using var formattedText = new PdfFormattedText();
// Set font face and size together using PdfFont.
formattedText.Font = new PdfFont("Times New Roman", 24);
formattedText.AppendLine("Hello World");

// Draw the text to the page, with its top-left corner at 100 points
// from the left and top edge of the page.
var origin = new PdfPoint(100, page.CropBox.Top - 100 - formattedText.Height);
page.Content.DrawText(formattedText, origin);

Content Streams and Resources Reading text info example

Gets the associated with this .

The associated with this .

Gets the size of this .

The size of this .

Initializes a new instance of the class from the specified font face name and font size.

The font face name. The font size. cannot be . is either , or . is less than 0.

Initializes a new instance of the class from the specified font family and font size.

The font family. The font size. cannot be . is either , or . is less than 0.

Initializes a new instance of the class from the specified font face and font size.

The font face. The font size. cannot be . is less than 0. is either , or .

Returns a that represents this instance.

A that represents this instance. This method should be used primarily for debugging purposes and should be considered volatile (format of its return value might change in future versions).

Represents the font embedding licensing rights for the . Valid fonts must set at most one of , , or .

Embeddable fonts may be stored in a document. When a document with embedded fonts is opened on a system that does not have the font installed (the remote system), the embedded font may be loaded for temporary (and in some cases, permanent) use on that system by an embedding-aware application. Embedding licensing rights are granted by the vendor of the font. Applications that implement support for font embedding must not embed fonts which are not licensed to permit embedding. Also, when embedding a font into a document, applications must not modify the embedding permissions and restrictions. In addition, applications loading embedded fonts for temporary use ( or embedding) must delete the fonts when the document containing the embedded font is closed. , , and fields are mutually exclusive: fonts should never have more than of these fields set. Note that, if two or more bits are set, some applications could assume the least-restrictive permission indicated. GemBox.Pdf ignores the , so it is the application developer's responsibility to perform the font licensing rights check. If in doubt, contact the font's vendor. fsType field in the OS/2 and Windows Metrics Table

The font may be embedded, and may be permanently installed for use on a remote systems, or for use by other users. The user of the remote system acquires the identical rights, obligations and licenses for that font as the original purchaser of the font, and is subject to the same end-user license agreement, copyright, design patent, and/or trademark as was the original purchaser.

The font must not be modified, embedded or exchanged in any manner without first obtaining explicit permission of the legal owner.

The font may be embedded, and may be temporarily loaded on other systems for purposes of viewing or printing the document. Documents containing fonts must be opened "read-only"; no edits can be applied to the document.

The font may be embedded, and may be temporarily loaded on other systems. As with embedding, documents containing fonts may be opened for reading. In addition, editing is permitted, including ability to format new text using the embedded font, and changes may be saved.

The font may not be subsetted prior to embedding. Other embedding restrictions specified in , , , , and also apply.

Only bitmaps contained in the font may be embedded. No outline data may be embedded. If there are no bitmaps available in the font, then the font is considered unembeddable and the embedding services will fail. Other embedding restrictions specified in , , , , and also apply.

Represents a single variation of a font in terms of , and within the same .

Content Streams and Resources Reading text info example

Gets the font family from which the font face was constructed.

The font family from which the font face was constructed.

Initializes a new instance of the class from the specified face name.

The face name. cannot be .

Initializes a new instance of the class for the specified , , and values.

The font family of the font face. The style of the font face. The weight of the font face. The stretch of the font face. cannot be .

Gets the style of the .

The style of the .

Gets the weight of the .

The weight of the .

Gets the stretch of the .

The stretch of the .

Gets the font embedding licensing rights of the .

The font embedding licensing rights of the . GemBox.Pdf ignores the , so it is the application developer's responsibility to perform the font licensing rights check. If in doubt, contact the font's vendor. fsType field in the OS/2 and Windows Metrics Table

Determines whether the is equal to this instance.

The other font face to compare with this font face instance. if the is equal to this instance; otherwise, .

Determines whether the specified is equal to this instance.

The to compare with this font face instance. if the specified is a and is equal to this instance; otherwise, .

Returns a hash code for this instance.

A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.

Returns a that represents this instance.

A that represents this instance. This method should be used primarily for debugging purposes and should be considered volatile (format of its return value might change in future versions).

Provides data for the event.

Gets the containing the for which the should be selected.

The containing the for which the should be selected. This property provides the context for implementing different font selection behavior based on the instance.

Gets, either explicitly specified or implicitly created, -derived instance representing the context of the current event or if no such context exists (such as in the method).

The -derived instance representing the context of the current event or if no such context exists. This property provides the context for implementing different font selection behavior based on the instance.

Gets the .Format.Text.GetFont for which the should be selected.

The for which the should be selected.

Gets a value that indicates whether the , on which the is applied, simulates a bold weight by applying the to its that has the same color as the and the of at least 2% of the font size.

if the simulates a bold weight; otherwise, .

Gets a value that indicates whether the , on which the is applied, simulates an italic style by applying a shearing, or slanting transformation to its .

if the simulates an italic style; otherwise, .

Gets the PostScript name of the .

The PostScript name of the . PDF Specification ISO 32000-1:2008, section '9.8 Font Descriptors'

Gets the optional preferred font family name specified in the 's font descriptor.

The optional preferred font family name specified in the 's font descriptor. PDF Specification ISO 32000-1:2008, section '9.8 Font Descriptors'

Gets the optional font face style specified in the Italic flag of the 's font descriptor flags.

The optional font face style specified in the Italic flag of the 's font descriptor flags. PDF Specification ISO 32000-1:2008, section '9.8 Font Descriptors' PDF Specification ISO 32000-1:2008, section '9.8.2 Font Descriptor Flags'

Gets the optional font face weight specified in the 's font descriptor.

The optional font face weight specified in the 's font descriptor. PDF Specification ISO 32000-1:2008, section '9.8 Font Descriptors'

Gets the optional font face stretch specified in the 's font descriptor.

The optional font face stretch specified in the 's font descriptor. PDF Specification ISO 32000-1:2008, section '9.8 Font Descriptors'

Gets a value that indicates whether the conforms to Unicode encoding.

if the conforms to Unicode encoding; otherwise, . If the doesn't conform to Unicode encoding (the is ), then the does not represent the Unicode character, but the character (glyph) identifier or code specific to the . In that case, the should also be set to the user provided Unicode representation of the (glyph) identifier (code) that will be used to select the glyph from the selected . PDF Specification ISO 32000-1:2008, section '9.8.2 Font Descriptor Flags'

Gets or sets the Unicode character that should be outlined with the or -1 if no character should currently be outlined.

The Unicode character that should be outlined with the or -1 if no character should currently be outlined. Value must be between 0 and 0x10FFFF (inclusive). The selected does not contain outlines for the specified character.

Gets or sets the actual font face that will be used for outlining the based on values of other members. Use any of the font faces returned from the , , or collections. Additionally, you can use any of the font faces returned from the collection if the is an instance of the .

The actual font face that will be used for outlining the based on values of other members. Value is . The selected PDF standard can be used only when saving to PDF (the is not an instance of the ) or the selected does not contain outlines for the specified .

Represents a group of font faces having a similar basic design and certain variations in style, weight or stretch.

The following example shows how you can write rich text to a specific point on a page.


using var formattedText = new PdfFormattedText();
// All text appended next uses the specified font family and size.
formattedText.FontFamily = new PdfFontFamily("Times New Roman");
formattedText.FontSize = 24;
formattedText.AppendLine("Hello World");

// Draw the text to the page, with its top-left corner at 100 points
// from the left and top edge of the page.
var origin = new PdfPoint(100, page.CropBox.Top - 100 - formattedText.Height);
page.Content.DrawText(formattedText, origin);

Content Streams and Resources Reading text info example

Initializes a new instance of the class from the specified font family name.

The family name that comprises the new . cannot be .

Initializes a new instance of the from a string value that represents the location of the font files and the specified font family name.

The location that contains the font files. The family name that comprises the new . If is or , is used. If is relative, it is converted to absolute with method. Private fonts example

Initializes a new instance of the class from the specified font family name whose font files are embedded as resources in the specified assembly at the specified location. Read the Remarks of the method for details about the arguments of this constructor for desktop and web applications.

The name of the assembly that contains the font files. The location of the font files in the assembly. The family name that comprises the new . Private fonts example

Gets the name that was used to construct the .

The name that was used to construct the .

Determines whether the is equal to this instance.

The other font family to compare with this font family instance. if the is equal to this instance; otherwise, .

Determines whether the specified is equal to this instance.

The to compare with this font family instance. if the specified is a and is equal to this instance; otherwise, .

Returns a hash code for this instance.

A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.

Returns a that represents this instance.

A that represents this instance. This method should be used primarily for debugging purposes and should be considered volatile (format of its return value might change in future versions).

Provides enumeration support for and objects.

Private fonts example

Gets the collection of objects from the default system font location.

An of objects that represent the fonts in the system fonts collection.

Gets the collection of objects that represent the PDF standard Type 1 fonts.

An of objects that represent the PDF standard Type 1 fonts. PDF Specification ISO 32000-1:2008, section '9.6.2.2 Standard Type 1 Fonts (Standard 14 Fonts)'

Gets the collection of objects from the default system font location.

An of objects that represent the fonts in the system fonts collection.

Gets the collection of objects that represent the PDF standard Type 1 fonts.

An of objects that represent the PDF standard Type 1 fonts. PDF Specification ISO 32000-1:2008, section '9.6.2.2 Standard Type 1 Fonts (Standard 14 Fonts)'

Occurs when the must be selected based on the and when the fallback font must be selected (if the current does not contain outlines for the ).

Returns the collection of objects from a string value that represents the location of the fonts.

The location that contains the fonts. An of objects that represent the fonts in . If is or , is used. If is relative, it is converted to absolute with method.

Returns the collection of objects embedded as resources in the specified assembly at the specified location. Read the Remarks for details about the arguments of the method for desktop and web applications.

The name of the assembly that contains the fonts. The location of the fonts in the assembly. An of objects embedded as resources in the specified assembly at the specified location.

Returns the collection of objects from a string value that represents the location of the fonts.

The location that contains the fonts. An of objects that represent the fonts in . If is or , is used. If is relative, it is converted to absolute with method.

The name of the assembly that contains the fonts. The location of the fonts in the assembly. An of objects embedded as resources in the specified assembly at the specified location.

Represents the degree to which a font has been stretched compared to the normal aspect ratio of that font.

The field values correspond to the usWidthClass definition in the OpenType specification. The usWidthClass represents an integer value between 1 and 9 — lower values indicate narrower widths; higher values indicate wider widths. Content Streams and Resources Reading text info example PDF Specification ISO 32000-1:2008, section '5.7 Font Descriptors' OpenType font file 'OS/2' table usWidthClass field OpenType font file 'head' table macStyle field

The ultra-condensed font stretch that represents 50% of the normal aspect ratio of the font form.

The extra-condensed font stretch that represents 62.5% of the normal aspect ratio of the font form.

The condensed font stretch that represents 75% of the normal aspect ratio of the font form.

The semi-condensed font stretch that represents 87.5% of the normal aspect ratio of the font form.

The normal font stretch that represents 100% of the normal aspect ratio of the font form.

The semi-expanded font stretch that represents 112.5% of the normal aspect ratio of the font form.

The expanded font stretch that represents 125% of the normal aspect ratio of the font form.

The extra-expanded font stretch that represents 150% of the normal aspect ratio of the font form.

The ultra-expanded font stretch that represents 200% of the normal aspect ratio of the font form.

Represents the style of a font as normal, italic or oblique.

The fields correspond to the fsSelection definition in the OpenType specification. if fsSelection bit 9 is set, font style is ; otherwise, if fsSelection bit 0 is set, font style is ; otherwise, font style is . Content Streams and Resources Reading text info example PDF Specification ISO 32000-1:2008, section '9.8.2 Font Descriptor Flags' OpenType font file 'OS/2' table fsSelection field OpenType font file 'head' table macStyle field

The characters are upright.

The characters are artificially slanted. The slant is achieved by performing a shear transformation on the characters from a normal font. When a true italic font is not available on a computer or printer, an oblique style can be generated from the normal font and used to simulate an italic font.

The characters are truly slanted and appear as they were designed.

Represents the density of a font, in terms of the lightness or heaviness of the strokes.

The field values correspond to the usWeightClass definition in the OpenType specification. The usWeightClass represents an integer value between 1 and 1000 — lower values indicate lighter weights; higher values indicate heavier weights. Content Streams and Resources Reading text info example PDF Specification ISO 32000-1:2008, section '5.7 Font Descriptors' OpenType font file 'OS/2' table usWeightClass field OpenType font file 'head' table macStyle field

The "Thin" font weight.

The "Extra-light" font weight.

The "Light" font weight.

The "Normal" font weight.

The "Medium" font weight.

The "Semi-bold" font weight.

The "Bold" font weight.

The "Extra-bold" font weight.

The "Black" font weight.

A form XObject is a PDF content stream that is a self-contained description of any sequence of graphics objects (including path objects, text objects, and sampled images). A form XObject may be painted multiple times—either on several pages or at several locations on the same page—and produces the same results each time, subject only to the graphics state at the time it is invoked.

Form XObjects example PDF Specification ISO 32000-1:2008, section '8.10 Form XObjects'

Initializes a new instance of the class.

The associated with the . The size of the . is .

(Required) The form XObject's bounding box, used to clip the form XObject and to determine its size for caching.

The form XObject's bounding box, used to clip the form XObject and to determine its size for caching. Value is . PDF Specification ISO 32000-1:2008, section '8.10.2 Form Dictionaries'

Sets the .

The left X coordinate of the . The bottom Y coordinate of the . The right X coordinate of the . The top Y coordinate of the .

(Optional) An array of six numbers specifying the form matrix, which maps form space into user space (see 8.3.4, "Transformation Matrices"). Default value: the identity matrix [1 0 0 1 0 0].

An array of six numbers specifying the form matrix, which maps form space into user space. PDF Specification ISO 32000-1:2008, section '8.10.2 Form Dictionaries'

Sets the s (fonts, images, etc.) from the specified to this . This method is useful if the property returns (if the doesn't have an associated resource dictionary).

The whose s (fonts, images, etc.) are set to this .

Gets the form size in the original (untransformed) coordinate system in which is .

The form size in the original (untransformed) coordinate system in which is .

Gets the content of the . Returns if the doesn't have an associated resource dictionary. In that case use either to retrieve the read-only content of the with s (fonts, images, etc.) resolved from the specified or method to set s (fonts, images, etc.) from the specified to this before retrieving the property.

Gets a value of type that represents the collection of s in the . A stores its rendering data in a content stream (whose data consists of a sequence of instructions describing the graphical elements to be painted) and an associated resource dictionary. For more information on how s store graphics data, see 7.8, "Content Streams and Resources". Content Streams and Resources Content Streams and Resources example PDF Specification ISO 32000-1:2008, section '8.10 Form XObjects'

Gets the read-only content of the with s (fonts, images, etc.) resolved from the specified . To get the editable content of the , use the property and, optionally, method before it, if the property returns .

The whose s (fonts, images, etc.) are used to resolve resources used by the 's content stream. The read-only content of the with s (fonts, images, etc.) resolved from the specified .

Provides control for drawing text in PDF document.

The following example shows how you can write rich text to a specific point on a page.


using var formattedText = new PdfFormattedText();
// All text appended next uses the specified font family and size.
formattedText.FontFamily = new PdfFontFamily("Times New Roman");
formattedText.FontSize = 24;
formattedText.AppendLine("Hello World");

// Draw the text to the page, with its top-left corner at 100 points
// from the left and top edge of the page.
var origin = new PdfPoint(100, page.CropBox.Top - 100 - formattedText.Height);
page.Content.DrawText(formattedText, origin);

Writing example

Gets or sets the text formatting mode.

The that specifies the text layout for the . is disposed. The specified is not supported.

Gets or sets the maximum text width for a line of text.

The maximum text width for a line of text, provided in points (1/72 inch per point). Value is less than zero.

Gets or sets the array of maximum text widths within the , on a per-line basis. Each element in the array represents the maximum text width of sequential lines of text.

The array of maximum text widths, each width provided in points (1/72 inch per point). Value is or empty array. If the text lines exceed the number of elements in the array, the last value in the array is used for the remaining lines.

Gets or sets the alignment of text within a object.

One of the values that specifies the alignment of text within a object. Text alignment and positioning example

Gets or sets the line height, or line spacing, between lines of text.

The line spacing between lines of text, provided in points (1/72 inch per point). Value is less than zero. The default line height is automatically calculated, and is based on the .

Gets or sets the font for the characters appended next to the object.

The font for the characters appended next to the object. Value is .

Gets or sets the font face for the characters appended next to the object.

The font face for the characters appended next to the object. Value is .

Gets or sets the font size, in points (1/72 inch per point), for the characters appended next to the object.

The font size, in points (1/72 inch per point), for the characters appended next to the object. Value is less than or equal to 0. Value is either , or .

Gets or sets the font family for the characters appended next to the object.

The font family for the characters appended next to the object. Value is .

Gets or sets the font style for the characters appended next to the object.

The font style for the characters appended next to the object.

Gets or sets the font weight for the characters appended next to the object.

The font weight for the characters appended next to the object.

Gets or sets the font stretch for the characters appended next to the object.

The font stretch for the characters appended next to the object.

Gets or sets the language for the characters appended next to the object.

The language for the characters appended next to the object. Value is . Text from complex scripts example

Gets or sets the opacity for the characters appended next to the object.

The opacity for the characters appended next to the object. Value is not between 0 and 1 inclusive.

Gets or sets the color for the characters appended next to the object.

The color for the characters appended next to the object. The value's is not device color space (, , or ).

Gets or sets the underline for the characters appended next to the object.

The underline for the characters appended next to the object.

Gets or sets the strikethrough for the characters appended next to the object.

The strikethrough for the characters appended next to the object.

Gets the total number of positions. Should be used with the method and the property.

The total number of positions.

Gets the width between the leading and trailing alignment points of a line, excluding any trailing white-space characters.

The width between the leading and trailing alignment points of a line, excluding any trailing white-space characters. Provided in points (1/72 inch per point). For multi-line text, the longest line is used for the value. Text alignment and positioning example

Gets the distance from the top of the first line to the bottom of the last line of the object.

The distance from the top of the first line to the bottom of the last line, provided in points (1/72 inch per point). Text alignment and positioning example

Appends the specified string to this instance.

The string to append. A reference to this instance. The following example shows how you can write rich text to a specific point on a page.


using var formattedText = new PdfFormattedText();
// All text appended next uses the specified font family and size.
formattedText.FontFamily = new PdfFontFamily("Times New Roman");
formattedText.FontSize = 24;
// Both strings are appended on the same line.
formattedText.Append("Hello").Append(" World");

// Draw the text to the page, with its top-left corner at 100 points
// from the left and top edge of the page.
var origin = new PdfPoint(100, page.CropBox.Top - 100 - formattedText.Height);
page.Content.DrawText(formattedText, origin);

Appends the line terminator to the end of the current object.

A reference to this instance. The following example shows how you can write rich text with multiple lines to a specific point on a page.


using var formattedText = new PdfFormattedText();
// All text appended next uses the specified font family and size.
formattedText.FontFamily = new PdfFontFamily("Times New Roman");
formattedText.FontSize = 24;
formattedText.AppendLine("Hello World");
formattedText.AppendLine();
formattedText.AppendLine("Goodbye World");

// Draw the text to the page, with its top-left corner at 100 points
// from the left and top edge of the page.
var origin = new PdfPoint(100, page.CropBox.Top - 100 - formattedText.Height);
page.Content.DrawText(formattedText, origin);

Appends the specified string followed by the line terminator to the end of the current object.

The string to append. A reference to this instance. The following example shows how you can write rich text to a specific point on a page.


using var formattedText = new PdfFormattedText();
// All text appended next uses the specified font family and size.
formattedText.FontFamily = new PdfFontFamily("Times New Roman");
formattedText.FontSize = 24;
formattedText.AppendLine("Hello World");

// Draw the text to the page, with its top-left corner at 100 points
// from the left and top edge of the page.
var origin = new PdfPoint(100, page.CropBox.Top - 100 - formattedText.Height);
page.Content.DrawText(formattedText, origin);

Removes all characters from the current instance.

A reference to this instance.

Creates a that starts with the specified character index and is of the specified maximum width. This method allows incremental breaking of a to s. It is useful in the following scenarios: The might contain a lot of text that would be broken in a lot of lines and you only want to draw some of those lines. The might not fit to the available height. Then each line should be formatted and, if it fits to the available height, drawn. The might have lines that should have different or be drawn in a custom location (for example, text contained in a non-rectangular area). To format the next , increment the by of the current , until is greater than or equal to the . Use method to draw the .

The character index of the starting character in the . The maximum width of a , provided in points (1/72 inch per point). A value that represents a line of that can be drawn with method. is less than zero or greater than or equal to the or is less than zero.

Releases all managed and unmanaged resources used by the object.

Converts the value of this instance to a .

A string whose value is the same as this instance.

Represents a line of .

Gets the total number of positions of the current line.

The total number of positions of the current line.

Gets the width of a line of text, excluding trailing whitespace characters.

The text line width, excluding trailing whitespace characters.

Gets the height of the text and any other content in the line.

The height of the text and any other content in the line.

Converts the value of this instance to a .

A string whose value is the same as this instance.

Represents a PDF content that is a self-contained description of any sequence of s.

Form XObjects example PDF Specification ISO 32000-1:2008, section '8.10 Form XObjects'

Gets the value.

The value.

Gets the bounds of the .

The bounds of the . This member, although exposed as a property for easier debugging, performs complex calculations, so instead of accessing it frequently, cache its result instead.

Gets the form or if the content is a PostScript language fragment or sets the form.

The form or if the content is a PostScript language fragment. Value is . If value that is being set is associated with another , this property setter will automatically clone it and associate the clone with the current . If the is edited, the is cloned and the clone's content is set to the edited when retrieving the property. This makes sure that the group XObject's behavior is maintained which is especially important for transparency group XObjects and that of fill or stroke color of any element contained in the edited is correct because the pattern is relative to the .

Gets the content of the associated subject to the of the current . The returned is editable, and editing it clones the and the clone's content is set to this edited content when retrieving the property. To modify the 's content, use its . Methods , , and do not have any affect when called on a instance. To cancel editing of the by discarding changes and rolling back to content specified in the 's underlying content stream subject to the of the current , set the property to the value retrieved before the was edited.

The content of the subject to the of the current . If the content is edited, when retrieving the property, the is cloned and the clone's content is set to this edited content. This makes sure that the group XObject's behavior is maintained which is especially important for transparency group XObjects and that of fill or stroke color of any element contained in the edited content is correct because the pattern is relative to the . If the associated is a transparency group XObject then the implicitly modified is used instead. Implicit modifications are: the blend mode initialized to Normal, the stroking and nonstroking alpha constants to 1.0, and the soft mask to None (see 11.6.6, "Transparency Group XObjects"). Content Streams and Resources PDF Specification ISO 32000-1:2008, section '8.10 Form XObjects'

Replaces the in the with a that represents flattened representation of the as specified in the PDF Specification ISO 32000-1:2008, section '8.10 Form XObjects' when the Do operator is applied to a form XObject.

If set to then all the descendant elements will also be flattened so that returned won't contain any descendant element. A that represents a flattened representation of the and replaces it in the . The is not contained in any . A that represents a flattened representation of the has the following properties and behavior: The 's is equal to the 's . The 's is equal to the 's . The element in the 's is a clipping created from the 's . of all elements contained in the 's is multiplied with the 's . After flattening, the collection of the is empty. To roll back to content specified in the 's underlying content stream subject to the of the current , set the property to its previously retrieved value. Flattening should not be done if the associated is a group XObject because the group's behavior is then lost which especially affects transparency group XObjects. Flattening should also not be done if the contains any element whose fill or stoke color space is because the pattern is relative to the . PDF Specification ISO 32000-1:2008, section '8.10 Form XObjects'

A rectangular array of sample values, each representing a color.

PDF Specification ISO 32000-1:2008, section '8.9.5 Image Dictionaries'

Loads a from a file with the specified path and with the options.

The path to a file from which to load a . A loaded .

Loads a from a file with the specified path and with the specified options.

The path to a file from which to load a . The options used for loading a from a file. A loaded or if the frame specified in the of the does not exist in the image file.

Loads a from the specified stream and with the options.

The stream from which to load a . A loaded .

Loads a from the specified stream and with the specified options.

The stream from which to load a . The options used for loading a from the specified stream. A loaded or if the frame specified in the of the does not exist in the image file.

Gets or sets the physical size of the in points (72 points = 1 inch). Default value: the and the of the (1 pixel = 1 point).

The physical size of the in points. This property is set when loading a if the encoded image data contains the DPI (dots or pixels per inch) information. For example, in the PNG-encoded image this information is contained in the pHYs chunk. It can be set to an arbitrary value to specify the physical size of the and is used when drawing a with the overload (the is set to the and the is set to the of the of the inserted ). If specified, it is used when saving a to encode the DPI information if the encoded image format supports it. It is also used for positioning and sizing the signature and when cloning the . This property is not saved to a PDF file because the physical size (or more exactly, the transformation) of the image in a PDF content is specified with the of the .

(Required) The width of the image, in samples (pixels). For physical dimensions (in points), use the property.

The width of the image, in samples (pixels).

(Required) The height of the image, in samples (pixels). For physical dimensions (in points), use the property.

The height of the image, in samples (pixels).

(Required for images, except those that use the JPXDecode filter; not permitted for image masks) The color space in which image samples shall be specified; it can be any type of color space except Pattern.

The color space in which image samples shall be specified.

(Required except for image masks and images that use the JPXDecode filter) The number of bits used to represent each color component. Only a single value shall be specified; the number of bits shall be the same for all color components. The value shall be 1, 2, 4, 8, or (in PDF 1.5) 16. If is , this entry is optional, but if specified, its value shall be 1.

The number of bits used to represent each color component.

(Optional) A flag indicating whether the image shall be treated as an image mask (see 8.9.6, "Masked Images"). If this flag is , the value of shall be 1 and Mask and shall not be specified; unmasked areas shall be painted using the current nonstroking color. Default value: .

A flag indicating whether the image shall be treated as an image mask.

(Optional; shall not be present for image masks; PDF 1.3) An image XObject defining an image mask to be applied to this image (see 8.9.6.3,"Explicit masking"), or an array specifying a range of colors to be applied to it as a color key mask (see 8.9.6.4, "Color key masking"). If ImageMask is true, this entry shall not be present.

An image XObject defining an image mask to be applied to this image.

(Optional; PDF 1.4) A subsidiary image XObject defining a soft-mask image (see 11.6.5.2, "Soft-mask images") that shall be used as a source of mask shape or mask opacity values in the transparent imaging model. The alpha source parameter in the graphics state determines whether the mask values shall be interpreted as shape or opacity. If present, this entry shall override the current soft mask in the graphics state, as well as the image’s Mask entry, if any.

A subsidiary image XObject defining a soft-mask image.

Clones this .

The clone of this . This method doesn't do a deep clone of the underlying indirect objects and is intended to be used only to edit inline as explained in the documentation of the property.

Represents a PDF content that is a rectangular array of sample values, each representing a color.

PDF Specification ISO 32000-1:2008, section '8.9 Images'

Gets the value.

The value.

Gets the bounds of the .

The bounds of the . This member, although exposed as a property for easier debugging, performs complex calculations, so instead of accessing it frequently, cache its result instead.

Gets or sets the image. If is , the is made read-only. This is required to correctly detect content changes. If is , use method on the to get that you want to edit and set the edited clone back to the property.

The image. Value is . The specified image cannot be used as an inline image because either its stream dictionary has indirect descendants or it has stream filters that are not supported in inline images (JPXDecode or JBIG2Decode). If value that is being set is associated with another , this property setter will automatically clone it and associate the clone with the current .

Gets or sets a value indicating whether the image content is inlined in the content stream. If is , the is made read-only. This is required to correctly detect content changes.

if this image content is inlined in the content stream; otherwise, . Value is and stream dictionary has indirect descendants or has stream filters that are not supported in inline images (JPXDecode or JBIG2Decode).

Saves the image content in the specified stream.

The stream in which to save the image content. The saving options which can be used to define settings for save operation. Export Images example

Saves the image content to a file with the specified path.

The path to which to save the image content. The saving options which can be used to define settings for save operation. Export Images example

Saves the image content to a file with the specified path. Path must include file extension.

The path to which to save the image content. If file extension is not specified or not supported. If file extension is not recognized, use method overload instead. File extension that is extracted from the is used to create the appropriate class instance that is then passed to the method. Following file extensions are supported:Portable Network Graphics: .pngJoint Photographic Experts Group: .jpeg, .jpgBitmap: .bmpTagged Image File Format: .tiff, .tif Export Images example

The line cap style shall specify the shape that shall be used at the ends of open subpaths (and dashes, if any) when they are stroked.

PDF Specification ISO 32000-1:2008, section '8.4.3.3 Line Cap Style'

Butt cap. The stroke shall be squared off at the endpoint of the path. There shall be no projection beyond the end of the path.

Round cap. A semicircular arc with a diameter equal to the line width shall be drawn around the endpoint and shall be filled in.

Projecting square cap. The stroke shall continue beyond the endpoint of the path for a distance equal to half the line width and shall be squared off.

Represents a set of predefined s.

Gets a solid line dash pattern.

Gets a line dash pattern with the following lengths of alternating dashes and gaps expressed in user space units: 8, 4.

Gets a line dash pattern with the following lengths of alternating dashes and gaps expressed in user space units: 8, 2, 2, 2.

Gets a line dash pattern with the following lengths of alternating dashes and gaps expressed in user space units: 6, 2, 2, 2, 2, 2.

Gets a line dash pattern with the following lengths of alternating dashes and gaps expressed in user space units: 2.

The line join style shall specify the shape to be used at the corners of paths that are stroked. Join styles shall be significant only at points where consecutive segments of a path connect at an angle; segments that meet or intersect fortuitously shall receive no special treatment.

PDF Specification ISO 32000-1:2008, section '8.4.3.4 Line Join Style'

Miter join. The outer edges of the strokes for the two segments shall be extended until they meet at an angle, as in a picture frame. If the segments meet at too sharp an angle (as defined by the miter limit parameter—see 8.4.3.5, "Miter Limit"), a join shall be used instead.

Round join. An arc of a circle with a diameter equal to the line width shall be drawn around the point where the two segments meet, connecting the outer edges of the strokes for the two segments. This pieslice-shaped figure shall be filled in, producing a rounded corner.

Bevel join. The two segments shall be finished with caps (see 8.4.3.3, "Line Cap Style") and the resulting notch beyond the ends of the segments shall be filled with a triangle.

Represents a collection of s.

Shapes (Paths) example PDF Specification ISO 32000-1:2008, section '8.5 Path Construction and Painting'

Gets the number of s contained in the .

The number of s contained in the .

Gets or sets the at the specified index.

The at the specified index. The zero-based index of the to get or set. The at the specified index. is less than 0 or is equal to or greater than .

Adds a to the end of the .

The to be added to the end of the .

Inserts a into the at the specified index.

The zero-based index at which should be inserted. The to insert. is less than 0 or is greater than .

Removes the at the specified index of the .

The zero-based index of the to remove. is less than 0 or is equal to or greater than .

Removes the first occurrence of a specific from the .

The to remove from the . if is successfully removed; otherwise, . This method also returns if was not found in the .

Removes all s from the .

Determines whether a is in the .

The to locate in the . if is found in the ; otherwise, .

Searches for the specified and returns the zero-based index of the first occurrence within the entire .

The to locate in the . The zero-based index of the first occurrence of within the entire , if found; otherwise, –1.

Copies the entire to a compatible one-dimensional array, starting at the specified index of the target array.

Returns an enumerator that iterates through the .

An for the .

Represents a PDF content that is a smooth transition between colors.

Shadings example PDF Specification ISO 32000-1:2008, section '8.7.4 Shading Patterns'

Gets the value.

The value.

Gets the explicit bounds of the .

The explicit bounds of the . This member, although exposed as a property for easier debugging, performs complex calculations, so instead of accessing it frequently, cache its result instead.

Gets or sets the shading.

The shading. Value is . If value that is being set is associated with another , this property setter will automatically clone it and associate the clone with the current .

Represents formatting properties that affect stroking of PDF textual or geometrical content.

The is always applicable to , is applicable to and if is , and is not applicable for any other . If the is not applicable, then stroke-related graphics state parameters won't be written when writing the associated to the underlying content stream. Stroking example PDF Specification ISO 32000-1:2008, section '8.4 Graphics State'

Gets or sets a value indicating whether the current PDF textual or geometrical content is stroked. Initial value: .

if the current PDF textual or geometrical content is stroked; otherwise, . PDF Specification ISO 32000-1:2008, section '8.5.3 Path-Painting Operators' PDF Specification ISO 32000-1:2008, section '9.3.6 Text Rendering Mode'

Gets or sets the stroke color. Initial value: .

The stroke color. If or of a value that is being set is associated with another , this property setter will automatically clone it and associate the clone with the current . Stroking example PDF Specification ISO 32000-1:2008, section '8.4 Graphics State'

Gets or sets the stroke opacity. Initial value: 1.0.

The stroke opacity. Value is not between 0 and 1 (inclusive). A value of 1 specifies that the stroke is completely opaque; a value of 0 specifies that it is completely transparent. Stroking example PDF Specification ISO 32000-1:2008, section '8.4 Graphics State'

Gets or sets the thickness, in user space units, of paths to be stroked (see 8.4.3.2, "Line Width"). Initial value: 1.0.

The thickness, in user space units, of paths to be stroked. Value is negative. Value is either , or . The shall be a non-negative number expressed in user space units; stroking a path shall entail painting all points whose perpendicular distance from the path in user space is less than or equal to half the line width. The effect produced in device space depends on the current transformation matrix (CTM) in effect at the time the path is stroked. If the CTM specifies scaling by different factors in the horizontal and vertical dimensions, the thickness of stroked lines in device space shall vary according to their orientation. The actual line width achieved can differ from the requested width by as much as 2 device pixels, depending on the positions of lines with respect to the pixel grid. Automatic stroke adjustment may be used to ensure uniform line width; see 10.6.5, "Automatic Stroke Adjustment". A line width of 0 shall denote the thinnest line that can be rendered at device resolution: 1 device pixel wide. However, some devices cannot reproduce 1-pixel lines, and on high-resolution devices, they are nearly invisible. Since the results of rendering such zero-width lines are device-dependent, they should not be used. PDF Specification ISO 32000-1:2008, section '8.4.3.2 Line Width'

Gets or sets the line cap style that specifies the shape used at the ends of open s (and dashes, if any) when they are stroked. Initial value: .

The line cap style that specifies the shape used at the ends of open s (and dashes, if any) when they are stroked. Value is not between and . PDF Specification ISO 32000-1:2008, section '8.4.3.3 Line Cap Style'

Gets or sets the line join style that specifies the shape to be used at the corners of s that are stroked. Initial value: .

The line join style that specifies the shape to be used at the corners of s that are stroked. Value is not between and . The is significant only at points where consecutive s of a connect at an angle; s that meet or intersect fortuitously shall receive no special treatment. PDF Specification ISO 32000-1:2008, section '8.4.3.4 Line Join Style'

Gets or sets the maximum length of mitered line joins for stroked s (see 8.4.3.5, "Miter Limit"). Initial value: 10.0 (for a miter cutoff below approximately 11.5 degrees).

The maximum length of mitered line joins for stroked s. Value is less than 1. Value is either , or . The limits the length of "spikes" produced when s join at sharp angles. PDF Specification ISO 32000-1:2008, section '8.4.3.5 Miter Limit'

Gets or sets the dash pattern to be used when paths are stroked (see 8.4.3.6, "Line Dash Pattern"). Initial value: .

The dash pattern to be used when paths are stroked. PDF Specification ISO 32000-1:2008, section '8.4.3.6 Line Dash Pattern'

(PDF 1.2) Gets or sets a value indicating whether to compensate for possible rasterization effects when stroking a path with a line width that is small relative to the pixel resolution of the output device (see 10.6.5, "Automatic Stroke Adjustment"). Initial value: .

to compensate for possible rasterization effects when stroking a path with a line width that is small relative to the pixel resolution of the output device; otherwise, . This is considered a device-independent parameter, even though the details of its effects are device-dependent. PDF Specification ISO 32000-1:2008, section '10.6.5 Automatic Stroke Adjustment'

Represents a snapshot mapping from a sequence of Unicode characters to a sequence of complete, partial or none s and provides various text related functionalities.

The is a snapshot and if the underlying PDF content is changed, that change won't be visible in the , instead should be retrieved again to get the actual snapshot. PDF Specification ISO 32000-1:2008, section '9.10 Extraction of Text Content' PDF Specification ISO 32000-1:2008, section '14.9.4 Replacement Text'

Gets the bounds of the .

The bounds of the .

Gets the number of Unicode characters in the current object.

The number of Unicode characters in the current object.

Retrieves a subtext from this instance. The subtext starts at a specified character position and continues to the end of the text.

The zero-based starting character position of a subtext in this instance. A that is equivalent to the subtext that begins at in this instance. is less than zero or greater than the length of this instance.

Retrieves a subtext from this instance. The subtext starts at a specified character position and has a specified length.

The zero-based starting character position of a subtext in this instance. The number of characters in the subtext. A that is equivalent to the subtext of length that begins at in this instance. plus indicates a position not within this instance or or is less than zero.

Finds all occurrences of the specified text in this instance.

The searched text. One of the enumeration values that specifies the rules for the search. All occurrences of the specified text in this instance. is .

Finds all matches of the specified regular expression in this instance.

The regular expression used to find the matches. All matches of the specified regular expression in this instance. is .

Removes the PDF content associated with the current .

Replaces the current with the specified at the position of the first glyph.

The to replace the current . To ensure visual consistency, the provided should match the formatting of the current text. This can be achieved by setting to .. and to ...

Replaces the current with the specified plain text at the position of the first glyph.

The text to replace the current .

Highlights the PDF content associated with the current .

The used to customize the highlight.

Gets the formatting properties applied to the .

The formatting properties applied to the . Setting the properties of the returned is currently not supported.

Returns a Unicode text contained in this .

A Unicode text contained in this .

Represents a textual PDF content (a sequence of glyphs from a single face of a single font).

Content Streams and Resources Reading text info example PDF Specification ISO 32000-1:2008, section '9.4 Text Objects'

Gets the value.

The value.

Gets the sequence of glyphs (s) contained in this element.

The sequence of glyphs (s) contained in this element. The returned is valid as long as the information on which it depends is not modified on this element. The information on which it depends is: , and -related members , , , and .

Gets or sets the sequence of character codes, with optionally individually positioned glyphs, that represent a -encoded text contained in this element. When setting a value, note that the current font (retrieved with ... method) might not contain all the necessary information to correctly position, render and/or convert to Unicode all characters of the new value so set it at your own risk.

The sequence of character codes, with optionally individually positioned glyphs, that represent a -encoded text contained in this element. Value is empty.

Gets or sets the transformation from text space to user space. Text space is the coordinate system in which text is shown. Specifically, the origin of the first glyph shown by a text-showing operator is placed at the origin of text space. If text space has been translated, scaled, or rotated, then the position, size, or orientation of the glyph in user space is correspondingly altered.

The transformation from text space to user space. PDF Specification ISO 32000-1:2008, section '9.4.4 Text Space Details'

Gets the baseline origin location of the .

The baseline origin location of the . This property is a shorthand for offset of the matrix. Content Streams and Resources Reading text info example

Gets the transformation from text space to device space of the parent . To get the transformation from text space to device space of the page, append matrices of all ancestor s to matrix.

The transformation from text space to device space of the parent . is a temporary matrix; conceptually, it is recomputed before each glyph is painted during a text-showing operation.

Gets the bounds of the .

The bounds of the . This member, although exposed as a property for easier debugging, performs complex calculations, so instead of accessing it frequently, cache its result instead.

Gets the offset of each glyph contained in this from the starting point. This method is deprecated. Instead use the property to iterate over each glyph () and retrieve its . Calculate the transformation matrix by inverting the , transform the retrieved using this transformation matrix and use the value of the transformed .

Returns an of type which has elements of glyph offsets.

Splits the current if it is shown in the underlying content stream using the TJ operator and if any position adjustment in the TJ array is such that it introduces a considerable spacing between the surrounding characters.

The number of s into which the current is split. If zero is returned, then the current is not split.

Returns a Unicode text contained in this .

A Unicode text contained in this . Content Streams and Resources Reading text info example

Represents a text decoration style.

Specifies a text decoration consisting of a single line across all characters in the run.

Specifies a text decoration consisting of two lines across all characters in the run.

Specifies a text decoration consisting of a single wavy line across all characters in the run.

Specifies a text decoration consisting of a pair of wavy lines across all characters in the run.

Represents formatting properties that only affect PDF textual content.

The is applicable to and , and is not applicable to any other . If the is not applicable, then text-related graphics state parameters won't be written when writing the associated to the underlying content stream. Content Streams and Resources Reading text info example PDF Specification ISO 32000-1:2008, section '9.3 Text State Parameters and Operators'

Gets or sets a value indicating whether the current PDF textual content is filled (the same as property on ). Initial value: .

if the current PDF textual content is filled; otherwise, . PDF Specification ISO 32000-1:2008, section '9.3.6 Text Rendering Mode'

Gets or sets a value indicating whether the current PDF textual content is stroked (the same as property on ). Initial value: .

if the current PDF textual content is stroked; otherwise, . PDF Specification ISO 32000-1:2008, section '9.3.6 Text Rendering Mode'

Gets or sets a value indicating whether the current PDF textual content is part of the clipping area (the same as property on ). Initial value: .

if the current PDF textual content is part of the clipping area; otherwise, . PDF Specification ISO 32000-1:2008, section '9.3.6 Text Rendering Mode'

Gets the font. Initial value: .

The font. Note that the of the returned for is resolved from the actual font size (retrieved with method) and the . Content Streams and Resources Reading text info example PDF Specification ISO 32000-1:2008, section '9.3 Text State Parameters and Operators'

Gets the font and size.

The size. The font. PDF Specification ISO 32000-1:2008, section '9.3 Text State Parameters and Operators'

Sets the font and size. Note that the might not contain all the necessary information to correctly position, render and/or convert to Unicode all characters of the so set it at your own risk.

The font. The size. The is . The is either , or . PDF Specification ISO 32000-1:2008, section '9.3 Text State Parameters and Operators'

Gets or sets the character spacing in unscaled text space units (although it shall be subject to scaling by the parameter if the writing mode is horizontal). When the glyph for each character in the string is rendered, shall be added to the horizontal or vertical component of the glyph's displacement, depending on the writing mode. Initial value: 0.

The character spacing in unscaled text space units. Value is either , or . PDF Specification ISO 32000-1:2008, section '9.3.2 Character Spacing'

Gets or sets the word spacing that works the same way as but shall apply only to the ASCII SPACE character (20h). Initial value: 0.

The word spacing. Value is either , or . PDF Specification ISO 32000-1:2008, section '9.3.3 Word Spacing'

Gets or sets the horizontal scaling that adjusts the width of glyphs by stretching or compressing them in the horizontal direction. Its value shall be specified as a percentage of the normal width of the glyphs, with 1.0 (100%) being the normal width. The shall apply to the horizontal coordinate in text space, independently of the writing mode. It shall affect both the glyph's shape and its horizontal displacement (that is, its displacement vector). If the writing mode is horizontal, it shall also effect the spacing parameters and . Initial value: 1.0 (100%) (normal width).

The horizontal scaling that adjusts the width of glyphs by stretching or compressing them in the horizontal direction. Value is either , or . PDF Specification ISO 32000-1:2008, section '9.3.4 Horizontal Scaling'

Gets or sets the leading that specifies the vertical distance between the baselines of adjacent lines of text in unscaled text space units. Initial value: 0.

The leading that specifies the vertical distance between the baselines of adjacent lines of text in unscaled text space units. Value is either , or . PDF Specification ISO 32000-1:2008, section '9.3.5 Leading'

Gets or sets the rise that shall specify the distance, in unscaled text space units, to move the baseline up or down from its default location. Positive values of shall move the baseline up. Initial value: 0.

The rise that shall specify the distance, in unscaled text space units, to move the baseline up or down from its default location. Value is either , or . PDF Specification ISO 32000-1:2008, section '9.3.7 Text Rise'

Gets or sets the text knockout parameter (PDF 1.4) that determines what elements shall be considered elementary objects for purposes of color compositing in the transparent imaging model. Initial value: .

If the value is , each glyph in a shall be treated as a separate elementary object; when glyphs overlap, they shall composite with one another. If the value is , all glyphs in the shall be treated together as a single elementary object; when glyphs overlap, later glyphs shall overwrite (“knock out”) earlier ones in the area of overlap. PDF Specification ISO 32000-1:2008, section '9.3.8 Text Knockout'

Defines the formatting methods supported by the class.

Indicates that the lays out text by using default primitive implementation.

Indicates that the lays out text by using Windows Presentation Foundation (WPF) implementation and ideal font metrics.

Indicates that the lays out text by using Windows Presentation Foundation (WPF) implementation and GDI-compatible font metrics.

Indicates that the lays out text by using HarfBuzz text-shaping engine. Make sure your project also references the appropriate HarfBuzzSharp.NativeAssets.* NuGet package depending on the platform on which you are building/running your application.

Represents options used for extracting text from a PDF content.

Gets the default options used for extracting any text from a PDF content.

The default options used for extracting any text from a PDF content.

Initializes a new instance of the class.

Gets or sets the order in which the text should be extracted. Default value: .

The order in which the text should be extracted.

Gets or sets a value that specifies how whitespace characters are inserted in the extracted text. Default value: | .

A value that specifies how whitespace characters are inserted in the extracted text.

Gets or sets the character string to use for line breaks in the extracted text if the flag is set in the property. Default value: .

The character string to use for line breaks in the extracted text if the flag is set in the property. The value assigned to the is .

Gets or sets the font face used for measuring insignificant whitespace characters inserted in the extracted text if the flag is set in the property. Default value: Courier.

The font face used for measuring insignificant whitespace characters inserted in the extracted text if the flag is set in the property. The value assigned to the is .

Gets or sets the bounds of the extracted text or if the extracted text is unbounded. Default value: (the extracted text is unbounded).

The bounds of the extracted text or if the extracted text is unbounded.

Represents a text order.

PDF Specification ISO 32000-1:2008, section '12.2 Viewer Preferences' PDF Specification ISO 32000-1:2008, section '14.8.2.3 Page Content Order' PDF Specification ISO 32000-1:2008, section '14.8.2.3.3 Reverse-Order Show Strings'

The page content order is determined by the sequencing of graphics objects within a page's content stream and of characters within a text object. To maintain elements in proper reading sequence, page content order should normally (for Western writing systems) proceed from top to bottom (and, in a multiple-column layout, from column to column).

The reading order is defined by a traversal of the page's content in lines running horizontally across the page (or vertically, if the page's content uses vertical writing mode fonts). The traversal within a horizontal line is determined by the . If the is , the traversal within a horizontal line is from left to right and the traversal of the Right-to-Left characters is reversed. If the is , the traversal within a horizontal line is from right to left and the traversal of the Left-to-Right characters is reversed.

Specifies how whitespace insertion is handled when extracting text from PDF content.

PDF Specification ISO 32000-1:2008, section '14.8.2.5 Identifying Word Breaks'

No character is inserted in the text.

The Unicode 'SPACE' (U+0020) character is inserted in the text where appropriate.

The is inserted in the text where appropriate.

The insignificant Unicode 'SPACE' (U+0020) characters and characters are inserted in the text where appropriate to simulate distances between words in a line and distances between lines.

Represents a base class for a PDF content element that has a visual representation.

Gets the bounds of the .

The bounds of the . This member, although exposed as a property for easier debugging, performs complex calculations, so instead of accessing it frequently, cache its result instead.

Gets or sets the formatting properties applied to the .

The formatting properties applied to the . This property always returns a new instance of a that points to data associated with this . This reduces memory footprint since simpler internal structures can be used to hold the data and execution time increase is negligible since Garbage Collector has a very good performance for a short-lived (Generation 0) objects. When setting a value, instance of a won't actually be stored in this , but the data to which the instance points to will be copied. This enables easy copying of a set of formatting properties from one to another. Also, when setting a value on a , the actual font and size (retrieved with method) remain unchanged because new font might not contain all the necessary information to correctly position, render and/or convert to Unicode all characters of the . As a workaround, set font and size directly by using method. If value that is being set comes from a that is contained in another , this property setter will automatically clone all s (s, s, s, and s) contained in the and associate the clones with the current . Content Formatting example PDF Specification ISO 32000-1:2008, section '8.4 Graphics State'

Gets or sets the transformation from the new (transformed) coordinate system to the original (untransformed) coordinate system. All coordinates used after the transformation are expressed in the transformed coordinate system. Before setting the , move into its own so that the transformation is confined to that and doesn't have any effect on s outside that .

The transformation from the new (transformed) coordinate system to the original (untransformed) coordinate system.

Represents a base class for a font contained in a . A font is represented in PDF as a dictionary specifying the type of font, its PostScript name, its encoding, and information that can be used to provide a substitute when the font program is not available. Optionally, the font program can be embedded as a stream object in the PDF file.

PDF Specification ISO 32000-1:2008, section '9.5 Introduction to Font Data Structures'

Gets or creates a from the specified that represents a font as specified in PDF Specification ISO 32000-1:2008, section '9.5 Introduction to Font Data Structures'.

A that represents a font as specified in PDF Specification ISO 32000-1:2008, section '9.5 Introduction to Font Data Structures'. An instance of a or . is . If was already created from the same , that instance is returned. This method provides a way to create various s which are currently not available in GemBox.Pdf.

Represents a sequence of character codes, with optionally individually positioned glyphs, that represent a text in a PDF content stream encoded by a .

This type is a lower-level counterpart of the . PDF Specification ISO 32000-1:2008, section '9.4.3 Text-Showing Operators'

Creates a from the specified .

The value. A new instance. The is . The is empty.

Creates a from the specified .

The value. A new instance. The is . The is empty.

Returns a that represents this instance.

A that represents this instance. This method should be used primarily for debugging purposes and should be considered volatile (format of its return value might change in future versions).

Determines whether the is equal to this instance.

The other content encoded string to compare with this content encoded string instance. if the is equal to this instance; otherwise, .

Determines whether the specified is equal to this instance.

The to compare with this content encoded string instance. if the specified is a and is equal to this instance; otherwise, .

Returns a hash code for this instance.

An integer value that specifies a hash value for this instance.

Determines whether and s are equal.

The first content encoded string. The second content encoded string. if and content encoded strings are equal; otherwise, .

Determines whether and s are not equal.

The first content encoded string. The second content encoded string. if and content encoded strings are not equal; otherwise, .

Provides access to low level graphics state parameter dictionary entries from a type and or objects that are used as a backing storage of structure.

PDF Specification ISO 32000-1:2008, section '8.4.5 Graphics State Parameter Dictionaries' PDF Specification ISO 32000-1:2008, section '9.4.3 Text-Showing Operators'

Gets the graphics state parameter value associated with the specified graphics state parameter key. Supported graphics state parameter keys are listed in the first column of the Table 58 – Entries in a Graphics State Parameter Dictionary.

The from where to retrieve the graphics state parameter. The key of the graphics state parameter to get. When this method returns, contains the graphics state parameter value associated with the specified key, if the key is a valid graphics state parameter key; otherwise, the value. if the graphics state parameter with the specified key is supported; otherwise, . or is .

Sets the graphics state parameter value associated with the specified graphics state parameter key. Supported graphics state parameter keys are listed in the first column of the Table 58 – Entries in a Graphics State Parameter Dictionary.

The where to set the graphics state parameter. The key of the graphics state parameter to set. The value of the graphics state parameter to set. if the graphics state parameter with the specified key is supported; otherwise, . or is . If value that is being set is associated with another , this method will automatically clone it and associate the clone with the current .

Gets the or that serves as a backing storage of the specified .

The for which the backing or should be retrieved. A or that serves as a backing storage of the specified . Implementation is taken from https://source.dot.net/#System.Private.CoreLib/src/System/Collections/Generic/List.cs.

Represents a one-dimensional collection of s arranged sequentially.

PDF Specification ISO 32000-1:2008, section '7.3.6 Array Objects'Objects

Creates a new instance of the class.

A new instance of the class.

Creates a new instance of the class that is empty and has the specified initial capacity.

The number of s that the new array can initially store. A new instance of the class that is empty and has the specified initial capacity. is less than 0.

Creates a new instance of the class that contains s copied from the specified collection and has sufficient capacity to accommodate the number of s copied.

The type of s in the . The collection whose s are copied to the new array. A new instance of the class that contains s copied from the specified collection. is or one of the 's element is . One of the 's element is already contained in some other or is or is the current .

Gets the value.

The value.

Gets the number of s contained in the .

The number of s contained in the .

Gets or sets the at the specified index.

The at the specified index. The zero-based index of the to get or set. The at the specified index. The current is read-only ( returns ). is less than 0 or is equal to or greater than . is . is already contained in some other or is or is the current .

Makes a deep clone of the with parameter that controls the cloning of s.

A parameter that controls the cloning of s. A deep clone of the .

Makes a deep clone of the with optionally cloning descendant s.

if set to descendant s won't be cloned. A deep clone of the .

Inserts a into the at the specified index.

The zero-based index at which should be inserted. The to insert. The value cannot be . Use value instead. The current is read-only ( returns ). is less than 0 or is greater than . is . is already contained in some other or is or is the current .

Adds a to the end of the .

The to be added to the end of the . The value cannot be . Use value instead. The current is read-only ( returns ). is . is already contained in some other or is or is the current .

Removes the at the specified index of the .

The zero-based index of the to remove. The current is read-only ( returns ). is less than 0 or is equal to or greater than .

Removes the first occurrence of a specific from the .

The to remove from the . if is successfully removed; otherwise, . This method also returns if was not found in the . The current is read-only ( returns ).

Removes all s from the .

The current is read-only ( returns ).

Searches for the specified and returns the zero-based index of the first occurrence within the entire .

The to locate in the . The zero-based index of the first occurrence of within the entire , if found; otherwise, –1.

Determines whether a is in the .

The to locate in the . if is found in the ; otherwise, .

Copies the entire to a compatible one-dimensional array, starting at the specified index of the target array.

The one-dimensional that is the destination of the s copied from . The must have zero-based indexing. The zero-based index in at which copying begins. is . is less than 0. The number of s in the source is greater than the available space from to the end of the destination .

Returns an enumerator that iterates through the .

A for the .

Returns a that represents this instance.

A that represents this instance. This method should be used primarily for debugging purposes and should be considered volatile (format of its return value might change in future versions).

Enumerates the s of a .

Gets the at the current position of the enumerator.

The in the at the current position of the enumerator.

Advances the enumerator to the next of the .

if the enumerator was successfully advanced to the next ; if the enumerator has passed the end of the collection. The collection was modified after the enumerator was created.

Releases all resources used by the .

Represents a base class for all basic PDF objects that are collections ( and ).

Objects

Gets the number of elements contained in the .

The number of s contained in the .

Represents a base class for all mutable basic PDF objects.

instance is mutable and therefore cannot be shared (contained in multiple or objects). The only exception is instance that is also mutable, but can be shared. instance is not thread-safe. instance implements reference equality. Objects

Gets a value indicating whether the and all of its descendants are read-only.

if the and all of its descendants are read-only; otherwise, .

Gets the if this is or otherwise.

The if this is or otherwise. PDF Specification ISO 32000-1:2008, section '7.3.10 Indirect Objects'

Makes a deep clone of the with parameter that controls the cloning of s.

A parameter that controls the cloning of s. A deep clone of the .

Makes a deep clone of the with optionally cloning descendant s.

if set to descendant s won't be cloned. A deep clone of the .

Determines whether the specified is equal to this instance.

The to compare with this instance. if the specified is equal to this instance; otherwise, .

Returns a hash code for this instance.

A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.

Represents a base class for all basic PDF objects.

PDF Specification ISO 32000-1:2008, section '7.3 Objects' Objects

Gets the single instance of type.

The single instance of type. PDF Specification ISO 32000-1:2008, section '7.3.9 Null Object' Objects

Gets the of the current instance.

The of the current instance.

Returns a that represents this instance.

A that represents this instance. This method should be used primarily for debugging purposes and should be considered volatile (format of its return value might change in future versions).

Represents a type of .

PDF Specification ISO 32000-1:2008, section '7.3 Objects' Basic Objects example

Object is .

Represents a base class for all immutable basic PDF objects.

instance is immutable and therefore can be shared (contained in multiple or objects). instance is thread-safe. instance implements value equality. Objects

Determines whether the specified is equal to this instance.

The to compare with this instance. if the specified is equal to this instance; otherwise, .

Returns a hash code for this instance.

A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.

Represents PDF logical values of and . There are only two instances of this type and those are and .

PDF Specification ISO 32000-1:2008, section '7.3.2 Boolean Objects' Objects

Gets the instance with logical value .

The instance with logical value .

Gets the instance with logical value .

The instance with logical value .

Gets a value of this instance.

A value of this instance.

Gets the value.

The value.

Determines whether the specified is equal to this instance.

The to compare with this instance. if the specified is equal to this instance; otherwise, .

Returns a hash code for this instance.

A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.

Returns a that represents this instance.

A that represents this instance. This method should be used primarily for debugging purposes and should be considered volatile (format of its return value might change in future versions).

Represents an associative table containing pairs of s, known as the dictionary’s entries.

PDF Specification ISO 32000-1:2008, section '7.3.7 Dictionary Objects' Basic Objects example Objects

Creates a new instance of the class.

A new instance of the class.

Creates a new instance of the class that is empty and has the specified initial capacity.

The number of entries that the new dictionary can initially store. A new instance of the class that is empty and has the specified initial capacity. is less than 0.

Creates a new instance of the class that contains entries copied from the specified collection and has sufficient capacity to accommodate the number of entries copied.

The collection whose entries are copied to the new dictionary. A new instance of the class that contains entries copied from the specified collection. is or one of the 's entries has key or value. One of the 's entries value is already contained in some other or is or is the current .

Gets the value.

The value.

Gets the if this is or otherwise.

The if this is or otherwise. PDF Specification ISO 32000-1:2008, section '7.3.8 Stream Objects'

Gets the number of entries contained in the .

The number of entries contained in the .

Gets a collection containing the keys in the .

A containing the keys in the .

Gets a collection containing the values in the .

A containing the values in the .

Gets or sets the value associated with the specified key.

The value associated with the specified key. If the specified key is not found, a get operation returns . A set operation overrides existing or adds a new entry with the specified key and value. The key of the value to get or set. A value associated with the specified key. If the specified key is not found, is returned. The current is read-only ( returns ). or value is . The value is already contained in some other or is or is the current .

Makes a deep clone of the with parameter that controls the cloning of s.

A parameter that controls the cloning of s. A deep clone of the .

Makes a deep clone of the with optionally cloning descendant s.

if set to descendant s won't be cloned. A deep clone of the .

Gets the value associated with the specified key.

The key of the value to get. When this method returns, contains the value associated with the specified key, if the key is found; otherwise, the value. if the contains an entry with the specified key; otherwise, . is .

Adds the specified key and value to the dictionary.

The key of the entry to add. The value of the entry to add. The value cannot be . Use value instead. The current is read-only ( returns ). or is . An entry with the same key already exists in the or is already contained in some other or is or is the current .

Removes the value with the specified key from the .

The key of the entry to remove. if the key is found and the entry removed; otherwise, . This method returns if key is not found in the . The current is read-only ( returns ). is .

Removes all keys and values from the .

The current is read-only ( returns ).

Determines whether the contains the specified key.

The key to locate in the . if the contains an entry with the specified key; otherwise, . is .

Returns an enumerator that iterates through the .

A structure for the .

Returns a that represents this instance.

A that represents this instance. This method should be used primarily for debugging purposes and should be considered volatile (format of its return value might change in future versions).

Represents the collection of keys in a .

Gets the number of s contained in the .

The number of s contained in the

Copies the elements to an existing one-dimensional , starting at the specified array index.

The one-dimensional that is the destination of the s copied from . The must have zero-based indexing. The zero-based index in at which copying begins. is . is less than zero. The number of elements in the source is greater than the available space from to the end of the destination .

Returns an enumerator that iterates through the .

A for the .

Enumerates the elements of a .

Gets the element at the current position of the enumerator.

The element in the at the current position of the enumerator.

Advances the enumerator to the next element of the .

if the enumerator was successfully advanced to the next element; if the enumerator has passed the end of the collection. The collection was modified after the enumerator was created.

Releases all resources used by the .

Represents the collection of values in a .

Gets the number of s contained in the .

The number of s contained in the

Copies the elements to an existing one-dimensional , starting at the specified array index.

Returns an enumerator that iterates through the .

A for the .

Enumerates the elements of a .

Gets the element at the current position of the enumerator.

The element in the at the current position of the enumerator.

Advances the enumerator to the next element of the .

if the enumerator was successfully advanced to the next element; if the enumerator has passed the end of the collection. The collection was modified after the enumerator was created.

Releases all resources used by the .

Enumerates the entries of a .

Gets the at the current position of the enumerator.

The in the at the current position of the enumerator.

Advances the enumerator to the next of the .

if the enumerator was successfully advanced to the next entry; if the enumerator has passed the end of the . The collection was modified after the enumerator was created.

Releases all resources used by the .

Represents a entry.

PDF Specification ISO 32000-1:2008, section '7.3.7 Dictionary Objects' Objects

Gets the key in the .

The key in the .

Gets the value in the .

The value in the .

Initializes a new instance of the structure with the specified key and value.

The defined in each . The associated with .

Initializes a new instance of the structure with the specified key and value.

The from which is created by using method. The associated with . is .

Returns a that represents this instance.

A that represents this instance. This method should be used primarily for debugging purposes and should be considered volatile (format of its return value might change in future versions).

Represents an indirect basic PDF object that other s can refer to (for example, as an element of an or as the value of a entry).

PDF Specification ISO 32000-1:2008, section '7.3.10 Indirect Objects' Basic Objects example Objects

Creates a new instance of the class.

A new instance of the class.

Creates a new instance of the class with the specified value.

A value that will be contained in the returned . A new instance of the class with the specified value. is . is already contained in some other or is .

Gets the value.

The value.

Gets the identifier of the current .

The identifier of the current .

Gets or sets the value of this . Set a value only if you are sure that this is not referenced from any other place. GemBox.Pdf never sets a value of an existing because the might be referenced from several places, instead new is created and its value is set.

The value of this . The current is read-only ( returns ). is . is already contained in some other or is . Objects

Makes a deep clone of the with parameter that controls the cloning of s.

A parameter that controls the cloning of s. A deep clone of the .

Makes a deep clone of the with optionally cloning descendant s.

if set to descendant s won't be cloned. A deep clone of the .

Returns a that represents this instance.

A that represents this instance. This method should be used primarily for debugging purposes and should be considered volatile (format of its return value might change in future versions).

Represents a unique identifier of a in a PDF file.

PDF Specification ISO 32000-1:2008, section '7.3.10 Indirect Objects' Objects

Represents an undefined identifier of a .

Gets the object number.

The object number.

Gets the generation number.

The generation number.

Determines whether the specified is equal to this instance.

The to compare with this instance. if the specified is equal to this instance; otherwise, .

Determines whether the specified is equal to this instance.

The to compare with this instance. if the specified is equal to this instance; otherwise, .

Returns a hash code for this instance.

A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.

Returns a that represents this instance.

A that represents this instance. This method should be used primarily for debugging purposes and should be considered volatile (format of its return value might change in future versions).

Determines whether and s are equal.

The first indirect PDF object identifier. The second indirect PDF object identifier. if and indirect PDF object identifiers are equal; otherwise, .

Determines whether and s are not equal.

The first indirect PDF object identifier. The second indirect PDF object identifier. if and indirect PDF object identifiers are not equal; otherwise, .

Represents an integer value PDF numeric object.

PDF Specification ISO 32000-1:2008, section '7.3.3 Numeric Objects' Objects

Gets because this PDF numeric object is integer value.

because this PDF numeric object is integer value.

Gets a value of this instance.

A value of this instance.

Creates the instance from the specified value.

The integer value. A instance created from the specified value.

Represents an atomic symbol uniquely defined by a sequence of any characters (8-bit values) except null (character code 0).

PDF Specification ISO 32000-1:2008, section '7.3.5 Name Objects' Basic Objects example Objects

Gets the empty .

The empty .

Gets the value.

The value.

Creates the instance from the specified value.

The string value. A instance created from the specified value. is .

Determines whether the specified is equal to this instance.

The to compare with this instance. if the specified is equal to this instance; otherwise, .

Determines whether the specified is equal to this instance.

The to compare with this instance. if the specified is equal to this instance; otherwise, .

Returns a hash code for this instance.

A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.

Returns a that represents this instance.

A that represents this instance.

Represents a PDF numeric object.

PDF Specification ISO 32000-1:2008, section '7.3.3 Numeric Objects' Objects

Gets a value indicating whether this instance is .

if this instance is ; otherwise, .

Gets a value of this instance.

A value of this instance.

Gets the value.

The value.

Creates the instance from the specified value rounded to 15 digits of precision.

The number value. A instance created from the specified value. Value is either , or .

Represents a sequence of bytes. consists of a and a number of bytes that represent, a potentially and usually encoded, stream's data.

PDF Specification ISO 32000-1:2008, section '7.3.8 Stream Objects' Content Stream example Objects

Creates a new instance of the class.

A new instance of the class.

Gets the value.

The value.

Gets the stream's dictionary.

The stream's dictionary.

(Required) The number of bytes from the beginning of the line following the keyword stream to the last byte just before the keyword endstream. (There may be an additional EOL marker, preceding endstream, that is not included in the count and is not logically part of the stream data.) See 7.3.8.2, "Stream Extent", for further discussion.

The number of bytes from the beginning of the line following the keyword stream to the last byte just before the keyword endstream. Value is less than zero. Value is not according to PDF Specification ISO 32000-1:2008. PDF Specification ISO 32000-1:2008, section '7.3.8.2 Stream Extent'

(Optional; PDF 1.5) A non-negative representing the number of bytes in the decoded (defiltered) . It can be used to determine, for example, whether enough disk space is available to write a to a file. This value shall be considered a hint only; for some stream filters, it may not be possible to determine this value precisely.

A non-negative representing the number of bytes in the decoded (defiltered) . Value is less than zero. Value is not according to PDF Specification ISO 32000-1:2008. PDF Specification ISO 32000-1:2008

Makes a deep clone of the with parameter that controls the cloning of s.

A parameter that controls the cloning of s. A deep clone of the .

Makes a deep clone of the with optionally cloning descendant s.

if set to descendant s won't be cloned. A deep clone of the .

Returns a that represents this instance.

A that represents this instance. This method should be used primarily for debugging purposes and should be considered volatile (format of its return value might change in future versions).

Gets the filters applied to this .

The filters applied to this . Content Stream example Objects

Opens this so its data can be accessed.

The mode in which data should be opened. The state in which data should be opened. The options with which data should be opened. A that can be used to either read or write data. is already opened. Make sure that instance returned from method is disposed before calling method again. specifies external data (through F entry) that is currently not supported. Decoded data is cached in the or is removed from the based on the following combination of parameters: is , is and doesn't have the set: If decoded data was cached in the , it is removed. is , is and has the set: If decoded data was not cached in the and returned decoded data is read to the end, its (decoded) data is cached in the . is , is and has the set: Decoded data written to the returned is cached in the . data will be encoded when encoded data is requested. Any other combination of , and : Cached decoded data in the remains unchanged. Returned must be disposed after it is no longer needed, otherwise, subsequent opening of will fail. Content Stream example Objects

Specifies how should be opened.

Content Stream example Objects

is opened for reading.

is opened for writing.

Specifies the options with which data should be opened.

The data should be opened with no options specified.

The default options with which data should be opened. Currently this option sets if mode is set to and sets if mode is set to and state is set to .

Reads the stream data from the input PDF file to a memory stream. This option is set by default, but it is useful not to set it if stream contains a lot of data which might cause . This option is not applicable if the stream data is encrypted. In that case, currently, stream data is always decrypted from the input PDF file to a memory stream.

Caches the decoded data in the or removes the decoded data from the based on the combination of parameters of the method as explained in the remarks of that method. This option is useful if (decoded) data will be frequently accessed so it doesn't have to be decoded each time.

Specifies the state of the data.

Content Stream example Objects

data is decoded.

data is encoded.

Represents a basic PDF object that consists of a series of zero or more bytes.

PDF Specification ISO 32000-1:2008, section '7.3.4 String Objects' Basic Objects example Objects

Gets the form in which this instance shall be written.

The form in which this instance shall be written.

Gets the value.

The value.

Creates the instance from the specified value.

The string value. The encoding used to encode the . The form in which created instance shall be written. A instance created from the specified value. is or is .

Creates the literal text instance from the specified value. If all characters from the can be encoded with encoding, then encoding will be used; otherwise, encoding will be used.

The string value. A literal text instance created from the specified value. is . PDF Specification ISO 32000-1:2008, section '7.9.2.2 Text String Type'

Creates the date instance from the specified value.

The date value. A date instance created from the specified value. PDF Specification ISO 32000-1:2008, section '7.9.4 Dates'

Gets the number of bytes in the current instance.

The number of bytes in the current instance.

Gets the value at a specified position in the current instance.

The value at a specified position in the current instance. A position in the current instance. The value at position . is greater than or equal to the of this instance or less than zero.

Determines whether the specified is equal to this instance.

The to compare with this instance. if the specified is equal to this instance; otherwise, .

Returns a hash code for this instance.

A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.

Returns a that represents this instance in the specified encoding.

The encoding used to decode this instance to . A that represents this instance in the specified encoding. is .

Returns a that represents this instance.

A that represents this instance. If the starts with the 0xFE 0xFF bytes, then encoding will be used; otherwise, if all bytes from this can be decoded with encoding, then encoding will be used; otherwise, encoding is used.

Returns an enumerator that iterates through the .

A for the .

Enumerates the elements of a .

Gets the at the current position of the enumerator.

The in the at the current position of the enumerator.

Advances the enumerator to the next of the .

if the enumerator was successfully advanced to the next ; if the enumerator has passed the end of the string.

Releases all resources used by the .

Represents a form in which object shall be written.

Objects

object shall be written as a sequence of literal characters enclosed in parentheses ( ).

PDF Specification ISO 32000-1:2008, section '7.3.4.2 Literal Strings'

object shall be written as hexadecimal data enclosed in angle brackets < >.

PDF Specification ISO 32000-1:2008, section '7.3.4.3 Hexadecimal Strings'

Provides access to low level and objects that are used as a backing storage of and derived types.

Basic Objects example Objects

Gets the that serves as a backing storage of the specified .

The for which the backing should be retrieved. A that serves as a backing storage of the specified . is . Changes made to the returned are not verified to be in accordance with the PDF Specification ISO 32000-1:2008 so make them at your own risk. Basic Objects example Objects

Gets the that serves as a backing storage of the specified .

The for which the backing should be retrieved. A that serves as a backing storage of the specified . is . If the backing is (lazily created when modifying the ), then the backing is created, added to the underlying model and returned. Changes made to the returned are not verified to be in accordance with the PDF Specification ISO 32000-1:2008 so make them at your own risk. Basic Objects example Objects

Gets the that serves as a backing storage of the specified or if no serves as a backing storage of the specified .

The for which the backing should be retrieved. A that serves as a backing storage of the specified or if no serves as a backing storage of the specified . is . Changes made to the returned are not verified to be in accordance with the PDF Specification ISO 32000-1:2008 so make them at your own risk. Basic Objects example Objects

Gets the that serves as a backing storage of the specified .

Represents errors that occur when filter decoder encounters an invalid sequence of bytes.

The CCITTFaxDecode filter decodes image data that has been encoded using either Group 3 or Group 4 CCITT facsimile(fax) encoding.

PDF Specification ISO 32000-1:2008, section '7.4.6 CCITTFaxDecode Filter'

Gets the value.

The value.

A code identifying the encoding scheme used: <0 Pure two-dimensional encoding (Group 4) =0 Pure one-dimensional encoding (Group 3, 1-D) >0 Mixed one- and two-dimensional encoding (Group 3, 2-D), in which a line encoded one-dimensionally may be followed by at most − 1 lines encoded two-dimensionally The filter shall distinguish among negative, zero, and positive values of to determine how to interpret the encoded data; however, it shall not distinguish between different positive values. Default value: 0.

The code identifying the encoding scheme used. Value is not according to PDF Specification ISO 32000-1:2008. PDF Specification ISO 32000-1:2008

A flag indicating whether end-of-line bit patterns shall be present in the encoding. The shall always accept end-of-line bit patterns. If is end-of-line bit patterns shall be present. Default value: .

The flag indicating whether end-of-line bit patterns shall be present in the encoding. Value is not according to PDF Specification ISO 32000-1:2008. PDF Specification ISO 32000-1:2008

A flag indicating whether the filter shall expect extra 0 bits before each encoded line so that the line begins on a byte boundary. If , the filter shall skip over encoded bits to begin decoding each line at a byte boundary. If , the filter shall not expect extra bits in the encoded representation. Default value: .

The flag indicating whether the filter shall expect extra 0 bits before each encoded line so that the line begins on a byte boundary. Value is not according to PDF Specification ISO 32000-1:2008. PDF Specification ISO 32000-1:2008

The width of the image in pixels. If the value is not a multiple of 8, the filter shall adjust the width of the unencoded image to the next multiple of 8 so that each line starts on a byte boundary. Default value: 1728.

The width of the image in pixels. Value is less than 1. Value is not according to PDF Specification ISO 32000-1:2008. PDF Specification ISO 32000-1:2008

The height of the image in scan lines. If the value is 0, the image’s height is not predetermined, and the encoded data shall be terminated by an end-of-block bit pattern or by the end of the filter’s data. Default value: 0.

The height of the image in scan lines. Value is less than zero. Value is not according to PDF Specification ISO 32000-1:2008. PDF Specification ISO 32000-1:2008

A flag indicating whether the filter shall expect the encoded data to be terminated by an end-of-block pattern, overriding the parameter. If , the filter shall stop when it has decoded the number of lines indicated by or when its data has been exhausted, whichever occurs first. The end-of-block pattern shall be the CCITT end-of-facsimile-block (EOFB) or return-to-control (RTC) appropriate for the parameter. Default value: .

The flag indicating whether the filter shall expect the encoded data to be terminated by an end-of-block pattern, overriding the parameter. Value is not according to PDF Specification ISO 32000-1:2008. PDF Specification ISO 32000-1:2008

A flag indicating whether 1 bits shall be interpreted as black pixels and 0 bits as white pixels, the reverse of the normal PDF convention for image data. Default value: .

The flag indicating whether 1 bits shall be interpreted as black pixels and 0 bits as white pixels, the reverse of the normal PDF convention for image data. Value is not according to PDF Specification ISO 32000-1:2008. PDF Specification ISO 32000-1:2008

The number of damaged rows of data that shall be tolerated before an error occurs. This entry shall apply only if is and is non-negative. Tolerating a damaged row shall mean locating its end in the encoded data by searching for an pattern and then substituting decoded data from the previous row if the previous row was not damaged, or a white scan line if the previous row was also damaged. Default value: 0.

The number of damaged rows of data that shall be tolerated before an error occurs. Value is less than zero. is or is negative. Value is not according to PDF Specification ISO 32000-1:2008. PDF Specification ISO 32000-1:2008

The Crypt filter (PDF 1.5) allows the document-level security handler (see 7.6, "Encryption") to determine which algorithms should be used to decrypt the input data.

PDF Specification ISO 32000-1:2008, section '7.4.10 Crypt Filter'

Gets the value.

The value.

The name of the crypt filter that shall be used to decrypt this stream. The name shall correspond to an entry in the CF entry of the encryption dictionary (see Table 20) or one of the standard crypt filters (see Table 26). Default value: Identity.

The name of the crypt filter that shall be used to decrypt this stream. Value is not according to PDF Specification ISO 32000-1:2008. PDF Specification ISO 32000-1:2008

Gets or sets the name of the crypt filter. Default value: .

The name of the crypt filter. is not according to PDF Specification ISO 32000-1:2008. PDF Specification ISO 32000-1:2008

Represents an enumeration of standard names.

PDF Specification ISO 32000-1:2008, Table 26 – Standard crypt filter names

name is not standard.

Input data shall be passed through without any processing.

Used by Standard security handler.

The DCTDecode filter decodes grayscale or color image data that has been encoded in the JPEG baseline format.

PDF Specification ISO 32000-1:2008, section '7.4.8 DCTDecode Filter'

Gets the value.

The value.

A value specifying the transformation that shall be performed on the sample values: 0 No transformation. 1 If the image has three color components, RGB values shall be transformed to YUV before encoding and from YUV to RGB after decoding. If the image has four components, CMYK values shall be transformed to YUVK before encoding and from YUVK to CMYK after decoding. This option shall be ignored if the image has one or two color components. Default value: if the image has three components; otherwise, .

The value specifying the transformation that shall be performed on the sample values. Value is not according to PDF Specification ISO 32000-1:2008. If the encoding algorithm has inserted the Adobe-defined marker code in the encoded data indicating the value, then the colors shall be transformed, or not, after the DCT decoding has been performed according to the value provided in the encoded data and the value of this property shall be ignored. If the Adobe-defined marker code in the encoded data indicating the value is not present then the value specified in this property will be used. If the Adobe-defined marker code in the encoded data indicating the value is not present and value of this property is then the default value of shall be if the image has three components and otherwise. Parameters that control the decoding process as well as other metadata is embedded within the encoded data stream using a notation referred to as "markers". When it defined the use of JPEG images within PostScript data streams, Adobe System Incorporated defined a particular set of rules pertaining to which markers are to be recognized, which are to be ignored and which are considered errors. A specific Adobe-defined marker was also introduced. The exact rules for producing and consuming DCT encoded data within PostScript are provide in Adobe Technical Note #5116 (reference). PDF DCT Encoding shall exactly follow those rules established by Adobe for PostScript. PDF Specification ISO 32000-1:2008

Represents a base class for all PDF filters used to encode and decode the sequence of bytes.

PDF Specification ISO 32000-1:2008, section '7.4 Filters' Content Stream example Objects

Gets the of the current instance.

The of the current instance.

Determines whether the specified is equal to this instance.

The to compare with this instance. if the specified is equal to this instance; otherwise, .

Returns a hash code for this instance.

A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.

Returns a that represents this instance.

A that represents this instance. This method should be used primarily for debugging purposes and should be considered volatile (format of its return value might change in future versions).

Represents a collection of s.

PDF Specification ISO 32000-1:2008, section '7.4 Filters' Content Stream example Objects

Adds a new filter of the specified type to the end of the .

Type of a new filter to be added to the end of the . A new filter of the specified type added to the end of the . is not supported by this method.

Adds a new filter of the specified type to the end of the .

Type of a new filter to be added to the end of the . A new filter of the specified type added to the end of the . is not supported by this method.

Gets the number of s contained in the .

The number of s contained in the .

Gets or sets the at the specified index.

The at the specified index. The zero-based index of the to get or set. The at the specified index. is less than 0 or is equal to or greater than . is .

Inserts a into the at the specified index.

The zero-based index at which should be inserted. The to insert. is less than 0 or is greater than . is .

Adds a to the end of the .

The to be added to the end of the . is .

Removes the at the specified index of the .

The zero-based index of the to remove. index is less than 0 or is equal to or greater than .

Searches for the specified and returns the zero-based index of the first occurrence within the entire .

The to locate in the . The zero-based index of the first occurrence of within the entire , if found; otherwise, –1.

Removes the first occurrence of a specific from the .

The to remove from the . if is successfully removed; otherwise, . This method also returns if was not found in the .

Removes all s from the .

Determines whether a is in the .

The to locate in the . if is found in the ; otherwise, .

Copies the entire to a compatible one-dimensional array, starting at the specified index of the target array.

Returns an enumerator that iterates through the .

A for the .

Enumerates the s of a .

Gets the at the current position of the enumerator.

The in the at the current position of the enumerator.

Advances the enumerator to the next of the .

if the enumerator was successfully advanced to the next ; if the enumerator has passed the end of the collection. The collection was modified after the enumerator was created.

Releases all resources used by the .

Represents an enumeration of standard s.

PDF Specification ISO 32000-1:2008, section '7.4 Filters'

is not standard.

Decodes data encoded in an ASCII hexadecimal representation, reproducing the original binary data. Parameters: no.

Decodes data encoded in an ASCII base-85 representation, reproducing the original binary data. Parameters: no.

Decompresses data encoded using the LZW (Lempel-Ziv-Welch) adaptive compression method, reproducing the original text or binary data. Parameters: yes.

(PDF 1.2) Decompresses data encoded using the zlib/deflate compression method, reproducing the original text or binary data. Parameters: yes.

Decompresses data encoded using a byte-oriented run-length encoding algorithm, reproducing the original text or binary data (typically monochrome image data, or any data that contains frequent long runs of a single byte value). Parameters: no.

Decompresses data encoded using the CCITT facsimile standard, reproducing the original data (typically monochrome image data at 1 bit per pixel). Parameters: yes.

(PDF 1.4) Decompresses data encoded using the JBIG2 standard, reproducing the original monochrome (1 bit per pixel) image data (or an approximation of that data). Parameters: yes.

Decompresses data encoded using a DCT (discrete cosine transform) technique based on the JPEG standard, reproducing image sample data that approximates the original data. Parameters: yes.

(PDF 1.5) Decompresses data encoded using the wavelet-based JPEG2000 standard, reproducing the original image data. Parameters: no.

(PDF 1.5) Decrypts data encrypted by a security handler, reproducing the data as it was before encryption. Parameters: yes.

The FlateDecode filter decode data that has been encoded using the public-domain zlib/deflate compression method, which is a variable length Lempel-Ziv adaptive compression method cascaded with adaptive Huffman coding. It is fully defined in Internet RFCs 1950, ZLIB Compressed Data Format Specification, and 1951, DEFLATE Compressed Data Format Specification.

PDF Specification ISO 32000-1:2008, section '7.4.4 LZWDecode and FlateDecode Filters'

Gets the value.

The value.

A code that selects the predictor algorithm, if any. If the value is 1, the shall assume that the normal algorithm was used to encode the data, without prediction. If the value is greater than 1, the shall assume that the data was differenced before being encoded, and selects the predictor algorithm. For more information regarding values greater than 1, see 7.4.4.4, "LZW and Flate Predictor Functions". Default value: 1.

The code that selects the predictor algorithm, if any. Value is less than 1. Value is not according to PDF Specification ISO 32000-1:2008. PDF Specification ISO 32000-1:2008

Gets or sets the predictor algorithm. Default value: .

The predictor algorithm. is not according to PDF Specification ISO 32000-1:2008. PDF Specification ISO 32000-1:2008

(May be used only if is greater than 1) The number of interleaved color components per sample. Valid values are 1 to 4 (PDF 1.0) and 1 or greater (PDF 1.3). Default value: 1.

The number of interleaved color components per sample. value Value is less than 1. is not greater than 1. Value is not according to PDF Specification ISO 32000-1:2008. PDF Specification ISO 32000-1:2008

(May be used only if is greater than 1) The number of bits used to represent each color component in a sample. Valid values are 1, 2, 4, 8, and (PDF 1.5) 16. Default value: 8.

The number of bits used to represent each color component in a sample. value Value is not 1, 2, 4, 8 or 16. is not greater than 1. Value is not according to PDF Specification ISO 32000-1:2008. PDF Specification ISO 32000-1:2008

(May be used only if is greater than 1) The number of samples in each row. Default value: 1.

The number of samples in each row. value Value is less than 1. is not greater than 1. Value is not according to PDF Specification ISO 32000-1:2008. PDF Specification ISO 32000-1:2008

The JBIG2Decode filter (PDF 1.4) decodes monochrome (1 bit per pixel) image data that has been encoded using JBIG2 encoding.

PDF Specification ISO 32000-1:2008, section '7.4.7 JBIG2Decode Filter'

Gets the value.

The value.

A containing the JBIG2 global (page 0) segments. Global segments shall be placed in this stream even if only a single JBIG2 image XObject refers to it.

The containing the JBIG2 global (page 0) segments. Value is not according to PDF Specification ISO 32000-1:2008. PDF Specification ISO 32000-1:2008

The LZWDecode filter decode data that has been encoded using the LZW (Lempel-Ziv-Welch) variable-length, adaptive compression method that has been adopted as one of the standard compression methods in the Tag Image File Format (TIFF) standard. For details on LZW encoding see 7.4.4.2, "Details of LZW Encoding."

PDF Specification ISO 32000-1:2008, section '7.4.4.2 Details of LZW Encoding'

Gets the value.

The value.

The code that selects the predictor algorithm, if any. Value is less than 1. Value is not according to PDF Specification ISO 32000-1:2008. PDF Specification ISO 32000-1:2008

Gets or sets the predictor algorithm. Default value: .

The predictor algorithm. is not according to PDF Specification ISO 32000-1:2008. PDF Specification ISO 32000-1:2008

(May be used only if is greater than 1) The number of interleaved color components per sample. Valid values are 1 to 4 (PDF 1.0) and 1 or greater (PDF 1.3). Default value: 1.

(May be used only if is greater than 1) The number of bits used to represent each color component in a sample. Valid values are 1, 2, 4, 8, and (PDF 1.5) 16. Default value: 8.

(May be used only if is greater than 1) The number of samples in each row. Default value: 1.

The number of samples in each row. value Value is less than 1. is not greater than 1. Value is not according to PDF Specification ISO 32000-1:2008. PDF Specification ISO 32000-1:2008

An indication of when to increase the code length. If the value is , code length increases shall be postponed as long as possible. If the value is , code length increases shall occur one code early. This parameter is included because LZW sample code distributed by some vendors increases the code length one code earlier than necessary. Default value: .

The indication of when to increase the code length. Value is not according to PDF Specification ISO 32000-1:2008. PDF Specification ISO 32000-1:2008

Represents a predictor function that can be applied to or data to make the encoded data more compact.

and encoding compress more compactly if their input data is highly predictable. One way of increasing the predictability of many continuous-tone sampled images is to replace each sample with the difference between that sample and a applied to earlier neighboring samples. If the works well, the post prediction data clusters toward 0. PDF Specification ISO 32000-1:2008, section '7.4.4.4 LZW and Flate Predictor Functions'

Prediction algorithm is unknown.

No prediction (the default value).

TIFF Predictor 2.

PNG prediction (on encoding, PNG None on all rows).

PNG prediction (on encoding, PNG Sub on all rows).

PNG prediction (on encoding, PNG Up on all rows).

PNG prediction (on encoding, PNG Average on all rows).

PNG prediction (on encoding, PNG Paeth on all rows).

PNG prediction (on encoding, PNG optimum).

Represents a non-standard .

PDF Specification ISO 32000-1:2008, section '7.4 Filters'

Gets the value.

The value.

Gets the name of this non-standard .

The name of this non-standard .

Gets the decoding parameters of this non-standard .

The decoding parameters of this non-standard .

Represents an appearance settings for a .

PDF Specification ISO 32000-1:2008, section '12.7.3.3 Variable Text'

Gets or sets the border thickness of the button appearance.

The border thickness of the button appearance. Value is less than 0. Value is either , or . PDF Specification ISO 32000-1:2008, section '12.5.4 Border Styles'

Gets or sets the border style of the button appearance.

The border style of the button appearance. Value of enumeration is not supported in the requested operation. PDF Specification ISO 32000-1:2008, section '12.5.4 Border Styles'

Gets or sets the border dash pattern of the button appearance.

The border dash pattern of the button appearance. PDF Specification ISO 32000-1:2008, section '12.5.4 Border Styles'

Gets or sets the border color of the button appearance.

The border color of the button appearance. The value's is not device color space (, , or ). PDF Specification ISO 32000-1:2008, section '12.5.6.19 Widget Annotations'

Gets or sets the background color of the button appearance.

The background color of the button appearance. The value's is not device color space (, , or ). PDF Specification ISO 32000-1:2008, section '12.5.6.19 Widget Annotations'

Gets or sets the font color of the button appearance text.

The font color of the button appearance text. PDF Specification ISO 32000-1:2008, section '12.7.3.3 Variable Text'

Gets or sets the font size of the button appearance text. A zero value for size means that the font shall be auto-sized: its size shall be computed as a function of the size of the annotation rectangle.

The font size of the button appearance text. Value is either , or . Value is less than 0. PDF Specification ISO 32000-1:2008, section '12.7.3.3 Variable Text'

Gets or sets the font face of the button appearance text.

The font face of the button appearance text. Value is . PDF Specification ISO 32000-1:2008, section '12.7.3.3 Variable Text'

Gets or sets the placement of the relative to its .

The placement of the relative to its . PDF Specification ISO 32000-1:2008, section '12.5.6.19 Widget Annotations'

Gets or sets the condition under which the shall be scaled inside the annotation rectangle.

The condition under which the shall be scaled inside the annotation rectangle. PDF Specification ISO 32000-1:2008, Table 247 – Entries in an icon fit dictionary

Gets or sets a value indicating whether to scale the to fit the width or height of the annotation rectangle while maintaining the icon's original aspect ratio. If the required horizontal and vertical scaling factors are different, the smaller of the two is used, centering the icon within the annotation rectangle in the other dimension. If , the is scaled to fill the annotation rectangle exactly, without regard to its original aspect ratio (ratio of width to height).

to scale the to fit the width or height of the annotation rectangle while maintaining the icon's original aspect ratio.; otherwise, . PDF Specification ISO 32000-1:2008, Table 247 – Entries in an icon fit dictionary

(Optional; PDF 1.5) If , indicates that the button appearance shall be scaled to fit fully within the bounds of the annotation without taking into consideration the line width of the border.

If , indicates that the button appearance shall be scaled to fit fully within the bounds of the annotation without taking into consideration the line width of the border. PDF Specification ISO 32000-1:2008, Table 247 – Entries in an icon fit dictionary

Gets or sets the two numbers that shall be between 0.0 and 1.0 indicating the fraction of leftover space to allocate at the left and bottom of the . A value of (0.0, 0.0) shall position the icon at the bottom-left corner of the annotation rectangle. A value of (0.5, 0.5) shall center it within the rectangle. This entry shall be used only if the icon is scaled proportionally.

The two numbers that shall be between 0.0 and 1.0 indicating the fraction of leftover space to allocate at the left and bottom of the . Value's and must be between 0.0 and 1.0 (inclusive). PDF Specification ISO 32000-1:2008, Table 247 – Entries in an icon fit dictionary

Gets or sets the label.

The label. PDF Specification ISO 32000-1:2008, section '12.5.6.19 Widget Annotations'

Gets or sets the icon.

The icon. PDF Specification ISO 32000-1:2008, section '12.5.6.19 Widget Annotations'

Gets the label for the specified appearance trigger.

The appearance trigger for which to get a label. A label for the specified appearance trigger. PDF Specification ISO 32000-1:2008, section '12.5.6.19 Widget Annotations'

Sets the label for the specified appearance trigger.

The appearance trigger for which to set the label. The label to set for the specified appearance trigger. PDF Specification ISO 32000-1:2008, section '12.5.6.19 Widget Annotations'

Gets the icon for the specified appearance trigger.

The appearance trigger for which to get an icon. An icon for the specified appearance trigger. PDF Specification ISO 32000-1:2008, section '12.5.6.19 Widget Annotations'

Sets the icon for the specified appearance trigger.

The appearance trigger for which to set the icon. The icon to set for the specified appearance trigger. PDF Specification ISO 32000-1:2008, section '12.5.6.19 Widget Annotations'

Sets the icon from the specified . icons are instances. This method creates, sets, and returns a icon that draws the specified input .This method is useful for setting an image to an Image field. For more information about Image fields, see remarks of the method .

The from which to set the icon. The optional appearance trigger for which to set the icon. The created and set icon that draws the specified input . is . PDF Specification ISO 32000-1:2008, section '12.5.6.19 Widget Annotations'

Represents a pushbutton which is a purely interactive control that responds immediately to user input without retaining a permanent value (see 12.7.4.2.2, "Pushbuttons").

Gets the value.

The value.

Gets the appearance settings for this .

The appearance settings for this .

(Optional; PDF 1.2) The annotation's highlighting mode, the visual effect that shall be used when the mouse button is pressed or held down inside its active area. A highlighting mode other than shall override any appearance defined for the annotation. Default value: .

Represents a check box that toggles between two states, on and off (see 12.7.4.2.3, "Check Boxes").

Fill in Form example

Gets the value.

The value.

Gets or sets the export value.

The export value. Value is or . PDF Specification ISO 32000-1:2008, section '12.7.4.2.3 Check Boxes'

Represents a base class for choice fields, such as and , that contain several text items, at most one of which may be selected as the field value.

PDF Specification ISO 32000-1:2008, section '12.7.4.4 Choice Fields'

Gets the items of this .

The items of this .

Gets or sets the index of the selected item or -1 if no item is selected.

The index of the selected item or -1 if no item is selected. Value is less than zero or greater than or equal to the number of items in the collection.

Gets or sets the selected item or if no item is selected.

The selected item or if no item is selected.

(PDF 1.5) If set to , the new value shall be committed as soon as a selection is made (commonly with the pointing device). In this case, supplying a value for a field involves three actions: selecting the field for fill-in, selecting a choice for the fill-in value, and leaving that field, which finalizes or "commits" the data choice and triggers any actions associated with the entry or changing of this data. If this property is , then processing does not wait for leaving the field action to occur, but immediately proceeds to the third step. This property enables applications to perform an action once a selection is made, without requiring the user to exit the field. If , the new value is not committed until the user exits the field.

If set to , the new value shall be committed as soon as a selection is made (commonly with the pointing device). If , the new value is not committed until the user exits the field. PDF Specification ISO 32000-1:2008, section '12.7.4.4 Choice Fields'

Represents an item for a .

PDF Specification ISO 32000-1:2008, section '12.7.4.4 Choice Fields'

Gets the (display) value of this .

The (display) value of this .

Gets the export value of this .

The export value of this .

Returns a that represents this instance.

A that represents this instance. This method should be used primarily for debugging purposes and should be considered volatile (format of its return value might change in future versions).

Determines whether the specified is equal to this instance.

The to compare with this instance. if the specified is equal to this instance; otherwise, .

Determines whether the specified is equal to this instance.

The to compare with this instance. if the specified is equal to this instance; otherwise, .

Returns a hash code for this instance.

A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.

Determines whether and s are equal.

The first item. The second item. if and items are equal; otherwise, .

Determines whether and s are not equal.

The first item. The second item. if and items are not equal; otherwise, .

Represents a collection of s.

PDF Specification ISO 32000-1:2008, section '12.7.4.4 Choice Fields'

Adds a new with the specified value to the .

The item value. A new with the specified value added to the . is or .

Adds a new with the specified value and export value to the .

The item value. The item export value. A new with the specified value and export value added to the . or is or .

Represents a combo box consisting of a drop-down list. The combo box may be accompanied by an editable text box in which the user can type a value other than the predefined choices.

PDF Specification ISO 32000-1:2008, section '12.7.4.4 Choice Fields'

Gets the value.

The value.

Gets or sets the value as an instance of a .

The value as an instance of a .

If set, the field shall have a value at the time it is exported by a submit-form action (see 12.7.5.2, "Submit-Form Action").

If set, the field shall have a value at the time it is exported by a submit-form action. PDF Specification ISO 32000-1:2008, section '12.7.3 Field Dictionaries'

Gets a value indicating whether the field shall include an editable text box as well as a drop-down list. Default value: .

if the field shall include an editable text box as well as a drop-down list; otherwise, . PDF Specification ISO 32000-1:2008, section '12.7.4.4 Choice Fields'

(PDF 1.4) Gets a value indicating whether the text entered in the field shall be spell-checked. Default value: . Applicable only if is .

if the text entered in the field shall be spell-checked; otherwise, . PDF Specification ISO 32000-1:2008, section '12.7.4.4 Choice Fields'

Represents a base class for all fields in an interactive form.

PDF Specification ISO 32000-1:2008, section '12.7 Interactive Forms' Read Form example

Gets the value.

The value.

Gets the type of this field.

The type of this field. PDF Specification ISO 32000-1:2008, section '12.7.3 Field Dictionaries'

Gets the appearance settings for this .

The appearance settings for this .

Gets the (fully qualified) field name.

The (fully qualified) field name. PDF Specification ISO 32000-1:2008, section '12.7.3.2 Field Names'

(Optional; PDF 1.3) An alternate field name that shall be used in place of the actual field name wherever the field shall be identified in the user interface (such as in error or status messages referring to the field). This text is also useful when extracting the document's contents in support of accessibility to users with disabilities or for other purposes (see 14.9.3, "Alternate Descriptions").

An alternate field name that shall be used in place of the actual field name wherever the field shall be identified in the user interface. PDF Specification ISO 32000-1:2008, section '12.7.3 Field Dictionaries'

(PDF 1.2) If set, do not display the annotation on the screen or allow it to interact with the user. The annotation may be printed (depending on the setting of the flag) but should be considered hidden for purposes of on-screen display and user interaction.

If set, do not display the annotation on the screen or allow it to interact with the user. PDF Specification ISO 32000-1:2008, section '12.5.3 Annotation Flags'

(PDF 1.2) If set, print the annotation when the page is printed. If clear, never print the annotation, regardless of whether it is displayed on the screen. This can be useful for annotations representing interactive pushbuttons, which would serve no meaningful purpose on the printed page.

If set, print the annotation when the page is printed. If clear, never print the annotation, regardless of whether it is displayed on the screen. PDF Specification ISO 32000-1:2008, section '12.5.3 Annotation Flags'

(Optional; inheritable) The field’s value, whose format varies depending on the field type. See the descriptions of individual field types for further information.

The field’s value, whose format varies depending on the field type. PDF Specification ISO 32000-1:2008, section '12.7.3 Field Dictionaries'

(Optional; inheritable) The default value to which the field reverts when a reset-form action is executed. The format of this value is the same as that of .

The default value to which the field reverts when a reset-form action is executed. PDF Specification ISO 32000-1:2008, section '12.7.3 Field Dictionaries'

If set, the user may not change the value of the field. Any associated widget annotations will not interact with the user; that is, they will not respond to mouse clicks or change their appearance in response to mouse motions. This flag is useful for fields whose values are computed or imported from a database.

If set, the user may not change the value of the field. PDF Specification ISO 32000-1:2008, section '12.7.3 Field Dictionaries'

(Optional; PDF 1.1) An action that shall be performed when the field's annotation is activated (see 12.6, "Actions").

An action that shall be performed when the field's annotation is activated. Form Actions example

Returns a that represents this instance.

A that represents this instance. This method should be used primarily for debugging purposes and should be considered volatile (format of its return value might change in future versions).

Represents a collection of 's actions performed when the mouse button is released inside the field's annotation active area. This collection also exposes actions for other trigger events (beside mouse button release) via , , , and properties.

PDF Specification ISO 32000-1:2008, section '12.6.3 Trigger Events' Form Actions example

(Optional; PDF 1.2) An action that shall be performed when the mouse button is pressed inside the field's annotation active area.

An action that shall be performed when the mouse button is pressed inside the field's annotation active area. PDF Specification ISO 32000-1:2008, section '12.6.3 Trigger Events'

(Optional; PDF 1.2) An action that shall be performed when the cursor enters the field's annotation active area.

An action that shall be performed when the cursor enters the field's annotation active area. PDF Specification ISO 32000-1:2008, section '12.6.3 Trigger Events'

(Optional; PDF 1.2) An action that shall be performed when the cursor exits the field's annotation active area.

An action that shall be performed when the cursor exits the field's annotation active area. PDF Specification ISO 32000-1:2008, section '12.6.3 Trigger Events'

(Optional; PDF 1.2; widget annotations only) An action that shall be performed when the field's annotation receives the input focus.

An action that shall be performed when the field's annotation receives the input focus. PDF Specification ISO 32000-1:2008, section '12.6.3 Trigger Events'

(Optional; PDF 1.2; widget annotations only) An action that shall be performed when the field's annotation loses the input focus.

An action that shall be performed when the field's annotation loses the input focus. PDF Specification ISO 32000-1:2008, section '12.6.3 Trigger Events'

Represents an appearance settings for a .

(Optional) The number of degrees by which the widget annotation shall be rotated counterclockwise relative to the page. The value shall be a multiple of 90. Default value: 0.

The number of degrees by which the widget annotation shall be rotated counterclockwise relative to the page. The value must be a multiple of 90. PDF Specification ISO 32000-1:2008, section '12.5.6.19 Widget Annotations'

Represents a collection of all fields in an interactive form.

PDF Specification ISO 32000-1:2008, section '12.7 Interactive Forms'

Gets the name that will be applied to the newly created .

The name that will be applied to the newly created .

Gets the first occurrence of a with the specified (fully qualified) field name or .

The first occurrence of a with the specified (fully qualified) field name or . The (fully qualified) name of the field. The first occurrence of a with the specified (fully qualified) field name or .

Forces an update of the to include all s contained in the of all that are not already contained in the . This method also handles the invalid AcroForm entry in the Catalog dictionary, updates the property of all s in the , and removes the invalid Parent entry of all Field dictionaries in the .

Adds a new invisible to the . Its associated widget annotation will be added to the first page of the and annotation's rectangle will have zero height and width, thus making the signature invisible. Its will be automatically set.

A new invisible added to the . Digital signature example

Adds a new visible to the . Its associated widget annotation will be added to the and annotation's rectangle will be defined by , , and in default user space units. Its will be automatically set.

The page on which the 's associated widget annotation will be added. The lower-left horizontal coordinate of the 's associated widget annotation rectangle on specified in default user space units. The lower-left vertical coordinate of the 's associated widget annotation rectangle on specified in default user space units. The width of the 's associated widget annotation rectangle specified in default user space units. The height of the 's associated widget annotation rectangle specified in default user space units. A new visible added to the . Visible digital signature example

Adds a new to the . Its associated widget annotation will be added to the and annotation's rectangle will be defined by , , and in default user space units. Its will be automatically set.

Adds a new to the . Its associated widget annotation will be added to the and annotation's rectangle will be defined by , , and in default user space units. Its will be automatically set to the value of .

Adds a new to the . Its associated widget annotation will be added to the and annotation's rectangle will be defined by , , and in default user space units. Its will be automatically set.

Adds a new Image field to the . Its associated widget annotation will be added to the and annotation's rectangle will be defined by , , and in default user space units. Its will be automatically set.

The page on which the Image field's associated widget annotation will be added. The lower-left horizontal coordinate of the Image field's associated widget annotation rectangle on specified in default user space units. The lower-left vertical coordinate of the Image field's associated widget annotation rectangle on specified in default user space units. The width of the Image field's associated widget annotation rectangle specified in default user space units. The height of the Image field's associated widget annotation rectangle specified in default user space units. A new Image field added to the . Image field is just a customized . The most notable customizations are that its ends with an "_af_image" suffix, its contains an instance of an that imports an icon to the button, and its is set to . To set a to the Image field, use the method on the Image field's appearance.

Returns an enumerator that iterates through the .

A for the .

Enumerates the elements of a .

Gets the element at the current position of the enumerator.

The element in the at the current position of the enumerator.

Advances the enumerator to the next element of the .

if the enumerator was successfully advanced to the next element; if the enumerator has passed the end of the collection. The collection was modified after the enumerator was created.

Releases all resources used by the .

Represents types of the s.

PDF Specification ISO 32000-1:2008, section '12.7.4 Field Types'

Field is unknown and currently not supported.

Field is a which is a purely interactive control that responds immediately to user input without retaining a permanent value (see 12.7.4.2.2, "Pushbuttons").

Field is a that toggles between two states, on and off (see 12.7.4.2.3, "Check Boxes").

Field is a in a set of related buttons that can each be on or off. Typically, at most one radio button in a set may be on at any given time, and selecting any one of the buttons automatically deselects all the others. (There are exceptions to this rule, as noted in "Radio Buttons").

Field is a which is a box or space for text fill-in data typically entered from a keyboard.

Field is a scrollable .

Field is a that may be accompanied by an editable text box in which the user can type a value other than the predefined choices.

Field is a that contains a digital signature (see 12.8, "Digital Signatures").

Represents a collection of names used in and .

PDF Specification ISO 32000-1:2008, section '12.7.5.2 Submit-Form Action' PDF Specification ISO 32000-1:2008, section '12.7.5.3 Reset-Form Action' Form Actions example

Gets or sets a value indicating whether to submit / reset all form fields. If , then only fields with names specified in are submitted / reset (if is ) or excluded from the submission / resetting (if is ). Default value: .

to submit / reset all form fields; otherwise, to submit / reset (if is ) or exclude from the submission / resetting (if is ) only fields with names specified in .

Gets or sets a value indicating whether fields with names specified in are excluded from the submission / resetting. Default value: .

to exclude fields with names specified in from the submission / resetting; otherwise, to submit / reset fields with names specified in .

Adds a to the end of the .

The to be added to the end of the . is .

Represents a file format used for exporting interactive form data via methods and for submitting interactive form data via .

PDF Specification ISO 32000-1:2008, section '12.7.7 Forms Data Format' Export Form example Form Actions example

Forms Data Format (FDF), which is described in 12.7.7, "Forms Data Format".

XFDF, a version of FDF based on XML. XFDF is described in the Adobe technical note XML Forms Data Format Specification, Version 2.0. XML is described in the W3C document Extensible Markup Language (XML) 1.1.

HTML Form format (described in the HTML 4.01 Specification). Not supported in methods.

PDF (in this case, the entire document shall be submitted rather than individual fields and values). Not supported in methods.

An import-data action imports Forms Data Format (FDF) data into the document's interactive form from a specified file.

PDF Specification ISO 32000-1:2008, section '12.7.5.4 Import-Data Action' Form Actions example

Gets the value.

The value.

(Required) The FDF file from which to import the data.

The FDF file from which to import the data. Value is or . PDF Specification ISO 32000-1:2008, section '12.7.5.4 Import-Data Action'

An interactive form (PDF 1.2)—sometimes referred to as an AcroForm—is a collection of fields for gathering information interactively from the user. A PDF document may contain any number of fields appearing on any combination of pages, all of which make up a single, global interactive form spanning the entire document.

PDF Specification ISO 32000-1:2008, section '12.7 Interactive Forms' Read Form example

Gets the fields.

The fields. PDF Specification ISO 32000-1:2008, section '12.7.2 Interactive Form Dictionary' Read Form example

(Optional; deprecated in PDF 2.0) A flag specifying whether to construct appearance streams and appearance dictionaries for all widget annotations in the document (see 12.7.3.3, "Variable text"). Default value: .

A flag specifying whether to construct appearance streams and appearance dictionaries for all widget annotations in the document. A PDF writer shall include this key, with a value of , if it has not provided appearance streams for all visible widget annotations present in the document. Appearance streams are required in PDF 2.0. PDF Specification ISO 32000-1:2008, section '12.7.2 Interactive Form Dictionary'

Exports the interactive form data from the current to an FDF or XFDF file with the specified path.

The path to an FDF or XFDF file to which to export the interactive form data. is . If file extension is not specified or not supported. Following file extensions are supported: Forms Data Format: .fdf XML Forms Data Format: .xfdf PDF Specification ISO 32000-1:2008, section '12.7.7 Forms Data Format' Export Form example

Exports the interactive form data from the current to the specified FDF or XFDF stream.

The FDF or XFDF stream to which to export the interactive form data. The format in which interactive form data is exported (either FDF or XFDF). is . PDF interactive form can be exported to either or file format. PDF Specification ISO 32000-1:2008, section '12.7.7 Forms Data Format' Export Form example

Represents a scrollable list box.

PDF Specification ISO 32000-1:2008, section '12.7.4.4 Choice Fields'

Gets the value.

The value.

Gets or sets the value as an instance of either a or an of type (if more than one item is selected).

The value as an instance of either a or an of type (if more than one item is selected).

(PDF 1.4) Gets a value indicating whether more than one of the field’s option items may be selected simultaneously. Default value: .

if more than one of the field’s option items may be selected simultaneously; otherwise, . PDF Specification ISO 32000-1:2008, section '12.7.4.4 Choice Fields'

(PDF 1.4) Gets the collection of indices of the selected items.

The collection of indices of the selected items.

(PDF 1.4) Gets the collection of selected items.

The collection of selected items.

Gets or set the top index (the index in the of the first option visible in the scrollable list box). Default value: 0.

The top index (the index in the of the first option visible in the scrollable list box). Value is less than zero or greater than or equal to number of . PDF Specification ISO 32000-1:2008, section '12.7.4.4 Choice Fields'

Represents a radio button field in a set of related buttons that can each be on or off. Typically, at most one radio button in a set may be on at any given time, and selecting any one of the buttons automatically deselects all the others. (There are exceptions to this rule, as noted in "Radio Buttons").

Fill in Form example

Gets the value.

The value.

Gets or sets the choice.

The choice. Value is or . PDF Specification ISO 32000-1:2008, section '12.7.4.2.4 Radio Buttons'

Gets or sets a value indicating whether buttons with the same name and choice are selected in unison.

if buttons with the same name and choice are selected in unison; otherwise, . PDF Specification ISO 32000-1:2008, section '12.7.4.2.4 Radio Buttons'

A reset-form action resets selected interactive form fields to their default values.

PDF Specification ISO 32000-1:2008, section '12.7.5.3 Reset-Form Action' Form Actions example

Gets the value.

The value.

Gets the names of the fields that are either reset (if is ) or excluded from resetting (if is ). Applicable only if is .

The names of the fields that are either reset or excluded from resetting.

A digital signature (PDF 1.3) may be used to authenticate the identity of a user and the document's contents. It stores information about the signer and the state of the document when it was signed.

PDF Specification ISO 32000-1:2008, section '12.8 Digital Signatures' Digital signature examples Digital Signatures in a PDF Adobe Acrobat 9 Digital Signatures, Changes and Improvements

(Optional) A name that describes the encoding of the signature value and key information in the signature dictionary. A PDF processor may use any handler that supports this format to validate the signature.

A name that describes the encoding of the signature value and key information in the signature dictionary. PDF Specification ISO 32000-1:2008, section '12.8 Digital Signatures'

Gets the content of the . For public-key signatures, should be either a DER-encoded PKCS#1 binary data object (octet string) or a DER-encoded CMS binary data object. For document timestamp signatures, shall be the TimeStampToken as specified in RFC 3161 as updated by RFC 5816. The value of the messageImprint field within the TimeStampToken shall be a hash of the bytes of the document indicated by the ByteRange and the ByteRange shall specify the complete PDF file contents (excepting the value).

The content of the . PDF Specification ISO 32000-1:2008, section '12.8 Digital Signatures'

Gets or sets the length of the (in bytes).

The length of the (in bytes).

(Optional) The time of signing. Depending on the signature handler, this may be a normal unverified computer time or a time generated in a verifiable way from a secure time server. This value should be used only when the time of signing is not available in the signature. Example: A time stamp can be embedded in a PKCS#7 binary data object (see 12.8.3.3, "PKCS#7 Signatures as used in ISO 32000").

The time of signing. PDF Specification ISO 32000-1:2008, section '12.8 Digital Signatures'

(Optional) The reason for the signing, such as ( I agree … ).

The reason for the signing, such as ( I agree … ). PDF Specification ISO 32000-1:2008, section '12.8 Digital Signatures'

(Optional) The CPU host name or physical location of the signing.

The CPU host name or physical location of the signing. PDF Specification ISO 32000-1:2008, section '12.8 Digital Signatures'

(Optional) The name of the person or authority signing the document. This value should be used only when it is not possible to extract the name from the signature. Example: From the certificate of the signer.

The name of the person or authority signing the document. PDF Specification ISO 32000-1:2008, section '12.8 Digital Signatures'

(Optional) Information provided by the signer to enable a recipient to contact the signer to verify the signature. Example: A phone number.

Information provided by the signer to enable a recipient to contact the signer to verify the signature. PDF Specification ISO 32000-1:2008, section '12.8 Digital Signatures'

Gets the set of s that specify what changes, made to the document after the signature was applied, invalidate the signature. If the value is , then the signature does not specify a Reference entry. To set the , sign the with a whose is not or use any method before signing on a that holds the signature.

The set of s that specify what changes, made to the document after the signature was applied, invalidate the signature. PDF Specification ISO 32000-1:2008, section '12.8 Digital Signatures'

Gets the depth of the PDF file section that contains the or -1 if the is not contained in any PDF file section.

The depth of the PDF file section that contains the or -1 if the is not contained in any PDF file section. The depth of the last PDF file section is 0 because a PDF file should be read from its end. The depth of all previous PDF file sections is greater than 0. Previous PDF file sections exist if the PDF file was incrementally updated. If the PDF file contains multiple s, the that is last applied should have equal to 0 and of all previously applied s should increase incrementally by 1. Otherwise, there might be one or more PDF file sections containing modifications that invalidate last applied and/or previously applied s. In PDF viewer/editor applications, a PDF file section that contains a is usually called a Signed Version or Revision of a PDF file and the last PDF file section is usually called the Current Version of a PDF file. For more information, see View previous versions of a digitally signed document and Compare versions of a signed document. A PDF file section that contains a could also contain other modifications that might invalidate previously applied s (for example, changing the content of a page) and a PDF file section that doesn't contain a could have modifications that do not invalidate previously applied s (see Digital Signature Workflows examples). This depends on the transform methods applied to the (exposed via the property) that guide the modification detection analysis that takes place when the signature is validated. The modification detection analysis is a complex process (for more information, see StackOverflow answers How to Validate Changes and Allowed actions for certified documents and for signed but uncertified documents and Adobe technical white paper Adobe Acrobat 9 Digital Signatures, Changes and Improvements, especially its section "Allowed and disallowed changes") and is currently not supported by GemBox.Pdf when validating the signature via method.

Validates the . This method validates only that the document has not been modified since the was applied. The signer's identity (its certificate validity and revocation status) is currently not validated.

An instance of a that contains a detailed error information for the status of the signature validation. Digital signature validation example

Computes the hash of the bytes of the document indicated by the ByteRange (the ByteRange should specify the complete PDF file contents, except the value) with the specified algorithm.

The algorithm with which to compute the hash. The computed hash of the bytes of the document indicated by the ByteRange.

Represents an appearance settings for a .

Visible digital signature example

Gets or sets the label. This property can be used to localize the label. Default value: "Digitally signed by ".

The label.

Gets or sets the name of the person or authority signing the document. Default value: .

The name of the person or authority signing the document.

Gets or sets the label. This property can be used to localize the label. Default value: "DN: ".

The label.

Gets or sets the distinguished name of the person or authority signing the document. Default value: .

The distinguished name of the person or authority signing the document.

Gets or sets the label. This property can be used to localize the label. Default value: "Reason: ".

The label.

Gets or sets the reason for the signing. Default value: .

The reason for the signing.

Gets or sets the label. This property can be used to localize the label. Default value: "Location: ".

The label.

Gets or sets the CPU host name or physical location of the signing. Default value: .

The CPU host name or physical location of the signing.

Gets or sets the label. This property can be used to localize the label. Default value: "Contact info: ".

The label.

Gets or sets the information provided by the signer to enable a recipient to contact the signer to verify the signature. Default value: (if set to , then it defaults to ).

The information provided by the signer to enable a recipient to contact the signer to verify the signature.

Gets or sets the label. This property can be used to localize the label. Default value: "Date: ".

The label.

Gets or sets the time of signing. Default value: .

The time of signing.

Gets or sets the format string. Default value: .

The format string.

Gets or sets the culture-specific formatting provider. Default value: .

The culture-specific formatting provider.

Gets or sets the component version label. This property can be used to localize the label. Default value: "GemBox.Pdf version: ".

The component version label.

Gets or sets a value indicating whether to include component version in the signature's appearance. Default value: .

if component version is included in the signature's appearance; otherwise, .

Gets or sets a value indicating whether to include labels in the signature's appearance. Default value: .

if labels are included in the signature's appearance; otherwise, .

Gets or sets a value indicating whether the signature appearance text should be auto-fit to the bounding box of the widget annotation associated with the signature field. Default value: .

if the signature appearance text should be auto-fit to the bounding box of the widget annotation associated with the signature field; otherwise, .

Gets or sets the line height, or line spacing, between lines of the signature appearance text. Default value: 11.56 points.

The line height, or line spacing, between lines of the signature appearance text. Value is less than zero.

Gets or sets the maximum text width for a line of the signature appearance text. Default value: 0. This formats the text into an infinite width without any implicit text wrapping.

The maximum text width for a line of the signature appearance text, provided in points (1/72 inch per point). Value is less than zero.

Gets or sets the position of the top-left corner of the signature appearance text. Default value: (1.66, 0).

The position of the top-left corner of the signature appearance text.

Gets or sets the border thickness of the signature appearance. Default value: 1 point.

The border thickness of the signature appearance. Value is less than 0. Value is either , or . PDF Specification ISO 32000-1:2008, section '12.5.4 Border Styles'

Gets or sets the border style of the signature appearance. Default value: .

The border style of the signature appearance. Value of enumeration is not supported in the requested operation. PDF Specification ISO 32000-1:2008, section '12.5.4 Border Styles'

Gets or sets the border dash pattern of the signature appearance. Default value: .

The border dash pattern of the signature appearance. PDF Specification ISO 32000-1:2008, section '12.5.4 Border Styles'

Gets or sets the border color of the signature appearance. Default value: .

The border color of the signature appearance. The value's is not device color space (, , or ). PDF Specification ISO 32000-1:2008, section '12.5.6.19 Widget Annotations'

Gets or sets the background color of the signature appearance. Default value: .

The background color of the signature appearance. The value's is not device color space (, , or ). PDF Specification ISO 32000-1:2008, section '12.5.6.19 Widget Annotations'

Gets or sets the font color of the signature appearance text. Default value: Black.

The font color of the signature appearance text.

Gets or sets the font size of the signature appearance text. A zero value for size means that the font shall be auto-sized: its size shall be computed as a function of the size of the annotation rectangle. Default value: 10 points.

The font size of the signature appearance text. Value is either , or . Value is less than 0.

Gets or sets the font face of the signature appearance text. Default value: Helvetica.

The font face of the signature appearance text. Value is .

Gets or sets the font of the signature appearance text. Default value: Helvetica of size 10 points.

The font of the signature appearance text. Value is .

Gets or sets the font family of the signature appearance text. Default value: Helvetica.

The font family of the signature appearance text. Value is .

Gets or sets the font style of the signature appearance text. Default value: .

The font style of the signature appearance text.

Gets or sets the font weight of the signature appearance text. Default value: .

The font weight of the signature appearance text.

Gets or sets the font stretch of the signature appearance text. Default value: .

The font stretch of the signature appearance text.

Gets or sets a value indicating whether the is transient and thus not serialized to the PDF file. Default value: .

if the is transient and thus not serialized to the PDF file; otherwise, . This property is useful to reduce the size of the PDF file since the won't be embedded in the PDF file.

Gets or sets the text alignment of the signature appearance text. Default value: .

The text alignment of the signature appearance text. , and alignments are supported for annotation's appearance text.

Gets or sets the placement of the signature text relative to the . Default value: .

The placement of the signature text relative to the .

Gets or sets the number that shall be between 0.0 and 1.0 indicating the fraction of the annotation rectangle size to allocate for the text. The rest is allocated for the . Applicable only if is not . Default value: 0.5.

The number that shall be between 0.0 and 1.0 indicating the fraction of the annotation rectangle size to allocate for the text. Value's and must be between 0.0 and 1.0 (inclusive).

Gets or sets the two numbers that shall be between 0.0 and 1.0 indicating the fraction of leftover space to allocate at the left and bottom of the signature appearance text bounds. A value of (0.0, 0.0) shall position the signature appearance text bounds at the bottom-left corner of the annotation rectangle. A value of (0.5, 0.5) shall center it within the rectangle. If is 0 or if is and the signature appearance text overflows then the scaled signature appearance text might allocate the entire leftover space at the left or at the bottom (or both) of the signature appearance text bounds and the alignment specified in that direction won't have any effect. Default value: (0, 1). This positions the signature appearance text bounds at the top-left corner of the annotation rectangle.

The two numbers that shall be between 0.0 and 1.0 indicating the fraction of leftover space to allocate at the left and bottom of the signature appearance text bounds. Value's and must be between 0.0 and 1.0 (inclusive).

Gets or sets the optional signature icon. Default value: .

The optional signature icon.

Gets or sets the condition under which the shall be scaled inside the annotation rectangle. Default value: .

The condition under which the shall be scaled inside the annotation rectangle.

to scale the to fit the width or height of the annotation rectangle while maintaining the icon's original aspect ratio.; otherwise, .

The two numbers that shall be between 0.0 and 1.0 indicating the fraction of leftover space to allocate at the left and bottom of the . Value's and must be between 0.0 and 1.0 (inclusive).

Gets or sets the background layer. This layer renders the background and border of the signature field. The properties that specify the background and border exist in the . Default value: a instance that renders the background and border of the signature field as specified by the background and border properties from this .

The background layer. Form's bounding box must have a default origin (left and bottom must be zero) and size equal to the size of the signature field bounds. Layer n0 Defining a custom PdfSignatureAppearance

Gets or sets the validity layer used for 'Signature valid' and 'Validity unknown' states. If this property is set to a non- value, then also property must be set to a non- value for Adobe Reader to show the run-time created signature validity icon. At runtime, Adobe Reader replaces the with the dynamically created 100 pt x 100 pt layer that shows either 'Signature valid' icon or 'Validity unknown' icon, depending on the state of the signature validity. Default value: .

The validity layer used for 'Signature valid' and 'Validity unknown' states. Prior to Adobe Acrobat 6.0 (released in July 2003), signature appearances were manipulated at run-time in order to display the validity of the signature. The validity was shown as a graphic icon and with an additional, optional text message. The manipulated portions of the signature appearance were contained in , and . Beginning with version 6, Adobe Acrobat does not maintain support for signature appearances that can be manipulated, though legacy signatures with these appearances may continue to display correctly. Use of , , and is not recommended because support of these layers in future versions of Adobe Acrobat may be discontinued at any time. Some applications will specifically warn against the presence of signatures with these layers because, for conformance with various signed document standards, signature appearances should be static. Standard AP dictionary and layers Defining a custom PdfSignatureAppearance

Gets or sets the transformation applied to the . Useful to reposition and resize the . Default value: .

The transformation applied to the . Standard AP dictionary and layers Defining a custom PdfSignatureAppearance

Gets or sets the signature appearance layer, containing information about the signature. This layer renders the information about the signature. The properties that specify the font, color and the rest of the information exist in the and the associated . Default value: if is not , a instance that renders the information about the signature as specified by the font, color, and other properties from this and the associated ; otherwise, .

The signature appearance layer, containing information about the signature. Form's bounding box must have a default origin (left and bottom must be zero) and size equal to the size of the signature field bounds. Layer n2 Defining a custom PdfSignatureAppearance

Gets or sets the validity layer used for the 'Signature invalid' state. If this property is set to a non- value, then also property must be set to a non- value for Adobe Reader to show the run-time created signature validity icon. At runtime, Adobe Reader replaces the with the dynamically created 100 pt x 100 pt layer that shows 'Signature invalid' icon if the signature is invalid. Default value: .

The validity layer used for the 'Signature invalid' state. Prior to Adobe Acrobat 6.0 (released in July 2003), signature appearances were manipulated at run-time in order to display the validity of the signature. The validity was shown as a graphic icon and with an additional, optional text message. The manipulated portions of the signature appearance were contained in , and . Beginning with version 6, Adobe Acrobat does not maintain support for signature appearances that can be manipulated, though legacy signatures with these appearances may continue to display correctly. Use of , , and is not recommended because support of these layers in future versions of Adobe Acrobat may be discontinued at any time. Some applications will specifically warn against the presence of signatures with these layers because, for conformance with various signed document standards, signature appearances should be static. Standard AP dictionary and layers Defining a custom PdfSignatureAppearance

Gets or sets the transformation applied to the . Useful to reposition and resize the . Default value: .

The transformation applied to the . Standard AP dictionary and layers Defining a custom PdfSignatureAppearance

Gets or sets the text layer used for a text representation of the state of the signature. If this property is set to a non- value, then also and properties must be set to a non- value for Adobe Reader to show the run-time created signature validity text message. At runtime, Adobe Reader replaces the with the dynamically created layer of the same size that shows the signature validity text message. Default value: .

The text layer used for a text representation of the state of the signature. Prior to Adobe Acrobat 6.0 (released in July 2003), signature appearances were manipulated at run-time in order to display the validity of the signature. The validity was shown as a graphic icon and with an additional, optional text message. The manipulated portions of the signature appearance were contained in , and . Beginning with version 6, Adobe Acrobat does not maintain support for signature appearances that can be manipulated, though legacy signatures with these appearances may continue to display correctly. Use of , , and is not recommended because support of these layers in future versions of Adobe Acrobat may be discontinued at any time. Some applications will specifically warn against the presence of signatures with these layers because, for conformance with various signed document standards, signature appearances should be static. Standard AP dictionary and layers Defining a custom PdfSignatureAppearance

Gets or sets the transformation applied to the . Useful to reposition and resize the . Default value: .

The transformation applied to the . Standard AP dictionary and layers Defining a custom PdfSignatureAppearance

Updates the appearance of widget annotation associated with the current based on the specified , , and properties of this .

The signer.

Returns a Unicode text contained in this .

A Unicode text contained in this .

Represents the content of the . For public-key signatures, should be either a DER-encoded PKCS#1 binary data object (octet string) or a DER-encoded CMS binary data object. For document timestamp signatures, shall be the TimeStampToken as specified in RFC 3161 as updated by RFC 5816. The value of the messageImprint field within the TimeStampToken shall be a hash of the bytes of the document indicated by the ByteRange and the ByteRange shall specify the complete PDF file contents (excepting the value).

PDF Specification ISO 32000-1:2008, section '12.8 Digital Signatures' PDF Specification ISO 32000-1:2008, section '12.8.3 Signature Interoperability' RFC 8017: PKCS #1: RSA Cryptography Specifications Version 2.2 RFC 5652: Cryptographic Message Syntax (CMS) Internet X.509 Public Key Infrastructure Time-Stamp Protocol (TSP)

Gets the signer certificate contained in the .

The signer certificate contained in the .

Gets the (potentially partial) validation-related information (certificates, certificate revocation lists and Online Certificate Status Protocol responses) contained in the .

The (potentially partial) validation-related information (certificates, certificate revocation lists and Online Certificate Status Protocol responses) contained in the .

Gets the hash algorithm used to hash the contents of a PDF file upon which the signature's is computed by .

The hash algorithm used to hash the contents of a PDF file upon which the signature's is computed by .

Gets the RSA signature padding used if signer's certificate has an 'RSA' public key.

The RSA signature padding used if signer's certificate has an 'RSA' public key.

Gets the signature policy identifier contained in the or if signature doesn't contain a policy identifier.

The signature policy identifier contained in the or if signature doesn't contain a policy identifier.

Gets the signature value.

The signature value.

Gets the timestamp token contained in the or if signature doesn't contain a timestamp.

The timestamp token contained in the or if signature doesn't contain a timestamp.

Gets the copy of raw data of a .

The copy of raw data of the as a byte array.

Gets the hash over which the signature was computed, if the hash is contained in the ; otherwise, . If the is a DER-encoded PKCS#1 binary data object (octet string) and conforms to PKCS#1 standard, the hash is because it not contained in the signature and is . If the is a DER-encoded CMS binary data object and conforms to RFC 5652 Cryptographic Message Syntax, the hash is either the value of the encapContentInfo field within the SignedData (if eContent field within the EncapsulatedContentInfo is not empty, in which case is because the is in the format) or the value of the MessageDigest signed attribute (if present). If the is a TimeStampToken as specified in RFC 3161 as updated by RFC 5816, the hash is the value of the messageImprint field within the TimeStampToken.

The hash algorithm that was used to compute the returned hash. The hash over which the signature was computed, if the hash is contained in the ; otherwise, .

Returns a that represents this instance.

A that represents this instance. This method should be used primarily for debugging purposes and should be considered volatile (format of its return value might change in future versions).

Represents a signature field (PDF 1.3) which is a form field that contains a digital signature (see 12.8, "Digital Signatures").

Digital signature examples

Gets the value.

The value.

Gets the appearance settings for this .

The appearance settings for this . Visible digital signature example

Gets or sets the value as an instance of the type. Setting this property, gets automatically updated.

The value as an instance of the type. The can be set to only (thus removing the from the ). To set a non- value, use any method instead. Remove digital signature example

If set, the field shall have a value at the time it is exported by a submit-form action (see 12.7.5.2, "Submit-Form Action").

If set, the field shall have a value at the time it is exported by a submit-form action. PDF Specification ISO 32000-1:2008, section '12.7.3 Field Dictionaries'

Gets or sets the set of form fields whose change invalidate the signature.

The set of form fields whose change invalidate the signature. The can be set to only (thus removing the entry from the ). To set a non- value, use any method instead. PDF Specification ISO 32000-1:2008, section '12.7.4.5 Signature Fields'

Sets the set of form fields whose change invalidate the signature to a predefined value that represents all fields in the document.

The set of form fields whose change invalidate the signature.

Sets the set of form fields whose change invalidate the signature to either those specified in the (if is ) or all fields except those specified in the (if is ).

if set to , then the set of form fields whose change invalidate the signature is set to all fields except those specified in the ; otherwise, it is set to those specified in the . The field names. The set of form fields whose change invalidate the signature. The parameter is either or an empty sequence.

Sets the set of form fields whose change invalidate the signature to either those specified in the (if is ) or all fields except those specified in the (if is ).

if set to , then the set of form fields whose change invalidate the signature is set to all fields except those specified in the ; otherwise, it is set to those specified in the . The fields. The set of form fields whose change invalidate the signature. The parameter is either or an empty sequence.

Sets the set of form fields whose change invalidate the signature to either those specified in the (if is ) or all fields except those specified in the (if is ).

if set to , then the set of form fields whose change invalidate the signature is set to all fields except those specified in the ; otherwise, it is set to those specified in the . The fields. The set of form fields whose change invalidate the signature. The parameter is either or an empty sequence.

Sets the set of form fields whose change invalidate the signature to those specified in the .

The field names. The set of form fields whose change invalidate the signature. The parameter is either or an empty sequence.

Sets the set of form fields whose change invalidate the signature to those specified in the .

The field names. The set of form fields whose change invalidate the signature. The parameter is either or an empty sequence.

Sets the set of form fields whose change invalidate the signature to those specified in the .

The fields. The set of form fields whose change invalidate the signature. The parameter is either or an empty sequence.

Sets the set of form fields whose change invalidate the signature to those specified in the .

The fields. The set of form fields whose change invalidate the signature. The parameter is either or an empty sequence.

Initiate signing of a PDF file with a digital ID available as a file with the specified file name and the password protecting the private key. The most common format for such files is a PKCS#12 file, which uses .pfx or .p12 file extension and is a password protected storage container for digital IDs containing the public key (Certificate) and the associated private key. The name of the preferred signature handler to use when validating the signature (Filter entry) is Adobe.PPKLite, the of the returned instance is and the is set to the internally estimated size. To finish the signing, call any of the . Next signing cannot be initiated before the current one is not finished. The returned is set to the thus automatically updating the . If your project doesn't target Windows platform, to use this method, make sure your project references NuGet package System.Security.Cryptography.Pkcs. If the is not , then the method re-signs the PDF file directly and the should not be called. This behavior enables delay-sign and re-sign scenarios.

The name of a digital ID file that contains the public key (Certificate) and the associated private key. The password protecting the private key. A instance that contains signature properties (the time of signing, the name of the person or authority signing the document, the reason for the signing, the CPU host name or physical location of the signing); key information (the signing certificate used to verify the signature value and, optionally, other certificates used to verify the authenticity of the signing certificate); reference (describes the exact byte range for the digest calculation); and signature value (usually a DER-encoded PKCS#7 binary data object that conforms to RFC 5652 Cryptographic Message Syntax). This is not contained in the of this PDF document. -or- Signing/timestamping of the PDF file has already been initiated on some in this PDF document. Finish that signing/timestamping by calling any of the before initiating a new signing/timestamping on this . Digital signature examples

Initiate signing of a PDF file with a digital ID from the specified source. The digital ID source is either an instance of a with a private key or an instance of a . The name of the preferred signature handler to use when validating the signature (Filter entry) is Adobe.PPKLite, the of the returned instance is and the is set to the internally estimated size. To finish the signing, call any of the . Next signing cannot be initiated before the current one is not finished. The returned is set to the thus automatically updating the . If your project doesn't target Windows platform, to use this method, make sure your project references NuGet package System.Security.Cryptography.Pkcs. If the is not , then the method re-signs the PDF file directly and the should not be called. This behavior enables delay-sign and re-sign scenarios.

The digital ID source that is either an instance of a with a private key or an instance of a . A instance that contains signature properties (the time of signing, the name of the person or authority signing the document, the reason for the signing, the CPU host name or physical location of the signing); key information (the signing certificate used to verify the signature value and, optionally, other certificates used to verify the authenticity of the signing certificate); reference (describes the exact byte range for the digest calculation); and signature value (usually a DER-encoded PKCS#7 binary data object that conforms to RFC 5652 Cryptographic Message Syntax). The parameter is not an instance of a or a . This is not contained in the of this PDF document. -or- Signing/timestamping of the PDF file has already been initiated on some in this PDF document. Finish that signing/timestamping by calling any of the before initiating a new signing/timestamping on this . Digital signature examples

Initiate signing of a PDF file using the specified delegate that does the actual signing in a format specified by . The length of the signature returned by the delegate must be less than . The name of the preferred signature handler to use when validating the signature (Filter entry) is Adobe.PPKLite, the of the returned instance is and the is bytes. To finish the signing, call any of the . Next signing cannot be initiated before the current one is not finished. The returned is set to the thus automatically updating the . If the is not , then the method re-signs the PDF file directly and the should not be called. This behavior enables delay-sign and re-sign scenarios.

The signer delegate called when saving the PDF file that takes the PDF file stream (without entry) as an input and returns the signature that will be set as the value of the entry. The encoding of the signature value and key information in the signature dictionary. The estimated length of the entry (in bytes) that should be large enough to contain the entire data returned by the delegate. A instance that contains signature properties (the time of signing, the name of the person or authority signing the document, the reason for the signing, the CPU host name or physical location of the signing); key information (the signing certificate used to verify the signature value and, optionally, other certificates used to verify the authenticity of the signing certificate); reference (describes the exact byte range for the digest calculation); and signature value (usually a DER-encoded PKCS#7 binary data object that conforms to RFC 5652 Cryptographic Message Syntax). is . This is not contained in the of this PDF document. -or- Signing/timestamping of the PDF file has already been initiated on some in this PDF document. Finish that signing/timestamping by calling any of the before initiating a new signing/timestamping on this . External digital signature example

Initiate signing of a PDF file using the specified that does the actual signing in a format specified by . The length of the signature returned by the must be less than . The name of the preferred signature handler to use when validating the signature (Filter entry) is Adobe.PPKLite, the of the returned instance is and the is bytes. To finish the signing, call any of the . Next signing cannot be initiated before the current one is not finished. The returned is set to the thus automatically updating the . If the is not , then the method re-signs the PDF file directly and the should not be called. This behavior enables delay-sign and re-sign scenarios.

The signer whose method is called when saving the PDF file that takes the PDF file stream (without entry) as an input and returns the signature that will be set as the value of the entry. A instance that contains signature properties (the time of signing, the name of the person or authority signing the document, the reason for the signing, the CPU host name or physical location of the signing); key information (the signing certificate used to verify the signature value and, optionally, other certificates used to verify the authenticity of the signing certificate); reference (describes the exact byte range for the digest calculation); and signature value (usually a DER-encoded PKCS#7 binary data object that conforms to RFC 5652 Cryptographic Message Syntax). is . This is not contained in the of this PDF document. -or- Signing/timestamping of the PDF file has already been initiated on some in this PDF document. Finish that signing/timestamping by calling any of the before initiating a new signing/timestamping on this . Digital signature examples

Initiate timestamping of a PDF file using the specified that does the actual timestamping. The length of the timestamp token returned by the must be less than . The name of the preferred signature handler to use when validating the signature (Filter entry) is Adobe.PPKLite, the of the returned instance is and the is bytes. To finish the timestamping, call any of the . Next signing or timestamping cannot be initiated before the current one is not finished.

The timestamper whose method is called when saving the PDF file that takes the PDF file stream (without entry) as an input and returns the timestamp token that will be set as the value of the entry. A instance that will contain TimeStampToken as specified in RFC 3161 as updated by RFC 5816. The value of the messageImprint field within the TimeStampToken shall be a hash of the bytes of the document indicated by the ByteRange and the ByteRange shall specify the complete PDF file contents (excepting the value). is . This is not contained in the of this PDF document. -or- Signing/timestamping of the PDF file has already been initiated on some in this PDF document. Finish that signing/timestamping by calling any of the before initiating a new signing/timestamping on this . PAdES B-LTA level example

Represents an encoding of the signature value and key information in the signature dictionary.

PDF Specification ISO 32000-1:2008, section '12.8.3 Signature Interoperability' PDF Advanced Electronic Signature (PAdES) examples

The format is unknown.

The shall be a DER-encoded PKCS#1 binary data object (octet string), conform to PKCS#1 standard and use the RSA algorithm. The certificate chain of the signer shall be stored in the 's Cert entry. PKCS#1 signatures are deprecated with PDF 2.0.

PDF Specification ISO 32000-1:2008, section '12.8.3.2 PKCS#1 Signatures' PKCS #1: RSA Cryptography Specifications Version 2.2

The shall be a DER-encoded CMS binary data object containing the signature and conform to RFC 5652 Cryptographic Message Syntax. The original signed message digest over the document’s byte range shall be incorporated as the normal CMS SignedData field. No data shall be encapsulated in the CMS SignedData field. At minimum the CMS object shall include the signer’s X.509 signing certificate. This certificate shall be used to verify the signature value in .

PDF Specification ISO 32000-1:2008, section '12.8.3.3 PKCS#7 Signatures as used in ISO 32000' Cryptographic Message Syntax (CMS)

The shall be a DER-encoded CMS binary data object containing the signature and conform to RFC 5652 Cryptographic Message Syntax. The SHA1 digest of the document’s byte range shall be encapsulated in the CMS SignedData field with ContentInfo of type Data. The digest of that SignedData shall be incorporated as the normal CMS digest. At minimum the CMS object shall include the signer’s X.509 signing certificate. This certificate shall be used to verify the signature value in . PKCS#7 SHA-1 signatures are deprecated with PDF 2.0.

PDF Specification ISO 32000-1:2008, section '12.8.3.3 PKCS#7 Signatures as used in ISO 32000' Cryptographic Message Syntax (CMS)

(PDF 2.0) The shall be a DER-encoded CMS binary data object containing the signature, conform to RFC 5652 Cryptographic Message Syntax and follow one of two profiles denoted as PAdES-E-BES (Basic Electronic Signature) and PAdES-E-EPES (Explicit Policy Electronic Signature). These are defined to be compatible with the corresponding profiles defined in ETSI EN 319 122-2 (i.e., CAdES-E-BES and CAdES-E-EPES, respectively).

Cryptographic Message Syntax (CMS)

(PDF 2.0) Signature is a document timestamp. The shall be the TimeStampToken as specified in RFC 3161 as updated by RFC 5816. The value of the messageImprint field within the TimeStampToken shall be a hash of the bytes of the document indicated by the ByteRange and the ByteRange shall specify the complete PDF file contents (excepting the value).

ETSI EN 319 142-1, section '5.4.3 Document Time-stamp'

Represents levels of PDF Advanced Electronic Signature (PAdES) baseline signatures, intended to facilitate interoperability and to encompass the life cycle of PAdES signature. The levels and are appropriate where the technical validity of signature needs to be preserved for a period of time after signature creation where certificate expiration, revocation and/or algorithm obsolescence is of concern. level targets long term availability and integrity of the validation material of digital signatures over long term. The B-LTA level can help to validate the signature beyond many events that limit its validity (for instance, the weakness of used cryptographic algorithms, or expiration of validation data). The use of B-LTA level is considered an appropriate preservation and transmission technique for signed data.

PAdES baseline signatures Extended PAdES signature profiles PDF Advanced Electronic Signature (PAdES) examples

Profile for CMS digital signatures in PDF (see also legacy PDF Advanced Electronic Signature Basic based on ISO 32000-1) is under this level. must satisfy the following requirements: must be either or .

PDF Advanced Electronic Signature baseline signature B-B level. B-B level provides requirements for the incorporation of signed and some unsigned attributes when the signature is generated. The main requirement is the protection of the signing certificate by the signature itself (the signing certificate digest is incorporated as part of a signed attribute to the signature). This allows to counter the certificate substitution attack. The main requirement is also present in extended levels: PAdES Enhanced Basic Electronic Signature (PAdES-E-BES and legacy PAdES-E-BES) and PAdES Enhanced Explicit Policy Electronic Signature (PAdES-E-EPES and legacy PAdES-E-EPES). must satisfy the following requirements: must be . cannot contain any CRL or OCSP response. cannot be . If is not , then must be .

PDF Advanced Electronic Signature baseline signature B-T level. B-T level, in addition to B-B level requirements, provides requirements for the generation and inclusion (for an existing signature) of a trusted token proving that the signature itself actually existed at a certain date and time. Generated timestamp token is either incorporated as a part of a signed attribute to the signature or included (for an existing signature) as a content of a signature dictionary (whose Type entry has a value of DocTimeStamp) that is a value of a signature field added as an incremental update. must satisfy the following requirements: must be . cannot contain any CRL or OCSP response. cannot be . If is not , then must be . cannot be .

PDF Advanced Electronic Signature baseline signature B-LT level. B-LT level, in addition to B-T level requirements, provides requirements for the incorporation of all the material required for validating the signature in the signature document. This level aims to tackle the long term availability of the validation material. Validation related information (VRI) for a signature includes: The full set of certificates, including the trust anchor when it is available in the form of a certificate, that have been used to validate the signature and which are not already present. This set includes certificates required for validating the signing certificate, for validating any attribute certificate present in the signature, and for validating any time-stamp token's signing certificate (i.e. a TSA certificate) already incorporated to the signature. The full set of revocation data (CRL or OCSP responses) that have been used in the validation of the signer and CA certificates used in signature. This set includes all certificate status information required for validating the signing certificate, for validating any attribute certificate present in the signature, and for validating any time-stamp token's signing certificate (i.e. a TSA certificate) already incorporated to the signature. This information is stored in a Document Security Store (DSS) dictionary. must satisfy the following requirements: must be . cannot contain any CRL or OCSP response. cannot be . If is not , then must be . cannot be .

PDF Advanced Electronic Signature baseline signature B-LTA level. B-LTA level, in addition to B-LT level requirements, provides requirements for the incorporation of electronic time-stamps that allow validation of the signature long time after its generation. This level aims to tackle the long term availability and integrity of the validation material. Validation related information (VRI) is stored in a Document Security Store (DSS) dictionary and generated timestamp token is included as a content of a signature dictionary (whose Type entry has a value of DocTimeStamp) that is a value of a signature field added as an incremental update. This requirement is also present in the extended level PAdES Enhanced Long Term Validation (PAdES-E-LTV and legacy PAdES-E-LTV). must satisfy the following requirements: must be . cannot contain any CRL or OCSP response. cannot be . If is not , then must be . cannot be .

Specifies what changes, made to the document after the signature was applied, invalidate the signature. The is specified by a certification signature (also known as an author signature) (PDF 1.5) which shall be the value of the first signed field in the document. It enables the author to specify what changes made to the document invalidate the author's signature. The is specified by either a certification signature or a regular, approval signature (also known as a recipient signature). It enables the signer to specify a set of form fields whose change invalidate the signature. Other set of changes, such as those that invalidate a usage rights signature or an FDF file signature (the Identity transform method), are currently not exposed because they are deprecated.

PDF Specification ISO 32000-1:2008, section '12.8.2 Transform Methods' Adobe Acrobat 9 Digital Signatures, Changes and Improvements

Gets the permission, specified by a certification signature (also known as an author signature) (PDF 1.5), with which the author specifies what changes made to the document invalidate the author's signature. If the value is , then the signature does not specify a DocMDP transform method in this , but some other. To set the , sign the with a whose is not .

The permission, specified by a certification signature (also known as an author signature), with which the author specifies what changes made to the document invalidate the author's signature. PDF Specification ISO 32000-1:2008, section '12.8.2.2 DocMDP'

Gets the set of form fields, specified by either a certification signature or a regular, approval signature (also known as a recipient signature), whose change invalidate the signature. If the value is , then the signature does not specify a FieldMDP transform method in this , but some other. To set the , use any method before signing on a that holds the signature.

The set of form fields, specified by either a certification signature or a regular, approval signature (also known as a recipient signature), whose change invalidate the signature. PDF Specification ISO 32000-1:2008, section '12.8.2.4 FieldMDP'

Represents a set of form fields whose change invalidate the signature.

PDF Specification ISO 32000-1:2008, section '12.7.4.5 Signature Fields' PDF Specification ISO 32000-1:2008, section '12.8.2.4 FieldMDP'

Gets or sets a value indicating whether the change of any form field in the document invalidate the signature.

if the change of any form field in the document invalidate the signature; otherwise, .

Gets or sets a value indicating whether the change of any form field NOT contained in this invalidate the signature.

if the change of any form field NOT contained in this invalidate the signature; otherwise, .

(Optional; PDF 2.0) The access permissions granted for this document. Valid values shall be: - No changes to the document are permitted; any change to the document shall invalidate the signature. - Permitted changes shall be filling in forms, instantiating page templates, and signing; other changes shall invalidate the signature. - Permitted changes are the same as for , as well as annotation creation, deletion, and modification; other changes shall invalidate the signature. The default value, , shall result in no effect on signature validation rules. If the is already in effect from an earlier incremental save section or the original part of the document (via ), the value shall specify permission less than or equal to the permission already in effect based on signatures earlier in the document. That is, permission can be denied but not added. If the value specifies greater permission than a value already in effect, the new value is ignored. If the document does not have an author signature ( is ), the initial permission in effect is those based on the . The new permission applies to any incremental changes to the document following the signature of which this is part.

The access permissions granted for this document. Supported are , , and . Adobe Acrobat 9 Digital Signatures, Changes and Improvements

Adds a of the to the end of the .

The whose is to be added to the end of the . field is . The property of a must be set (to either or ) before the can be modified.

A signature policy defines the rules for creation and validation of an electronic signature, and is included as a signed attribute with every PAdES Enhanced Explicit Policy Electronic Signature (PAdES-E-EPES and legacy PAdES-E-EPES).

ETSI EN 319 122-1 V1.0.0 (2015-06) ETSI TS 101 733 V2.2.1 (2013-04) RFC 5126: CMS Advanced Electronic Signatures (CAdES), section '5.8.1. signature-policy-identifier'

Initializes a new instance of the class.

The OID of the signature policy.

Initializes a new instance of the class.

The OID of the signature policy. The optional URI or URL where a copy of the signature policy document can be obtained.

Gets the OID of the signature policy.

The OID of the signature policy.

Represents a container that shall contain validation-related information (VRI) for one signature in the document that a given signature handler or PDF processor has used to successfully validate the given signature. A shall reference: a selection of certificates from the in the applicable to the signature; a selection of certificate revocation lists (CRLs) from the in the applicable to the signature, if any; a selection of Online Certificate Status Protocol (OCSP) responses from the in the applicable to the signature.

Signature VRI Dictionary Digital signature examples PAdES B-LT level example

Gets the read-only collection of X.509 certificates used in the validation of the signature. Each certificate shall also be included in of the .

The read-only collection of X.509 certificates used in the validation of the signature.

Gets the read-only collection of X.509 Certificate Revocation Lists (CRLs) used to determine the validity of the certificates in the chains related to the signature. Each certificate revocation list shall also be included in of the .

The read-only collection of X.509 Certificate Revocation Lists (CRLs) used to determine the validity of the certificates in the chains related to the signature.

Gets the read-only collection of X.509 Online Certificate Status Protocol (OCSP) responses used to determine the validity of the certificates in the chains related to the signature. Each Online Certificate Status Protocol (OCSP) response shall also be included in of the .

The read-only collection of X.509 Online Certificate Status Protocol (OCSP) responses used to determine the validity of the certificates in the chains related to the signature.

Initializes a new instance of the class.

The X.509 certificates used in the validation of the signature. The X.509 Certificate Revocation Lists (CRLs) used to determine the validity of the certificates in the chains related to the signature. The X.509 Online Certificate Status Protocol (OCSP) responses used to determine the validity of the certificates in the chains related to the signature. , or contains a item.

Returns a that represents this instance.

A that represents this instance. This method should be used primarily for debugging purposes and should be considered volatile (format of its return value might change in future versions).

Represents a result of a validation.

Digital signature validation example

Returns true if the is valid; otherwise, .

if the is valid; otherwise, .

Returns a that represents this instance.

A that represents this instance. This method should be used primarily for debugging purposes and should be considered volatile (format of its return value might change in future versions).

Represents a signer that computes the content of a digital signature in a format specified by .

PDF Specification ISO 32000-1:2008, section '12.8 Digital Signatures' PDF Specification ISO 32000-1:2008, section '12.8.3 Signature Interoperability' Digital signature examples

Initializes a new instance of the class. Used if the contents of a PDF signature is created externally in which case property and method must be overridden.

Initializes a new instance of the class with a digital ID available as a file with the specified file name and the password protecting the private key. The most common format for such files is a PKCS#12 file, which uses .pfx or .p12 file extension and is a password protected storage container for digital IDs containing the public key (Certificate) and the associated private key.

The name of a digital ID file that contains the public key (Certificate) and the associated private key. The password protecting the private key.

Initializes a new instance of the class with a digital ID from the specified source. The digital ID source is either an instance of a with a private key or an instance of a .

The digital ID source that is either an instance of a with a private key or an instance of a . The parameter is not an instance of a or a .

Initializes a new instance of the class with the specified digital ID.

The digital ID used to sign documents. The certificate that comes with your digital ID is sent to others so that they can verify your signature. is . The of the is .

Gets the digital ID used to sign documents. The certificate that comes with your digital ID is sent to others so that they can verify your signature.

The digital ID used to sign documents.

Gets or sets the format of the that this signer produces. The must be if is set to or higher. Default value: .

The format of the that this signer produces. Value must be , , or (required if is or higher). Values and are deprecated. Instead of value , method should be used. Signer's certificate doesn't have an 'RSA' public key so value cannot be . PDF Advanced Electronic Signature (PAdES) examples

Gets or sets the level of the PDF Advanced Electronic Signature (PAdES) that signature created by this signer must satisfy. Default value: . If is set to: or higher, then must be , must be specified, and cannot both be specified and , if specified, cannot contain any CRL or OCSP response (because this information is added to the signature as 'adbe-revocationInfoArchival' signed attribute which or higher doesn't allow). or higher, then must be specified. or higher, then check that validation data is added to the security store is not performed since that can be done only after signing finishes. or higher, then check that validation data is added to the security store and that validation data is protected by document timestamp is not performed since that can be done only after signing finishes.

The level of the PDF Advanced Electronic Signature that signature created by this signer must satisfy. One of the conditions specified in the description of this member is not satisfied. PDF Advanced Electronic Signature (PAdES) examples

Gets or sets the hash algorithm that hashes the bytes of the document indicated by the ByteRange and the ByteRange shall specify the complete PDF file contents (excepting the value). Default value: .

The hash algorithm that hashes the bytes of the document indicated by the ByteRange. The specified hash algorithm value is not supported for creating a digital signature or signer's certificate has a 'DSA' public key and the specified value is not .

Gets or sets the RSA signature padding to use if signer's certificate has an 'RSA' public key. Default value: . If signer's certificate has an 'RSA' public key, is used.

The RSA signature padding to use if signer's certificate has an 'RSA' public key. Signer's certificate doesn't have an 'RSA' public key so RSA signature padding must be or signature format is so RSA signature padding must be .

Gets or sets the timestamper used to retrieve the TimeStampToken as specified in RFC 3161 as updated by RFC 5816 for the signature field within SignerInfo for the CMS-based that will be added as a unsigned attribute to the SignerInfo. The must be specified if is set to or higher. The is ignored if is set to . Default value: (no timestamp will be embedded in the signature).

The timestamper used to retrieve the TimeStampToken as specified in RFC 3161 as updated by RFC 5816 for the signature field within SignerInfo for the CMS-based that will be added as a unsigned attribute to the SignerInfo. Value is and is or higher. PAdES B-T level example

Gets or sets the (potentially partial) validation-related information (certificates, certificate revocation lists and Online Certificate Status Protocol responses) that should be embedded in the signature. The cannot contain any CRL or OCSP response if is set to or higher. The CRLs and OCSP responses are ignored if is set to . Default value: (only signing certificate will be embedded in the signature).

The (potentially partial) validation-related information (certificates, certificate revocation lists and Online Certificate Status Protocol responses) that should be embedded in the signature. Value contains at least one CRL or OCSP response and is or higher.

Gets or sets the signature policy identifier to use when creating PAdES Enhanced Explicit Policy Electronic Signature (PAdES-E-EPES and legacy PAdES-E-EPES). The and cannot both be specified if is set to or higher. The is ignored if is set to . Default value: .

The signature policy identifier. Value cannot be set if is specified and is or higher.

Gets or sets the name of the person or authority signing the document. Default value: of a certificate associated with .

The name of the person or authority signing the document.

Gets or sets the distinguished name of the person or authority signing the document. Default value: so that distinguished name is not automatically added to the signature's appearance. If set to , default value is distinguished name of a certificate associated with .

The distinguished name of the person or authority signing the document.

Gets or sets the time of signing. The must be specified if is set to or higher. Default value: .

The time of signing. Value is and is or higher.

Gets or sets a value indicating whether to update , and before the is saved to a PDF file. Default value: .

to update , and before the is saved to a PDF file; otherwise, .

Gets or sets the information provided by the signer to enable a recipient to contact the signer to verify the signature. Default value: .

The information provided by the signer to enable a recipient to contact the signer to verify the signature.

Gets or sets the reason for the signing. The and cannot both be specified if is set to or higher. Default value: .

The reason for the signing. Value cannot be set if is specified and is or higher.

Gets or sets the CPU host name or physical location of the signing. Default value: .

The CPU host name or physical location of the signing.

(Optional; PDF 1.5) The name of the software module used to create the signature. When used as an entry in the data dictionary of the Filter attribute (Table 2.1), the value is the name of the signature handler. The value is normally equal to the value of the Filter attribute in the signature dictionary. Default value: .

The name of the software module used to create the signature. is shown in 'Acrobat Reader' when 'Advanced Properties...' button in 'Signature Properties' dialog window is clicked. The Digital Signature Build Properties Dictionary Specification

(Optional; PDF 1.6) A text string indicating the version of the application implementation, as described by the Name attribute in this dictionary. When set by Adobe Acrobat, this entry is in the format: major.minor.micro (for example 7.0.7). Default value: .

A text string indicating the version of the application implementation, as described by the Name attribute in this dictionary. is shown in 'Acrobat Reader' when 'Advanced Properties...' button in 'Signature Properties' dialog window is clicked. The Digital Signature Build Properties Dictionary Specification

Gets or sets the permitted actions after certifying the document with this . If set to a value, then the signature created by this is a regular, approval signature (also known as a recipient signature). Otherwise, the signature created by this is a certification signature (also known as an author signature) (PDF 1.5). A document can contain only one signature field that contains a certification signature; it shall be the first signed field in the document. It enables the author to specify what changes shall be permitted to be made to the document and what changes invalidate the author's signature. The in any of the shall indicate the author's specification of which changes to the document will invalidate the signature. These changes to the document shall also be prevented if the is referred from the property. A value of indicates that the document shall be final; that is, any changes shall invalidate the signature. The values and shall permit modifications that are appropriate for form field or comment workflows. Setting the value to any other is not supported and throws . Default value: .

The permitted actions after certifying the document with this . Supported are , , and . PDF Specification ISO 32000-1:2008, section '12.8.2.2 DocMDP'

Gets the estimated length of the entry (in bytes) that should be large enough to contain the entire data returned by the method. This property supports the GemBox product infrastructure and is not intended to be used directly from your code.

The estimated length of the entry (in bytes) that should be large enough to contain the entire data returned by the method.

A method called when saving the PDF file that takes the PDF file stream (without entry) as an input and returns the signature that will be set as the value of the entry. This method supports the GemBox product infrastructure and is not intended to be used directly from your code.

The PDF file stream (without entry) for which the signature should be computed. The signature that will be set as the value of the entry.

A submit-form action transmits the names and values of selected interactive form fields to a specified uniform resource locator (URL).

PDF Specification ISO 32000-1:2008, section '12.7.5.2 Submit-Form Action' Form Actions example

Gets the value.

The value.

(Required) A uniform resource locator (URL) of the script at the Web server that will process the submission.

A uniform resource locator (URL) of the script at the Web server that will process the submission. Value is or . PDF Specification ISO 32000-1:2008, section '12.7.5.2 Submit-Form Action'

Gets or sets the format in which the PDF form data is exported. Default value: .

The format in which the PDF form data is exported.

Gets the names of the fields that are either included in the submission (if is ) or excluded from the submission (if is ). Applicable only if is .

The names of the fields that are either included in the submission or excluded from the submission.

Gets or sets a value indicating whether fields with no values are excluded from the submission. Default value: .

if fields with no values are excluded from the submission; otherwise, .

Represents a box or space for text fill-in data typically entered from a keyboard.

PDF Specification ISO 32000-1:2008, section '12.7.4.3 Text Fields'

Gets the value.

The value.

Gets or sets the value as an instance of a .

The value as an instance of a .

If set, the field shall have a value at the time it is exported by a submit-form action (see 12.7.5.2, "Submit-Form Action").

If set, the field shall have a value at the time it is exported by a submit-form action. PDF Specification ISO 32000-1:2008, section '12.7.3 Field Dictionaries'

(PDF 1.4) Gets a value indicating whether the text entered in the field represents the pathname of a file whose contents shall be submitted as the value of the field. Default value: .

if the text entered in the field represents the pathname of a file whose contents shall be submitted as the value of the field; otherwise, . PDF Specification ISO 32000-1:2008, section '12.7.4.3 Text Fields'

Gets a value indicating whether the field is intended for entering a secure password that should not be echoed visibly to the screen. Default value: .

if the field is intended for entering a secure password that should not be echoed visibly to the screen; otherwise, . PDF Specification ISO 32000-1:2008, section '12.7.4.3 Text Fields'

(PDF 1.4) Gets a value indicating whether the text entered in the field shall be spell-checked. Default value: .

if the text entered in the field shall be spell-checked; otherwise, . PDF Specification ISO 32000-1:2008, section '12.7.4.3 Text Fields'

Gets a value indicating whether the field may contain multiple lines of text. Default value: .

if the field may contain multiple lines of text; otherwise, . PDF Specification ISO 32000-1:2008, section '12.7.4.3 Text Fields'

(PDF 1.4) Gets a value indicating whether the field shall scroll to accommodate more text than fits within its rectangle. Default value: .

if the field shall scroll to accommodate more text than fits within its rectangle; otherwise, . PDF Specification ISO 32000-1:2008, section '12.7.4.3 Text Fields'

(PDF 1.5) Gets a value indicating whether the value of this field shall be a rich text string. Default value: .

if the value of this field shall be a rich text string; otherwise, . PDF Specification ISO 32000-1:2008, section '12.7.4.3 Text Fields'

Gets the maximum length of the field’s text, in characters. Default value: .

The maximum length of the field’s text, in characters. PDF Specification ISO 32000-1:2008, section '12.7.4.3 Text Fields'

(PDF 1.5) Gets the number of equally spaced positions the field shall be automatically divided into. Default value: .

The number of equally spaced positions the field shall be automatically divided into. May be set only if the , , and properties are set to . PDF Specification ISO 32000-1:2008, section '12.7.4.3 Text Fields'

Represents an appearance settings for a toggle button fields and .

Gets or sets the border thickness of the toggle button appearance.

The border thickness of the toggle button appearance. Value is less than 0. Value is either , or . PDF Specification ISO 32000-1:2008, section '12.5.4 Border Styles'

Gets or sets the border style of the toggle button appearance.

The border style of the toggle button appearance. Value of enumeration is not supported in the requested operation. PDF Specification ISO 32000-1:2008, section '12.5.4 Border Styles'

Gets or sets the border dash pattern of the toggle button appearance.

The border dash pattern of the toggle button appearance. PDF Specification ISO 32000-1:2008, section '12.5.4 Border Styles'

Gets or sets the border color of the toggle button appearance.

The border color of the toggle button appearance. The value's is not device color space (, , or ). PDF Specification ISO 32000-1:2008, section '12.5.6.19 Widget Annotations'

Gets or sets the background color of the toggle button appearance.

The background color of the toggle button appearance. The value's is not device color space (, , or ). PDF Specification ISO 32000-1:2008, section '12.5.6.19 Widget Annotations'

Gets or sets the font color of the toggle button appearance text.

The font color of the toggle button appearance text.

Gets or sets the font size of the toggle button appearance text. A zero value for size means that the font shall be auto-sized: its size shall be computed as a function of the size of the annotation rectangle.

The font size of the toggle button appearance text. Value is either , or . Value is less than 0.

Gets or sets the style of the toggle button appearance. The usual values are: Check ✔ - '\u2714' (default for ) Circle ● - '\u25CF' (default for ) Cross ✘ - '\u2718' Diamond ◆ - '\u25C6' Square ■ - '\u25A0' Star ★ - '\u2605'

The style of the toggle button appearance. Value is .

Represents a base class for button fields that can switch states, such as and .

PDF Specification ISO 32000-1:2008, section '12.7.4.2 Button Fields' Fill in Form example

Gets the appearance settings for this .

The appearance settings for this .

Gets or sets the value as an instance of the type.

The value as an instance of the type.

Gets or sets a value indicating whether this is checked.

if this is checked; otherwise, .

If set, the field shall have a value at the time it is exported by a submit-form action (see 12.7.5.2, "Submit-Form Action").

If set, the field shall have a value at the time it is exported by a submit-form action. PDF Specification ISO 32000-1:2008, section '12.7.3 Field Dictionaries'

Represents an appearance settings for a variable text fields , and .

PDF Specification ISO 32000-1:2008, section '12.7.3.3 Variable Text'

Gets or sets the border thickness of the variable text field appearance.

The border thickness of the variable text field appearance. Value is less than 0. Value is either , or . PDF Specification ISO 32000-1:2008, section '12.5.4 Border Styles'

Gets or sets the border style of the variable text field appearance.

The border style of the variable text field appearance. Value of enumeration is not supported in the requested operation. PDF Specification ISO 32000-1:2008, section '12.5.4 Border Styles'

Gets or sets the border dash pattern of the variable text field appearance.

The border dash pattern of the variable text field appearance. PDF Specification ISO 32000-1:2008, section '12.5.4 Border Styles'

Gets or sets the border color of the variable text field appearance.

The border color of the variable text field appearance. The value's is not device color space (, , or ). PDF Specification ISO 32000-1:2008, section '12.5.6.19 Widget Annotations'

Gets or sets the background color of the variable text field appearance.

The background color of the variable text field appearance. The value's is not device color space (, , or ). PDF Specification ISO 32000-1:2008, section '12.5.6.19 Widget Annotations'

Gets or sets the font color of the field's appearance text.

The font color of the field's appearance text.

Gets or sets the font size of the field's appearance text. A zero value for size means that the font shall be auto-sized: its size shall be computed as a function of the size of the annotation rectangle.

The font size of the field's appearance text. Value is either , or . Value is less than 0.

Gets or sets the font face of the field's appearance text.

The font face of the field's appearance text. Value is .

Gets or sets the text alignment of the field's appearance text.

The text alignment of the field's appearance text. , and alignments are supported for field's appearance text.

Gets or sets the underline text decoration of the field's appearance text.

The underline text decoration of the field's appearance text. The is not preserved in a PDF file when the is saved to a PDF file.

Gets or sets the strikethrough text decoration of the field's appearance text.

The strikethrough text decoration of the field's appearance text. The is not preserved in a PDF file when the is saved to a PDF file.

Gets or sets the line height, or line spacing, between lines of the appearance text (if the is ). Default value: 0 (the default line height is automatically calculated, and is based on the and the ).

The line height, or line spacing, between lines of the appearance text. Value is less than zero.

Represents a base class for variable text fields, such as , and .

PDF Specification ISO 32000-1:2008, section '12.7.3.3 Variable Text'

Gets the appearance settings for this .

The appearance settings for this .

Provides data for the event.

Gets the document on which limit was reached.

The document on which limit was reached.

Gets or sets the choice for proceeding when free limit is reached.

The choice for proceeding when free limit is reached.

Type of action that can be chosen when free limit is reached.

Throw .

Stop reading/writing page contents.

Exception that occurs when free limit is reached.

The exception that is thrown when a contains an invalid . This exception is also thrown when internal runtime implementation limits have been exceeded by the .

Gets the type of the error.

The type of the error.

Type 2 functions (PDF 1.3) include a set of parameters that define an exponential interpolation of one input value and n output values: f(x) = y[0], ..., y[n-1].

PDF Specification ISO 32000-1:2008, section '7.10.3 Type 2 (Exponential Interpolation) Functions'

Initializes a new instance of the class. The property should be subsequently populated and the property should be set.

Gets the value.

The value.

(Optional) A list of n numbers that shall define the function result when x = 0.0. Default value (if ): [0.0].

A list of n numbers that shall define the function result when x = 0.0. PDF Specification ISO 32000-1:2008, section '7.10.3 Type 2 (Exponential Interpolation) Functions'

(Optional) A list of n numbers that shall define the function result when x = 1.0. Default value (if ): [1.0].

A list of n numbers that shall define the function result when x = 1.0. PDF Specification ISO 32000-1:2008, section '7.10.3 Type 2 (Exponential Interpolation) Functions'

(Required) The interpolation exponent. Each input value x shall return n values, given by y[j] = [j] + x^ × ([j] − [j]), for 0 ≤ j < n.

The interpolation exponent. PDF Specification ISO 32000-1:2008, section '7.10.3 Type 2 (Exponential Interpolation) Functions'

PDF provides several types of function objects (PDF 1.2) that represent parameterized classes of functions, including mathematical formulas and sampled representations with arbitrary resolution. Functions in PDF represent static, self-contained numerical transformations. In general, a function can take any number (m) of input values and produce any number (n) of output values: f(x[0], ..., x[m-1]) = y[0], ..., y[n-1] In PDF functions, all the input values and all the output values shall be numbers, and functions shall have no side effects.

Each function definition includes a , the set of legal values for the input. Some types of functions also define a , the set of legal values for the output. Input values passed to the function shall be clipped to the , and output values produced by the function shall be clipped to the . PDF Specification ISO 32000-1:2008, section '7.10 Functions'

Gets the type of the function.

The type of the function. PDF Specification ISO 32000-1:2008, section '7.10 Functions'

(Required) A collection of m s, where m shall be the number of input values. For each i from 0 to m − 1, [i]. shall be less than or equal to [i]., and the ith input value, x[i], shall lie in the interval [i]. ≤ x[i] ≤ [i].. Input values outside the declared domain shall be clipped to the nearest boundary value.

A collection of m s, where m shall be the number of input values. Value is . PDF Specification ISO 32000-1:2008, section '7.10 Functions'

(Required for s and s, optional otherwise) A collection of n s, where n shall be the number of output values. For each j from 0 to n − 1, [j]. shall be less than or equal to [j]., and the jth output value, y[j] , shall lie in the interval [j]. ≤ y[j] ≤ [j].. Output values outside the declared range shall be clipped to the nearest boundary value. If this entry is absent, no clipping shall be done.

A collection of n s, where n shall be the number of output values. PDF Specification ISO 32000-1:2008, section '7.10 Functions'

Compiles the PDF function described by this instance into executable code and produces a delegate that represents the PDF function.

A delegate of type that represents the compiled PDF function described by this instance. The method produces a delegate of type at runtime. When that delegate is executed, it has the behavior described by the semantics of this instance. The method can be used to obtain the value of any PDF function. First, create a PDF function by using any of the -derived types. Then call to obtain a delegate, and execute the delegate to obtain the value of the PDF function.

Compiles the PDF function described by this instance into executable code and produces a delegate that represents the PDF function.

If set to the output array is cached in the compiled form of a PDF function and used for subsequent calculations; otherwise, to return a new output array instance for each calculation. A delegate of type that represents the compiled PDF function described by this instance. The method produces a delegate of type at runtime. When that delegate is executed, it has the behavior described by the semantics of this instance. The method can be used to obtain the value of any PDF function. First, create a PDF function by using any of the -derived types. Then call to obtain a delegate, and execute the delegate to obtain the value of the PDF function.

Represents types of the s.

PDF Specification ISO 32000-1:2008, section '7.10 Functions'

An unknown function that is not supported.

(PDF 1.2) A sampled function (type 0) uses a table of sample values to define the function. Various techniques are used to interpolate values between the sample values; see 7.10.2, "Type 0 (Sampled) Functions".

(PDF 1.3) An exponential interpolation function (type 2) defines a set of coefficients for an exponential function; see 7.10.3, "Type 2 (Exponential Interpolation) Functions".

(PDF 1.3) A stitching function (type 3) is a combination of other functions, partitioned across a domain; see 7.10.4, "Type 3 (Stitching) Functions".

(PDF 1.3) A PostScript calculator function (type 4) uses operators from the PostScript language to describe an arithmetic expression; see 7.10.5, "Type 4 (PostScript Calculator) Functions".

Represents types of errors in a .

The unknown error.

Operand out of bounds.

Operand stack overflow.

Operand stack underflow.

PostScript language syntax error.

Operand of wrong type.

Overflow, underflow, or meaningless result.

Internal error.

A type 4 function (PDF 1.3), also called a PostScript calculator function, shall be represented as a stream containing code written in a small subset of the PostScript language.

PDF Specification ISO 32000-1:2008, section '7.10.5 Type 4 (PostScript Calculator) Functions'

Initializes a new instance of the class. The and properties should be subsequently populated and the property should be set.

Gets the value.

The value.

Gets or sets the PostScript Calculator operation written in a small subset of the PostScript language.

The PostScript Calculator operation written in a small subset of the PostScript language. The PostScript Calculator operation must be an . The scanner has encountered program text that does not conform to the PostScript language syntax rules. PDF Specification ISO 32000-1:2008, section '7.10.5 Type 4 (PostScript Calculator) Functions'

Represents a PostScript operation that may appear in a .

PDF Specification ISO 32000-1:2008, section '7.10.5 Type 4 (PostScript Calculator) Functions' PDF Specification ISO 32000-1:2008, section 'Annex B (normative) Operators in Type 4 Functions'

Initializes a new instance of the structure from the specified PostScript Calculator operator.

The PostScript Calculator operator. The PostScript Calculator operator is not supported.

Initializes a new instance of the structure from the specified constant.

The constant.

Initializes a new instance of the structure from the specified constant.

The constant.

Initializes a new instance of the structure from the specified PostScript Calculator expression.

The PostScript Calculator expression.

Initializes a new instance of the structure from the specified PostScript Calculator expression.

The PostScript Calculator expression.

Gets the PostScript Calculator operator.

The PostScript Calculator operator.

Gets a value indicating whether this instance is an constant.

if this instance is an constant; otherwise, .

Gets the constant, if the is and is ; otherwise, or is thrown.

The constant, if the is and is ; otherwise, or is thrown.

Gets the constant, if the is ; otherwise, is thrown.

The constant, if the is ; otherwise, is thrown.

Gets the PostScript Calculator expression, if the is ; otherwise, is thrown.

The PostScript Calculator expression, if the is ; otherwise, is thrown.

Returns a that represents this instance.

A that represents this instance. This method should be used primarily for debugging purposes and should be considered volatile (format of its return value might change in future versions).

Determines whether the is equal to this instance.

The other PostScript Calculator operation to compare with this PostScript Calculator operation instance. if the is equal to this instance; otherwise, .

Determines whether the specified is equal to this instance.

The to compare with this PostScript Calculator operation instance. if the specified is a and is equal to this instance; otherwise, .

Returns a hash code for this instance.

An integer value that specifies a hash value for this instance.

Determines whether and s are equal.

The first PostScript Calculator operation. The second PostScript Calculator operation. if and PostScript Calculator operations are equal; otherwise, .

Determines whether and s are not equal.

The first PostScript Calculator operation. The second PostScript Calculator operation. if and PostScript Calculator operations are not equal; otherwise, .

Implicitly converts an instance of to an instance of .

The value to be converted. A equal in value to instance of .

Implicitly converts an instance of to an instance of .

The value to be converted. A equal in value to instance of .

Implicitly converts an instance of to an instance of .

The value to be converted. A equal in value to instance of .

Implicitly converts an instance of to an instance of .

The value to be converted. A equal in value to instance of . Array element type must be , , or .

Explicitly converts an instance of to an instance of .

The value to be converted. A equal in value to instance of .

Explicitly converts an instance of to an instance of .

The value to be converted. An equal in value to instance of .

Explicitly converts an instance of to an instance of .

The value to be converted. A equal in value to instance of .

Explicitly converts an instance of to an instance of .

The value to be converted. An equal in value to instance of .

Represents a PostScript operator that may appear in a .

PDF Specification ISO 32000-1:2008, section '7.10.5 Type 4 (PostScript Calculator) Functions' PDF Specification ISO 32000-1:2008, section 'Annex B (normative) Operators in Type 4 Functions'

The PostScript Calculator operator is unknown and not supported. Errors:

Push the number ( or ) constant on the stack. Errors:

Push the expression on the stack. Errors:

num1 num2 add sum returns the sum of num1 and num2. If both operands are integers and the result is within integer range, the result is an integer; otherwise, the result is a real number. Examples 3 4 add ⇒ 7
9.9 1.1 add ⇒ 11.0 Errors: , , See Also: , , , ,

num1 num2 sub difference returns the result of subtracting num2 from num1. If both operands are integers and the result is within integer range, the result is an integer; otherwise, the result is a real number. Errors: , , See Also: , , , ,

num1 num2 mul product returns the product of num1 and num2. If both operands are integers and the result is within integer range, the result is an integer; otherwise, the result is a real number. Errors: , , See Also: , , , ,

num1 num2 div quotient divides num1 by num2, producing a result that is always a real number even if both operands are integers. Use instead if the operands are integers and an integer result is desired. Examples 3 2 div ⇒ 1.5
4 2 div ⇒ 2.0 Errors: , , See Also: , , , ,

int1 int2 idiv quotient divides int1 by int2 and returns the integer part of the quotient, with any fractional part discarded. Both operands of must be integers and the result is an integer. Examples 3 2 idiv ⇒ 1
4 2 idiv ⇒ 2
-5 2 idiv ⇒ -2 Errors: , , See Also: , , , , ,

int1 int2 mod remainder returns the remainder that results from dividing int1 by int2. The sign of the result is the same as the sign of the dividend int1. Both operands must be integers and the result is an integer. Examples 5 3 mod ⇒ 2
5 2 mod ⇒ 1
-5 3 mod ⇒ -2 The last example above demonstrates that is a remainder operation rather than a true modulo operation. Errors: , , See Also: ,

num1 neg num2 returns the negative of num1. The type of the result is the same as the type of num1 unless num1 is the smallest (most negative) integer, in which case the result is a real number. Examples 4.5 neg ⇒ -4.5
-3 neg ⇒ 3 Errors: , See Also:

num1 abs num2 returns the absolute value of num1. The type of the result is the same as the type of num1 unless num1 is the smallest (most negative) integer, in which case the result is a real number. Examples 4.5 abs ⇒ 4.5
-3 abs ⇒ 3
0 abs ⇒ 0 Errors: , See Also:

num1 ceiling num2 returns the least integer value greater than or equal to num1. The type of the result is the same as the type of the operand. Examples 3.2 ceiling ⇒ 4.0
–4.8 ceiling ⇒ –4.0
99 ceiling ⇒ 99 Errors: , See Also: , , ,

num1 floor num2 returns the greatest integer value less than or equal to num1. The type of the result is the same as the type of the operand. Examples 3.2 floor ⇒ 3.0
–4.8 floor ⇒ –5.0
99 floor ⇒ 99 Errors: , See Also: , , ,

num1 round num2 returns the integer value nearest to num1. If num1 is equally close to its two nearest integers, returns the greater of the two. The type of the result is the same as the type of the operand. Examples 3.2 round ⇒ 3.0
6.5 round ⇒ 7.0
-4.8 round ⇒ -5.0
-6.5 round ⇒ -6.0
99 round ⇒ 99 Errors: , See Also: , , ,

num1 truncate num2 truncates num1 toward 0 by removing its fractional part. The type of the result is the same as the type of the operand. Examples 3.2 truncate ⇒ 3.0
-4.8 truncate ⇒ -4.0
99 truncate ⇒ 99 Errors: , See Also: , , ,

num sqrt real returns the square root of num, which must be a nonnegative number. The result is a real number. Errors: , , See Also:

angle sin real returns the sine of angle, which is interpreted as an angle in degrees. The result is a real number. Errors: , See Also: ,

angle cos real returns the cosine of angle, which is interpreted as an angle in degrees. The result is a real number. Examples 0 cos ⇒ 1.0
90 cos ⇒ 0.0 Errors: , See Also: ,

num den atan angle returns the angle (in degrees between 0 and 360) whose tangent is num divided by den. Either num or den may be 0, but not both. The signs of num and den determine the quadrant in which the result will lie: a positive num yields a result in the positive y plane, while a positive den yields a result in the positive x plane. The result is a real number. Examples 0 1 atan ⇒ 0.0
1 0 atan ⇒ 90.0
-100 0 atan ⇒ 270.0
4 4 atan ⇒ 45.0 Errors: , , See Also: ,

base exponent exp real raises base to the exponent power. The operands may be either integers or real numbers. If the exponent has a fractional part, the result is meaningful only if the base is nonnegative. The result is always a real number. Examples 9 0.5 exp ⇒ 3.0
-9 -1 exp ⇒ -0.111111 Errors: , , See Also: , , ,

num ln real returns the natural logarithm (base e) of num. The result is a real number. Examples 10 ln ⇒ 2.30259
100 ln ⇒ 4.60517 Errors: , , See Also: ,

num log real returns the common logarithm (base 10) of num. The result is a real number. Examples 10 log ⇒ 1.0
100 log ⇒ 2.0 Errors: , , See Also: ,

num cvi int (convert to integer) takes an integer or real number from the stack and produces an integer result. If the operand is an integer, simply returns it. If the operand is a real number, it truncates any fractional part (that is, rounds it toward 0) and converts it to an integer. A error occurs if a real number is too large to convert to an integer. (See the , , , and operators, which remove fractional parts without performing type conversion.) Examples –47.8 cvi ⇒ –47
520.9 cvi ⇒ 520 Errors: , , See Also: , , , ,

num cvr real (convert to real) takes an integer or real number and produces a real result. If the operand is an integer, converts it to a real number. If the operand is a real number, simply returns it. Errors: , See Also:

any1 any2 eq bool pops two objects from the operand stack and pushes true if they are equal, or false if not. The definition of equality depends on the types of the objects being compared. Simple objects are equal if their types and values are the same. This operator performs some type conversions. Integers and real numbers can be compared freely: an integer and a real number representing the same mathematical value are considered equal by . Examples 4.0 4 eq ⇒ true % A real number and an integer may be equal Errors: See Also: , , , ,

any1 any2 ne bool pops two objects from the operand stack and pushes false if they are equal, or true if not. What it means for objects to be equal is presented in the description of the operator. Errors: See Also: , , , ,

num1 num2 gt bool pops two numbers from the operand stack and pushes true if the first number is greater than the second, or false otherwise. Errors: , See Also: , , , ,

num1 num2 ge bool pops two numbers from the operand stack and pushes true if the first number is greater than or equal to the second, or false otherwise. Examples 4.2 4 ge ⇒ true Errors: , See Also: , , , ,

num1 num2 lt bool pops two numbers from the operand stack and pushes true if the first number is less than the second, or false otherwise. Errors: , See Also: , , , ,

num1 num2 le bool pops two numbers from the operand stack and pushes true if the first number is less than or equal to the second, or false otherwise. Errors: , See Also: , , , ,

bool1 bool2 and bool3 int1 int2 and int3 returns the logical conjunction of the operands if they are boolean. If the operands are integers, returns the bitwise "and" of their binary representations. Examples true true and ⇒ true % A complete truth table
true false and ⇒ false
false true and ⇒ false
false false and ⇒ false
99 1 and ⇒ 1
52 7 and ⇒ 4 Errors: , See Also: , , , ,

bool1 bool2 or bool3 int1 int2 or int3 returns the logical disjunction of the operands if they are boolean. If the operands are integers, returns the bitwise "inclusive or" of their binary representations. Examples true true or ⇒ true % A complete truth table
true false or ⇒ true
false true or ⇒ true
false false or ⇒ false
17 5 or ⇒ 21 Errors: , See Also: , ,

bool1 bool2 xor bool3 int1 int2 xor int3 returns the logical "exclusive or" of the operands if they are boolean. If the operands are integers, returns the bitwise "exclusive or" of their binary representations. Examples true true xor ⇒ false % A complete truth table
true false xor ⇒ true
false true xor ⇒ true
false false xor ⇒ false
7 3 xor ⇒ 4
12 3 xor ⇒ 15 Errors: , See Also: , ,

bool1 not bool2 int1 not int2 returns the logical negation of the operand if it is boolean. If the operand is an integer, returns the bitwise complement (ones complement) of its binary representation. Examples true not ⇒ false % A complete truth table
false not ⇒ true
52 not ⇒ -53 Errors: , See Also: , , ,

int1 shift bitshift int2 shifts the binary representation of int1 left by shift bits and returns the result. Bits shifted out are lost; bits shifted in are 0. If shift is negative, a right shift by –shift bits is performed. This operation produces an arithmetically correct result only for positive values of int1. Both int1 and shift must be integers. Examples 7 3 bitshift ⇒ 56
142 –3 bitshift ⇒ 17 Errors: , See Also: , , ,

– true true pushes a boolean object whose value is true on the operand stack. Errors: See Also: , , , ,

– false false pushes a boolean object whose value is false on the operand stack. Errors: See Also: , , , ,

bool {expr} if - removes both operands from the stack, then executes {expr} if bool is true. The operator pushes no results of its own on the operand stack, but {expr} may do so. Examples 3 4 lt {3 4 add} if ⇒ 7 Errors: , See Also:

bool {expr1} {expr2} ifelse - removes all three operands from the stack, then executes {expr1} if bool is true or {expr2} if bool is false. The operator pushes no results of its own on the operand stack, but the expression it executes may do so. Examples 4 3 lt {4 3 add} {4 3 sub} ifelse ⇒ 1 % Since 4 is not less than 3 Errors: , See Also:

any pop - removes the top element from the operand stack and discards it. Examples 1 2 3 pop ⇒ 1 2
1 2 3 pop pop ⇒ 1 Errors: See Also:

any1 any2 exch any2 any1 exchanges the top two elements on the operand stack. Examples 1 2 exch ⇒ 2 1 Errors: See Also: , , ,

any dup any any duplicates the top element on the operand stack. Errors: , See Also: ,

any1 … anyn n copy any1 … anyn any1 … anyn pops n from the stack and duplicates the top n elements on the stack as shown above. Examples 5 4 3 2 copy ⇒ 5 4 3 4 3
5 4 3 0 copy ⇒ 5 4 3 Errors: , , , See Also:

anyn … any0 n index anyn … any0 anyn removes the nonnegative integer n from the operand stack, counts down to the nth element from the top of the stack, and pushes a copy of that element on the stack. Examples 7 6 5 4 0 index ⇒ 7 6 5 4 4
7 6 5 4 3 index ⇒ 7 6 5 4 7 Errors: , , See Also: , ,

anyn-1 … any0 n j roll any(j-1) mod n … any0 anyn-1 … anyj mod n performs a circular shift of the objects anyn-1 through any0 on the operand stack by the amount j. Positive j indicates upward motion on the stack, whereas negative j indicates downward motion. n must be a nonnegative integer and j must be an integer. first removes these operands from the stack; there must be at least n additional elements. It then performs a circular shift of these n elements by j positions. If j is positive, each shift consists of removing an element from the top of the stack and inserting it between element n - 1 and element n of the stack, moving all intervening elements one level higher on the stack. If j is negative, each shift consists of removing element n - 1 of the stack and pushing it on the top of the stack, moving all intervening elements one level lower on the stack. Examples 6 5 4 3 -1 roll ⇒ 5 4 6
6 5 4 3 1 roll ⇒ 4 6 5
6 5 4 3 0 roll ⇒ 6 5 4 Errors: , , See Also: , , ,

Type 0 functions use a sequence of sample values (contained in a stream) to provide an approximation for functions whose domains and ranges are bounded. The samples are organized as an m-dimensional table in which each entry has n components.

PDF Specification ISO 32000-1:2008, section '7.10.2 Type 0 (Sampled) Functions'

Initializes a new instance of the class. The , , , and properties should be subsequently populated and the property should be set.

Gets the value.

The value.

(Required) A list of m positive integers that shall specify the number of samples in each input dimension of the sample table.

A list of m positive integers that shall specify the number of samples in each input dimension of the sample table. Value is . PDF Specification ISO 32000-1:2008, section '7.10.2 Type 0 (Sampled) Functions'

(Required) The number of bits that shall represent each sample. If the function has multiple output values, each one shall occupy bits. Valid values shall be 1, 2, 4, 8, 12, 16, 24, and 32.

The number of bits that shall represent each sample. Value is not 1, 2, 4, 8, 12, 16, 24, nor 32. PDF Specification ISO 32000-1:2008, section '7.10.2 Type 0 (Sampled) Functions'

(Optional) The order of interpolation between samples. Valid values shall be 1 and 3, specifying linear and cubic spline interpolation, respectively. Default value: 1.

The order of interpolation between samples. Value is not 1 nor 3. PDF Specification ISO 32000-1:2008, section '7.10.2 Type 0 (Sampled) Functions'

(Optional) A collection of m s specifying the linear mapping of input values into the domain of the function's sample table. Default value (if ): [ { 0, [0] − 1 }, { 0, [1] − 1 }, …].

A collection of m s specifying the linear mapping of input values into the domain of the function's sample table. PDF Specification ISO 32000-1:2008, section '7.10.2 Type 0 (Sampled) Functions'

(Optional) A collection of n s specifying the linear mapping of sample values into the range appropriate for the function's output values. Default value (if ): same as the value of .

A collection of n s specifying the linear mapping of sample values into the range appropriate for the function's output values. PDF Specification ISO 32000-1:2008, section '7.10.2 Type 0 (Sampled) Functions'

Gets or sets the samples organized as an m-dimensional table in which each entry has n components.

The samples organized as an m-dimensional table in which each entry has n components. Each sample value shall be represented as a sequence of bits. For a function with multidimensional input (more than one input variable), the sample values in the first dimension vary fastest, and the values in the last dimension vary slowest. For a function with multidimensional output (more than one output value), the values shall be stored in the same order as . The stream data shall be long enough to contain the entire sample array, as indicated by , , and ; see 7.3.8.2, "Stream Extent". This API is not CLS-compliant because it supports samples whose is 24 or 32. If you are writing your application in a .NET language that doesn't support type, you will have to use on a instance and then use on the 's to read or write samples. PDF Specification ISO 32000-1:2008, section '7.10.2 Type 0 (Sampled) Functions'

Type 3 functions (PDF 1.3) define a stitching of the subdomains of several 1-input functions to produce a single new 1-input function. Since the resulting stitching function is a 1-input function, the domain is given by a one-element collection.

PDF Specification ISO 32000-1:2008, section '7.10.4 Type 3 (Stitching) Functions'

Initializes a new instance of the class. The , , , and properties should be subsequently populated.

Gets the value.

The value.

(Required) A list of k 1-input functions that shall make up the stitching function. The output dimensionality of all functions shall be the same, and compatible with the value of if is present.

A list of k 1-input functions that shall make up the stitching function. Value is . PDF Specification ISO 32000-1:2008, section '7.10.4 Type 3 (Stitching) Functions'

(Required) A list of k − 1 numbers that, in combination with , shall define the intervals to which each function from the list shall apply. elements shall be in order of increasing value, and each value shall be within the domain defined by .

A list of k − 1 numbers that, in combination with , shall define the intervals to which each function from the list shall apply. Value is . PDF Specification ISO 32000-1:2008, section '7.10.4 Type 3 (Stitching) Functions'

(Required) A collection of k s that shall map each subset of the domain defined by and the list to the domain of the corresponding function.

A collection of k s that shall map each subset of the domain defined by and the list to the domain of the corresponding function. Value is . PDF Specification ISO 32000-1:2008, section '7.10.4 Type 3 (Stitching) Functions'

Represents options used for loading a from a file or a stream.

Gets the default options used for loading any from an image file.

The default options used for loading any from an image file.

Gets or sets the name of the PDF version to which the file applies.

The name of the PDF version to which the file applies.

Gets or sets the zero-based index of the frame that should be loaded. If the frame at the specified index does not exist in the image file, then and methods return .

The zero-based index of the frame that should be loaded.

Gets or sets a value indicating whether to automatically orient the when drawing the loaded using any of the overloads based on the orientation stored in the encoded image Exif metadata. Default value: .

to automatically orient the when drawing the loaded using any of the overloads based on the orientation stored in the encoded image Exif metadata; otherwise, . Reading the orientation from the encoded image is supported for the following image formats: JPEG - the Exif APP1 application data segment. TIFF - the Orientation field. PNG - the eXIf chunk.

An enumeration of supported image file formats when saving an image.

Bitmap (BMP) format.

Graphics Interchange Format (GIF).

Joint Photographic Experts Group (JPEG) format.

Portable Network Graphics (PNG) format.

Tagged Image File Format (TIFF).

Windows Media Photo format.

Scalable Vector Graphics (SVG) format. Currently supported only via SkiaSharp.

Represents a class which stores saving options for image files.

Convert example Export Images example Export to ImageSource / Image Control example

Gets or sets the image format.

The image format.

Gets or sets the zero-based page number of the document's page which should be saved to an image.

The zero-based page number of the document's page which should be saved to an image.

Gets or sets the number of pages which should be saved to a multi-frame image. If image format doesn't support multiple frames, this property is ignored. Default value is 1. To save all pages, set value to . Only Tagged Image File Format (TIFF) and Graphics Interchange Format (GIF) format images support multiple frames.

The number of pages which should be saved to a multi-frame image.

Gets or sets the image width in pixels.

The image width in pixels. If both and are not specified, then image size will be equal to the slide size. If only one of the or is specified, then the specified dimension will be respected and other dimension will be calculated so that original aspect ratio is maintained. If both and are specified, then both specified dimensions will be respected (which may result in non-uniformly scaled image, if aspect ratio is not equal to the original one.

Gets or sets the image height in pixels.

The image height in pixels. If both and are not specified, then image size will be equal to the slide size. If only one of the or is specified, then the specified dimension will be respected and other dimension will be calculated so that original aspect ratio is maintained. If both and are specified, then both specified dimensions will be respected (which may result in non-uniformly scaled image, if aspect ratio is not equal to the original one.

Gets or sets a pixel format, which will be used for the image.

The pixel format, which will be used for the image.

Gets or sets the value that indicated whether dithering should be applied when converting to pixel formats , , and . Default value: .

if dithering should be applied when converting to pixel formats , , and ; otherwise, .

Gets or sets compression schema, which will be used when exporting to Tagged Image File Format (TIFF).

The compression schema, which will be used when exporting to Tagged Image File Format (TIFF).

Gets or sets the rendering mode used when saving the content to an image. This property is not applicable when saving a .

The rendering mode used when saving the content to an image. The rendering mode is not supported because of the reasons explained in the exception's .

Gets or sets a value indicating whether to automatically orient the image based on the total transformation of the on the and the optional . This property is applicable only when saving a . Default value: .

if the image is automatically oriented based on the total transformation of the on the .

Gets or sets the transformation used for determining the image orientation. The is appended to the transformation that gets calculated if the is set to . This property is applicable only when saving a . Default value: .

The transformation used for determining the image orientation. This property is usually set to the value of the . * * to optimally auto-orient images when iterating over all elements on the . In that case should be set to because orientation is specified manually via the .

Initializes a new instance of the class.

Initializes a new instance of the class for a specific image format.

The image format.

Gets or sets the horizontal dots per inch (dpi) of the image. Default value is , which means that component specific default value will be used (currently 300).

The horizontal dots per inch (dpi) of the image; that is, the dots per inch (dpi) along the x-axis. Value is not greater than 0.

Gets or sets the vertical dots per inch (dpi) of the image. Default value is , which means that component specific default value will be used (currently 300).

The vertical dots per inch (dpi) of the image; that is, the dots per inch (dpi) along the y-axis. Value is not greater than 0.

Contains the correspondence between names and objects for some categories of objects in a PDF file that can be referred to by name rather than by object reference.

PDF Specification ISO 32000-1:2008, section '7.7.4 Name Dictionary'

(Optional; PDF 1.2) A name tree mapping name strings to destinations (see 12.3.2.3, "Named Destinations").

A name tree mapping name strings to destinations. PDF Specification ISO 32000-1:2008, section '7.7.4 Name Dictionary'

(Optional; PDF 1.4) A name tree mapping name strings to file specifications for embedded file streams (see 7.11.4, "Embedded File Streams").

A name tree mapping name strings to file specifications for embedded file streams. The property on a is a shortcut to this property. PDF Specification ISO 32000-1:2008, section '7.7.4 Name Dictionary'

Represents errors that occur when a value that is being retrieved from or being set to a instance is not according to the PDF Specification ISO 32000-1:2008.

Gets the that either contains an invalid item or to which an invalid item tried to be set.

The that either contains an invalid item or to which an invalid item tried to be set.

Gets the index of an invalid item in the that is either being retrieved or set.

The index of an invalid item in the that is either being retrieved or set.

Represents errors that occur when a value that is being retrieved from or being set to a is not according to the PDF Specification ISO 32000-1:2008.

Gets the that either contains an invalid entry or to which an invalid entry tried to be set.

The that either contains an invalid entry or to which an invalid entry tried to be set.

Gets the key of an invalid entry value in the that is either being retrieved or set.

The key of an invalid entry value in the that is either being retrieved or set.

Represents errors that occur when a value that is being retrieved from or being set to a or a instance is not according to the PDF Specification ISO 32000-1:2008.

Gets the invalid value that is either being retrieved or set.

The invalid value that is either being retrieved or set.

Gets a link to the appropriate page of the PDF Specification ISO 32000-1:2008.

The link to the appropriate page of the PDF Specification ISO 32000-1:2008. Setting a value is not supported.

Gets the s that the can be according to the PDF Specification ISO 32000-1:2008.

The s that the can be according to the PDF Specification ISO 32000-1:2008.

Exception that occurs when licensing information is not correctly specified.

Specifies how pages of content are oriented on print media.

The feature (whose options are represented by this enumeration) is set to an option not defined in the Print Schema.

Content of the imageable area is rotated on the page 90 degrees counterclockwise from standard (portrait) orientation.

Standard orientation.

Content of the imageable area is rotated on the page 90 degrees clockwise from standard (portrait) orientation.

Content of the imageable area is upside down relative to standard (portrait) orientation.

Represents a collection of associated files that provide a means to associate content in other formats with selected objects of a PDF file and to identify the relationship between them. For associated files their associated shall include the property indicating one of several possible relationships that the file has to the associated PDF object.

Associated Files example

Adds a new with the specified relationship and an empty . Use the method of the of a returned to fill the empty .

The relationship between the component of a PDF document that refers to this and the newly added . The name of a newly added . This value is also used to resolve a key in the (if is not ) of a newly added . The media type of the embedded file. The to which the newly created should be added or . A newly created with the specified relationship and an empty added to the . is or . Associated Files example

Adds a new with the specified relationship and the copied from the resource specified by the .

The relationship between the component of a PDF document that refers to this and the newly added . The location of the resource copied to the of a newly added . This value is also used to resolve the and a key in the (if is not ) of a newly added . The media type of the embedded file. The to which the newly created should be added or . A newly created with the specified relationship and the copied from the resource specified by the added to the . is or . The 's , , , and properties are automatically set, if they can be resolved from the resource specified by the . Associated Files example

Represents the type of the relationship between the component of the that refers to the and the associated file denoted by the .

Associated Files example

The relationship is a custom, second-class name (see Annex E, "PDF Name Registry").

The is the original source material for the associated content.

The represents information used to derive a visual presentation – such as for a table or a graph.

The represents a supplemental representation of the original source or data that may be more easily consumable (e.g., A MathML version of an equation).

The is an encrypted payload document that should be displayed to the user if the PDF processor has the cryptographic filter needed to decrypt the document.

The is the data associated with the AcroForm (see 12.7.2, "Interactive Form Dictionary") of this PDF.

The is a schema definition for the associated object (e.g. an XML schema associated with a metadata stream).

Used when the relationship is not known or cannot be described using one of the other values except .

Represents a base non-generic class for all collection types that implement various PDF components in the GemBox.Pdf assembly.

Gets the number of elements contained in the .

The number of elements contained in the .

Removes the element at the specified index of the .

The zero-based index of the element to remove. The underlying is read-only ( returns ). is less than 0 or is equal to or greater than .

Removes all elements from the .

The underlying is read-only ( returns ).

Represents a base class for all collection types that implement various PDF components in the GemBox.Pdf assembly.

The type of elements in the collection. PDF Specification ISO 32000-1:2008, section '7.7 Document Structure'

Gets or sets the element at the specified index.

The element at the specified index. The zero-based index of the element to get or set. The element at the specified index. The underlying is read-only ( returns ). is less than 0 or is equal to or greater than . is invalid for the current collection.

Adds an element to the end of the .

The element to be added to the end of the . The underlying is read-only ( returns ). is invalid for the current collection.

Inserts an element into the at the specified index.

The zero-based index at which should be inserted. The element to insert. The underlying is read-only ( returns ). is less than 0 or is greater than . is invalid for the current collection.

Removes the first occurrence of a specific element from the .

The element to remove from the . if is successfully removed; otherwise, . This method also returns if was not found in the . The underlying is read-only ( returns ).

Searches for the specified element and returns the zero-based index of the first occurrence within the entire .

The element to locate in the . The zero-based index of the first occurrence of within the entire , if found; otherwise, –1.

Determines whether an element is in the .

The element to locate in the . if is found in the ; otherwise, .

Copies the entire to a compatible one-dimensional array, starting at the specified index of the target array.

The one-dimensional that is the destination of the elements copied from . The must have zero-based indexing. The zero-based index in at which copying begins. is . is less than 0 or greater than 's . The number of elements in the source is greater than the available space from to the end of the destination .

Returns an enumerator that iterates through the .

A for the .

Enumerates the elements of a .

Gets the element at the current position of the enumerator.

The element in the at the current position of the enumerator.

Advances the enumerator to the next element of the .

if the enumerator was successfully advanced to the next element; if the enumerator has passed the end of the collection. The collection was modified after the enumerator was created.

Releases all resources used by the .

Represents how cross-reference information (information about byte positions of the indirect objects) and indirect objects are stored in the PDF file.

Cross-reference information is stored as a list of cross-reference entries in a fixed format directly after all indirect objects and before PDF file trailer. Use this option if file size is not an issue and you want to achieve the maximum portability of the PDF file.

(PDF 1.5) Cross-reference information is stored compactly in the cross-reference stream that is usually compressed and indirect objects can be stored compactly in object streams that are also usually compressed. Use this option if file size is an issue and PDF file won't be opened by old PDF applications that do not support PDF version 1.5 such as Acrobat Reader or Adobe Acrobat before version 6.0 that support PDF version 1.5 and were released on July 2003.

A destination defines a particular view of a document, consisting of the following items: The page of the document that shall be displayed. The location of the document window on that page. The magnification (zoom) factor.

PDF Specification ISO 32000-1:2008, section '12.3.2 Destinations'

Gets or sets the destination object. Specifying a destination explicitly in a PDF file, page is an indirect reference to a page object.

The destination object. Value is .

Gets or sets the destination page number. Should be used only in a context of a remote go-to action (see 12.6.4.3 Remote Go-To Actions).

The destination page number. The first page is numbered 0. Value is . Value is less than zero.

Gets the of this instance.

The of this instance.

Gets or sets the horizontal coordinate of the upper-left corner of the window expressed in the default user space coordinate system or if the value is to be retained unchanged.

The horizontal coordinate of the upper-left corner of the window expressed in the default user space coordinate system or if the value is to be retained unchanged. Value cannot be for view type. The can be set only for , , and view types.

Gets or sets the vertical coordinate of the upper-left corner of the window expressed in the default user space coordinate system or if the value is to be retained unchanged.

The vertical coordinate of the upper-left corner of the window expressed in the default user space coordinate system or if the value is to be retained unchanged. Value cannot be for view type. The can be set only for , , and view types.

Gets or sets the horizontal coordinate of the bottom-right corner of the window expressed in the default user space coordinate system or if the value is to be retained unchanged.

The horizontal coordinate of the bottom-right corner of the window expressed in the default user space coordinate system or if the value is to be retained unchanged. Value cannot be . The can be set only for view type.

Gets or sets the vertical coordinate of the bottom-right corner of the window expressed in the default user space coordinate system or if the value is to be retained unchanged.

The vertical coordinate of the bottom-right corner of the window expressed in the default user space coordinate system or if the value is to be retained unchanged. Value cannot be . The can be set only for view type.

Gets or sets the zoom factor or if the value is to be retained unchanged. Value 1 represents 100%, 0.5 represents 50%, 1.5 represents 150%, etc.

The zoom factor or if the value is to be retained unchanged. The can be set only for view type.

Sets the view and the view's parameters where represent the following values depending on the parameter: , , and . , and . and . and . and None.

Type of the view. The parameters of the view. is when they are required. The number of passed is not according to the documentation.

Returns a that represents this instance.

A that represents this instance. This method should be used primarily for debugging purposes and should be considered volatile (format of its return value might change in future versions).

Enumerates the allowed syntactic forms for specifying a destination explicitly in a PDF file.

PDF Specification ISO 32000-1:2008, section '12.3.2.2 Explicit Destinations'

Display the page designated by page, with the coordinates (left, top) positioned at the upper-left corner of the window and the contents of the page magnified by the factor zoom. Parameters: , and This value corresponds to value XYZ from PDF Specification ISO 32000-1:2008, section '12.3.2.2 Explicit Destinations'.

Display the page designated by page, with its contents magnified just enough to fit the entire page within the window both horizontally and vertically. Parameters: none. This value corresponds to value Fit from PDF Specification ISO 32000-1:2008, section '12.3.2.2 Explicit Destinations'.

Display the page designated by page, with the vertical coordinate top positioned at the top edge of the window and the contents of the page magnified just enough to fit the entire width of the page within the window. Parameters: . This value corresponds to value FitH from PDF Specification ISO 32000-1:2008, section '12.3.2.2 Explicit Destinations'.

Display the page designated by page, with the horizontal coordinate left positioned at the left edge of the window and the contents of the page magnified just enough to fit the entire height of the page within the window. Parameters: . This value corresponds to value FitV from PDF Specification ISO 32000-1:2008, section '12.3.2.2 Explicit Destinations'.

Display the page designated by page, with its contents magnified just enough to fit the rectangle specified by the coordinates left, bottom, right, and top entirely within the window both horizontally and vertically. Parameters: , , and . This value corresponds to value FitR from PDF Specification ISO 32000-1:2008, section '12.3.2.2 Explicit Destinations'.

(PDF 1.1) Display the page designated by page, with its contents magnified just enough to fit its bounding box entirely within the window both horizontally and vertically. Parameters: none. This value corresponds to value FitB from PDF Specification ISO 32000-1:2008, section '12.3.2.2 Explicit Destinations'.

(PDF 1.1) Display the page designated by page, with the vertical coordinate top positioned at the top edge of the window and the contents of the page magnified just enough to fit the entire width of its bounding box within the window. Parameters: . This value corresponds to value FitBH from PDF Specification ISO 32000-1:2008, section '12.3.2.2 Explicit Destinations'.

(PDF 1.1) Display the page designated by page, with the horizontal coordinate left positioned at the left edge of the window and the contents of the page magnified just enough to fit the entire height of its bounding box within the window. Parameters: . This value corresponds to value FitBV from PDF Specification ISO 32000-1:2008, section '12.3.2.2 Explicit Destinations'.

Represents a root class in the GemBox.Pdf implementation of the PDF Document Structure as specified in the PDF Specification ISO 32000-1:2008, section '7.7 Document Structure'.

Document Structure

Initializes a new instance of the PDF document.

File Structure

Gets or sets the options used when saving the to a PDF file. Default value: .

The options used when saving the to a PDF file. Value is . File Structure

(Required if an Encrypt entry is present in the file trailer; optional otherwise; PDF 1.1) An array of two byte-strings constituting a file identifier (see 14.4, "File Identifiers") for the file. Because the entries are not encrypted it is possible to check the key to assure that the correct file is being accessed without decrypting the file. Although this entry is optional, its absence might prevent the file from functioning in some workflows that depend on files being uniquely identified.

The array of two byte-strings constituting a file identifier for the file. PDF Specification ISO 32000-1:2008, section '7.5.5 File Trailer'

Sets the to a specified value. Both and will be set to the specified value.

The value to which and will be set. The document's . already has an . To modify the , use property of the 's . Value is .

(Optional; shall be an indirect reference) The document’s information dictionary (see 14.3.3, "Document Information Dictionary").

The document’s information dictionary. Value is not according to PDF Specification ISO 32000-1:2008. PDF Specification ISO 32000-1:2008, section '7.5.5 File Trailer' Document Information example

(Optional; PDF 1.4) The version of the PDF specification to which the document conforms (for example, 1.4) if later than the version specified in the file’s header (see 7.5.2, "File Header"). If the header specifies a later version, or if this entry is absent, the document shall conform to the version specified in the header. This entry enables a conforming writer to update the version using an incremental update; see 7.5.6, "Incremental Updates".

The version of the PDF specification to which the document conforms (for example, 1.4) if later than the version specified in the file’s header (see 7.5.2, "File Header").

(Required; shall be an indirect reference) The page tree node that shall be the root of the document’s page tree (see 7.7.3, "Page Tree").

The page tree node that shall be the root of the document’s page tree. PDF Specification ISO 32000-1:2008, section '7.7.2 Document Catalog' Page Tree example Document Structure

(Optional; PDF 1.2) The document's name dictionary (see 7.7.4, "Name Dictionary").

The document's name dictionary. PDF Specification ISO 32000-1:2008, section '7.7.2 Document Catalog'

(Optional; PDF 1.4) A name tree mapping name strings to file specifications for embedded file streams (see 7.11.4, "Embedded File Streams").

A mapping s to s for s. This property is a shortcut to the property .. PDF Specification ISO 32000-1:2008, section '7.7.4 Name Dictionary' PDF Specification ISO 32000-1:2008, section '7.11.4 Embedded File Streams' Embedded Files example

(Optional; PDF 1.2) A viewer preferences dictionary (see 12.2, "Viewer Preferences") specifying the way the document shall be displayed on the screen. If this entry is absent, conforming readers shall use their own current user preference settings.

A viewer preferences dictionary specifying the way the document shall be displayed on the screen. PDF Specification ISO 32000-1:2008, section '7.7.2 Document Catalog' Viewer Preferences example

(Optional) Gets or sets the value specifying the page layout to be used when the document is opened. Default value: .

The value specifying the page layout to be used when the document is opened. PDF Specification ISO 32000-1:2008, section '7.7.2 Document Catalog'

(Optional) Gets or sets the value specifying how the document shall be displayed when opened. Default value: .

The value specifying how the document shall be displayed when opened. PDF Specification ISO 32000-1:2008, section '7.7.2 Document Catalog'

(Optional; shall be an indirect reference) The outline dictionary that shall be the root of the document’s outline hierarchy (see 12.3.3, "Document Outline").

The outline dictionary that shall be the root of the document’s outline hierarchy. PDF Specification ISO 32000-1:2008, section '7.7.2 Document Catalog' Outlines example

(Optional; PDF 1.2) The document’s interactive form (AcroForm) dictionary (see 12.7.2, "Interactive Form Dictionary").

The document’s interactive form (AcroForm) dictionary. PDF Specification ISO 32000-1:2008, section '12.7 Interactive Forms' Read Form example

(Optional; PDF 1.4; shall be an indirect reference) A metadata stream that shall contain metadata for the document (see 14.3.2, "Metadata Streams").

A metadata stream that shall contain metadata for the document. PDF Specification ISO 32000-1:2008, section '7.7.2 Document Catalog'

(Optional; PDF 1.7) A that a conforming reader shall use to enhance the presentation of file attachments stored in the PDF document. (see 12.3.5, "Collections").

A that a conforming reader shall use to enhance the presentation of file attachments stored in the PDF document. PDF Specification ISO 32000-1:2008, section '7.7.2 Document Catalog' Portfolios example

Sets a new to the property thus making the this a PDF Portfolio (a collection of file attachments). This method also clears collection so that a new is empty.

A new set to the property. PDF Specification ISO 32000-1:2008, section '7.7.2 Document Catalog' PDF Specification ISO 32000-1:2008, section '12.3.5 Collections' Overview of PDF Portfolios Portfolios example

Gets or sets the certifying signature (also known as an author signature) (PDF 1.5) whose in any of the shall indicate the author's specification of which changes to the document shall be prevented by the consumer applications.

The certifying signature (also known as an author signature) (PDF 1.5) whose in any of the shall indicate the author's specification of which changes to the document shall be prevented by the consumer applications. The document's author signature can be set to only (so consumer applications won't prevent the author's disallowed changes but will instead mark the author's signature as invalid if any of the disallowed changes were done after the author signed the document). To set a non- value, use the method with a whose is not . PDF Specification ISO 32000-1:2008, section '12.8.4 Permissions'

(Optional; PDF 2.0) Document-wide security-related information.

Document-wide security-related information. ETSI EN 319 142-1, section '5.4.2 Document Security Store' PAdES B-LT level example

(Optional; PDF 2.0) An array of one or more s which denote the associated files for this . For unencrypted wrapper documents for an encrypted payload document the property is required and shall include a reference to the for the encrypted payload document.

An array of one or more s which denote the associated files for this . Associated Files example

Loads a PDF document from a file with the specified path and with the options.

Loads a PDF document from a file with the specified path and with the specified options.

The path to a file from which to load a PDF document. The options used for loading a from a PDF file. A loaded PDF document. is or is . PDF file is encrypted and the is invalid. File Structure

Loads a PDF document from the specified stream and with the options.

The stream from which to load a PDF document. A loaded PDF document. is . is not readable. PDF file is encrypted and the password is required to load a PDF document. Use method and provide a valid . File Structure

Loads a PDF document from the specified stream and with the specified options.

The stream from which to load a PDF document. The options used for loading a from a PDF file. A loaded PDF document. is or is . is not readable. PDF file is encrypted and the is invalid. File Structure

Loads the entirely from the PDF file. PDF file remains open. If you want to close the PDF file, use method.

File Structure

The method that does exactly the opposite of the method. References to all s whose s were already parsed from the PDF file associated with this are cleared so they can be parsed again when requested for the first time. This method also resets all fields of the so they are recreated when requested for the first time. The is, effectively, reset to the state when it was either last loaded from a PDF file or last saved to a PDF file. Use this method if you are reading a very large PDF document (with thousands of pages) to free memory necessary for reading additional pages.

Gets or sets a value indicating whether to close the stream of the PDF file currently associated with the when closing or disposing the . This option is ignored if or is not called. Setting this option to has the same effect as not calling nor . Default value: .

if the stream of the PDF file currently associated with the should be closed when closing or disposing the ; otherwise, .

Closes the PDF file associated with this . Any that is associated with the PDF file should be closed, otherwise memory and resource leaks might occur because PDF file stream might not be closed until the application exists.

File Structure

This method is used as a convenience so that instance can be used in a block. File Structure

Save all the changes made to the current PDF document to the same location from where the PDF document was loaded or last saved. This feature is also called incremental update. Use to specify options used for saving the to a PDF file.

is not associated with any PDF file and therefore its changes cannot be saved or the associated PDF file was loaded in a read-only mode. Use with or parameters instead to save the entire to a new PDF file. PDF Specification ISO 32000-1:2008, section '7.5.6 Incremental Updates' File Structure

Saves the entire PDF document to a file with the specified path. Use to specify options used for saving the to a PDF file.

The path to a file to which to save a PDF document. is . File Structure Convert example

Saves the entire PDF document to a file with the specified path.

The path to a file to which to save a PDF document. The saving options which can be used to define settings for save operation. is . is . Convert example

Saves the entire PDF document to the specified stream. Use to specify options used for saving the to a PDF file.

The stream to which to save a PDF document. is . is not writable. File Structure

Saves the entire PDF document to the specified stream.

The stream to which to save a PDF document. The saving options which can be used to define settings for save operation. is . is . Convert example

Converts this instance to an instance.

The options used when converting to XML Paper Specification (XPS) document. A New instance created from this instance. Export to XpsDocument / DocumentViewer Control example

Converts single page specified in of this instance to an instance.

The options used when converting a single page to an image. A new instance created from a single page specified in . Export to ImageSource / Image Control example

Prints the document to the default printer.

Print example

Prints the document to the specified printer.

Printer name. Print example

Prints the document to the specified printer according to specified options.

Printer name. Print options. Print example

Makes a deep clone of this instance. The clone and this do not share any objects, thus the cloned is a deep clone of this .

A deep clone of this instance. Document Structure

Returns a that represents this instance.

A that represents this instance. This method should be used primarily for debugging purposes and should be considered volatile (format of its return value might change in future versions).

Represents an identifier of a .

PDF Specification ISO 32000-1:2008, section '14.4 File Identifiers'

Gets the permanent identifier based on the contents of the file at the time it was originally created as a array.

The permanent identifier based on the contents of the file at the time it was originally created as a array. PDF Specification ISO 32000-1:2008, section '14.4 File Identifiers'

Gets the permanent identifier based on the contents of the file at the time it was originally created as a value or if cannot be converted to .

The permanent identifier based on the contents of the file at the time it was originally created as a value or if cannot be converted to . PDF Specification ISO 32000-1:2008, section '14.4 File Identifiers'

Gets the changing identifier based on the file’s contents at the time it was last updated as a array.

The changing identifier based on the file’s contents at the time it was last updated as a array. PDF Specification ISO 32000-1:2008, section '14.4 File Identifiers'

Gets or sets the changing identifier based on the file’s contents at the time it was last updated as a value or if cannot be converted to .

The changing identifier based on the file’s contents at the time it was last updated as a value or if cannot be converted to . Value is or equal to . PDF Specification ISO 32000-1:2008, section '14.4 File Identifiers'

Returns a that represents this instance.

A that represents this instance. This method should be used primarily for debugging purposes and should be considered volatile (format of its return value might change in future versions).

Contains metadata for the .

PDF Specification ISO 32000-1:2008, section '14.3.3 Document Information Dictionary' Document Information example

(Optional; PDF 1.1) The document’s title.

The document’s title. PDF Specification ISO 32000-1:2008, section '14.3.3 Document Information Dictionary'

(Optional) The name of the person who created the document.

The name of the person who created the document. PDF Specification ISO 32000-1:2008, section '14.3.3 Document Information Dictionary'

(Optional; PDF 1.1) The subject of the document.

The subject of the document. PDF Specification ISO 32000-1:2008, section '14.3.3 Document Information Dictionary'

(Optional; PDF 1.1) Keywords associated with the document.

Keywords associated with the document. PDF Specification ISO 32000-1:2008, section '14.3.3 Document Information Dictionary'

(Optional) If the document was converted to PDF from another format, the name of the conforming product that created the original document from which it was converted.

If the document was converted to PDF from another format, the name of the conforming product that created the original document from which it was converted. PDF Specification ISO 32000-1:2008, section '14.3.3 Document Information Dictionary'

(Optional) If the document was converted to PDF from another format, the name of the conforming product that converted it to PDF.

If the document was converted to PDF from another format, the name of the conforming product that converted it to PDF. PDF Specification ISO 32000-1:2008, section '14.3.3 Document Information Dictionary'

(Optional) The date and time the document was created, in human-readable form (see 7.9.4, "Dates").

The date and time the document was created, in human-readable form. PDF Specification ISO 32000-1:2008, section '14.3.3 Document Information Dictionary'

(Required if PieceInfo is present in the document catalog; otherwise optional; PDF 1.1) The date and time the document was most recently modified, in human-readable form (see 7.9.4, "Dates").

The date and time the document was most recently modified, in human-readable form. PDF Specification ISO 32000-1:2008, section '14.3.3 Document Information Dictionary'

Removes the entry from the parent .

Represents an embedded file stream (PDF 1.3) that enables embedding the contents of referenced files directly within the body of the PDF file. This makes the PDF file a self-contained unit that can be stored or transmitted as a single entity.

PDF Specification ISO 32000-1:2008, section '7.11.4 Embedded File Streams' Embedded Files example

(Optional, required in the case of an embedded file stream used as as associated file) The media type of the embedded file. The value of this entry shall conform to the MIME media type names defined in Internet RFC2046, Multipurpose Internet Mail Extensions (MIME), Part Two: Media Types.

The media type of the embedded file. PDF Specification ISO 32000-1:2008, section '7.11.4 Embedded File Streams' Associated Files example

(Optional) The size of the uncompressed embedded file, in bytes. See "Table 157: Entries in a collection field dictionary".

The size of the uncompressed embedded file, in bytes. PDF Specification ISO 32000-1:2008, section '7.11.4 Embedded File Streams' Embedded Files example

Gets the size of the compressed embedded file, in bytes.

The size of the compressed embedded file, in bytes. Embedded Files example

(Optional) The date and time when the embedded file was created. See "Table 157: Entries in a collection field dictionary".

The date and time when the embedded file was created. PDF Specification ISO 32000-1:2008, section '7.11.4 Embedded File Streams'

(Optional, required in the case of an embedded file stream used as an associated file) The date and time when the embedded file was last modified. See "Table 157: Entries in a collection field dictionary".

The date and time when the embedded file was last modified. PDF Specification ISO 32000-1:2008, section '7.11.4 Embedded File Streams' Embedded Files example

(Optional) A 16-byte array that is the checksum of the bytes of the uncompressed embedded file. The checksum shall be calculated by applying the standard MD5 message-digest algorithm (described in Internet RFC 1321, The MD5 Message-Digest Algorithm) to the bytes of the embedded file stream. This is strictly a checksum, and is not used for security purposes.

A 16-byte array that is the checksum of the bytes of the uncompressed embedded file. PDF Specification ISO 32000-1:2008, section '7.11.4 Embedded File Streams'

Opens this so its data can be read. The data is automatically uncompressed, if needed.

A that can be used to read data. is already opened. Make sure that instance returned from or method is disposed before calling method again. specifies external data (through F entry) that is currently not supported. Returned must be disposed after it is no longer needed, otherwise, subsequent opening of will fail. Embedded Files example

Opens this so its data can be written.

If set to then the written data is compressed using the data compression method. A that can be used to write data. is already opened. Make sure that instance returned from or method is disposed before calling method again. Returned must be disposed after it is no longer needed, otherwise, subsequent opening of will fail. Embedded Files example

Represents a name tree mapping name strings to file specifications for embedded file streams (see 7.11.4, "Embedded File Streams").

PDF Specification ISO 32000-1:2008, section '7.7.4 Name Dictionary' PDF Specification ISO 32000-1:2008, section '7.11.4 Embedded File Streams' Embedded Files example

Add a new with the specified name and an empty . Use the method of the of a returned to fill the empty .

The name of a newly added . This value is also used to resolve a key in the of a newly added . A newly created with the specified name and an empty added to the under the returned key. is or . A with the same key already exists in the . Embedded Files example

Adds a new with the copied from the resource specified by the .

The location of the resource copied to the of a newly added . This value is also used to resolve the and a key in the of a newly added . A newly created with the copied from the resource specified by the added to the under the returned key. is or . A with the same key already exists in the . The 's , , , and properties are automatically set, if they can be resolved from the resource specified by the . Embedded Files example

Represents a base class for all errors that occur in GemBox.Pdf assembly.

Represents a full file specification that might include information related to one or more specific file systems with which a PDF file can refer to the contents of another file (PDF 1.1). A file specification shall refer to a file external to the PDF file or to a file embedded within the referring PDF file, allowing its contents to be stored or transmitted along with the PDF file. The file is considered external to the PDF file in either case.

PDF Specification ISO 32000-1:2008, section '7.11.3 File Specification Dictionaries' Embedded Files example

Gets or sets a value indicating whether the URL file system shall be used to interpret this file specification. When the property in a has the value , the value of the property in that is not a file specification string, but a uniform resource locator (URL) of the form defined in Internet RFC 3986, Uniform Resource Locators. Default value: .

if the URL file system shall be used to interpret this file specification; otherwise, . The URL shall adhere to the character-encoding requirements specified in RFC 3986. Because 7-bit U.S. ASCII is a strict subset of , this value shall also be considered to be in that encoding. PDF Specification ISO 32000-1:2008, section '7.11.3 File specification dictionaries' PDF Specification ISO 32000-1:2008, section '7.11.5 URL Specifications'

Gets or sets the file specification string of the form described in 7.11.2, "File Specification Strings", or (if the is ) a uniform resource locator, as described in 7.11.5, "URL Specifications".

The file specification string, or (if the is ) a uniform resource locator. Value is or . GemBox.Pdf tries to get this value from the following entries: On Mac OS system: UF, F, Mac, DOS, Unix. On UNIX system: UF, F, Unix, DOS, Mac. On DOS and all other systems: UF, F, DOS, Mac, Unix. UF entry is decoded using either or encoding and all other entries (F, DOS, Mac, Unix) are decoded using encoding. GemBox.Pdf sets the following entries: UF entry encoded either with or encoding for cross-platform and cross-language compatibility. F entry encoded with encoding for backwards compatibility. DOS, Mac and Unix entries are removed because they are obsolescent and should not be used by conforming writers. PDF Specification ISO 32000-1:2008, section '7.11.3 File specification dictionaries' PDF Specification ISO 32000-1:2008, section '7.11.2 File Specification Strings' PDF Specification ISO 32000-1:2008, section '7.11.5 URL Specifications'

(Optional; PDF 1.2) A flag indicating whether the file referenced by the file specification is volatile (changes frequently with time). If the value is , applications shall not cache a copy of the file. For example, a movie annotation referencing a URL to a live video camera could set this flag to to notify the conforming reader that it should re-acquire the movie each time it is played. Default value: .

A flag indicating whether the file referenced by the file specification is volatile (changes frequently with time). PDF Specification ISO 32000-1:2008, section '7.11.3 File specification dictionaries'

(Required if collection is not empty; PDF 1.3) An embedded file stream (see 7.11.4, "Embedded File Streams").

An embedded file stream. PDF Specification ISO 32000-1:2008, section '7.11.3 File specification dictionaries' PDF Specification ISO 32000-1:2008, section '7.11.4 Embedded File Streams' Embedded Files example

Sets the to a new empty .

The file specification's . PDF Specification ISO 32000-1:2008, section '7.11.3 File specification dictionaries' PDF Specification ISO 32000-1:2008, section '7.11.4 Embedded File Streams'

Sets the to a new copied from the resource specified by the .

The location of the resource copied to the . The file specification's . PDF Specification ISO 32000-1:2008, section '7.11.3 File specification dictionaries' PDF Specification ISO 32000-1:2008, section '7.11.4 Embedded File Streams'

(Optional; PDF 1.3) A related files array (see 7.11.4.2, "Related Files Arrays") identifying files that are related to the .

A related files array identifying files that are related to the . PDF Specification ISO 32000-1:2008, section '7.11.3 File specification dictionaries' PDF Specification ISO 32000-1:2008, section '7.11.4.2 Related Files Arrays'

Adds a new empty to the collection.

The name of one of the related file. The related file added to the file specification's . is . The is .

(Optional; PDF 1.6) Descriptive text associated with the file specification. It shall be used for files in the name tree (see 7.7.4, "Name Dictionary").

Descriptive text associated with the file specification. PDF Specification ISO 32000-1:2008, section '7.11.3 File specification dictionaries' Embedded Files example

(Optional; shall be indirect reference; PDF 1.7) A collection item dictionary, which shall be used to create the user interface for portable collections (see 7.11.6, "Collection Items").

A collection item dictionary, which shall be used to create the user interface for portable collections. PDF Specification ISO 32000-1:2008, section '7.11.3 File specification dictionaries' PDF Specification ISO 32000-1:2008, section '7.11.6 Collection Items' Portfolios example

Gets the parent or if the PDF document is not a PDF Portfolio ( is ) or if this is one of the root contained in the .

The parent or if the PDF document is not a PDF Portfolio ( is ) or if this is one of the root contained in the . This property performs a linear search in the to find a key associated with this , extracts an internal folder ID from the found key and then performs a search in the folder tree to find a with that ID.

(Optional; PDF 2.0) A stream object defining the thumbnail image for the file specification (see 12.3.4, "Thumbnail Images").

A stream object defining the thumbnail image for the file specification. PDF Specification ISO 32000-1:2008, section '12.3.4 Thumbnail Images'

(Optional; PDF 2.0) A name value that represents the relationship between the component of this PDF document that refers to this and the associated file denoted by this . Default value: .

A name value that represents the relationship between the component of this PDF document that refers to this and the associated file denoted by this . Value of enumeration is not supported in the requested operation. is to be used only when no other value correctly reflects the relationship. Second-class names (see Annex E, "PDF Name Registry") might be used to represent other types of relationships. In that case, returns . The value of does not explicitly provide any processing instructions for a PDF processor. It is provided for information and semantic purposes for those processors that are able to use such additional information. Associated Files example

(PDF 2.0; Required if this file specification references an encrypted payload document) The value of this property is a which identifies that the file specified in the is an encrypted payload.

The value of this property is a which identifies that the file specified in the is an encrypted payload.

Sets the to a new with the specified .

The name of the cryptographic filter used to encrypt the encrypted payload document. This allows a PDF processor to easily determine whether it has the appropriate cryptographic filter. The file specification's . Value is or .

Returns a that represents this instance.

A that represents this instance. This method should be used primarily for debugging purposes and should be considered volatile (format of its return value might change in future versions).

Represents a language identifier that shall either be the empty text string, to indicate that the language is unknown, or a Language-Tag as defined in RFC 3066, Tags for the Identification of Languages.

PDF Specification ISO 32000-1:2008, section '14.9.2.2 Language Identifiers' RFC 3066, Tags for the Identification of Languages

Initializes a new instance of the structure.

An RFC 3066 language string.

Returns a that represents this instance.

A that represents this instance.

Determines whether the is equal to this instance.

The other language to compare with this language instance. if the is equal to this instance; otherwise, .

Determines whether the specified is equal to this instance.

The to compare with this language instance. if the specified is a and is equal to this instance; otherwise, .

Returns a hash code for this instance.

An integer value that specifies a hash value for this instance.

Determines whether and s are equal.

The first language. The second language. if and languages are equal; otherwise, .

Determines whether and s are not equal.

The first language. The second language. if and languages are not equal; otherwise, .

Represents data for an event that occurs when a PDF document is being loaded from an encrypted PDF file.

PDF Specification ISO 32000-1:2008, section '7.6 Encryption'

Gets the encryption-related information for a PDF file from which a PDF document is being loaded.

The encryption-related information for a PDF file from which a PDF document is being loaded.

Sets the password used to load a PDF document from a password-encrypted PDF file and returns if the is correct.

The password used to load a PDF document from a password-encrypted PDF file. if is invalid; otherwise, . is .

Exception that occurs when or is not correctly specified.

Decrypt example

Represents an X.509 certificate sent to others so that they can verify your digital signature with a public key contained in the certificate.

GemBox.Pdf doesn't use class to represent a certificate because creates a file that holds the certificate with the public key (in various locations on a hard drive) and on some operating systems and platforms that file is not deleted unless method is called. Another reason why GemBox.Pdf abstracts a certificate with a class instead of using directly is to enable different implementations of a certificate. For example, either implementation from .NET or Org.BouncyCastle.X509.X509Certificate implementation from Bouncy Castle could be used. RFC 5280: Internet X.509 Public Key Infrastructure Certificate and Certificate Revocation List (CRL) Profile Digital signature examples

Creates a from a PEM encoded certificate data.

The PEM encoded certificate data. A created from the specified PEM encoded certificate data.

Creates a self-signed or chain-signed X.509 Public-Key certificate.

The X.500 Distinguished Name to use as the Subject in a created certificate. The X.509 SubjectPublicKeyInfo structure to include in the certificate. Supported types are , of s that represent DER-encoding of the X.509 SubjectPublicKeyInfo structure, that represent PEM-encoding of the X.509 SubjectPublicKeyInfo structure, , , System.Security.Cryptography.ECParameters, and Org.BouncyCastle.Crypto.Parameters.ECPublicKeyParameters. A instance representing the issuing Certificate Authority (CA). If the 's is , then the created certificate is self-signed (the certificate's Issuer is equal to its Subject). The oldest date and time when the certificate is considered valid. Typically , plus or minus a few seconds. The date and time when the certificate is no longer considered valid. The optional serial number to use for the new certificate. This value should be unique per issuer. The value is interpreted as an unsigned integer of arbitrary size in big-endian byte ordering. RFC 5280 recommends confining it to 20 bytes or less. The optional X.509 Certificate Extensions collection, which is a mutable collection, to include in the certificate. The optional hash algorithm to use when signing the certificate. The optional RSA signature padding to apply when signing the certificate if has an 'RSA' private key. A with the specified values. , , or is .

Initializes a new instance of the class from a file with the specified file name.

The name of a certificate file. is .

Initializes a new instance of the class from the specified source. The certificate source is an instance of a .

The certificate source that is an instance of a . The parameter is not an instance of a .

Gets the subject distinguished name from the certificate.

The subject distinguished name from the certificate.

Gets the value of a Common Name attribute from 's distinguished name.

The value of a Common Name attribute from 's distinguished name.

Gets the copy of raw data of a .

The copy of raw data of the as a byte array.

Determines whether the specified is equal to this instance.

The to compare with this instance. if the specified is equal to this instance; otherwise, .

Determines whether the specified is equal to this instance.

The to compare with this instance. if the specified is equal to this instance; otherwise, .

Returns a hash code for this instance.

A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.

Returns a that represents this instance.

A that represents this instance. This method should be used primarily for debugging purposes and should be considered volatile (format of its return value might change in future versions).

Represents an X.509 Certificate Revocation List (CRL) that is a time-stamped list identifying revoked certificates that is signed by a Certificate Authority (CA) or CRL issuer and made freely available in a public repository.

RFC 5280: Internet X.509 Public Key Infrastructure Certificate and Certificate Revocation List (CRL) Profile

Initializes a new instance of the class.

A byte array containing X.509 Certificate Revocation List (CRL) in a format specified by RFC 5280. is .

Gets the copy of raw data of a .

The copy of raw data of the as a byte array.

Represents a digital ID used to delay-sign (deferred-sign) or re-sign a PDF file. A does not perform the actual signing because it contains only a (with a public key) and no private key. Instead, a is used in the following process: Delay-sign a PDF file by using the method followed by any of the methods. The property must be and after the signing is done, the property contains the hash of the (delay-)signed PDF file. The content of the delay-signed signature is empty (a sequence of bytes whose value is zero), thus the signature is not valid. But the signature content is replaced with the valid signature content when re-signing the PDF file. Sign the using an external signer. Re-sign the PDF file by using the method on the same on which delay-sign was performed (the method should not be called after as explained in the note of the method). The property must be set to a value returned by the external signer and after the signing is done, the property contains the hash of the re-signed PDF file (that should be the same as the hash of the delay-signed PDF file). The instances used in the delay-sign and re-sign should have equal properties so that the signature content created by re-signing fits into the delay-signed signature content that it replaces. Delay-signing is also possible with method, but then you must take care to provide the appropriate value of the estimatedSignatureContentsLength parameter that should be large enough to contain the entire signature content created when re-signing the PDF file. If the is not available when performing the delay-sign, then delay-signing must be done by using the method. The first parameter of that method should return an array of bytes whose value is zero of the estimatedSignatureContentsLength length. Note that if is not , then delay-signing with method is difficult because hash provided to the external signer is not as explained in the Message Digest Calculation Process.

Initializes a new instance of the class.

The certificate associated with this digital ID. is .

Gets a value indicating whether the is the actual hash or a data yet to be hashed. Set this value to , if the external signer expects the non-hashed data. Default value: .

if the is the actual hash; otherwise, if the is a data yet to be hashed. This property is applicable only when doing the delay-sign. When doing the re-sign, the hash is always calculated.

Gets the hash of either delay-signed (if the is ) or re-signed (if the is not ) PDF file. In the case of a delay-signing the should be passed to an external signer for signing and the returned signature should be set to the and the PDF file should be re-signed.

The hash of either delay-signed or re-signed PDF file.

Gets or sets the signature with which the PDF file should be re-signed. Should be if the is used for delay-sign.

The signature with which the PDF file should be re-signed. Value is .

A digital ID used to sign and encrypt documents. The certificate that comes with your digital ID is sent to others so that they can verify your signature. The most secure digital IDs are issued by trusted Certificate authorities and are based on secure devices like smart card or token. Some are based on files.

GemBox.Pdf doesn't use class to represent a digital ID because creates a file that holds the private key and another file that holds the certificate with the public key (in various locations on a hard drive) and on some operating systems and platforms those files are not deleted unless method is called. Another reason why GemBox.Pdf abstracts a digital ID with a class instead of using directly is to enable different implementations of a digital ID. For example, either implementation from .NET or Org.BouncyCastle.X509.X509Certificate with Org.BouncyCastle.Crypto.AsymmetricKeyParameter (private key) implementation from Bouncy Castle could be used. Lastly, GemBox.Pdf abstracts a digital ID with a class to enable usage of signers for which private key parameters cannot be exported into .NET or Bouncy Castle implementation. These are, for example, Hardware Security Module (HSM), USB token, smart card or a web service and their functionality is called when overriding method. Digital signature examples External digital signature example

Gets or sets the certificate.

The certificate. The is already set. Value is .

Sets the certificate even if the is already set.

The certificate. Value is .

Initializes a new instance of the class. Used if the value of PDF signature is computed externally in which case method must be overridden.

The certificate associated with this digital ID. If value is passed, then property must be set before signing the document.

Initializes a new instance of the class from a file with the specified file name and the password protecting the private key. The most common format for such files is a PKCS#12 file, which uses .pfx or .p12 file extension and is a password protected storage container for digital IDs containing the public key (Certificate) and the associated private key.

The name of a digital ID file that contains the public key (Certificate) and the associated private key. The password protecting the private key. is . Digital ID doesn't have a private key.

Initializes a new instance of the class from the specified source. The digital ID source is either an instance of a with a private key or an instance of a .

The digital ID source that is either an instance of a with a private key or an instance of a . The parameter is not an instance of a or a . Digital ID doesn't have a private key.

When overridden in a derived class, computes the signature for the specified hash value.

The hash value of the data to be signed. The hash algorithm used to create the hash value of the data. The RSA signature padding. The signature for the specified hash value. Class deriving from must override method. External digital signature example

Returns a that represents this instance.

A that represents this instance. This method should be used primarily for debugging purposes and should be considered volatile (format of its return value might change in future versions).

Represents a container that may contain: a collection of all certificates used for the signatures, including timestamp signatures, that occur in the document. It shall also hold all the auxiliary certificates required to validate the certificates participating in certificate chain validations. a collection of all Certificate Revocation Lists (CRLs) (see RFC 5280) used for some of the signatures, and a collection of all Certificate Status Protocol (OCSP) responses (see RFC 6960) used for some of the signatures.

ETSI EN 319 142-1, section '5.4.2.2 DSS Dictionary' PAdES B-LT level example

Gets the X.509 certificates that maybe used in the validation of any signatures in the document.

The X.509 certificates that maybe used in the validation of any signatures in the document.

Gets the X.509 Certificate Revocation Lists (CRLs) that may be used in the validation of the signatures in the document.

The X.509 Certificate Revocation Lists (CRLs) that may be used in the validation of the signatures in the document.

Gets the X.509 Online Certificate Status Protocol (OCSP) responses that may be used in the validation of the signatures in the document.

The X.509 Online Certificate Status Protocol (OCSP) responses that may be used in the validation of the signatures in the document.

Gets the validation-related information (CA certificates, CRLs and/or OCSPs responses) used to validate the specified certificate.

The certificate for which to retrieve the validation-related information. The validation-related information (CA certificates, CRLs and/or OCSPs responses) used to validate the specified certificate. PAdES B-LT level example

Adds certificates, certificate revocation lists and Online Certificate Status Protocol responses for the specified to this . The full set of certificates, including the trust anchor when it is available in the form of a certificate, used to validate the signature and which are not already present in the signature are added to the security store. This set includes certificates required for validating the signing certificate, for validating any attribute certificate present in the signature, and for validating any time-stamp token's signing certificate (i.e. a TSA certificate) already incorporated to the signature. The full set of revocation data (CRL or OCSP responses) used in the validation of the signer and CA certificates used in signature are added to the security store. This set includes all certificate status information required for validating the signing certificate, for validating any attribute certificate present in the signature, and for validating any time-stamp token's signing certificate (i.e. a TSA certificate) already incorporated to the signature.

The signature whose certificates, certificate revocation lists and Online Certificate Status Protocol responses are added to this . is . PAdES B-LTA level example

Adds certificates, certificate revocation lists and Online Certificate Status Protocol responses from the specified to this .

The signature validation-related information whose certificates, certificate revocation lists and Online Certificate Status Protocol responses are added to this . is . If certificate already exists in the , it is not added. PAdES B-LT level example

Removes all certificates, certificate revocation lists and Online Certificate Status Protocol responses from this .

Returns a that represents this instance.

A that represents this instance. This method should be used primarily for debugging purposes and should be considered volatile (format of its return value might change in future versions).

Identifies that the file specified in the of a is an encrypted payload.

(Required) The name of the cryptographic filter used to encrypt the encrypted payload document. This allows a PDF processor to easily determine whether it has the appropriate cryptographic filter.

The name of the cryptographic filter used to encrypt the encrypted payload document. Value is or .

(Optional) The version number of the cryptographic filter used to encrypt the encrypted payload.

The version number of the cryptographic filter used to encrypt the encrypted payload.

Returns a that represents this instance.

A that represents this instance. This method should be used primarily for debugging purposes and should be considered volatile (format of its return value might change in future versions).

Stores encryption-related information.

PDF Specification ISO 32000-1:2008, section '7.6 Encryption' Encryption examples

Represents an encryption algorithm used in a PDF file.

PDF Specification ISO 32000-1:2008, section '7.6 Encryption' Encryption settings example

A proprietary encryption algorithm known as RC4. RC4 is a symmetric stream cipher: the same algorithm shall be used for both encryption and decryption, and the algorithm does not change the length of the data.

The AES (Advanced Encryption Standard) algorithm (beginning with PDF 1.6). AES is a symmetric block cipher: the same algorithm shall be used for both encryption and decryption, and the length of the data when encrypted is rounded up to a multiple of the block size, which is fixed to always be 16 bytes, as specified in FIPS 197, Advanced Encryption Standard (AES). Strings and streams encrypted with AES shall use a padding scheme that is described in Internet RFC 2898, PKCS #5: Password-Based Cryptography Specification Version 2.0. For an original message length of M, the pad shall consist of 16 - (M mod 16) bytes whose value shall also be 16 - (M mod 16). The Cipher Block Chaining (CBC) mode, which requires an initialization vector, is used. The block size parameter is set to 16 bytes, and the initialization vector is a 16-byte random number that is stored as the first 16 bytes of the encrypted stream or string.

Represents a symmetric encryption algorithm used in a PDF file and the length of the encryption key used in that algorithm.

PDF Specification ISO 32000-1:2008, section '7.6 Encryption' Encryption settings example

The 40-bit RC4 encryption level.

The 128-bit RC4 encryption level.

The 128-bit AES encryption level. Compatible with .

The 256-bit AES encryption level. Compatible with using Adobe's extension level 8 or with .

Gets the symmetric encryption algorithm.

The symmetric encryption algorithm.

Gets the length of the encryption key (in bits) used in the .

The length of the encryption key (in bits) used in the .

Initializes a new instance of the structure.

The symmetric encryption algorithm. The length of the encryption key (in bits) used in the .

Determines whether the specified is equal to this instance.

The to compare with this instance. if the specified is equal to this instance; otherwise, .

Determines whether the specified is equal to this instance.

The to compare with this instance. if the specified is equal to this instance; otherwise, .

Returns a hash code for this instance.

A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.

Returns a that represents this instance.

A that represents this instance. This method should be used primarily for debugging purposes and should be considered volatile (format of its return value might change in future versions).

Determines whether and s are equal.

The first PDF encryption level. The second PDF encryption level. if and PDF encryption levels are equal; otherwise, .

Determines whether and s are not equal.

The first PDF encryption level. The second PDF encryption level. if and PDF encryption levels are not equal; otherwise, .

Represents options for PDF file password-based encryption.

PDF Specification ISO 32000-1:2008, section '7.6.3 Standard Security Handler' Encryption settings example

No content shall be encrypted.

All strings shall be encrypted.

All streams shall be encrypted except embedded file streams (if is not set) and document-level metadata stream (if is not set).

All content (strings and streams) shall be encrypted except embedded file streams (if is not set) and document-level metadata stream (if is not set).

Embedded files shall be encrypted.

Document-level metadata stream (see 14.3.2, "Metadata Streams") shall be encrypted. If is set, it is applicable only if is also set. If is not set, it is applicable always.

All content (strings and streams) in the document shall be encrypted.

Represents a hash algorithm used in GemBox.Pdf cryptographic operations.

PDF Specification ISO 32000-1:2008, Table 253 'Entries in a signature reference dictionary'

The hash algorithm is unknown.

The MD5 cryptographic hash algorithm that produces a hash whose size is 128 bits (16 bytes).

The SHA1 cryptographic hash algorithm that produces a hash whose size is 160 bits (20 bytes).

The RIPEMD160 cryptographic hash algorithm that produces a hash whose size is 160 bits (20 bytes).

The SHA256 cryptographic hash algorithm that produces a hash whose size is 256 bits (32 bytes).

The SHA384 cryptographic hash algorithm that produces a hash whose size is 384 bits (48 bytes).

The SHA512 cryptographic hash algorithm that produces a hash whose size is 512 bits (64 bytes).

Represents an X.509 Online Certificate Status Protocol Response useful in determining the current status of a digital certificate without requiring Certificate Revocation Lists.

RFC 6960: X.509 Internet Public Key Infrastructure Online Certificate Status Protocol - OCSP

Initializes a new instance of the class.

A byte array containing an X.509 Online Certificate Status Protocol Response in a format specified by RFC 6960. is .

Gets the copy of raw data of a .

The copy of raw data of the as a byte array.

Stores encryption-related information for a PDF's standard security handler that shall allow up to two passwords to be specified for a document: a and a with access .

PDF Specification ISO 32000-1:2008, section '7.6.3 Standard Security Handler' Encryption examples

Gets or sets the Document Open password (also known as a user password) required to open the PDF file. Default value: (PDF file can be decrypted without a password).

The Document Open password. Current encryption information is used to read or write an encrypted PDF file and cannot be changed. Set new encryption information instead.

Gets or sets the Permissions password (also known as a master password) required if a user performs an action that is not allowed by . Default value: (actions not allowed by can be performed without a password).

The Permissions password. Current encryption information is used to read or write an encrypted PDF file and cannot be changed. Set new encryption information instead. Restrict editing example

(Required) A set of flags specifying which operations shall be permitted when the document is opened with user access (see Table 22).

A set of flags specifying which operations shall be permitted when the document is opened with user access. Current encryption information is used to read or write an encrypted PDF file and cannot be changed. Set new encryption information instead. PDF Specification ISO 32000-1:2008, section '7.6.3.2 Standard Encryption Dictionary' Restrict editing example

Gets or sets the encryption level. Default value: .

The encryption level. Value is not , , nor . Current encryption information is used to read or write an encrypted PDF file and cannot be changed. Set new encryption information instead. Encryption settings example

Gets or sets the encryption options. Default value: .

The encryption options. Current encryption information is used to read or write an encrypted PDF file and cannot be changed. Set new encryption information instead. Encryption settings example

Determines whether the specified is correct password to decrypt the specified using this .

The password to check for correctness. The encrypted document for which to check the specified . If set to , the specified is a correct . if the specified is a correct password to decrypt the specified using this ; otherwise, . or is .

Represents a digital ID that is stored on a cryptographic device accessible through PKCS#11 application programming interface called "Cryptoki".

Gets the key identifier for public/private key pair (default empty) as hex encoded string.

The key identifier for public/private key pair (default empty) as hex encoded string.

Gets the optional label associated with either private key, public key, or certificate of the current .

The optional label associated with either private key, public key, or certificate of the current .

Gets or sets the context-specific Personal Identification Number (PIN) for each use of a private key. "Use" in this case means a cryptographic operation such as sign or decrypt. Default value: .

The context-specific Personal Identification Number (PIN) for each use of a private key. CKA_ALWAYS_AUTHENTICATE

Creates a self-signed X.509 Public-Key certificate with a X.509 SubjectPublicKeyInfo structure to include in the certificate extracted from the PKCS#11 private key or public key associated with this .

The X.500 Distinguished Name to use as the Subject in a created certificate. If , the value is extracted from the PKCS#11 private key or public key associated with this or a predefined value is used. The oldest date and time when the certificate is considered valid. Typically , plus or minus a few seconds. If , the value is extracted from the PKCS#11 private key or public key associated with this or a predefined value is used. The date and time when the certificate is no longer considered valid. If , the value is extracted from the PKCS#11 private key or public key associated with this or a predefined value is used. A created or if the creation was not successful.

Represents a cryptographic device that stores cryptographic information and possibly performs cryptographic functions accessible through PKCS#11 application programming interface called "Cryptoki". Cryptographic device may be implemented as a smart card, smart disk, PCMCIA card, or with some other technology, including software-only. GemBox.Pdf uses Pkcs11Interop to communicate with a cryptographic device from a .NET runtime so your project must reference NuGet package Pkcs11Interop in order to use this class. initialized for the specified PKCS#11 module should be a singleton instance in the application (process). After it is disposed or closed, either manually or automatically (via finalizer), the unmanaged library is unloaded from the process and cannot be reloaded easily. After you are finished using make sure you either dispose it or call its method.

Pkcs11Interop PKCS #11 Cryptographic Token Interface Base Specification Version 3.0 PKCS#11 (Cryptoki) digital signature example

Initializes a new instance of the class using a path to the specified PKCS#11 module.

The path to the PKCS#11 module (usually a .dll). If set to (recommended option), the PKCS#11 module will be used from multi-threaded application and needs to perform locking with native OS threading model; otherwise, the PKCS#11 module will be used from single-threaded application and does not need to perform any kind of locking.

Gets the ID of the Cryptoki library manufacturer.

The ID of the Cryptoki library manufacturer.

Gets the description of the library.

The description of the library.

Gets the Cryptoki library version number.

The Cryptoki library version number.

Gets the Cryptoki interface version number.

The Cryptoki interface version number.

Gets the path to the PKCS#11 module (usually a .dll).

The path to the PKCS#11 module (usually a .dll).

Gets the tokens present in all slots of this cryptographic device.

The tokens present in all slots of this cryptographic device.

Returns a that represents this instance.

A that represents this instance. This method should be used primarily for debugging purposes and should be considered volatile (format of its return value might change in future versions).

Indicates that an application is finished with the Cryptoki library. It should be the last Cryptoki call made by an application.

5.4.2 C_Finalize

Closes the .

Represents the logical view of a cryptographic device defined by Cryptoki. Various objects can be stored on a token. These include data, certificates and keys. Stored objects can be accessed and cryptographic functions performed only after the session (a logical connection between an application and a token) is opened. The implicitly opens the session when required, and reuses the opened session until the is disposed. The session can be opened only on the thread the was created on. To open a session on another thread, clone the , use the clone with its own session, and dispose the clone. associates a single session with itself because Cryptoki doesn't guarantee that a particular object on a token has a handle which is fixed for the lifetime of the object; however, if a particular session can use a particular handle to access a particular object, then that session will continue to be able to use that handle to access that object as long as the session continues to exist, the object continues to exist, and the object continues to be accessible to the session. uses object handles to access private keys, public keys, and certificates contained on the token in order to build the and, therefore, this must be done in the scope of a single session.

PKCS#11 (Cryptoki) digital signature example

Gets the application-defined label, assigned during token initialization.

The application-defined label, assigned during token initialization.

Gets the ID of the device manufacturer.

The ID of the device manufacturer.

Gets the model of the device.

The model of the device.

Gets the serial number of the device.

The serial number of the device.

Gets the digital IDs contained on this token.

The digital IDs contained on this token.

Logs a user into a token.

The user's Personal Identification Number (PIN). Since all sessions an application has with a token have a shared login state, only needs to be called for one of the sessions (source). If the is going to be used from multiple threads concurrently, then there should be one master on which the should be called once and instances returned by the method on the master should be used in each thread. 5.6.8 C_Login PKCS#11 (Cryptoki) digital signature example Workflow in the multithreaded application

Logs a user out from a token.

5.6.10 C_Logout

Clones the so that the returned clone can rebuild its using its own session on another thread. For more information about Cryptoki sessions, read the documentation of the class. After you are finished using the cloned make sure you dispose it so that its associated session is closed.

The clone of the whose session can be used on another thread.

Closes the Cryptoki session associated with this . It should be called only on instances returned by the method.

Returns a that represents this instance.

A that represents this instance. This method should be used primarily for debugging purposes and should be considered volatile (format of its return value might change in future versions).

Represents the padding to use with RSA signature.

Gets the object that represents RSASSA-PKCS1-v1.5 signature scheme of the PKCS #1: RSA Encryption Standard that is supported for compatibility with existing applications.

The object that represents RSASSA-PKCS1-v1.5 signature scheme of the PKCS #1: RSA Encryption Standard that is supported for compatibility with existing applications. RFC 8017, section 8.2. RSASSA-PKCS1-v1_5 RFC 8017, appendix A.2.4. RSASSA-PKCS-v1_5

Gets the object that represents Probabilistic Signature Scheme (RSASSA-PSS) of the PKCS #1: RSA Encryption Standard that is recommended for new applications. Parameters of the RSASSA-PSS are set to the following default values: hashAlgorithm: value of . maskGenAlgorithm: MGF1 (a mask generation function based on a hash function) with . saltLength: the octet length of the hash value produced by . trailerField: default (DER-encoded integer 1 which is hexadecimal value 0xBC).

The object that represents Probabilistic Signature Scheme (RSASSA-PSS) of the PKCS #1: RSA Encryption Standard that is recommended for new applications. RFC 8017, section 8.1. RSASSA-PSS RFC 8017, appendix A.2.3. RSASSA-PSS

Determines whether the is equal to this instance.

The other RSA signature padding to compare with this RSA signature padding instance. if the is equal to this instance; otherwise, .

Determines whether the specified is equal to this instance.

The to compare with this RSA signature padding instance. if the specified is a and is equal to this instance; otherwise, .

Returns a hash code for this instance.

An integer value that specifies a hash value for this instance.

Returns a that represents this instance.

A that represents this instance.

Determines whether and s are equal.

The first RSA signature padding. The second RSA signature padding. if and RSA signature paddings are equal; otherwise, .

Determines whether and s are not equal.

The first RSA signature padding. The second RSA signature padding. if and RSA signature paddings are not equal; otherwise, .

Represents a timestamper that gets the TimeStampToken as specified in RFC 3161 as updated by RFC 5816. The value of the messageImprint field within the TimeStampToken shall be a hash of either: the bytes of the signature field within SignerInfo for the CMS-based if the generated timestamp token is included as a unsigned attribute of that SignerInfo (signature timestamp). the bytes of the document indicated by the ByteRange and the ByteRange shall specify the complete PDF file contents (excepting the value) if the generated timestamp token is included as a content of a signature dictionary (whose Type entry has a value of DocTimeStamp) that is a value of a signature field added as an incremental update (document timestamp).

PDF Specification ISO 32000-1:2008, section '12.8.3.3 PKCS#7 Signatures as used in ISO 32000' ETSI EN 319 142-1, section '5.4.3 Document Time-stamp' PAdES B-T level example PAdES B-LTA level example

Initializes a new instance of the class. Used if the timestamp is created externally in which case property and method must be overridden.

Initializes a new instance of the class with the specified address of a Timestamp Authority (TSA) that generates the timestamp token.

The address of a Timestamp Authority (TSA) that generates the timestamp token. is .

Gets the address of a Timestamp Authority (TSA) that generates the timestamp token.

The address of a Timestamp Authority (TSA) that generates the timestamp token.

Gets or sets the user name used in an HTTP Authorization header if Timestamp Authority (TSA) requires authentication information for the TimeStampToken request. Default value: .

The user name used in an HTTP Authorization header if Timestamp Authority (TSA) requires authentication information for the TimeStampToken request.

Gets or sets the password used in an HTTP Authorization header if Timestamp Authority (TSA) requires authentication information for the TimeStampToken request. Default value: .

The password used in an HTTP Authorization header if Timestamp Authority (TSA) requires authentication information for the TimeStampToken request.

Gets or sets the client digital ID used in a Transport Layer Security protocol if Timestamp Authority (TSA) requires it to identify the TimeStampToken request client. Default value: .

The client digital ID used in a Transport Layer Security protocol if Timestamp Authority (TSA) requires it to identify the TimeStampToken request client.

Gets or sets the proxy used by the . Default value:

The proxy used by the .

Gets or sets the hash algorithm that hashes either: the bytes of the signature field within SignerInfo for the CMS-based if the generated timestamp token is included as an unsigned attribute of that SignerInfo (signature timestamp). the bytes of the document indicated by the ByteRange and the ByteRange shall specify the complete PDF file contents (excepting the value) if the generated timestamp token is included as a content of a signature dictionary (whose Type entry has a value of DocTimeStamp) that is a value of a signature field added as an incremental update (document timestamp). Default value: .

The hash algorithm.

(Optional; PDF 1.5) The name of the software module used to create the timestamp. When used as an entry in the data dictionary of the Filter attribute (Table 2.1), the value is the name of the signature handler. The value is normally equal to the value of the Filter attribute in the signature dictionary. Default value: .

The name of the software module used to create the timestamp. The Digital Signature Build Properties Dictionary Specification

A text string indicating the version of the application implementation, as described by the Name attribute in this dictionary. The Digital Signature Build Properties Dictionary Specification

Gets the estimated length of the timestamp token (in bytes) that should be large enough to contain the entire data returned by the method.

The estimated length of the timestamp token (in bytes) that should be large enough to contain the entire data returned by the method.

A method called when saving the PDF file that takes either the signature field value (in case of a signature timestamp) or the PDF file stream (without entry) (in case of a document timestamp) as an input and returns the TimeStampToken as specified in RFC 3161 as updated by RFC 5816.

Either the signature field value (in case of a signature timestamp) or the PDF file stream (without entry) (in case of a document timestamp) for which the TimeStampToken should be retrieved. The TimeStampToken that is included either as an unsigned attribute of the SignerInfo (in case of a signature timestamp) or as a content of a signature dictionary (whose Type entry has a value of DocTimeStamp) that is a value of a signature field added as an incremental update (in case of a document timestamp).

Represents user access permissions.

PDF Specification ISO 32000-1:2008, section '7.6.3.2 Standard Encryption Dictionary' PDF Specification ISO 32000-1:2008, section '7.6.4.2 Public-Key Encryption Dictionary' PDF Specification ISO 32000-1:2008, section '12.8.2.2.2 Validating Signatures That Use the DocMDP Transform Method' Restrict editing example

None. Supported in the and with the following meaning: No changes to the document are permitted; any change to the document shall invalidate the signature.

(Security handlers of revision 2) Print the document. (Security handlers of revision 3 or greater) Print the document (possibly not at the highest quality level, depending on whether is also set). Not supported in the and ( is thrown).

Modify the contents of the document by operations other than those controlled by bits , , and . Not supported in the and ( is thrown).

(Security handlers of revision 2) Copy or otherwise extract text and graphics from the document, including extracting text and graphics (in support of accessibility to users with disabilities or for other purposes). (Security handlers of revision 3 or greater) Copy or otherwise extract text and graphics from the document by operations other than that controlled by bit . Not supported in the and ( is thrown).

Add or modify text annotations, fill in interactive form fields, and, if bit is also set, create or modify interactive form fields (including signature fields). Supported in the and with the following meaning: Permitted changes are the same as for , as well as annotation creation, deletion, and modification; other changes shall invalidate the signature.

(Security handlers of revision 3 or greater) Fill in existing interactive form fields (including signature fields), even if bit is clear. Supported in the and with the following meaning: Permitted changes shall be filling in forms, instantiating page templates, and signing; other changes shall invalidate the signature. Adding pages with a rarely used technique called spawning page templates is allowed, but not manually adding pages with Tools, Pages, Insert Pages. Only signing by clicking a signature field is allowed, but not via Acrobat's menu items.

(Security handlers of revision 3 or greater) Extract text and graphics (in support of accessibility to users with disabilities or for other purposes). Not supported in the and ( is thrown).

(Security handlers of revision 3 or greater) Assemble the document (insert, rotate, or delete pages and create bookmarks or thumbnail images), even if bit is clear. Not supported in the and ( is thrown).

(Security handlers of revision 3 or greater) Print the document to a representation from which a faithful digital copy of the PDF content could be generated. When this bit is clear (and bit is set), printing is limited to a low-level representation of the appearance, possibly of degraded quality. Not supported in the and ( is thrown).

Represents options used for loading a from a PDF file.

File Structure

Gets the default options used for loading any from a PDF file.

The default options used for loading any from a PDF file.

Gets or sets a value indicating whether to load a from a read-only PDF file so that changes made to the cannot be saved back to the same PDF file. When a PDF file is opened in Adobe Acrobat Reader, it will lock the file so no other process can write to the file while it is opened. Use this property to load a from the PDF file in a read-only mode while it is still opened in Adobe Acrobat Reader. Also, if you want to open a PDF file in Adobe Acrobat Reader while the is loaded from the PDF file and before it is closed, then use this property to load a from a PDF file in a read-only mode. Note that loading a from a PDF file in a read-only mode (without acquiring an exclusive write lock on the file) might lead to unpredictable behavior if the file is simultaneously changed by another process because the PDF file is read into memory incrementally and lazily. To prevent the unpredictable behavior at the expense of performance, use method to read the entire PDF file into memory. Default value: .

to load from a read-only PDF file so that changes made to the cannot be saved back to the same PDF file; otherwise, .

Gets or sets the password used to load a PDF document from a password-encrypted PDF file. If PDF file is not encrypted, then this property is ignored. If PDF file is encrypted and is invalid, then is thrown when loading a PDF document.

The password used to load a PDF document from a password-encrypted PDF file. Value is . Decrypt example

Gets or sets a value indicating whether authorization should be handled right away when PDF document is opened or when the first string or stream is read. Default value: .

if authorization should be handled right away when PDF document is opened; otherwise, .

Occurs when a PDF document is being loaded from an encrypted PDF file. This even must be handled in cases when some kind of authorization (for example, password) is required in order to decrypt the PDF file.

PDF Specification ISO 32000-1:2008, section '7.6 Encryption'

Initializes a new instance of the class.

Represents a range of numbers.

A range of numbers might be specified in the reversed order. In that case is greater than . This is usually used when a is used to specify interpolation bounds of an interpolation that inverts a value. This is also the reason why properties and are not named Min and Max (Min would be greater than Max, which is confusing).

Gets the first number in the range.

The first number in the range.

Gets the last number in the range.

The last number in the range.

Initializes a new instance of the structure.

The first number of the new structure. The last number of the new structure. or is either , or .

Returns a that represents this instance.

A that represents this instance. This method should be used primarily for debugging purposes and should be considered volatile (format of its return value might change in future versions).

Determines whether the is equal to this instance.

The other number range to compare with this number range instance. if the is equal to this instance; otherwise, .

Determines whether the specified is equal to this instance.

The to compare with this number range instance. if the specified is a and is equal to this instance; otherwise, .

Returns a hash code for this instance.

An integer value that specifies a hash value for this instance.

Returns 0 if a specified is between the and the , -1 if it is less than the , or 1 if it is greater than the . This method is applicable only if the is less than or equal to the .

A to compare. A signed number indicating the relative order of this instance and .

Determines whether and s are equal.

The first number range. The second number range. if and number ranges are equal; otherwise, .

Determines whether and s are not equal.

The first number range. The second number range. if and number ranges are not equal; otherwise, .

Represents a collection of s.

Initializes a new instance of the class.

Adds a with the specified first and last number to the collection.

The number of the to add. The number of the to add.

Represents a base class for all types that implement various PDF components in the GemBox.Pdf assembly.

GemBox.Pdf assembly doesn't publicly expose constructors for types assignable from (except ), , and types. These types are instead instantiated either through Create or other factory methods. Reasons for this is to support either the current or future extensibility of the type without affecting backward compatibility and without using composition to reduce the number of object allocations. For example, type is implemented as and PdfReal type. When using method, GemBox.Pdf assembly is able to create either PdfReal or , or return a cached instance of available for an implementation-defined interval of integers, thus reducing memory overhead. and types have several implementations that reduce the number of byte[] allocations. type is currently implemented as a dynamic array. In the future, GemBox.Pdf assembly might provide an implementation that is immutable (without a need to use composition) to reduce memory overhead and optimize cloning operation. type is currently implemented as a hash table with a separate chaining collision resolution. In the future, GemBox.Pdf assembly might provide an implementation that uses dynamic array (without a need to use composition) if number of entries is small, to reduce memory overhead and, potentially, improve performance. All these current and future implementations would not be possible in a backward compatible way (without unnecessary usage of composition) if constructors were publicly exposed.

(Optional; PDF 1.4) A metadata stream containing metadata for the component.

A metadata stream containing metadata for the component. Value is not according to PDF Specification ISO 32000-1:2008. PDF Specification ISO 32000-1:2008, section '14.3.2 Metadata Streams'

Represents a base class for all collection types whose backing storage (usually ) is optional and created only if required.

The type of elements in the collection.

A PDF document may contain a document outline that the conforming reader may display on the screen, allowing the user to navigate interactively from one part of the document to another. The outline consists of a tree-structured hierarchy of outline items (sometimes called bookmarks), which serve as a visual table of contents to display the document's structure to the user. represents a single outline item that is a node in the doubly linked list of outline items represented by .

PDF Specification ISO 32000-1:2008, section '12.3.3 Document Outline' Outlines example

Gets the that the belongs to.

The that the belongs to.

Gets the parent of this in the outline hierarchy.

The parent of this in the outline hierarchy.

Gets the s contained directly under this .

The s contained directly under this .

(Required) The text that shall be displayed on the screen for this item.

The text that shall be displayed on the screen for this item. Value is . PDF Specification ISO 32000-1:2008, section '12.3.3 Document Outline'

(Required for all but the first item at each level; shall be an indirect reference) The previous item at this outline level.

The previous item at this outline level. PDF Specification ISO 32000-1:2008, section '12.3.3 Document Outline'

(Required for all but the last item at each level; shall be an indirect reference) The next item at this outline level.

The next item at this outline level. PDF Specification ISO 32000-1:2008, section '12.3.3 Document Outline'

(Optional; shall not be present if an A entry is present) The destination that shall be displayed when this item is activated (see 12.3.2, "Destinations").

The explicit destination that shall be displayed when this item is activated. PDF Specification ISO 32000-1:2008, section '12.3.2 Destinations'

(Optional; shall not be present if an A entry is present) The named destination that shall be displayed when this item is activated (see 12.3.2.3, "Named Destinations").

The named destination that shall be displayed when this item is activated. PDF Specification ISO 32000-1:2008, section '12.3.2.3 Named Destinations'

(Optional; PDF 1.1; shall not be present if a Dest entry is present) The action that shall be performed when this item is activated (see 12.6, "Actions").

The action that shall be performed when this item is activated.

Gets or sets a value indicating whether this is closed.

if is closed; otherwise, .

Sets the explicit destination that shall be displayed when this item is activated (see 12.3.2.2, "Explicit Destinations"). represent the following values depending on the parameter: , , and . , and . and . and . and None.

The page that shall be displayed when this item is activated. Type of the view. The parameters of the view. The explicit destination that shall be displayed when this item is activated. PDF Specification ISO 32000-1:2008, section '12.3.2.2 Explicit Destinations'

Returns a that represents this instance.

A that represents this instance. This method should be used primarily for debugging purposes and should be considered volatile (format of its return value might change in future versions).

A PDF document may contain a document outline that the conforming reader may display on the screen, allowing the user to navigate interactively from one part of the document to another. The outline consists of a tree-structured hierarchy of outline items (sometimes called bookmarks), which serve as a visual table of contents to display the document's structure to the user. represents a collection of outline items. This collection is implemented as doubly linked list and therefore methods that use random access (index) are an O(n) operations, where n is .

PDF Specification ISO 32000-1:2008, section '12.3.3 Document Outline' Outlines example

(Required if the item has any descendants; shall be an indirect reference) The first of this item’s immediate children in the outline hierarchy.

The first of this item’s immediate children in the outline hierarchy. PDF Specification ISO 32000-1:2008, section '12.3.3 Document Outline'

(Required if the item has any descendants; shall be an indirect reference) The last of this item’s immediate children in the outline hierarchy.

The last of this item’s immediate children in the outline hierarchy. PDF Specification ISO 32000-1:2008, section '12.3.3 Document Outline'

Returns an enumerator that iterates through the .

A for the .

Adds a new with the specified title after the specified existing in the .

The after which to insert a new with the specified title. The title of a new added to the . The new with the specified title. or is . is not in the current .

Adds the specified new after the specified existing in the .

The after which to insert . The new to add to the . or is . is not in the current or belongs to another .

Adds a new with the specified title before the specified existing in the .

The before which to insert a new with the specified title. The title of a new added to the . The new with the specified title. or is . is not in the current .

Adds the specified new before the specified existing in the .

The before which to insert . The new to add to the . or is . is not in the current or belongs to another .

Adds a new with the specified title at the start of the .

The title of a new added at the start of the . The new with the specified title. is .

Adds the specified at the start of the .

The to add at the start of the . is . belongs to another .

Adds a new with the specified title at the end of the .

The title of a new added at the end of the . The new with the specified title. is .

Adds the specified at the end of the .

The to add at the end of the . is . belongs to another .

Removes the at the start of the .

The is empty.

Removes the at the end of the .

The is empty.

Enumerates the elements of a .

Gets the element at the current position of the enumerator.

The element in the at the current position of the enumerator.

Advances the enumerator to the next element of the .

if the enumerator was successfully advanced to the next element; if the enumerator has passed the end of the collection. The collection was modified after the enumerator was created.

Releases all resources used by the .

Represents padding or margin information.

Initializes a new instance of the structure.

The padding value for the left edge. The padding value for the bottom edge. The padding value for the right edge. The padding value for the top edge.

Gets the padding value for the left edge.

The padding value for the left edge.

Gets the padding value for the bottom edge.

The padding value for the bottom edge.

Gets the padding value for the right edge.

The padding value for the right edge.

Gets the padding value for the top edge.

The padding value for the top edge.

Returns a that represents this instance.

A that represents this instance. This method should be used primarily for debugging purposes and should be considered volatile (format of its return value might change in future versions).

Determines whether the is equal to this instance.

The other padding to compare with this padding instance. if the is equal to this instance; otherwise, .

Determines whether the specified is equal to this instance.

The to compare with this padding instance. if the specified is a and is equal to this instance; otherwise, .

Returns a hash code for this instance.

An integer value that specifies a hash value for this instance.

Determines whether and s are equal.

The first padding. The second padding. if and paddings are equal; otherwise, .

Determines whether and s are not equal.

The first padding. The second padding. if and paddings are not equal; otherwise, .

Represents the leaf of the page tree, a page object, a dictionary specifying the attributes of a single page of the document.

PDF Specification ISO 32000-1:2008, section '7.7.3.3 Page Objects' Page Tree example Document Structure

Gets the content of the .

Gets a value of type that represents the collection of s in the . A stores its rendering data in a one or more content streams (whose data consists of a sequence of instructions describing the graphical elements to be painted) and an associated resource dictionary. For more information on how s store graphics data, see 7.8, "Content Streams and Resources". Content Streams and Resources Reading example Content Streams and Resources example PDF Specification ISO 32000-1:2008, section '7.8 Content Streams and Resources'

(Optional) An array of annotation dictionaries that shall contain indirect references to all annotations associated with the page (see 12.5, "Annotations").

An array of annotation dictionaries that shall contain indirect references to all annotations associated with the page. PDF Specification ISO 32000-1:2008, section '7.7.3.3 Page Objects'

(Optional; PDF 1.6) A positive number that shall give the size of default user space units, in multiples of 1/72 inch. The range of supported values shall be implementation-dependent. Default value: 1.0 (user space unit is 1/72 inch).

A positive number that shall give the size of default user space units, in multiples of 1/72 inch. Value is less than or equal to 0.

(Optional; PDF 2.0) An array of one or more s which denote the associated files for this .

An array of one or more s which denote the associated files for this . Associated Files example

Gets the transformation from the coordinate system transformed by ., ., , and entries to the original (untransformed) coordinate system in which . is 0, .) is 0, is 0, and is 1.

The transformation from the coordinate system transformed by ., ., , and entries to the original (untransformed) coordinate system in which . is 0, .) is 0, is 0, and is 1. PDF Specification ISO 32000-1:2008, section '8.3.2.3 User Space'

Gets the page size in the original (untransformed) coordinate system in which is 0, and is 1.

The page size in the original (untransformed) coordinate system in which is 0, and is 1. PDF Specification ISO 32000-1:2008, section '8.3.2.3 User Space'

Converts the to a .

The associated with the . A with the same contents as this .

A PDF page may be prepared either for a finished medium, such as a sheet of paper, or as part of a prepress process in which the content of the page is placed on an intermediate medium, such as film or an imposed reproduction plate. In the latter case, it is important to distinguish between the intermediate page and the finished page. The intermediate page may often include additional production-related content, such as bleeds or printer marks, that falls outside the boundaries of the finished page. To handle such cases, a PDF page may define as many as five separate boundaries to control various aspects of the imaging process:

The media box defines the boundaries of the physical medium on which the page is to be printed. It may include any extended area surrounding the finished page for bleed, printing marks, or other such purposes. It may also include areas close to the edges of the medium that cannot be marked because of physical limitations of the output device. Content falling outside this boundary may safely be discarded without affecting the meaning of the PDF file.

The crop box defines the region to which the contents of the page shall be clipped (cropped) when displayed or printed. Unlike the other boxes, the crop box has no defined meaning in terms of physical page geometry or intended use; it merely imposes clipping on the page contents. However, in the absence of additional information (such as imposition instructions specified in a JDF or PJTF job ticket), the crop box determines how the page’s contents shall be positioned on the output medium.

The bleed box (PDF 1.3) defines the region to which the contents of the page shall be clipped when output in a production environment. This may include any extra bleed area needed to accommodate the physical limitations of cutting, folding, and trimming equipment. The actual printed page may include printing marks that fall outside the bleed box.

The trim box (PDF 1.3) defines the intended dimensions of the finished page after trimming. It may be smaller than the media box to allow for production-related content, such as printing instructions, cut marks, or color bars.

The art box (PDF 1.3) defines the extent of the page’s meaningful content (including potential white space) as intended by the page’s creator.

Represents a page layout that shall be used when the document is opened.

PDF Specification ISO 32000-1:2008, table '28 – Entries in the catalog dictionary'

Display one page at a time.

Display the pages in one column.

Display the pages in two columns, with odd-numbered pages on the left.

Display the pages in two columns, with odd-numbered pages on the right.

(PDF 1.5) Display the pages two at a time, with odd-numbered pages on the left.

(PDF 1.5) Display the pages two at a time, with odd-numbered pages on the right.

Represents how the document should be displayed by a viewer when opened.

PDF Specification ISO 32000-1:2008, table '28 – Entries in the catalog dictionary'

Neither document outline nor thumbnail images visible.

Document outline visible.

Thumbnail images visible.

Full-screen mode, with no menu bar, window controls, or any other window visible.

(PDF 1.5) Optional content group panel visible.

(PDF 1.6) Attachments panel visible.

Represents a base class for page tree nodes: intermediate nodes, called page tree nodes represented with type, and leaf nodes, called page objects represented with type.

PDF Specification ISO 32000-1:2008, section '7.7.3 Page Tree' Page Tree example Document Structure

(Required except in root node; prohibited in the root node; shall be an indirect reference) The page tree node that is the immediate parent of this one.

The page tree node that is the immediate parent of this one. PDF Specification ISO 32000-1:2008, section '7.7.3.2 Page Tree Nodes'

(Required; inheritable) A rectangle (see 7.9.5, "Rectangles"), expressed in default user space units, that shall define the boundaries of the physical medium on which the page shall be displayed or printed (see 14.11.2, "Page Boundaries"). Value of this property might be if this is an instance of a , but it should never be if this is an instance of a .

A rectangle, expressed in default user space units, that shall define the boundaries of the physical medium on which the page shall be displayed or printed. PDF Specification ISO 32000-1:2008, section '7.7.3.3 Page Objects'

Sets the .

The left X coordinate of the . The bottom Y coordinate of the . The right X coordinate of the . The top Y coordinate of the .

Sets the .

The right X coordinate of the . The left X coordinate of the is set to 0. The top Y coordinate of the . The bottom Y coordinate of the is set to 0.

(Optional; inheritable) A rectangle, expressed in default user space units, that shall define the visible region of default user space. When the page is displayed or printed, its contents shall be clipped (cropped) to this rectangle and then shall be imposed on the output medium in some implementation-defined manner (see 14.11.2, "Page Boundaries"). Default value: the value of . Value of this property might be if this is an instance of a , but it should never be if this is an instance of a .

A rectangle, expressed in default user space units, that shall define the visible region of default user space. PDF Specification ISO 32000-1:2008, section '7.7.3.3 Page Objects'

Sets the .

The left X coordinate of the . The bottom Y coordinate of the . The right X coordinate of the . The top Y coordinate of the .

Sets the .

The right X coordinate of the . The left X coordinate of the is set to 0. The top Y coordinate of the . The bottom Y coordinate of the is set to 0.

(Optional; inheritable) The number of degrees by which the page shall be rotated clockwise when displayed or printed. The value shall be a multiple of 90. Default value: 0.

The number of degrees by which the page shall be rotated clockwise when displayed or printed. PDF Specification ISO 32000-1:2008, section '7.7.3.3 Page Objects'

Represents a collection of page tree nodes, both intermediate and leaf that are kids of the particular intermediate page tree node.

PDF Specification ISO 32000-1:2008, section '7.7.3 Page Tree' Page Tree example Document Structure

Adds a new empty to the .

The added to the .

Adds a new empty to the at the specified index.

The zero-based index at which should be inserted. The inserted to the . is less than 0 or greater than .

Adds a new empty to the .

The added to the .

Adds a new empty to the at the specified index.

The zero-based index at which should be inserted. The inserted to the . is less than 0 or greater than .

Adds the clone of the specified to the .

The whose clone should be added to the . Clone of the specified added to the . is .

Inserts the clone of the specified to the at the specified index.

The zero-based index at which clone of the should be inserted. The whose clone should be inserted to the . Clone of the specified inserted to the . is .

Represents an intermediate node in a page tree, called a page tree node. This class provides a flattened view of all descendant s by implementing the interface.

PDF Specification ISO 32000-1:2008, section '7.7.3.2 Page Tree Nodes' Page Tree example Document Structure

(Required) An array of indirect references to the immediate children of this node. The children shall only be page objects or other page tree nodes.

An array of indirect references to the immediate children of this node. PDF Specification ISO 32000-1:2008, section '7.7.3.2 Page Tree Nodes'

(Required) The number of leaf nodes (page objects) that are descendants of this node within the page tree.

The number of leaf nodes (page objects) that are descendants of this node within the page tree.

Gets or sets the at the specified index.

The at the specified index. The zero-based index of the to get or set. The at the specified index.

Adds a new empty to the .

The added to the .

Adds a new empty to the at the specified index.

The zero-based index at which should be inserted. The inserted to the . is less than 0 or greater than .

Adds the clone of the specified to the .

The whose clone should be added to the . Clone of the specified added to the . is .

Adds the clone of the specified to the .

The whose clone should be added to the . Clone of the specified added to the . is .

Inserts the clone of the specified to the at the specified index.

The zero-based index at which clone of the should be inserted. The whose clone should be inserted to the . Clone of the specified inserted to the . is .

Inserts the clone of the specified to the at the specified index.

The zero-based index at which clone of the should be inserted. The whose clone should be inserted to the . Clone of the specified inserted to the . is .

Removes the first occurrence of a specific from the collection.

The to remove from the collection. if is successfully removed; otherwise, . This method also returns if was not found in the collection.

Removes the at the specified index of the collection.

The zero-based index of the to remove.

Removes all s from the .

Searches for the specified and returns the zero-based index of the first occurrence within the entire collection.

The to locate in the collection. The zero-based index of the first occurrence of within the entire collection, if found; otherwise, –1.

Determines whether a is in the collection.

The to locate in the collection. if is found in the collection; otherwise, .

Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.

The one-dimensional that is the destination of the elements copied from collection. The must have zero-based indexing. The zero-based index in at which copying begins. is . is less than 0 or greater than 's . The number of elements in the source is greater than the available space from to the end of the destination .

Returns an enumerator that iterates through the collection of s.

An enumerator for the collection of s.

Moves the at the specified index to a new location in the collection.

The zero-based index specifying the location of the to be moved. The zero-based index specifying the new location of the .

Enumerates the s underneath a .

Gets the at the current position of the enumerator.

The underneath the at the current position of the enumerator.

Advances the enumerator to the next underneath the .

if the enumerator was successfully advanced to the next ; if the enumerator has passed the end of the collection. The collection was modified after the enumerator was created.

Releases all resources used by the .

Represents a rectangle used to describe locations on a page and bounding boxes for a variety of objects.

PDF Specification ISO 32000-1:2008, section '7.9.5 Rectangles'

Gets the left X coordinate of the rectangle.

The left X coordinate of the rectangle.

Gets the bottom Y coordinate of the rectangle.

The bottom Y coordinate of the rectangle.

Gets the right X coordinate of the rectangle.

The right X coordinate of the rectangle.

Gets the top Y coordinate of the rectangle.

The top Y coordinate of the rectangle.

Gets the width of the rectangle.

The width of the rectangle.

Gets the height of the rectangle.

The height of the rectangle.

Returns a that represents this instance.

A that represents this instance. This method should be used primarily for debugging purposes and should be considered volatile (format of its return value might change in future versions).

Determines whether the is equal to this instance.

The other rectangle to compare with this rectangle instance. if the is equal to this instance; otherwise, .

Determines whether the specified is equal to this instance.

The to compare with this instance. if the specified is equal to this instance; otherwise, .

Returns a hash code for this instance.

A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.

Represents options used for saving a to a PDF file.

File Structure

Gets the default options used for saving any to a PDF file.

The default options used for saving any to a PDF file.

Initializes a new instance of the class.

Gets a value indicating how cross-reference information (information about byte positions of the indirect objects) and indirect objects are stored in the PDF file. This option is ignored if is not saved to a new file. Default value: .

A value indicating how cross-reference information (information about byte positions of the indirect objects) and indirect objects are stored in the PDF file.

Gets or sets a value indicating whether to close the PDF file currently associated with the . This option is ignored if is not saved to a new file. Using this option has the same effect as calling before saving the to a new file. Default value: .

if the PDF file currently associated with the should be closed; otherwise, .

Gets or sets a value indicating whether to close the new PDF file to which the will be saved. Using this option has the same effect as calling after saving the . Default value: .

if the new PDF file to which the will be saved should be closed; otherwise, .

Gets or sets the version of the PDF specification to which the conforms specified in the PDF file's header (see 7.5.2, "File Header"). This option is ignored if is not saved to a new file. Note that the PDF file's header version might be coerced to a value higher than the one specified in if the PDF file uses features that are not supported by the version specified in . If the value is then PDF file's header version will be automatically set to a specific value depending on the features used in the PDF file. Default value: .

The version of the PDF specification to which the conforms specified in the PDF file's header.

Gets a value indicating whether to set or update before the is saved to a PDF file. If does not have an , then new will be assigned to it; otherwise, of an existing will be updated. Default value: .

to set or update before the is saved to a PDF file; otherwise, .

Gets a value indicating whether to update before the is saved to a PDF file. If set to , then will be set to user-friendly name of the GemBox.Pdf assembly. Default value: .

to update before the is saved to a PDF file; otherwise, .

Gets or sets a value indicating whether to update and/or before the is saved to a PDF file. If is saved to a new file, then will be set to and will be set to . If is not saved to a new file, then will be set to . Default value: .

to update and/or before the is saved to a PDF file; otherwise, .

Gets or sets the encryption-related information or if a PDF document is not saved to an encrypted PDF file.

The encryption-related information or if a PDF document is not saved to an encrypted PDF file. PDF Specification ISO 32000-1:2008, section '7.6 Encryption' Encryption examples

Sets the to a PDF file to which a PDF document is saved. Use the returned to set the password(s) and other encryption-related information. Encryption method is set based on the value of the as specified in Remarks.

An instance of the that contains encryption-related information with which a PDF file is encrypted. Encryption method is set based on the value of the : is or less is or is or is or greater Encryption examples

Specifies whether the text is left-aligned, right-aligned, centered, or justified.

Default. Text is aligned to the left.

Text is aligned to the right.

Text is centered between the left and right edges.

Text is aligned with both the left and right edges, with internal spacing within each line expanded, if necessary, to achieve such alignment. The last (or only) line is aligned to the left edge only.

Represents a base class for name trees and number trees.

The type of the keys in the tree. for name trees and for number trees. The type of the values in the tree. and are used as keys instead of and to avoid, possibly costly, conversions. GemBox.Pdf, currently, doesn't maintain the tree's structure when modifying the tree. Instead the entire tree structure is flattened into a single root node. PDF Specification ISO 32000-1:2008, section '7.9.6 Name Trees' PDF Specification ISO 32000-1:2008, section '7.9.7 Number Trees'

Gets or sets the value associated with the specified key.

The value associated with the specified key. If the specified key is not found, a get operation returns default value. A set operation overrides existing or adds a new entry with the specified key and value. The key of the value to get or set. A value associated with the specified key. If the specified key is not found, default value is returned. is .

Determines whether the tree contains the specified key.

The key to locate in the tree. if the tree contains an entry with the specified key; otherwise, . is .

Gets the value associated with the specified key.

The key of the value to get. When this method returns, contains the value associated with the specified key, if the key is found; otherwise, the default value for the type of the parameter. if the tree contains an entry with the specified key; otherwise, . is .

Adds the specified key and value to the tree.

The key of the entry to add. The value of the entry to add. is . An entry with the same key already exists in the tree.

Removes the value with the specified key from the tree.

The key of the entry to remove. if the key is found and the entry removed; otherwise, . This method returns if key is not found in the tree. is .

Returns an enumerator that iterates through the .

A for the .

Enumerates the elements of a .

Gets the element at the current position of the enumerator.

The element in the at the current position of the enumerator.

Advances the enumerator to the next element of the .

if the enumerator was successfully advanced to the next element; if the enumerator has passed the end of the tree. The tree was modified after the enumerator was created.

Releases all resources used by the .

Represents the version of the PDF specification to which the conforms.

History and standardization of Portable Document Format

The conforms to the PDF 1.0 specification released in 1993.

The conforms to the PDF 1.1 specification released in 1994 and supported in Acrobat Reader 2.0.

The conforms to the PDF 1.2 specification released in 1996 and supported in Acrobat Reader 3.0.

The conforms to the PDF 1.3 specification released in 2000 and supported in Acrobat Reader 4.0.

The conforms to the PDF 1.4 specification released in 2001 and supported in Acrobat Reader 5.0.

The conforms to the PDF 1.5 specification released in 2003 and supported in Acrobat Reader 6.0.

The conforms to the PDF 1.6 specification released in 2004 and supported in Acrobat Reader 7.0.

The conforms to the PDF 1.7 specification released in 2006 and to the ISO 32000-1:2008 specification released in 2008 and supported in Acrobat Reader 8.0.

The conforms to the ISO 32000-2:2017 specification released in 2017.

Represents a viewer preferences dictionary (PDF 1.2) controlling the way the document shall be presented on the screen or in print. If no such dictionary is specified, conforming readers should behave in accordance with their own current user preference settings.

PDF Specification ISO 32000-1:2008, section '12.2 Viewer Preferences' Viewer Preferences example

(Optional) A flag specifying whether to hide the conforming reader’s tool bars when the document is active. Default value: .

A flag specifying whether to hide the conforming reader’s tool bars when the document is active. PDF Specification ISO 32000-1:2008, section '12.2 Viewer Preferences'

(Optional) A flag specifying whether to hide the conforming reader’s menu bar when the document is active. Default value: .

A flag specifying whether to hide the conforming reader’s menu bar when the document is active. PDF Specification ISO 32000-1:2008, section '12.2 Viewer Preferences'

(Optional) A flag specifying whether to hide user interface elements in the document’s window (such as scroll bars and navigation controls), leaving only the document’s contents displayed. Default value: .

A flag specifying whether to hide user interface elements in the document’s window (such as scroll bars and navigation controls), leaving only the document’s contents displayed. PDF Specification ISO 32000-1:2008, section '12.2 Viewer Preferences'

(Optional) A flag specifying whether to resize the document’s window to fit the size of the first displayed page. Default value: .

A flag specifying whether to resize the document’s window to fit the size of the first displayed page. PDF Specification ISO 32000-1:2008, section '12.2 Viewer Preferences'

(Optional) A flag specifying whether to position the document’s window in the center of the screen. Default value: .

A flag specifying whether to position the document’s window in the center of the screen. PDF Specification ISO 32000-1:2008, section '12.2 Viewer Preferences'

(Optional) A flag specifying whether the window’s title bar should display the document title taken from the entry of the document information dictionary (see 14.3.3, "Document Information Dictionary"). If , the title bar should instead display the name of the PDF file containing the document. Default value: .

A flag specifying whether the window’s title bar should display the document title taken from the entry of the document information dictionary. PDF Specification ISO 32000-1:2008, section '12.2 Viewer Preferences'

(Optional) The document’s page mode, specifying how to display the document on exiting full-screen mode. This entry is meaningful only if the value of the property is ; it shall be ignored otherwise. Default value: .

The document’s page mode, specifying how to display the document on exiting full-screen mode. PDF Specification ISO 32000-1:2008, section '12.2 Viewer Preferences'

(Optional; PDF 1.3) A flag specifying whether the predominant reading order for text is right to left. This entry has no direct effect on the document’s contents or page numbering but may be used to determine the relative positioning of pages when displayed side by side or printed n-up. Default value: .

A flag specifying whether the predominant reading order for text is right to left. PDF Specification ISO 32000-1:2008, section '12.2 Viewer Preferences'

(Optional; PDF 1.4) The name of the page boundary representing the area of a page that shall be displayed when viewing the document on the screen. The value is the key designating the relevant page boundary in the page object (see 7.7.3, "Page Tree" and 14.11.2, "Page Boundaries"). Default value: .

The name of the page boundary representing the area of a page that shall be displayed when viewing the document on the screen. PDF Specification ISO 32000-1:2008, section '12.2 Viewer Preferences'

(Optional; PDF 1.4) The name of the page boundary to which the contents of a page shall be clipped when viewing the document on the screen. The value is the key designating the relevant page boundary in the page object (see 7.7.3, "Page Tree" and 14.11.2, "Page Boundaries"). Default value: .

The name of the page boundary to which the contents of a page shall be clipped when viewing the document on the screen. PDF Specification ISO 32000-1:2008, section '12.2 Viewer Preferences'

(Optional; PDF 1.4) The name of the page boundary representing the area of a page that shall be rendered when printing the document. The value is the key designating the relevant page boundary in the page object (see 7.7.3, "Page Tree" and 14.11.2, "Page Boundaries"). Default value: .

The name of the page boundary representing the area of a page that shall be rendered when printing the document. PDF Specification ISO 32000-1:2008, section '12.2 Viewer Preferences'

(Optional; PDF 1.4) The name of the page boundary to which the contents of a page shall be clipped when printing the document. The value is the key designating the relevant page boundary in the page object (see 7.7.3, "Page Tree" and 14.11.2, "Page Boundaries"). Default value: .

The name of the page boundary to which the contents of a page shall be clipped when printing the document. PDF Specification ISO 32000-1:2008, section '12.2 Viewer Preferences'

(Optional; PDF 1.6) The page scaling option that shall be selected when a print dialog is displayed for this document. Valid values are , which indicates no page scaling, and , which indicates the conforming reader’s default print scaling. Default value: .

indicates no page scaling while indicates the conforming reader’s default print scaling. PDF Specification ISO 32000-1:2008, section '12.2 Viewer Preferences'

Removes the entry from the parent .

Represents an XML metadata stream.

PDF Specification ISO 32000-1:2008, section '14.3.2 Metadata Streams' Adobe XMP Developer Center XMP Specification Part 1: Data Model, Serialization, and Core Properties XMP Specification Part 2: Additional Properties XMP Specification Part 3: Storage in Files

A value because cannot have a metadata of its own.

A value. PDF Specification ISO 32000-1:2008, section '14.3.2 Metadata Streams'

Gets or sets the XML text of the .

The XML text of the .

Gets a value indicating whether XML of this is valid.

if XML of this is valid; otherwise, .

Gets the number of properties in this .

The number of properties in this .

Gets the property with the specified name.

The property with the specified name. The fully qualified name of the property. The property with the specified name.

Adds the specified property to this .

The property to add. is .

Removes the property with the specified name.

The fully qualified name of the property to remove. if the property is successfully found and removed; otherwise, . This method returns if property is not found in the .

Removes the entry from the parent .

Returns an enumerator that iterates through the properties of this .

A structure for the .

Enumerates the properties of a .

Gets the property at the current position of the enumerator.

The property in the at the current position of the enumerator.

Advances the enumerator to the next property of the .

if the enumerator was successfully advanced to the next property; if the enumerator has passed the end of the .

Releases all resources used by the .

An enumeration of supported pixel formats when saving a to an image using an .

Pixel format that is best suited for the particular operation.

Bgr101010 is a sRGB format with 32 bits per pixel (BPP). Each color channel (blue, green, and red) is allocated 10 bits per pixel (BPP).

Bgr24 is a sRGB format with 24 bits per pixel (BPP). Each color channel (blue, green, and red) is allocated 8 bits per pixel (BPP).

Bgr32 is a sRGB format with 32 bits per pixel (BPP). Each color channel (blue, green, and red) is allocated 8 bits per pixel (BPP).

Bgr555 is a sRGB format with 16 bits per pixel (BPP). Each color channel (blue, green, and red) is allocated 5 bits per pixel (BPP).

Bgr565 is a sRGB format with 16 bits per pixel (BPP). Each color channel (blue, green, and red) is allocated 5, 6, and 5 bits per pixel (BPP) respectively.

Bgra32 is a sRGB format with 32 bits per pixel (BPP). Each channel (blue, green, red, and alpha) is allocated 8 bits per pixel (BPP).

Black and white pixel format which displays one bit of data per pixel as either black or white.

Cmyk32 pixel format which displays 32 bits per pixel (BPP) with each color channel (cyan, magenta, yellow, and black) allocated 8 bits per pixel (BPP).

Gray16 pixel format which displays a 16 bits-per-pixel grayscale channel, allowing 65536 shades of gray. This format has a gamma of 1.0.

Gray2 pixel format which displays a 2 bits-per-pixel grayscale channel, allowing 4 shades of gray.

Gray32Float displays a 32 bits per pixel (BPP) grayscale channel, allowing over 4 billion shades of gray. This format has a gamma of 1.0.

Gray4 pixel format which displays a 4 bits-per-pixel grayscale channel, allowing 16 shades of gray.

Gray8 pixel format which displays an 8 bits-per-pixel grayscale channel, allowing 256 shades of gray.

Pbgra32 is a sRGB format with 32 bits per pixel (BPP). Each channel (blue, green, red, and alpha) is allocated 8 bits per pixel (BPP). Each color channel is pre-multiplied by the alpha value.

Prgba128Float is a ScRGB format with 128 bits per pixel (BPP). Each channel (red, green, blue, and alpha) is allocated 32 bits per pixel (BPP). Each color channel is pre-multiplied by the alpha value. This format has a gamma of 1.0.

Prgba64 is a sRGB format with 64 bits per pixel (BPP). Each channel (blue, green, red, and alpha) is allocated 32 bits per pixel (BPP). Each color channel is pre-multiplied by the alpha value. This format has a gamma of 1.0.

Rgb128Float is a ScRGB format with 128 bits per pixel (BPP). Each color channel is allocated 32 BPP. This format has a gamma of 1.0.

Rgb24 is a sRGB format with 24 bits per pixel (BPP). Each color channel (red, green, and blue) is allocated 8 bits per pixel (BPP).

Rgb48 is a sRGB format with 48 bits per pixel (BPP). Each color channel (red, green, and blue) is allocated 16 bits per pixel (BPP). This format has a gamma of 1.0.

Rgba128Float is a ScRGB format with 128 bits per pixel (BPP). Each color channel is allocated 32 bits per pixel (BPP). This format has a gamma of 1.0.

Rgba64 is an sRGB format with 64 bits per pixel (BPP). Each channel (red, green, blue, and alpha) is allocated 16 bits per pixel (BPP). This format has a gamma of 1.0.

Specifies how a conforming reader's user interface presents collections of file attachments. If property of a is not , the conforming reader shall present the document as a PDF Portfolio (also known as portable collection). The file attachments comprising a PDF Portfolio shall be located in the name tree. All attachments in that tree are in the PDF Portfolio; any attachments not in that tree are not. When a conforming reader first opens a PDF Portfolio document, it shall display the contents of the , along with a list of the documents present in the name tree. The document list shall include the additional document information specified by the . The initial document may be the container PDF (if is ) or one of the embedded documents.

PDF Specification ISO 32000-1:2008, section '12.3.5 Collections' Overview of PDF Portfolios Portfolios example

Gets the Portfolio fields. If empty, the conforming reader may choose useful defaults that are known to exist in a , such as the file name, file size, and modified date.

The Portfolio fields. PDF Specification ISO 32000-1:2008, section '12.3.5 Collections' Portfolios example

(Optional) The embedded file that shall be initially presented in the user interface. If the is or is not a valid , the initial file shall be the current document (PDF Portfolio). If the is valid and does not match any file in the name tree, the interactive PDF processor shall select the first item from the list of files to display in its user interface; if no files exist in the name tree, the interactive PDF processor shall display an empty preview window. (PDF 2.0) For unencrypted wrapper documents for an encrypted payload document the is required, and shall identify the encrypted payload entry in the name tree.

The embedded file that shall be initially presented in the user interface. The is not in the PDF Portfolio (not contained in the ). When setting a value this property performs a linear search in the to find a key associated with the that is to be set; therefore, it is an O(n) operation, where n is count. PDF Specification ISO 32000-1:2008, section '12.3.5 Collections' Portfolios example

(Optional) The initial view. Default value: .

The initial view. PDF Specification ISO 32000-1:2008, section '12.3.5 Collections'

(Optional; PDF 2.0) A specifying a suggested set of colors for use by a layout.

A specifying a suggested set of colors for use by a layout.

Gets the sort levels by which files and folders in the are sorted. If multiple files and folders in the have the same value for the field specified by the first level in the collection, the values for fields specified by the successive levels in the collection shall be used for sorting, until a unique order is determined or until the sort levels are exhausted.

The sort levels by which files and folders in the are sorted. PDF Specification ISO 32000-1:2008, section '12.3.5 Collections'

Gets the root contained in the .

The root contained in the .

Gets the root folders contained in the .

The root folders contained in the .

(Optional; PDF 2.0) The orientation of the splitter bar.

The orientation of the splitter bar. When displaying a , an interactive PDF processor presents an initial view in which the available display area may be divided by a splitter bar into two areas; one area containing a display of the navigation controls of the as defined by the property, and one area containing a preview of the initial or currently selected document of the . The visibility, orientation or position of the splitter bar may be interactively adjusted by user action subsequent to its initial view as defined by the and properties, if provided.

(Optional; PDF 2.0) The initial position of the splitter bar, specified as a percentage of the available window area. Values shall range from 0 to 100. The property shall be ignored if is set to .

The initial position of the splitter bar, specified as a percentage of the available window area. Value must be between 0 and 100 (inclusive). When displaying a , an interactive PDF processor presents an initial view in which the available display area may be divided by a splitter bar into two areas; one area containing a display of the navigation controls of the as defined by the property, and one area containing a preview of the initial or currently selected document of the . The visibility, orientation or position of the splitter bar may be interactively adjusted by user action subsequent to its initial view as defined by the and properties, if provided.

Specifies a suggested set of colors for use by a layout.

(Optional; PDF 2.0)A color used for the background of the view.

A color used for the background of the view. Color with invalid color space specified. Color space must be .

(Optional; PDF 2.0)A color used for the background of the card.

A color used for the background of the card. Color with invalid color space specified. Color space must be .

(Optional; PDF 2.0)A color used for the border of the card.

A color used for the border of the card. Color with invalid color space specified. Color space must be .

(Optional; PDF 2.0)A color used for the primary text in a navigator.

A color used for the primary text in a navigator. Color with invalid color space specified. Color space must be .

(Optional; PDF 2.0)A color used for other text in a navigator.

A color used for other text in a navigator. Color with invalid color space specified. Color space must be .

Describes the attributes of a particular field in a PDF Portfolio, including the type of data stored in the and the lookup key used to locate the in the file or the Portfolio folder.

PDF Specification ISO 32000-1:2008, section '12.3.5 Collections' Portfolios example

(Required) The data type of or and related property that this describes.

The data type of or /-related property that this describes. PDF Specification ISO 32000-1:2008, section '12.3.5 Collections'

(Required) The textual field name that shall be presented to the user by the conforming reader.

The textual field name that shall be presented to the user by the conforming reader. Value is or . PDF Specification ISO 32000-1:2008, section '12.3.5 Collections' Portfolios example

(Optional) The relative order of the field name in the user interface. Fields shall be sorted by the conforming reader in ascending order.

The relative order of the field name in the user interface. PDF Specification ISO 32000-1:2008, section '12.3.5 Collections' Portfolios example

(Optional) If set, do not display the in the user interface. Default value: .

If set, do not display the in the user interface. PDF Specification ISO 32000-1:2008, section '12.3.5 Collections' Portfolios example

(Optional) If set, the user may not change the value associated with the . Default value: .

If set, the user may not change the value associated with the . PDF Specification ISO 32000-1:2008, section '12.3.5 Collections'

Returns a that represents this instance.

A that represents this instance. This method should be used primarily for debugging purposes and should be considered volatile (format of its return value might change in future versions).

Represents the types of fields in the and the types of and related properties.

PDF Specification ISO 32000-1:2008, section '12.3.5 Collections'

The data type is unknown.

A text field. The field data shall be stored as a PDF text string.

A date field. The field data shall be stored as a PDF date string.

A number field. The field data shall be stored as a PDF number.

A file name or a Portfolio folder name.

A file description or a Portfolio folder description.

A file modification date or a Portfolio folder modification date.

A file creation date or a Portfolio folder creation date.

A file size.

(PDF 2.0) The field data is the length of the , as identified by the property of a that is associated with the .

A file associated relationship.

Represents a collection of s. Each has a key chosen by the conforming writer, which shall be used to associate a field with data in a file or a Portfolio folder.

PDF Specification ISO 32000-1:2008, section '12.3.5 Collections' Portfolios example

Adds a new with the specified data type and name to the . Use the returned key to populate file field values and Portfolio folder field values and use the returned value to customize it further.

The data type of or and related property that a newly added describes. The textual name of a newly added that shall be presented to the user by the conforming reader. This value is also used to resolve a key in the of a newly added . A newly created with the specified data type and name added to the under the returned key. is or . A with the same key already exists in the or a key name is 'Type' which is reserved.

Gets or sets the associated with the specified key.

The associated with the specified key. If the specified key is not found, a get operation returns . A set operation overrides existing or adds a new entry with the specified key and . The key of the to get or set. A associated with the specified key. If the specified key is not found, is returned. or value is . name is 'Type' which is reserved.

Determines whether the contains the with the specified key.

The key to locate in the . if the contains the with the specified key; otherwise, . is .

Removes the with the specified key from the .

The key of the to remove. if the key is found and the removed; otherwise, . This method returns if key is not found in the . is .

Returns an enumerator that iterates through the .

A for the .

Enumerates the entries of a .

Gets the entry at the current position of the enumerator.

The entry in the at the current position of the enumerator.

Advances the enumerator to the next entry of the .

if the enumerator was successfully advanced to the next entry; if the enumerator has passed the end of the collection. The collection was modified after the enumerator was created.

Releases all resources used by the .

Represents a Portfolio field value that provides the data corresponding to the related in the , and it provides a means of associating a prefix string with that data value. The prefix shall be ignored by the sorting algorithm.

PDF Specification ISO 32000-1:2008, section '7.11.6 Collection Items' Portfolios example

Initializes a new instance of the structure from the specified data and the optional prefix.

The data. The optional prefix. is . Portfolios example

Initializes a new instance of the structure from the specified data and the optional prefix.

The data. The optional prefix.

Initializes a new instance of the structure from the specified data and the optional prefix.

The data. The optional prefix.

(Optional) The data. The type of data shall match the data type identified by the property of the corresponding . Possible types: , , , or . Default value: .

The data. PDF Specification ISO 32000-1:2008, section '7.11.6 Collection Items'

(Optional) A prefix string that shall be concatenated with the text string presented to the user. This entry is ignored when a conforming reader sorts the items in the collection. Default value: .

The prefix.

Determines whether the is equal to this instance.

The other Portfolio field value to compare with this Portfolio field value instance. if the is equal to this instance; otherwise, .

Determines whether the specified is equal to this instance.

The to compare with this Portfolio field value instance. if the specified is a and is equal to this instance; otherwise, .

Returns a hash code for this instance.

An integer value that specifies a hash value for this instance.

Converts the current to its equivalent string representation using the specified format and culture-specific format information.

A format string. An object that supplies culture-specific formatting information. A string representation of the current , as specified by and .

Converts the current to its equivalent string representation.

A string representation of a .

Determines whether and s are equal.

The first Portfolio field value. The second Portfolio field value. if and Portfolio field values are equal; otherwise, .

Determines whether and s are not equal.

The first Portfolio field value. The second Portfolio field value. if and Portfolio field values are not equal; otherwise, .

Contains the data described by the Portfolio fields for a particular file or a Portfolio folder in a .

PDF Specification ISO 32000-1:2008, section '7.11.6 Collection Items' Portfolios example

Adds the specified to the under the specified key.

The key under which to add the specified . The to add under the specified key. A with the same key already exists in the or a name is 'Type' which is reserved.

Gets or sets the associated with the specified key.

The associated with the specified key. If the specified key is not found, a get operation returns the default . A set operation overrides existing or adds a new entry with the specified key and . The key of the to get or set. A associated with the specified key. If the specified key is not found, the default is returned. is . name is 'Type' which is reserved.

Gets the associated with the specified key.

The key of the to get. When this method returns, contains the associated with the specified , if the is found; otherwise, the default . if the contains a with the specified ; otherwise, . is .

Determines whether the contains the with the specified key.

The key to locate in the . if the contains the with the specified key; otherwise, . is .

Removes the with the specified key from the .

The key of the to remove. if the key is found and the removed; otherwise, . This method returns if key is not found in the . is .

Returns an enumerator that iterates through the .

A for the .

Enumerates the entries of a .

Gets the entry at the current position of the enumerator.

The entry in the at the current position of the enumerator.

Advances the enumerator to the next entry of the .

if the enumerator was successfully advanced to the next entry; if the enumerator has passed the end of the collection. The collection was modified after the enumerator was created.

Releases all resources used by the .

Represents a collection of a s contained in the Portfolio (root files) or some Portfolio folder.

This collection is a filtered view of the that contains only s located in the current (the associated key of a in the has a prefix folder ID that is equal to the internal ID of the current . Portfolios example

Add a new with the specified name and an empty to under the (root file) or parent . Use the method of the of a returned to fill the empty .

The name of a newly added . This value is also used to resolve a key in the of a newly added . A newly created with the specified name and an empty added to the under the (root file) or parent . is or . A with the same key already exists in the . The parent is not in the PDF portfolio. Portfolios example

Adds a new with the copied from the resource specified by the to under the (root file) or parent .

The location of the resource copied to the of a newly added . This value is also used to resolve the and a key in the of a newly added . A newly created with the copied from the resource specified by the added to the under the (root file) or parent . is or . A with the same key already exists in the . The parent is not in the PDF portfolio. The 's , , , and properties are automatically set, if they can be resolved from the resource specified by the . Portfolios example

Returns an enumerator that iterates through the .

A for the .

Enumerates the elements of a .

Gets the element at the current position of the enumerator.

The element in the at the current position of the enumerator.

Advances the enumerator to the next element of the .

if the enumerator was successfully advanced to the next element; if the enumerator has passed the end of the collection. The collection was modified after the enumerator was created.

Releases all resources used by the .

Represents a folder used to organize the attached files into a hierarchical structure.

Portfolios example

(Required; PDF 2.0) Gets or sets the name of this . Two sibling folders shall not share the same name following case normalization.

The name of this . Value is or .

Gets the parent folder, or if this is a root folder (contained in the collection).

The parent folder, or if this is a root folder.

(Optional; PDF 2.0) A collection item dictionary, which shall be used to create the user interface for portable collections (see 7.11.6, "Collection Items").

A collection item dictionary, which shall be used to create the user interface for portable collections. Portfolios example

(Optional; PDF 2.0) A text description associated with this folder.

A text description associated with this folder.

(Optional; PDF 2.0) The date the folder was first created.

The date the folder was first created.

(Optional; PDF 2.0) The date of the most recent change to immediate child files or folders of this folder.

The date of the most recent change to immediate child files or folders of this folder. Portfolios example

(Optional; PDF 2.0) A stream object defining the thumbnail image for the folder (see 12.3.4, "Thumbnail Images").

A stream object defining the thumbnail image for the folder.

Gets the contained in this .

The contained in this .

Gets the subfolders contained in this .

The subfolders contained in this .

Returns a that represents this instance.

A that represents this instance. This method should be used primarily for debugging purposes and should be considered volatile (format of its return value might change in future versions).

Represents a collection of a s contained in the Portfolio (root folders) or some Portfolio folder.

This collection is implemented as singly linked list and therefore methods that use random access (index) or modify the collection are an O(n) operations, where n is count. Portfolios example

Adds a new empty to the (root folder) or parent .

The name of a newly added . A newly created empty with the specified name added to the (root folder) or parent . is or . A with the same name already exists in this . The parent is not in the PDF portfolio. Portfolios example

Adds a new with the files and folders copied from the file system folder specified by the to the (root folder) or parent .

The location of the file system folder whose files and folders are copied to a newly added . This value is also used to resolve the of a newly added . If set to then all files and subfolders contained under the are copied. A newly created with the files and folders copied from the file system folder specified by the added to the (root folder) or parent . is or . The folder with either doesn't exist or an error occurred while trying to determine if the specified folder exists or a with the same name already exists in this or a with the same key already exists in the . The parent is not in the PDF portfolio. Portfolios example

Returns an enumerator that iterates through the .

A for the .

Enumerates the elements of a .

Gets the element at the current position of the enumerator.

The element in the at the current position of the enumerator.

Advances the enumerator to the next element of the .

if the enumerator was successfully advanced to the next element; if the enumerator has passed the end of the collection. The collection was modified after the enumerator was created.

Releases all resources used by the .

Represents settings for a single sort level of a .

PDF Specification ISO 32000-1:2008, section '12.3.5 Collections'

Gets the key of the in the by which files and folders in the are sorted.

The key of the in the by which files and folders in the are sorted.

Gets a value indicating whether to sort the values in the ascending order.

to sort the values in the ascending order; otherwise, .

Initializes a new instance of the structure from the specified key of the in the and the optional ordering preference.

The key of the in the by which files and folders in the are sorted. to sort the values in the ascending order; otherwise, .

Determines whether the is equal to this instance.

The other Portfolio sort level to compare with this Portfolio sort level instance. if the is equal to this instance; otherwise, .

Determines whether the specified is equal to this instance.

The to compare with this Portfolio sort level instance. if the specified is a and is equal to this instance; otherwise, .

Returns a hash code for this instance.

An integer value that specifies a hash value for this instance.

Returns a that represents this instance.

A that represents this instance. This method should be used primarily for debugging purposes and should be considered volatile (format of its return value might change in future versions).

Determines whether and s are equal.

The first Portfolio sort level. The second Portfolio sort level. if and Portfolio sort levels are equal; otherwise, .

Determines whether and s are not equal.

The first Portfolio sort level. The second Portfolio sort level. if and Portfolio sort levels are not equal; otherwise, .

Represents a collection of s.

PDF Specification ISO 32000-1:2008, section '12.3.5 Collections'

Returns an enumerator that iterates through the .

A for the .

Enumerates the elements of a .

Gets the element at the current position of the enumerator.

The element in the at the current position of the enumerator.

Advances the enumerator to the next element of the .

if the enumerator was successfully advanced to the next element; if the enumerator has passed the end of the collection. The collection was modified after the enumerator was created.

Releases all resources used by the .

Represents the orientation of the splitter bar.

The value is unknown and currently not supported.

The window is split horizontally.

The window is split vertically.

The window is not split. The entire window region shall be dedicated to the file navigation view.

Represents a view or the layout of a navigator.

PDF Specification ISO 32000-1:2008, section '12.3.5 Collections'

The has a navigator with the custom layout.

The shall be presented in details mode, with all information in the dictionary presented in a multi-column format. This mode provides the most information to the user.

The shall be presented in tile mode, with each file in the Portfolio denoted by a small icon and a subset of information from the dictionary. This mode provides top-level information about the file attachments to the user.

The shall be initially hidden. The interactive PDF processor shall provide means for the user to view the Portfolio by some explicit action. The PDF processor should display the document specified by the property. How the PDF processor chooses to display the is implementation specific.

(PDF 2.0) A layout which displays a strip of thumbnails, providing an index to the file attachments within the . The selected attachment should be previewed alongside the index.

(PDF 2.0) A layout which places thumbnails of the file attachments within the randomly in the view.

(PDF 2.0) A layout which provides a large size preview of one file attachment in the and displays alongside the metadata for the file attachment, including the name, description and other entries.

(PDF 2.0) A layout presenting the contents of the in a tree view, showing the folder structure and the files as leaf nodes of the tree, akin to a traditional file system folder view.

Specifies information about how a document is printed.

Print example

Initializes a new instance of the class.

Initializes a new instance of the class by using an XML stream (that contains a document) that complies with the XML Print Schema.

Gets or sets the number of copies of the document to print.

The number of copies of the document to print. Value must be positive.

Gets or sets the page orientation of the pages to print.

The page orientation of the pages to print. If page orientation is not set or set to and if page has larger width than height then the page will be rotated.

Gets or sets the page index of the first page to print.

The page index of the first page to print. Value cannot be negative. Document pages are zero-indexed meaning that first page in the document has index 0 (zero).

Gets or sets the index of the last page to print.

The index of the last page to print. Value cannot be lower than . Use value to print to the last page.

Gets or sets the name of the printed document in the print queue. Default value is 'Pdf'.

The name of the printed document in the print queue.

Defines the supported rendering modes.

Use either the default implementation, , , or for rendering, depending on the availability and supported features.

Use Windows Presentation Foundation (WPF) for rendering.

Use Skia (via SkiaSharp NuGet package) for rendering and HarfBuzz text-shaping engine for text formatting. Make sure your project also references the appropriate SkiaSharp.NativeAssets.* and HarfBuzzSharp.NativeAssets.* NuGet packages depending on the platform on which you are building/running your application.

Represents a base class for saving options of various file formats.

Gets the default saving options for Portable Document Format (PDF).

The default saving options for Portable Document Format (PDF). This property always returns a clone of the instance.

Gets the default saving options for XML Paper Specification (XPS) format.

The default saving options for XML Paper Specification (XPS) format. This property always returns a new instance of class initialized with default constructor.

Gets the default saving options for image file format. Image will be saved in format.

The default saving options for image file format. This property always returns a new instance of class initialized with default constructor.

Represents an interface used for transforming a into a sequence of bytes and vice versa.

Calculates the maximum number of bytes produced by encoding the specified number of characters.

The number of characters to encode. The maximum number of bytes produced by encoding the specified number of characters. is less than zero.

Calculates the number of bytes produced by encoding the characters in the specified string.

The string containing the set of characters to encode. The number of bytes produced by encoding the specified characters. is .

Encodes a set of characters from the specified string into the specified byte array.

The string containing the set of characters to encode. The byte array to contain the resulting sequence of bytes. Index of the byte. The actual number of bytes written into . is or is . is not a valid index in . does not have enough capacity from to the end of the array to accommodate the resulting bytes.

Decodes a sequence of bytes from the specified byte array into a string.

The byte array containing the sequence of bytes to decode. The index of the first byte to decode. The number of bytes to decode. A string that contains the results of decoding the specified sequence of bytes. The byte array contains invalid Unicode code points. is . or is less than zero or and do not denote a valid range in .

Represents a base class for all types used for transforming a into a sequence of bytes and vice versa.

Basic Objects example Objects

Gets the PDFDoc encoding.

The PDFDoc encoding.

Gets the UTF-16 Big Endian encoding with leading byte order mark.

The UTF-16 Big Endian encoding with leading byte order mark.

Gets the ASCII encoding.

The ASCII encoding.

Gets the Byte encoding.

The Byte encoding.

A type that extends interface.

Encodes all the characters in the specified string into a sequence of bytes.

The encoding. The string containing the characters to encode. A byte array containing the results of encoding the specified set of characters. or is .

Decodes a sequence of bytes from the specified byte array into a string.

The encoding. The byte array containing the sequence of bytes to decode. A string that contains the results of decoding the specified sequence of bytes. or is .

An enumeration of supported compression schemes for Tagged Image File Format (TIFF) when saving a to an image using an .

The encoder attempts to save the bitmap with the best possible compression schema.

The Tagged Image File Format (TIFF) image will not be compressed.

The CCITT3 compression schema.

The CCITT4 compression schema.

The LZW compression schema.

The RLE compression schema.

Zip compression schema.

Provides helper methods for dealing with Windows Presentation Foundation (WPF) dispatcher resource leaks in multithreaded applications.

GemBox uses or might use WPF for the following operations: printing, converting to an XpsDocument or an ImageSource, saving to an XPS file or an image file, getting page or drawing content as FrameworkElement, bitmap decoding and encoding, rasterizing the vectorized content, text formatting (shaping), converting colors between custom color spaces, transferring data to and from the system Clipboard, and other. For some of these operations, such as printing and converting to an ImageSource, the use of WPF is mandatory because no alternative is currently provided or possible. For other operations, an alternative to WPF might be used instead. For example, for saving to an XPS file or an image file and rasterizing the vectorized content, Skia (via SkiaSharp NuGet package) might be used instead. For bitmap decoding and encoding, GDI+, Skia, or internal GemBox implementation might be used instead. And for text shaping, HarfBuzz (via HarfBuzzSharp NuGet package) or internal GemBox implementation might be used instead. If WPF is used in a non-WPF application or in a WPF application but not in its main (UI) thread, the instance of a Dispatcher class is implicitly created for each thread in which WPF is used and this instance must be shutdown before the thread terminates, otherwise the resource leak happens. The Dispatcher shutdown must be invoked in the same thread in which the Dispatcher was created. Since GemBox doesn't know if the code running after the GemBox code in the same thread might use WPF (and therefore require a Dispatcher instance that is not shutdown) nor GemBox has an option to be notified before a thread terminates (to shutdown the Dispatcher then and prevent the resource leak), GemBox won't use WPF in a thread that doesn't already have an associated Dispatcher or if it was already shutdown. In other words, GemBox guarantees that its code won't initiate a creation of a Dispatcher instance in any currently existing thread, except those listed below, thus preventing the resource leak. Therefore, for operations for which the use of WPF is not mandatory, an alternative to WPF will be used instead, and for operations for which the use of WPF is mandatory, GemBox will create a new thread, associate a new Dispatcher with it, use WPF in that thread, and shutdown the Dispatcher before that thread terminates thus preventing the resource leak. In the meantime, the current thread will wait for this thread to terminate via the Join method. For reasons explained below, GemBox might still initiate a creation of a Dispatcher instance in the following threads without shutting it down, thus allowing the resource leak to happen: The thread in which you set the to because with this operation you explicitly allow the thread to leak resources. The main (primary) thread of your application because when it terminates, the application's process exists and the operating system reclaims all used resources. Threads whose name ends with 'GemBox WPF background thread' because GemBox component and testing infrastructure relies on this. If you want GemBox to use WPF (for operations for which the use of WPF is mandatory) or to consider using WPF (for operations for which an alternative to WPF might be used instead) in the current thread, you must create a Dispatcher instance for the current thread and you must shutdown the Dispatcher before that thread terminates to prevent the resource leak. A utility method can be used for this purpose. The returned must be disposed before the current thread terminates to shutdown the newly created Dispatcher and prevent the resource leak. If the of the returned is then GemBox will use or consider using WPF in the current thread; otherwise, if the value is , GemBox won't use WPF in the current thread because its Dispatcher is already shutdown. You should create and shutdown the Dispatcher instance for the current thread (for example, with the method and the returned ) only if you created the current thread or it is the main (primary) thread of your application. Otherwise, the thread might belong to the managed thread pool and/or the code running after your code in that thread might use WPF and therefore require a Dispatcher instance that is not shutdown. WPF Threading Model WPF Architecture - System.Threading.DispatcherObject HwndWrapper leaks class registrations (ATOMs returned by RegisterClassEx) Atom table leak after window running on a separate thread closes (Check the demo) Atom Table Monitor

Gets or sets the maximum number of Dispatcher instances associated with terminated threads that have not been shutdown while their associated thread was alive, thus leaking resources. If the value is negative, then counting of Dispatcher instances associated with terminated threads that have not been shutdown while their associated thread was alive is not performed. Default value: -1.

The maximum number of Dispatcher instances associated with terminated threads that have not been shutdown while their associated thread was alive. For diagnostics purposes of reliably detecting the dispatcher resource leaks in multithreaded applications, you can set the value of the property to a non-negative value and optionally use in each newly created thread. If you want the current thread to be excluded from this verification and allow it to leak resources, set the to . Setting the to also enables GemBox to use or consider using WPF in the current thread without GemBox shutting down the associated Dispatcher instance thus allowing GemBox code to leak resources.

Gets or sets the value whether the Dispatcher instance associated with the current thread must be shutdown before the current thread terminates in the context of verification done by the method. The default list of threads whose associated Dispatcher instance doesn't have to be shutdown are listed in the remarks of the class.

to include the current thread to the the verification done by the method; otherwise, to exclude the current thread from the the verification done by the method thus allowing it to leak resources.

Iterates over the list of threads in which was called and counts the number of Dispatcher instances associated with terminated threads that have not been shutdown while their associated thread was alive, thus leaking resources, and throws an if that number is greater than the . If the value of the is negative, then this method does nothing.

The application is leaking more resources that specified by the limit. Please read the documentation of the class for more information how to prevent the resource leak.

Creates a Dispatcher instance for the current thread if it was not already created. The returned must be disposed before the current thread terminates to shutdown the newly created Dispatcher and prevent the resource leak. Use this method if you want GemBox to use WPF (for operations for which the use of WPF is mandatory) or to consider using WPF (for operations for which an alternative to WPF might be used instead) in the current thread. If the of the returned is then GemBox will use or consider using WPF in the current thread; otherwise, if the value is , GemBox won't use WPF in the current thread because its Dispatcher is already shutdown. You should call this method only if you created the current thread or it is the main (primary) thread of your application. Otherwise, the thread might belong to the managed thread pool and/or the code running after your code in that thread might use WPF and therefore require a Dispatcher instance that is not shutdown. For more information, read the class remarks.

A instance that must be disposed before the current thread terminates to shutdown the newly created Dispatcher and prevent the resource leak.

Represents the Dispatcher instance associated with the current thread and provides a means to shut it down if it was newly created before the current thread terminates, thus preventing the resource leak.

Gets a value indicating whether a Dispatcher instance associated with the current thread was created with the method call or it already existed before.

if a Dispatcher instance associated with the current thread was created with the method call; otherwise, if it already existed before. The method will shutdown the Dispatcher instance associated with the current thread only if the value of this property is .

Gets a value indicating a Dispatcher instance associated with the current thread is already shutdown.

if a Dispatcher instance associated with the current thread is already shutdown; otherwise, . If the value of this property is then GemBox will use or consider using WPF in the current thread; otherwise, if the value is , GemBox won't use WPF in the current thread because its Dispatcher is already shutdown.

Shuts down the Dispatcher instance associated with the current thread if it was newly created.

The call was not made in the same thread in which the method was called. This method must be called in the same thread in which the method was called.

Represents options for saving to XML Paper Specification file format.

Convert example Export to XpsDocument / DocumentViewer Control example

Gets or sets the rendering mode used when saving the content to an XML Paper Specification (XPS) file.

The rendering mode used when saving the content to an XML Paper Specification (XPS) file. The rendering mode is not supported because of the reasons explained in the exception's .

Initializes a new instance of the class.