ABCpdf

IBookmark interface.

The factory for creating objects in the same application domain.

For internal use only.

Whether the bookmark appears open or closed.

The destination Page ID associated with this bookmark.

The bookmark title to be displayed on screen.

Refresh and reload the document bookmarks.

Adopt a specified bookmark.

The number of Bookmarks in the collection.

Add a new bookmark to the end of the list.

Inserts a Bookmark into the list at the specified position.

Removes a Bookmark at a specified position.

Gets an enumerator for the Collection.

The ID of the PDF object.

Returns a particular bookmark referenced by name or index.

IComFactory interface.

Create a Doc object.

Create an Image object.

Create an XColor object.

Create an XPoint object.

Create an XRect object.

Create an XSaveTemplateData object.

Create an XSettings object.

Create an XTextStyle object.

Create an XTransform object.

COM interface for ABCpdf

The factory for creating objects in the same application domain.

For internal use only.

The ID of the current page.

The ID of the current font.

The current text size (points).

The current line width (points).

The horizontal positioning factor (0 to 1).

The vertical positioning factor (0 to 1).

The current drawing color.

The current drawing position.

The current drawing rectangle.

The page size.

The visible page size.

The current text style.

The current default transformation.

The current encryption settings.

The current license details.

The ID of the root catalog.

The content insertion position (one is top).

The number of layers in the current page.

Add a page - return the page ID.

Add a font resource - return the font ID.

Add a block of text - return the text ID.

Add a block of HTML styled text - return the text ID.

Add a line - return the line ID.

Add an image - return the image ID.

Add a copy of an existing image to the current page - return the image ID.

Extract an image from a chunk of data and add it to the current page - return the image ID.

Draw a page from one PDF document onto the current page of this document - return the image ID.

Extract an image from a file and add it to the current page - return the image ID.

Adds an image to the current page - return the image ID.

Renders a web page specified as HTML - return the image ID.

Add a new page from a paged HTML or PostScript render - return the image ID.

Renders a web page specified by URL - return the image ID.

Get a particular type of information about an object.

Get numeric information about an object.

Get numeric information about an object.

Add a framed rounded rectangle - return the line ID.

Add a filled rectangle - return the line ID.

Delete a specified object.

Write out the PDF.

Get the PDF as raw data.

Read an existing document from file.

Embed a font resource - return the font ID.

Alters an aspect of an existing object.

Adds a bookmark for the current page.

Adds a native PDF object to the document.

Flattens and compresses the current page.

Clears the document freeing up resources.

Adds an alignment grid to help position objects.

The page number (one is the first page).

The number of pages in the document.

Appends a PDF document to the end of the current document.

Add an arc - return the arc ID.

The current line options.

The current measurement units.

Whether to measure from the top of the page.

The ID of the current color space.

Add an ICC based color space - return the ID.

Add a separation color space - return the ID.

Add an oval - return the line ID.

Add a pie slice - return the line ID.

Add a polygon - return the line ID.

Determine if an object is chainable.

Extract content from the current page in a specified format.

Remap pages for reordering, copying and deletion.

The HTML and URL rendering options and control.

The save options and control.

The PDF rendering options and control.

The document form and fields.

The top level bookmark for the document.

IField interface.

The factory for creating objects in the same application domain.

The value of the field.

The object ID.

The type of the field.

The possible values for this field.

The fully qualified field name.

The Page on which this field is located.

The rectangle which defines the position and area of the annotation on the page.

All the children of this field.

Prepare document for drawing at the field location.

Stamp this field into the document.

The partial field name.

The format for this field.

Whether the field supports multiple selections.

The validation policy for certificates.

Return binary X509 certificate(s) data.

Sign a signature using a private key and password.

Commit a previously signed signature to the document.

The location of the signing.

The reason for signing.

The name of the person signing.

The URL to a timestamping service.

The time of signing in UTC format.

True if the PDF was modified after signing.

True if the signature's certificate is trusted according to ValidationPolicy.

True if the signature's certificate was time-valid when the document was signed.

Check and validate the status of this signature.

IFields interface.

The factory for creating objects in the same application domain.

The number of Fields in the collection.

Internal property _NewEnum.

Returns a particular field referenced by name or index.

IXColor interface.

The factory for creating objects in the same application domain.

A string representation of the color.

The red intensity of the color (0 to 255).

The green intensity of the color (0 to 255).

The blue intensity of the color (0 to 255).

The gray intensity of the color (0 to 255).

The cyan intensity of the color (0 to 100).

The magenta intensity of the color (0 to 100).

The yellow intensity of the color (0 to 100).

The black intensity of the color (0 to 100).

The alpha opacity of the color (0 to 255).

The native color space for the color.

IXEncryption interface.

The factory for creating objects in the same application domain.

The level of encryption to use.

The crypt method for strings.

The crypt method for streams.

Sets the crypt methods.

The user password.

The owner password.

Whether to encrypt the document metadata.

Whether a user can print the document.

Whether a user can modify the document.

Whether a user can copy from the document.

Whether a user can edit the document.

Whether a user can fill forms in the document.

Whether a user can extract detail from the document.

Whether a user can assemble the document.

Whether a user can print a high resolution copy of the document.

IXForm interface.

The factory for creating objects in the same application domain.

Returns a particular field referenced by full name.

All top level fields in the form.

Whether values should be formatted before insertion into fields.

Whether field appearances should be pre-generated.

Whether the viewer should automatically regenerate field appearances.

Stamp all fields into the document.

Refresh and reload the document fields.

Make fields unique across pages, duplicating fields if necessary.

Make fields unique across pages, duplicating fields if necessary.

IXHtmlOptions interface.

The factory for creating objects in the same application domain.

The width of the virtual browser in pixels.

A user name to be used for authentication.

A password to be used for authentication.

Whether hyperlinks should be live.

Whether form fields should be live.

Whether movies and other active content should be live.

Whether the location of certain tags should be noted.

Whether hyperlinks with targets should be allowed to open in a new browser window.

Whether the values of form elements, except radio buttons, with the same name are distinct.

Whether font substitution should be used to reduce file size.

Whether fonts should be embedded rather than referenced.

Whether embedded fonts should be subset.

Whether fonts with restricted licensing should be protected from embedding.

The quality of compression acceptable for continuous tone images such as JPEGs.

The maximum amount of time allowed for obtaining a page (ms).

The minimum number of content items required for a page to be valid.

The number of times a page should be retried if unavailable or invalid.

Whether content should be rendered in multipaged format.

Whether to hide the background color of a page.

Additional HTTP headers to send in the request.

The user-agent string.

A script to be run after the page is loaded.

The request method for URL.

Whether to disable automatic cookies.

Whether to reload page.

The HTML engine to use.

The set of CSS style sheets to use while rendering the HTML page.

Whether to host a WebBrowser control.

Whether to deactivate the WebBrowser.

The method for loading URI/HTML.

The module for obtaining URI/HTML data.

Whether to enable JavaScript.

Whether to enable ActiveX.

Whether to enable Java.

Whether to enable Video.

Whether to resynchronize page.

Whether any proxy servers should re-request items of content.

Whether to use theme or not.

Whether the page cache should be searched first.

The length of time that pages can be held in the cache (ms).

The number of pages that can be held in the cache.

The maximum size at which an image may be regarded as atomic.

Whether HTML pages are marked up before conversion to PDF.

Whether HTML layout is checked and adjusted for optimal output to PDF.

Whether to automatically clip redundant content at the end of the page.

Clear all items from the page cache.

Clear all expired items from the page cache.

Convert external links to internal links wherever possible.

Gets an array of the HTML IDs of tagged visible items.

Gets an array of the locations of tagged visible items.

Retrieves the client side onload script return value.

Greatest interval we should wait for paint calls before rendering the page. Measured in ms.

The maximum amount of time to wait for repaints when using RepaintDelay (ms).

IXImage interface.

The factory for creating objects in the same application domain.

For internal use only.

Load an image from a file.

Load an image from data.

Assign a soft mask to the image.

The type of image.

The number of frames in the image.

The currently selected frame.

The width of the current frame (pixels).

The height of the current frame (pixels).

The horizontal resolution of the current frame (DPI).

The vertical resolution of the current frame (DPI).

The current selection rectangle.

The physical bounds of the image in points.

Whether the image can be added indirect.

Clears the image freeing up resources.

IXPoint Interface.

The factory for creating objects in the same application domain.

A string representation of the point.

The horizontal offset of the point from the bottom left.

The vertical offset of the point from the bottom left.

IXRect Interface.

The factory for creating objects in the same application domain.

For internal use only.

A string representation of the rectangle.

The offset of the top edge from the bottom left.

The offset of the left edge from the bottom left.

The offset of the bottom edge from the bottom left.

The offset of the right edge from the bottom left.

The width of the rectangle.

The height of the rectangle.

Translate the rectangle up and right.

Scale the rectangle, pinning the bottom left corner.

Move the bottom left corner to a position, preserving width and height.

Inset the rectangle horizontally and vertically.

The corner of the rectangle to pin.

Resize the rectangle preserving position.

Set the position and size of the rectangle.

IXRendering interface.

The factory for creating objects in the same application domain.

The output resolution in dots per inch.

The horizontal output resolution in dots per inch.

The vertical output resolution in dots per inch.

A string representation of the output colorspace.

The output bits per color channel.

Whether to anti-alias text.

Whether to anti-alias polygons.

Whether to anti-alias images.

Whether to apply entire scene anti-aliasing.

Whether to save the alpha channel.

The output file quality factor for lossy compression (0 to 100).

The type of compression to prefer when saving.

Whether to append to (rather than overwrite) existing image files.

The path to the default Gray ICC color profile.

The path to the default RGB ICC color profile.

The path to the default CMYK ICC color profile.

The path to the default CMYK ICC color profile.

Whether to apply overprint.

Whether to render fields and annotations.

The named separation.

Halftone type and options.

Whether to use embedded halftones.

Whether pages should be automatically rotated.

The log for the last render.

Renders and saves the current area of the current page as data.

Renders and saves the current area of the current page as a file.

IXSaveOptions interface.

The factory for creating objects in the same application domain.

Whether to reduce size by remapping objects.

Whether to linearize the output for fast web viewing.

Whether to use incremental update to preserve the validity of signature fields.

Whether to update the file version identifier.

Whether to assign a constant file version identifier.

Whether to assign non-ASCII file identifiers.

The file extension when the target is specified not with a path or a file name.

The path to the template file.

The template data.

IXSaveTemplateData interface.

The factory for creating objects in the same application domain.

The horizontal measurement resolution.

The vertical measurement resolution.

The JPEG quality level.

Whether JPEG images are re-encoded in JPEG.

Sets the measurement resolutions.

IXSettings interface.

The factory for creating objects in the same application domain.

The current license for the software.

Install a license.

Install a redistribution license.

Install a system license.

IXTextStyle interface.

The factory for creating objects in the same application domain.

A string representation of the style.

The text size (points).

The first line of paragraph indent (points).

The inter-character spacing (points).

The inter-word spacing (points).

The inter-line spacing (points).

The inter-paragraph spacing (points).

The horizontal justification factor (0 to 1).

Whether to apply an underline.

Whether to apply a strikethrough.

Whether to apply a double strikethrough.

The width of outline to use.

Whether to synthesize and apply an italic style.

Whether to synthesize and apply a bold style.

The paragraph indent (points).

IXTransform interface.

The factory for creating objects in the same application domain.

A string representation of the transform.

Reset to the identity.

Invert the transform.

Translate horizontally and vertically.

Rotate about a locked anchor point (angle in degrees).

Scale about a locked anchor point.

Skew horizontally and vertically about a locked anchor point.

Write all materials as JSON compliant string

Write the provided geometry object as JSON mesh

The geometry object to write The StringBuilder instance to write the JSON to The Indentation helper to apply correct indentation The name of the shader to use for The mesh attributes to use The texture to use, if any

Add a test cube object

Add an axis object of size 1, which can be rendered (at any size) on the WebGL site

Add a grid object of size 1, which can be rendered (at any size) on the WebGL site

Add all shader helper functions to the provided StringBuilder (to be added to a javascript file)

Write the shader compiler function which can be used in a javascript

Write the createShaderProgram function which can be used in a javascript

Write the getShaderProgram function which can be used in a javascript

Append the vertices to JSON data

The geometry object to write The StringBuilder to append the JSON data to The indent helper to use

Append the indices to JSON data

The geometry object to write The StringBuilder to append the JSON data to The indent helper to use

Append the normals to JSON data

The geometry object to write The StringBuilder to append the JSON data to The indent helper to use

Append the available colors to JSON data

The geometry object to write The StringBuilder to append the JSON data to The indent helper to use

Append the color indices to JSON data

The geometry object to write The StringBuilder to append the JSON data to The indent helper to use

Append the provided texture coordinate array to JSON data

Append the available texture coordinates to JSON data

Append the available texture coordinates to JSON data

Write a texture as JSON object (so it can be loaded by a javascript), the image data itself is written as base64 string

The texture to write as JSON The StringBuilder used to write the JSON texture info The indenter instance used to write to the StringBuilder The index of the texture, which is used to create the name of the texture The line delimiter to use to separate the JSON data

Helper class for managing the current indent level of source code that gets generated

Constructor

How many characters to use for one level of indentation The delimiter to use for a new line (for example when opening/closing blocks)

Indent more

The number of levels to indent Returns the current indentation string

Decrease indentation level

The number of levels to decrease If true, it will just return an empty string instead of the current indentation string Returns the current indentation string

Open a new block (for example with an '{'), indent more, and add line delimiters (if applicable)

How many new line delimiters to add after the block opening What character to use for marking a new block Returns the current indentation string

Close the current block (for example with an '}'), indent less, and add line delimiters (if applicable)

How many new line delimiters to add after the block is closed What character to use for closing the block Returns the current indentation string

Simplified block creation: Open a block, indent, add the specified text, unindent, close the block, and add new lines (if applicable)

The text to put into the block How many line delimiters to apply after the block (if any) Which block delimiter to use for opening the block Which block delimiter to use for closing the block

Get the current indentation string

Maximum number of spaces for indent

Default number of spaces to use for indent

Line delimited to use (for example '\n')

Number of spaces to indent

Current indentation string (to be used as prefix for generated source)

Current indentation length (number of "tabs")

A bookmark or outline item.

Test whether the two Bookmarks are the same.

The Bookmark to test against. Whether the Bookmarks are equal.

Whether the bookmark appears open or closed.

The parent of this bookmark.

The destination Page associated with this bookmark.

The destination Page ID associated with this bookmark.

The bookmark title to be displayed on screen.

Refresh and reload the document bookmarks.

Adopt a specified bookmark.

The bookmark to be adopted.

The number of Bookmarks in the collection.

Copies the Bookmarks into an array.

The array that is the destination for the elements. The zero-based index in array at which copying begins.

Gets or sets the Bookmark at the specified index.

Add a Bookmark to the end of the list.

The bookmark to be added. The position in which the new element was inserted.

Add a Bookmark to the end of the list.

The title for the bookmark to be added. The position in which the new element was inserted.

Removes all child Bookmarks.

Determines whether the array contains a specific Bookmark.

The object to locate. True if the object is found, otherwise false.

Determines the index of a specific Bookmark.

The object or the title of the object to locate in the Collection. If found, the index of value, otherwise -1.

Determines the index of a specific Bookmark.

The object or the title of the object to locate in the Collection. If found, the index of value, otherwise -1.

Inserts a Bookmark into the list at the specified position.

The zero-based index at which value should be inserted. The bookmark to be added.

Inserts a Bookmark into the list at the specified position.

The zero-based index at which value should be inserted. The title for the bookmark to be added.

Removes a Bookmark.

The Bookmark to be removed. True if the Bookmark is removed, otherwise false.

Removes a Bookmark at a specified position.

The zero based index specifying the Bookmark to be removed.

Gets an enumerator for the Collection.

The enumerator for the collection.

A field in a PDF form.

Field Flags Enumeration.

Do not let the user change the value of the field.

Require that the field has a value at the time it is exported by a form submission action.

Do not export the value of the field as part of a form submission action.

This is used for radio buttons and specifies that exactly one button shall be selected at all times.

Indicates whether the field is a radio button or a checkbox. This field is ignored if the Pushbutton flag is set.

Whether this field is a pushbutton that stores no permanent value.

Allow radio buttons with the same 'on' value to turn on and off together.

Allow a text field to contain multiple lines of text.

Display text field as a password box in which the text contents are obscured.

Display a text field that allows a file to be selected. When the form is submitted the contents of the file will be used as the value of the field.

Text in this text or choice field shall not be spell checked.

Text in this text field shall not scroll. Once text has been entered which fills the field it shall accept no further characters.

Use the MaxLen property to equally space out text field characters into a comb-like slot position.

The value of this text field shall be a rich text string.

Whether this field is a combo or list field.

Whether field shall present an editable text box in addition to a list.

Whether entries in the list shall be put into alphabetical order.

Whether more than one entry in the list can be selected at the same time.

A change to the value of this field will be committed as soon as it is made.

Test whether the two Fields are the same.

The Field to test against. Whether the Fields are equal.

The value of the field.

The type of the field.

The possible values for this field.

The fully qualified field name.

The Page on which this field is located.

The ID of the Page on which this field is located.

The Parent of this field.

The rectangle which defines the position and area of the annotation on the page.

All the immediate children of this field.

Prepare document for drawing at the field location.

True if the focus operation was successful.

Stamp this field into the document.

Gets all the Annotations referenced by this field or its children.

Gets all the Fields that are descendents of this one.

The maximum depth to search. One for immediate children. Two for children and grandchildren. etc

The partial field name.

The format for this field.

Whether the field supports multiple selections.

The Field Flags (Ff) entry.

QuaddingType Enumeration.

Left aligned text.

Center aligned text.

Right aligned text.

The alignment for the text. Getting this property gets the effective value which may be inherited. Setting this property sets the alignment on this item itself. This feature is referred to as quadding within the Adobe PDF Specification. We call it alignment because quadding is not normal terminology. The appearance of the field is not updated until you change the or call .

The default appearance (DA) used for the text. This property controls the base set of drawing instructions used for controlling the appearance of variable text in a field. Getting this property gets the effective value which may be inherited. Setting this property sets the value on this item itself. Similarly setting this property to null will remove the property on the item itself but the value may continue to be inherited. The appearance of the field is not updated until you change the or call .

The font used for the text. This is derived from the for the field. Getting this property gets the effective value which may be inherited from a parent field or from document defaults. To change this property use the function.

The font size used for the text. This is derived from the for the field. Getting this property gets the effective value which may be inherited from a parent field or from document defaults. To change this property use the function.

Sets the font and font size to be used for text. Callng this function works by changing the for the field. Properties such ase the and gets the effective value which may be inherited. Calling this funtion sets the value on this item itself which will override any inherited value. Passing a font value of null will remove both the font and size from the item itself though a value may be still be present if it is inherited from a parent field or from document defaults. A zero size font indicates that the font should scale so that it fits the size of the field. Negative font heights appear the same as positive ones but are best avoided as they are likely to cause confusion. The appearance of the field is not updated until you change the or call .

The color used for the text. This is derived from the for the field. Getting this property gets the effective value which may be inherited. Setting this property sets the value on this item itself. When you set this property a clone of the XColor you assign is created to avoid one XColor being shared by multiple fields. The appearance of the field is not updated until you change the or call .

Update the Appearance Stream for all the Annotations associated with this field.

The export values for this field. Choice fields such as Combo boxes and Lists have a value selected from one of their Options. However it is possible to specify an export value which is different from the value of field. The export value will be used if the form data is exported or submitted in some way so it is purely for external use. This function allows you to get the export values from the field. Please note that export values are only meaningful for fields of FieldType FieldType.Combo or FieldType.List and they are only relevant for form export.

An array of strings - one for each option. The size of the array is always equal to the number of options.

Dispose of the Field.

A collection of Fields.

The number of Fields in the collection.

Copies the Fields into an array.

The array that is the destination for the elements. The zero-based index in array at which copying begins.

Gets or sets the Field at the specified index.

Gets or sets the Field of the specified name.

Add a Field to the end of the list.

The item to be added. The position in which the new element was inserted.

Removes all child Fields.

Determines whether the list contains a specific Field.

The object to locate. True if the object is found, otherwise false.

Determines the index of a specific Field.

The object to locate in the collection. If found, the index of value, otherwise -1.

Inserts a Field into the list at the specified position.

The zero-based index at which value should be inserted. The item to insert into the array.

Removes a Field.

The name of the element to be removed. True if the Field is removed, otherwise false.

Removes a Field at a specified position.

The zero-based index of the item to remove.

Gets an enumerator for the Collection.

The enumerator for the collection.

The top level outline item.

Test whether the two Outlines are the same.

The Outline to test against. Whether the Outlines are equal.

A digital Signature Field.

The validation policy type for certificates.

Perform an X.509 certificate path validation using the Windows Trusted Root CA store. Additional certificates passed in through Validate() will also be added as trust anchors.

Just verify that the certificate(s) in the document has or have been signed with one of the certificates specified as a parameter in Validate().

Test whether the two Signatures are the same.

The Signature to test against. Whether the Signatures are equal.

The validation policy for certificates.

Return binary X509 certificate(s) data.

The encoded X.509 data for the certificate(s).

Return binary X509 certificate(s) data.

The number of certificates. The encoded X.509 data for the certificate(s).

Sign a signature using a private key and password.

The path to the PFX/PKCS #12 (.pfx or .p12) file used for signing. The password used to authorize use of the private key.

Sign a signature using a private key and password.

The data for the PFX/PKCS #12 (.pfx or .p12) file used for signing. The password used to authorize use of the private key.

Sign a signature using a private key and password.

The stream for the PFX/PKCS #12 (.pfx or .p12) file used for signing. The password used to authorize use of the private key.

Sign a signature using a private key and password.

The stream for the PFX/PKCS #12 (.pfx or .p12) file used for signing. The password used to authorize use of the private key. The OID of the hash algorithm that should be used.

Sign a signature using a private key.

The System.Security.Cryptography.X509Certificates.X509Certificate2 object for the PFX/PKCS #12 (.pfx or .p12) certificate used for signing. Whether to suppress prompting the user to use the private key.

Sign a signature using a private key.

The System.Security.Cryptography.X509Certificates.X509Certificate2 object for the PFX/PKCS #12 (.pfx or .p12) certificate used for signing. Whether to suppress prompting the user to use the private key. The OID of the hash algorithm that should be used. The parts of the signing certificate chain which should be included in the signature.

Commit a previously signed signature to the document.

The location of the signing.

The reason for signing.

The name of the person signing.

The URL to a timestamping service.

The time of signing in UTC format.

True if the PDF was modified after signing.

True if the signature's certificate is trusted according to ValidationPolicy.

True if the signature's certificate was time-valid when the document was signed.

True if the signature and document look well formed and well applied.

The type of hash algorithm used in the signature.

Check and validate the status of this signature.

True if the certificate is valid.

Check and validate the status of this signature.

Check and validate the status of this signature.

An array of paths to X.509 certificate (.cer) files. True if the certificate is valid.

An Annotation such as a text note or hyperlink.

AnnotationFlags Enumeration.

Do not display the annotation if it does not belong to one of the standard types and no special handler is available.

Do not display or print the annotation or allow it to interact with the user, regardless of its type or whether an annotation handler is available.

Print the annotation when the page is printed. Typically used to hide pushbuttons when a page is printed.

Do not scale the annotation as the zoom level of the page is changed. The top left of the annotation on the page remains fixed regardless of the page zoom level.

Do not rotate the annotation as the page is rotated. The top left of the annotation on the page remains fixed regardless of the page rotation.

Do not show the annotation on the screen or allow it to interact with the user. The annotation may be printed if the Print flag is set.

Do not allow the annotation to interact with the user.

Do not allow the annotation to be moved, deleted or otherwiser modified. However the content may be changed even if this property is set.

Invert the interpretation of the NoView flag for certain events.

Do not allow the contents of the annotation to be modified. Other annotation properties such as size and location may be modified.

Test whether the two Annotations are the same.

The Annotation to test against. Whether the Annotations are equal.

The sub-type of Annotation.

The visible text of the annotation.

The full name of any form field associated with this annotation.

The field type of any form field associated with this annotation.

The value of any form field associated with this annotation.

The rotation of the annotation in degrees counterclockwise to the page - a multiple of 90. This property is only valid if this annotation is associated with a form field. After changing this property you will need to call to realize the change.

The background color of the field. This color must be grayscale, RGB or CMYK. If it is null then the background is transparent. This property is only valid if this annotation is associated with a form field. When you set this property a clone of the XColor you assign is created to avoid one XColor being shared by multiple annotations. After changing this property you will need to call to realize the change.

The border color of the field. This color must be grayscale, RGB or CMYK. If it is null then the border is transparent. This property is only valid if this annotation is associated with a form field. When you set this property a clone of the XColor you assign is created to avoid one XColor being shared by multiple annotations. After changing this property you will need to call to realize the change.

The border appearance. This property is a three or four element array. The first three elements describe the horizontal corner radius, the vertical corner radius and the border width. If the corners are zero then the border has rectangular rather than rounded corners. If the border width is zero then there is no border. The last optional element is a dash array to be used in drawing dashed borders. This conforms to the standard dash array format which indicates alternatingly the length of lines and gaps. So [2 1] would indicate two on, one off, two on, one off... Longer arrays can be used for more complex dash patterns. If this property is null then a solid rectangular border of width one will be drawn. This is equivalent to the following code: annot.Border = (ArrayAtom)Atom.FromString("[0 0 1"); // C# annot.Border = DirectCast(Atom.FromString("[0 0 1]"), ArrayAtom) ' VB.NET After changing this property you will need to call to realize the change.

The possible values for any form field associated with this annotation.

The Page on which this annotation is located.

The rectangle which defines the position and area of the annotation on the page.

The default text direction.

Update the Appearance Stream for this Annotation.

Stamp this Annotation into the page.

Prepare document for drawing at the Annotation location.

True if the focus operation was successful.

The Annotation Flags entry.

Dispose of the Annotation.

The Catalog for the document.

Test whether the two Catalogs are the same.

The Catalog to test against. Whether the Catalogs are equal.

The root Pages Object.

The root Outlines Object.

Any document level Metadata.

The names of all the eForm fields in the document.

The names of all the eForm fields in the document.

Get all the eForm fields in the document.

The names of all the eForm fields in the document.

Perform whole document analysis of page contents.

Gets all the fonts in this document.

All the fonts in the document.

Gets all the embedded files in this document. PDF documents can contain a set of named files. These files can then be referenced by name elsewhere in the document. The most common case in which named files are used is in the case of PDF portfolios. Adobe now uses the name Portfolio for this type of document but in the PDF specification they are known as Portable Collections. While the names may vary two are the same. PDF Portfolios appear as one PDF document but actually contain many. Typically the first document represents the visible face of the collection when opened. After the collection is open you can switch between the embedded PDFs. PDF portfolios can be used to represent a folder of PDFs. For example you might find a portable collection being used to display multiple emails within a single PDF Portfolio.

All the files embedded in the document.

ColorSpaceType Enumeration.

Unknown or undefined.

Device dependent Gray.

Device dependent RGB.

Device dependent CMYK.

Calibrated Gray.

Calibrated RGB.

ICC Color Profile Based.

Lab.

Indexed Color.

Pattern.

Separation.

DeviceN.

A color space.

ColorSpace constructor.

The ObjectSoup to contain the newly created StreamObject.

ColorSpace constructor.

The ObjectSoup to contain the newly created StreamObject. The type of color space required.

Test whether the two ColorSpaces are the same.

The ColorSpace to test against. Whether the ColorSpaces are equal.

The type of color space.

Any name associated with the color space.

The number of color components in the color space.

The type of color space.

The base type of color space. For non-indexed color spaces this will always be the same as the ColorSpaceType.

The white point for the color space specified in CIE 1931 XYZ space. X and Y must be positive and Z must be one. The default for this peroperty is 0 0 0. When you set this property a clone of the XColor you assign is created to avoid one XColor being shared by multiple fields.

The black point for the color space specified in CIE 1931 XYZ space. All components for this valud must be non-negative. The default for this peroperty is 0 0 0. When you set this property a clone of the XColor you assign is created to avoid one XColor being shared by multiple fields.

The gamma correction for the color space. Gamma is defined for each component of a calibrated color space. So for a CalGray color space it has one entry and for a CalRGB color space it has three. This means that for a CalGray color space this property will be a NumAtom and for a CalRGB color space it will be an ArrayAtom with three entries. Gamma is not valid for other color spaces. Each gamma entry must be positive and is generally greater than or equal to one.

Any ICC Color Profile associated with this color space.

"A 3D stream.

D3DStream constructor.

The ObjectSoup to contain the newly created D3DStream.

D3DStream constructor.

The ObjectSoup to contain the newly created D3DStream. A path to a file containing data which should be placed in the D3DStream.

D3DStream constructor.

The ObjectSoup to contain the newly created D3DStream. An array of bytes which should be placed in the D3DStream.

Test whether the two D3DStream objects are the same.

The D3DStream to test against. Whether the D3DStream objects are equal.

Set the 3D data for the stream.

The 3D data in U3D or PRC format.

Set the 3D content of the stream from data embedded in a file.

A path to a file containing 3D data in OBJ, U3D or PRC format.

An EmbeddedFile represents a file stream embedded inside a PDF document. It includees a small amount of metadata such as, optionally, the file creation and modification date. However it is primarily related to file data.

EmbeddedFile constructor.

The ObjectSoup to contain the newly created EmbeddedFile.

EmbeddedFile constructor. This constructor takes a path to a file. The file data will be inserted into the this object, appropriate metadata will be added using the function and the data will be compressed using the function.

The ObjectSoup to contain the newly created StreamObject. A path to a file containing data which should be placed in the EmbeddedFile.

EmbeddedFile constructor. This constructor takes a byte array. The data will be inserted into the this object, and the data will be compressed using the function.

The ObjectSoup to contain the newly created StreamObject. An array of bytes which should be placed in the EmbeddedFile.

Test whether the two EmbeddedFiles are the same.

The EmbeddedFile to test against. Whether the EmbeddedFiles are equal.

Update properties like the ModificationDate, CreationDate and Size to reflect the file values. The EmbeddedFile must be part of an ObjectSoup or an exception will be thrown.

A path to a file containing data. If null is passed the data will be cleared.

The subtype of the embedded file. This property is represented via a and hence it cannot take an empty string. Setting this property to an empty string will set it to null.

The size of the embedded file.

The creation date of the embedded file.

The modification date of the embedded file.

The 16 byte checksum for the embedded file.

The Macintosh file type - a four char code represented as an integer.

The Macintosh file creator - a four char code represented as an integer.

The Macintosh resource forks stream for this file.

FieldType Enumeration.

Pushbutton Type.

Checkbox Type.

Radio Type.

Text Type.

List Type.

Combo Type.

Signature Type.

Unknown Type.

A file specification represents the name and location of a file and optionally may also include references to embedded data.

FileSpecification constructor.

The ObjectSoup to contain the newly created FileSpecification.

FileSpecification constructor. This constructor takes a path to a file. The file data will be inserted into the this object, appropriate metadata will be added using the function and the data will be compressed using the CompressFlate function.

The ObjectSoup to contain the newly created FileSpecification. This should not be null. A file to embed within the file specification. Thrown if the soup is null.

Test whether the two FileSpecifications are the same.

The FileSpecification to test against. Whether the FileSpecifications are equal.

A description of the file for use in a user interface.

The default platform being used for the file specification. For historic reasons PDF has supported multiple different files for multiple different platforms. This was appropriate when files were often non-interoperable and would not port easily between machines. Fortunately this state of affairs is now unusual and only the default "UF" platform is commonly used. Adobe do not specify what the initials stand for, but it is likely to be Unicode File, though it could be Universal File or URL File. While you are unlikely to wish to create documents which use these obsolescent platforms, you may find old documents that use them. This method allows you to access information specified by platform. Appropriate selectors are "UF", "F", "DOS", "Mac" or "Unix" as per the descriptions in the Adobe PDF Specification. You can use the Platforms property to deterine which are being used. The defaut of "UF" provides access via the standard settings as specified in the PDF 1.7 specification.

The URI to the file. For the default plaform, attempting to set this property to a value which is nov a valid URI will result in an exception being thrown. To convert a standard Windows path to a URI use (new System.Uri(path).AbsouteUri. For some values of the Platform property (eg Mac, DOS, Unix) raw file paths can be used. However these are obsolete and while you may see PDFs which contain them, you would be inadvised to generate new documents containing these structures.

The embedded file if one has been embedded in the PDF. If a file has not been embedded then the URL needs to be intepreted in the context of the current PDF to locate the external file. Setting this property will clear the EmbeddedFiles property if one is present. This property references another in the Doc. So if this object is not part of a Doc then this property will always be null.

The set of embedded files if a set has been embedded in the PDF. Normally a file specification will refer to one file. However in some situations it may be necessary to allow it to refer to multiple. For example if a CMYK image is available as four color separations then it may be useful to be able to embed four different files to make up the whole data set. Each file will need a name so this property reflects both the name and the content of each file. If the EmbeddedFiles property has a value, then the first file in the array should always be the same as the EmbeddedFile property. For this reason setting this property will also set the EmbeddedFile property to be equal to the first file in the array. If there are no items in the array then the EmbeddedFile property will be cleared.

This property references other objects in the Doc. So if this object is not part of a Doc then this property will always be null.

Whether the file changes frequently and needs to be reloaded each time it is used, or if it is not and may be cached.

Removes any obsolescent and redundant entries and converts this object to the PDF 1.7 standard.

Get the path to the file for the specified platform. If there is no matching path then null will be returned.

Set the path to the file for the specified platform. Setting to null will remove the path.

A specific font as used in the document.

The font writing mode type.

Horizontal writing mode.

Vertical writing mode.

The support for encoding text.

Encode all text.

Encode nothing if any character is not included in the font.

Encode up to and excluding the first character not included in the font.

Font Descriptor Flags Enumeration.

All glyphs have the same width; as opposed to proportional or variable-pitch fonts, which have different widths.

Glyphs have serifs - short strokes drawn at an angle on the top and bottom of glyph stems. Sans serif fonts do not have serifs.

Font contains glyphs outside the Adobe standard Latin character set. This flag and the Nonsymbolic flag are mutually exclusive.

Glyphs look like cursive handwriting.

Font uses the Adobe standard Latin character set or a subset of it.

Glyphs have slanted dominant vertical strokes.

Font contains no lowercase letters.

Lower case letters in this font look like smaller versions of their upper case equivalents.

Whether bold glyphs shall be painted with extra pixels even at very small text sizes.

Test whether the two FontObjects are the same.

The FontObject to test against. Whether the FontObjects are equal.

The font writing mode.

Encode text for use with PDF text operators.

The text to be encoded. The way in which characters not included in the font are to be encoded. The PDF string containing the encoded text.

Encode text for use with PDF text operators.

The text to be encoded. The way in which characters not included in the font are to be encoded. The number of characters in (parameter) text that are encoded in the return value. The PDF string containing the encoded text.

Subset a previously embedded font.

Whether subsetting was performed succesfully.

Subset a previously embedded font to include only those characters in the provided string.

Attempt to regenerate a ToUnicode map.

Whether a new ToUnicode map was generated.

Whether the font contains an embedded subset.

The PostScript name of the font.

Whether to exclude invalid glyphs from our lookup tables. When fonts are subsetted the glyphs in the tables may be rendered invalid because they are not used. By default we attempt to detect such glyphs and exclude them from any operations or font properties.

The unicode to glyph mapping table for all the characters in the font.

The glyph to unicode mapping table for all the characters in the font.

The glyph to unicode string mapping table for all the characters in the font that contain one. This should be viewed as a supplement and an override for the GlyphToUnicode and UnicodeToGlyph mappings.

The character widths in thousandths of a unit for all the characters in the font.

The bounding box for the glyphs in this font. This corresponds to the xMin, xMax, yMin and yMax entries in the 'head' TrueType table. The PDF format only supports a limited range of metrics so FontObjects read from PDF may contain some approximations compared with 'live' FontObjects which have been added using the Doc.AddFont or Doc.EmbedFont methods.

The line spacing for the glyphs in this font. This broadly reflects the distance in 1000ths between the bottom of the lowest descender and the top of the highest ascender on two subsequent lines. We follow Microsoft best practice on this metric and vary the calculations depending on whether bit 7 of the fsSelection entry in the 'OS/2' TrueType table is set or not. However it is worth noting that many items of software including Microsoft flagship products do not. The PDF format only supports a limited range of metrics so FontObjects read from PDF may contain some approximations compared with 'live' FontObjects which have been added using the Doc.AddFont or Doc.EmbedFont methods.

The line gap for the glyphs in this font. This corresponds to the sTypoLineGap entry in the 'OS/2' TrueType table.

The PDF format only supports a limited range of metrics so FontObjects read from PDF may contain some approximations compared with 'live' FontObjects which have been added using the Doc.AddFont or Doc.EmbedFont methods.

The ascent for the glyphs in this font. This corresponds to the usWinAscent entry in the 'OS/2' TrueType table.

The PDF format only supports a limited range of metrics so FontObjects read from PDF may contain some approximations compared with 'live' FontObjects which have been added using the Doc.AddFont or Doc.EmbedFont methods.

The descent for the glyphs in this font. This corresponds to the usWinDescent entry in the 'OS/2' TrueType table.

The PDF format only supports a limited range of metrics so FontObjects read from PDF may contain some approximations compared with 'live' FontObjects which have been added using the Doc.AddFont or Doc.EmbedFont methods.

The ascender for the glyphs in this font. This corresponds to the sTypoAscender entry in the 'OS/2' TrueType table.

The PDF format only supports a limited range of metrics so FontObjects read from PDF may contain some approximations compared with 'live' FontObjects which have been added using the Doc.AddFont or Doc.EmbedFont methods.

The descender for the glyphs in this font. This corresponds to the sTypoDescender entry in the 'OS/2' TrueType table.

The PDF format only supports a limited range of metrics so FontObjects read from PDF may contain some approximations compared with 'live' FontObjects which have been added using the Doc.AddFont or Doc.EmbedFont methods.

Whether the font is a complex composite font.

Whether the font is a descendent of a complex composite font.

Whether the font is a composite glyph encoded identity font.

The Font Descriptor Flags entry.

Whether the font is for vertical writing.

Search for and automatically embed a font file into this font object. If an existing font file is already embedded it will be replaced. If you wish to subset the font you will need to call the Subset method after Embedding the font. Calling this function on Identity encoded fonts should be done with great caution as thse types of fonts rely on glyph IDs and are thus specific to a particular font file.

Whether a font file was embedded as a result of this operation.

The embedded font file.

Unembed the font if this is a simple operation. Latin based fonts can often be unembedded as a simple and fast operation. However Unicode and symbolic fonts are more complex to unembed and cannot be simply removed from the document.

The number of bytes of font data that were removed as a result of this call. Note that if multiple font objects reference the same embedded font then the same number may be returned multiple times.

Obtain a standard encoding dictionary for use with PDF text operators.

The language type for the desired encoding. Whether the writing direction should be horizontal or vertical. A dictionary mapping Unicode values to native character IDs.

A Form XObject is a self contained stream of graphics operations which can be referenced as a group.

FormXObject constructor.

The ObjectSoup to contain the newly created FormXObject.

Test whether the two FormXObjects are the same.

The FormXObject to test against. Whether the FormXObjects are equal.

The rect defining the bounding box of the graphic. Content will be clipped to this area.

The transformation matrix used for mapping the Form XObject space into user space. This entry may be null which signifies the identity matrix.

Get a dictionary mapping the names of a particular type of resource to Atoms.

The type of resource to be indexed. A dictionary mapping resource names to Atoms.

Get a dictionary mapping the names of a particular type of resource to Atoms.

The type of resource to be indexed. Whether to include resources from other Form XObjects referenced from this one. Whether to include resources from Patterns referenced from this Form XObject. A set of IDs indicating IndirectObjects that should be skipped. This value may be null if you do not want to skip any items. A set of IDs of all the resources that have been encountered. The set of resources is generally the same as the set of items in the returned dictionary, but may not be if resource names have clashed. This value may be null if you are not interested in the set. A dictionary mapping resource names to Atoms.

Add a particular type of resource.

The resource to be added. The type of resource. The format of the name that should be used. The actual name that was used.

A specific GraphicLayer as used in the document.

Test whether the two GraphicLayers are the same.

The GraphicLayer to test against. Whether the GraphicLayers are equal.

A pre-specified graphics state.

Test whether the two GraphicsStates are the same.

The GraphicsState to test against. Whether the GraphicsStates are equal.

An ICC Color Profile.

IccProfile constructor.

The ObjectSoup to contain the newly created IccProfile. A path to an ICC file.

IccProfile constructor.

The ObjectSoup to contain the newly created IccProfile. An ICC profile stored in an array of bytes.

Test whether the two IccProfiles are the same.

The IccProfile to test against. Whether the IccProfiles are equal.

Set the raw binary content of the stream.

The raw binary content of the stream.

Updates this object to reflect the values contained within the embedded ICC color profile data.

The alternate color space for this ICC color profile. This represents the base non-ICC color space.

A rendition of a image on a page.

Test whether the two ImageLayers are the same.

The ImageLayer to test against. Whether the ImageLayers are equal.

The PixMap containing the image data.

The name used to identify the PixMap in the Page resources.

The clipping path to be applied to the image.

ComparisonType Enumeration.

Nothing.

Consider ID.

Consider ID.

Consider Atom.

Consider Data.

A PDF Indirect Object.

Construct an appropriate type of IndirectObject given a string value.

The string representing the value of the object. The resulting IndirectObject.

IndirectObject constructor.

IndirectObject destructor.

Whether the two IndirectObjects are the same.

The object to test against. Whether the objects are equal.

Test whether the two IndirectObjects are the same.

The IndirectObject to test against. Whether the IndirectObjects are equal.

Test whether the data in two IndirectObjects is the same. The comparison type specifies the type of data to compare. Only if all the comparisons are true are the objects said to be equal.

The IndirectObject to test against. Whether the IndirectObjects are equal.

Creates a deep copy of the current IndirectObject.

The newly created copy.

Transcodes and reloads the IndirectObject. Normally transcoding takes place automatically as objects are added. However sometimes changes occur after the even which may result in core aspects of the object changing. These changes may require caches to be regenerated or even an entirely new object to be created - one which better represents the new underlying structure of the PDF data. This is particualy the caes for the FontObject class which implements a lot of caching and is often dependent on other objcts in the soup. If transcoding results in a new object being created it will displace the current object from the soup. As such you will noremlly discard the old reference if a new IndirectObject is returned.

An appropriate subclass of IndirectObject.

A hash code for the IndirectObject.

The returned hash code.

A hash code derived from this IndirectObject. The hash code can be made up of a variety of parts of the indirect object combined together. The ID and the Atom hash codes are derived from the value of the ID and Atom respectively. The Data hash code is made from a sample of the compressed data contained in the stream. For this reason two StreamObjects, compressed differently, will return different hash codes even if the uncompressed data is identical. The data sample is kept small - in the order of a few hundred bytes - to ensure a fast response even for very large streams.

The returned hash code.

The string representation of the IndirectObject.

The string representation of the object.

Dispose of the IndirectObject.

Dispose of the IndirectObject.

The ID of the PDF object.

The Generation of the PDF object.

The revision of the document in which this object is stored. One is the oldest update and larger values are more recent. A value of zero indicates that the object was not read from stream.

The minimum version of the PDF specification required to support this object.

The minimum extension level of Adobe Supplement to the PDF specification required to support this object.

Whether the IndirectObject is currently alive.

The atom contained by the IndirectObject.

Resolves any indirect references and returns the Atom.

The Atom to resolve. The final Atom or null if no Atom could be found.

Resolves any indirect references and returns the final RefAtom.

The Atom to resolve. The final RefAtom or null if no valid RefAtom could be found.

Resolves any indirect references and returns the final IndirectObject.

The Atom to resolve. The final IndirectObject or null if no valid object could be found.

The Doc containing this IndirectObject.

The ObjectSoup containing this IndirectObject.

A layer of visible content.

Test whether the two Layers are the same.

The Layer to test against. Whether the Layers are equal.

The Page on which the Layer is located. While Layers are normally only referenced from one page, it is possible to reference them from multiple. This property reflects the orginal Page for which this layer was created.

The transform which has been applied to the visible content.

The transformed rect defining the bounds of the visible content on the page.

The untransformed rect defining the bounds of the visible content on the page.

An XMP Metadata stream.

Metadata constructor.

The ObjectSoup to contain the newly created Metadata.

Metadata constructor.

The ObjectSoup to contain the newly created Metadata. A path to a file containing data which should be placed in the Metadata.

Metadata constructor.

The ObjectSoup to contain the newly created Metadata. An array of bytes which should be placed in the Metadata.

Test whether the two Metadata objects are the same.

The Metadata to test against. Whether the Metadata objects are equal.

The Title entry within the Metadata. This corresponds to the dc:title entry.

The Author entry within the Metadata. This corresponds to the dc:creator entry. The PDF 2.0 Specification states that this corresponds to the dc:author entry, but this seems to be a mistake since all related specifications and indeed all examples in the PDF 2.0 specification use the dc:creator.

The Subject entry within the Metadata. This corresponds to the dc:description entry.

The Keywords entry within the Metadata. This corresponds to the pdf:Keywords entry.

The Creator entry within the Metadata. This corresponds to the xmp:CreatorTool entry.

The Producer entry within the Metadata. This corresponds to the pdf:Producer entry.

The CreationDate entry within the Metadata. This corresponds to the xmp:CreateDate entry. Use StringAtom.StringToDate and DateToString to convert between DateTime and string formats.

The ModDate entry within the Metadata. This corresponds to the xmp:ModifyDate entry. Use StringAtom.StringToDate and DateToString to convert between DateTime and string formats.

The collection of IndirectObjects for a PDF.

ObjectSoup destructor.

Dispose of the Collection.

Gets the number of items in the Collection.

Gets the number of incremental updates. No object in the collection will have a Revision higher than this.

Copies the objects in the Collection to an Array.

The array that is the destination for the elements. The zero-based index in array at which copying begins.

Gets or sets the object at the specified index.

Adds an object to the Collection.

The IndirectObject to be added. The position in which the new element was inserted.

Removes all objects from the Collection.

Determines whether the Collection contains a specific object.

The object to locate. True if the object is found, otherwise false.

Determines the index of a specific object.

The object to locate in the Soup. If found, the index of value, otherwise -1.

Inserts an object into the Collection at the specified position.

The zero-based index at which value should be inserted. The Object to insert into the Soup.

Removes an object from the Collection.

The IndirectObject to be removed. True if the IndirectObject is removed, otherwise false.

Removes an object at a specified position from the Collection.

The zero-based index of the item to remove.

Gets an enumerator for the Collection.

The enumerator for the collection.

The Catalog for the document.

The Trailer or XRef for the document.

A set of IndirectObjects from an ObjectSoup. This may be used for selecting related objects and copying them to a new soup while maintaining the relationships between the items in the selection.

ObjectSet constructor.

The soup from which objects will be selected.

Gets a dictionary used to redirect all objects of a specific type to a specific object ID.

Gets the dictionary used to map object IDs from the source soup to new object IDs in the final soup. Some mappings may be populated via the RemapTypes as IndirectObjects are added. Most will be populated at the point that the CopyTo method is called.

Gets the collection of IndirectObjects currently contained in the subset.

Add a parent object along with all objects it refers to.

The IndirectObject to be added. The number of objects that were added.

Add all the objects this dictionary refers to.

A dictionary atom to be added. The number of objects that were added.

Add just this object ignoring any objects it may refer to.

The IndirectObject to be added. True if the item was added.

Copy the objects in this subset to a new soup while preserving the relationships between the items in the selection.

The destination soup.

A visible page within the document.

TextType Enumeration.

Unicode Text.

Unicode Text without features like inferred spaces and de-hyphenation.

Scalable Vector Graphics (SVG).

Scalable Vector Graphics (SVG). Extra attributes related to PDF drawing operators.

Scalable Vector Graphics (SVG). Extra attributes related to PDF drawing operators. Form XObject content included.

Test whether the two Pages are the same.

The Page to test against. Whether the Pages are equal.

The parent of this page.

The number of degrees to rotate the page before display. Should be a multiple of 90.

The page number (one is the first page).

Detaches a content stream from the page.

The stream to detach from the page.

Gets all the named separations referenced by the page.

An array of the names of the separations.

Gets all the content Layers for the page.

An array of all the content Layers on the page.

Gets all the Annotations on the page.

An array of all the Annotations on the page.

Gets the decompressed content data from the page. If the page contains multiple content streams then the data from these will be concatenated so you can treat them as one. However, while the data is concatenated, the streams are left untouched - the function does not alter the page. If a content stream could not be decompressed then an exception will be raised.

The content data.

Converts the page from one color space to another.

The destination color space. Whether to convert the color space of annotation appearance streams.

Converts the page from one color space to another.

The destination color space. Whether to convert the color space of annotation appearance streams. All the PixMaps which were recolored as a result of the call.

Makes any inline images into external images.

Makes any inline images into external images. Return the extracted images.

Replaces the content stream of a page containing text to one containing glyph outlines.

Extract content from the current page in a specified format.

Extract content from the current page in a specified format.

Extract content from selected layers of the current page in a specified format.

Flatten and compress the page content stream.

Whether to force the flattening even if the streams contain extra information which might be lost. Whether the page is flat.

Flatten the page content stream.

Whether to force the flattening even if the streams contain extra information which might be lost. Whether to compress the resulting stream or whether to leave it as undetermined compression. Whether the page is flat.

Get all the resources of a named type, optionally including any used by referenced objects.

The type of resource to be found. Whether to include resources in annotations. Whether to include resources in referenced Form XObjects. Whether to include resources in pattern dictionaries. Whether to include resources in parent objects. A set of IndirectObject IDs that should be skipped when performing the scan. May be null. A set of matching resource Atoms.

Get a dictionary mapping the names of a particular type of resource to Atoms.

The ID of the resource containing object. This is typically the Page ID but you may also use a Form XObject ID. The type of resource to be indexed. A dictionary mapping resource names to Atoms.

Get a dictionary mapping the names of a particular type of resource to Atoms.

The ID of the resource containing object. This is typically the Page ID but you may also use a Form XObject ID. The type of resource to be indexed. Whether to include resources from Annotations on the page (assuming the containing object is a page). Whether to include resources from Form XObjects referenced from this containing object. Whether to include resources from Patterns referenced from this containing object. Whether to include resources from parents of this page (assuming the containing object is a page). A set of IDs indicating IndirectObjects that should be skipped. This value may be null if you do not want to skip any items. A set of IDs of all the resources that have been encountered. The set of resources is generally the same as the set of items in the returned dictionary, but may not be if resource names have clashed. This value may be null if you are not interested in the set. A dictionary mapping resource names to Atoms.

Makes a FormXObject out of the page.

Removes all FormXObjects from the page by embedding them into the content. Most Form XObjects can be embedded in the page with no difference in page appearance. However Form XObjects such as transparency groups contain structures which cannot be represented any other way. These structures are uncommon in most documents but they do occur. In this situation you need to decide whether a change in page appearance is acceptable and that the objects should be forcably embedded. The alternative is to skip these objects and embed only those that will not affect the page appearance.

Whether to stamp FormXObjects that may cause a change in the page appearance. The number of FormXObjects removed from the page.

Add a particular type of resource to the page.

The resource to be added. The type of resource. The format of the name that should be used. The actual name that was used.

Add a content layer to the top of the page.

The layer to be added.

Render one or more layers on the current page.

This function renders a set of layers and returns the result as a System.Drawing.Bitmap. The Bitmap covers the smallest possible area which encompasses all the layers provided. If this Page is not in a Doc then an exception will be raised. The function will return null if the layers argument is null or empty or the output Bitmap would be smaller than one pixel in area. Rendering options such as resolution in DPI,are taken directly from the current XRendering settings for the doc. However automatic page rotation (XRendering.AutoRotate) is disabled so that a Layer can be rendered and then re-inserted into the page as a raster copy of itself. Note that a layer can exist on multiple pages and indeed can be rendered in the context of a page that does not contain it. However layers typically contain references to named resources which are only available in the context of a specific page. So rendering a layer in the context of a page which does not normally contain it is prone to error unless the page and layer have been specifically consructed to allow this. The layers to be rendered.

The MediaBox for the page.

The MediaBox defines the boundaries of the physical medium on which the page may be displayed or printed. This may include bleed areas or printing marks and also parts of the medium on which printing cannot take place because of physicsal limitations of the output technology. Any PDF drawing outside the MediaBox can be safely ignored. These boundaries may be defined directly on the Page object or they may be inherited from a parent Pages object. A MediaBox is mandatory for all pages so this property should never be null. Assigning a new value to this property will change the property for the current Page rather than any Pages object from which the value may have been inherited. In this way the property exhibits a copy-on-write behavior. Attempting to assign a null value to this property will result in a NullReferenceException being thrown.

The CropBox for the page. The CropBox defines the visible part of the physical medium on which the page may be displayed or printed. This is what you see as the boundary of the page when you view a document using Acrobat Reader. These boundaries may be defined directly on the Page object or they may be inherited from a parent Pages object. The CropBox is optional and if this property is null it is implicitly assumed to be the same as the MediaBox. Assigning a new value to this property will change the property for the current Page rather than any Pages object from which the value may have been inherited. In this way the property exhibits a copy-on-write behavior. Attempting to assign a null value to this property will result in a NullReferenceException being thrown. If you want to assign an effective value of null to this property you should assign it the value of the MediaBox.

The TrimBox for the page.

The TrimBox defines the intended boundaries of the page after trimming. These boundaries are always defined directly on the Page object. If no property has been defined then this property will be null and the effective value is assumed to be that of the CropBox.

The ArtBox for the page.

The ArtBox defines the extent of meaningful content on this page. These boundaries are always defined directly on the Page object. If no property has been defined then this property will be null and the effective value is assumed to be that of the CropBox.

The BleedBox for the page.

The BleedBox defines the region to which the contents of the page shall be clipped when rendered in a production environment. These boundaries are always defined directly on the Page object. If no property has been defined then this property will be null and the effective value is assumed to be that of the CropBox.

The Thumbnail for the page.

The User Unit set for this page///

Dispose of the Page.

A Pages node within the document.

Test whether the two Pages are the same.

The Pages to test against. Whether the Pages are equal.

The parent of this node.

The number of visible pages under this node.

Performs a fast lookup to identify a particular Page from this node tree.

The page number - a one based index. The specified Page object or null if one could not be found.

Gets all the Page objects under this node. Only immediate children are returned. Any Pages objects are returned as null Page objects.

An array of all the Page objects under this node. Only immediate children are returned. Any Pages objects are returned as null Page objects.

Gets all the Page objects under this node and descendents of this node.

Gets all the Page objects under this node and descendents of this node.

Converts all the visible Page objects from one color space to another.

The destination color space. Whether to convert the color space of annotation appearance streams.

Converts all the visible Page objects from one color space to another.

The destination color space. Whether to convert the color space of annotation appearance streams. All the PixMaps which were recolored as a result of the call.

Interpolation Enumeration.

Automatically decide a good method.

Nearest neighbor interpolation.

Linear interpolation.

Cubic interpolation.

Supersampling interpolation (cannot be used for enlarging).

Interpolation using 3-lobed Lanczos window function.

Rendering Intent Enumeration.

Use a perceptual model for handling out of gamut colors (good for photographs).

Keep color values the same but allow the brightness to vary.

Use a saturation model for handling out of gamut colors (good for diagrams).

Use the closest color at the gamut boundary.

A bitmap based image.

PixMap constructor.

The ObjectSoup to contain the newly created StreamObject.

PixMap static constructor.

The ObjectSoup to contain the newly created PixMap. The XImage from which the PixMap should be created.

PixMap static constructor.

The ObjectSoup to contain the newly created PixMap. The XImage from which the PixMap should be created.

Test whether the two PixMaps are the same.

The PixMap to test against. Whether the PixMaps are equal.

The width of the image in pixels.

In general you will want to call Resize rather than change the value of this property. This is because the width, height, bits per component and number of components need to match up with the image data. Changing this property does not change the underlying data and unless you ensure the data matches up, you will end up with an invalid PixMap that does not display correctly when saved into PDF.

The height of the image in pixels.

In general you will want to call Resize rather than change the value of this property. This is because the width, height, bits per component and number of components need to match up with the image data. Changing this property does not change the underlying data and unless you ensure the data matches up, you will end up with an invalid PixMap that does not display correctly when saved into PDF.

The number of color components for each pixel.

The number of bits per color component.

In general you will want to call Resample rather than change the value of this property. This is because the width, height, bits per component and number of components need to match up with the image data. Changing this property does not change the underlying data and unless you ensure the data matches up, you will end up with an invalid PixMap that does not display correctly when saved into PDF.

The type of color space for this image.

In general you will want to call Recolor rather than change the value of this property. This is because the width, height, bits per component and number of components need to match up with the image data. Changing this property does not change the underlying data and unless you ensure the data matches up, you will end up with an invalid PixMap that does not display correctly when saved into PDF.

The ColorSpace for this image.

Whether corrupt data should automatically be fixed.

Whether this image is a one bit image mask.

Any one bit image mask associated with this image.

Any soft image mask associated with this image.

Any matte associated with this soft mask.

Sets a constant alpha value (0-255) for this image.

A constant alpha value to assign to this image.

Sets a chromakey transparent color for this image.

A chromakey string to assign to this image.

Converts the image to grayscale.

Decompress the data in the stream using on-the-fly resizing. This type of scaling is fast but may change the depth of the image. Only some compression types support on-the-fly resizing.

Converts the image from indexed color to component color.

Converts the image from one color space to another.

The destination color space.

Converts the image from one color space to another.

The destination color space. The rendering intent enumeration.

Gets the content of the object as a Bitmap.

The Bitmap containing the image.

Set the content of the object as a Bitmap.

The Bitmap containing the image. Whether any transparency information should be preserved. If transparency is required the PixMap must be contained within an ObjectSoup. After the Bitmap has been set the PixMap will be uncompressed so you may wish to compress it using a call like CompressJpeg or CompressFlate.

Changes the number of bits per color component.

The number of bits per color component.

Resizes the image.

The destination width for the image. The destination height for the image.

Resizes the image.

The destination width for the image. The destination height for the image. The type of interpolation to be used when resizing the image.

JPEG compresses the image.

The quality of compression to use (0 to 100).

CCITT compresses the image.

JPEG 2000 compresses the image.

The quality of compression to use (0 to 100).

JBIG2 compresses the image.

Rotate the image clockwise.

The number of degrees clockwise that the image should be rotated. This must be a multiple of 90. This function rotates the PixMap image clockwise. The rotation angle must be a multiple of 90. If an invalid number of degrees is specified then an ArgumentOutOfRangeException will be thrown. An image may have an associated bit mask or soft (alpha) mask. If this is the case the associated mask will be transformed as well. When a PixMap is drawn on a page it is scaled to fit into a particular location. The scaling is separate from the PixMap itself. Rotating by 90 or 270 degrees will swap the width and height of the PixMap. Because the scaling of drawn copies is separate from the PixMap itself, any previously drawn instances of the PixMap may appear to have an incorrect aspect ratio. After this method has been called the PixMap will no longer be compressed. You may wish to compress it using the StreamObject.Compress method or similar.

Flip the image horizontally or vertically.

Whether to flip the image horizontally. Whether to flip the image vertically. This function flips the image horizontally or vertically or both. Flipping both horizontally and vertically is equivalent to a 180 degree rotation. An image may have an associated bit mask or soft (alpha) mask. If this is the case the associated mask will be transformed as well. Flipping horizontally will mean that pixels that were on the far right of the image will be moved to the far left and pixels on the left will be moved to the right. Flipping horizontally will mean that pixels that were on the top of the image will be moved to the bottom and pixels that were on the bottom will be moved to the top. After this method has been called the PixMap will no longer be compressed. You may wish to compress it using the StreamObject.Compress method or similar.

Saves the PixMap as a file attempting to preserve resolution, color space and depth as far as the output format allows.

The destination file path.

Saves the PixMap to stream attempting to preserve resolution, color space and depth as far as the output format allows.

The destination output stream. A dummy file name used to determine the type of image required.

CompressionType Enumeration.

Not compressed.

Compressed in an undefined or complex way.

Flate compressed.

LZW compressed.

CCITT compressed.

JPEG compressed.

JPEG 2000 compressed.

ASCII Hex encoded.

ASCII 85 encoded.

Run length compressed.

JBIG2 compressed.

Security handler encrypted.

StreamObjectTypes Enumeration.

No stream object.

All stream objects.

Other stream objects.

PixMap.

Form XObject.

Tiling pattern objects.

Shading objects that are streams.

Function objects that are streams.

A PDF data stream.

StreamObject constructor.

The ObjectSoup to contain the newly created StreamObject.

StreamObject constructor.

The ObjectSoup to contain the newly created StreamObject. A path to a file containing data which should be placed in the StreamObject.

StreamObject constructor.

The ObjectSoup to contain the newly created StreamObject. An array of bytes which should be placed in the StreamObject.

Test whether the two StreamObjects are the same.

The StreamObject to test against. Whether the StreamObjects are equal.

The number of bytes of encoded stream data.

Whether the stream data is compressed or otherwise encoded.

The primary compression type.

All compression types, ordered in terms of the complete decompression sequence required for the stream.

Get the raw binary content of the stream.

The raw binary content of the stream.

Copy the decompressed binary content of the stream into a byte array. This method does not alter the content of the StreamObject so it is an efficient way of getting the decompressed data without altering the document. If the data could not be decompressed then an exception will be raised. The decompressed data is cached so that multiple calls to this function are efficient. For this reason calling this value with a null destination is an efficient way of determining the length of the decompressed stream.

The destination byte array. Default is null. The index in the byte array at which the first byte should be written. Default is 0. The maximum number of bytes that should be written. Default is Int.MaxValue. The length of the decompressed data that has been written to the array. If the destination is null then this returns the length that would have been written if a destination had been provided.

Set the raw binary content of the stream from data held in another StreamObject.

The raw binary content of the stream from data held in another StreamObject.

Set the raw binary content of the stream.

The raw binary content of the stream.

Set the raw binary content of the stream.

Set the raw binary content of the stream from data embedded in a file.

A path to a file containing data which should be placed in the StreamObject.

Get the content of the stream as a string.

The content of the stream as a string.

Set the content of the stream as a string.

The content of the stream as a string.

Compress the data in the stream.

Compress the data in the stream using Flate compression.

Whether the compression was applied.

Compress the data in the stream using Flate compression.

Whether to force the stream to be compressed in this way. Whether the compression was applied.

Compress the data in the stream using ASCII Hex compression.

Whether the compression was applied.

Compress the data in the stream using ASCII Hex compression.

Whether to force the stream to be compressed in this way. Whether the compression was applied.

Compress the data in the stream using ASCII85 (Base85) compression.

Whether the compression was applied.

Compress the data in the stream using ASCII85 (Base85) compression.

Whether to force the stream to be compressed in this way. Whether the compression was applied.

Compress the data in the stream using run length compression.

Whether the compression was applied.

Compress the data in the stream using run length compression.

Whether to force the stream to be compressed in this way. Whether the compression was applied.

Decompress the data in the stream.

Whether the data in the stream is uncompressed.

Clear the data and compression settings for the stream.

Clear the cached, decompressed data for the stream.

A multistyled text object appearing on a page.

Test whether the two TextLayers are the same.

The TextLayer to test against. Whether the TextLayers are equal.

The number of characters appearing on the page.

The number of lines appearing on the page.

Whether the text had to be truncated.

The previous text object in the text chain.

The point defining the end position of the text.

The full text provided in the initial call to AddHtml or AddText. This text is shared between all the items in a chain.

The offset to the first character (in the full text) to be drawn onto this layer.

The offset to the last character (in the full text) to be drawn onto this layer.

The offset to the character (in the full text) which will be drawn at the start of the next item in the chain.

A TextOperation describing the precise layout of this text layer.

The TextFragments describing the precise layout of this text layer.

Removes any cached TextOperation and TextFragments associated with this fragment. This can reduce memory use or it can be used to allow text information to be regenerated after the TextLayer contents have been updated..

A view onto a larger underlying graphic.

Test whether the two ViewLayers are the same.

The ViewLayer to test against. Whether the ViewLayers are equal.

The content width of the image.

The content height of the image.

The scroll width of the image.

The scroll height of the image.

The offset to the top of the current page.

The width of the content on the current page.

The height of the content on the current page.

Whether the image is truncated.

An object encapsulating a PDF document.

Document constructor.

Doc destructor.

Dispose of the Doc.

Dispose of the Doc.

A string representation of the graphic style of the document.

The string representation of the object.

A string representation of the graphic style of the document. This covers the Transform, ColorSpace, Color, Font, TextStyle, Width and Options properties. However it does not cover the Page, Layer, Rect or Pos properties.

The ID of the current page.

The ID of the current font.

The current text size (points).

The current line width (points).

The horizontal positioning factor (0 to 1).

The vertical positioning factor (0 to 1).

The current drawing color.

The current drawing position.

The current drawing rectangle.

The page size.

The visible page size.

The current text style.

The current default transformation.

The current encryption settings.

The current license details.

The ID of the root catalog.

The content insertion position (one is top).

The number of layers in the current page.

Add a page - return the page ID.

The Object ID of the newly added Page Object.

Add a page at a specified location - return the page ID.

The page insertion location. The Object ID of the newly added Page Object.

Add a font resource - return the font ID.

The name of the font typeface. The Object ID of the newly added Font Object.

Add a font resource - return the font ID.

The name of the font typeface. The language type to use. The Object ID of the newly added Font Object.

Add a font resource - return the font ID.

The name of the font typeface The language type to use. Whether the text direction should be vertical. The Object ID of the newly added Font Object.

Add a font resource - return the font ID.

The name of the font typeface. LanguageType enumeration value. The Object ID of the newly added Font Object.

Add a font resource - return the font ID.

The name of the font typeface. LanguageType enumeration value. Whether the text direction should be vertical. The Object ID of the newly added Font Object.

Add a block of text - return the text ID.

The text to be added to the page. The Object ID of the newly added Text Object.

Fit a block of text into the current rectangle - return the text ID.

The text to be added to the page. The Object ID of the newly added Text Object.

Add a block of HTML styled text - return the text ID.

The HTML to be added to the page. The Object ID of the newly added Text Object.

Chain a block of HTML styled text - return the text ID.

A dummy parameter. The contents are not used. The Object ID of a previously added text block. The Object ID of the newly added Text Object.

Fit a block of HTML styled text into the current rectangle - return the text ID.

The HTML to be added to the page. The Object ID of the newly added Text Object.

Add a block of HTML styled text - return the text ID.

The HTML to be added to the page. The Object ID of the newly added Text Object.

Chain a block of HTML styled text - return the text ID.

A dummy parameter. The contents are not used. The Object ID of a previously added text block. The Object ID of the newly added Text Object.

Fit a block of HTML styled text into the current rectangle - return the text ID.

The HTML to be added to the page. The Object ID of the newly added Text Object.

Measure a block of text - return the length in the current measurement units (typically points).

The text to be measured. The length of the text in the current measurement units (typically points).

Measure a block of text - return the length. This method is unit agnostic so you can use whatever units you like and the result will be returned in terms of those units. However typically you would provide point based measurements.

The text to be measured. The size of the font. The spacing to be applied between each character. The spacing to be applied between each word. Whether a synthetic italic style is to be applied. Whether a synthetic bold style is to be applied. The size of any outline to be applied to the font. The length of the text.

Measure a block of text - return the length. This method is unit agnostic so you can use whatever units you like and the result will be returned in terms of those units. However typically you would provide point based measurements.

The text to be measured. The size of the font. The spacing to be applied between each character. The spacing to be applied between each word. Whether a synthetic italic style is to be applied. Whether a synthetic bold style is to be applied. The size of any outline to be applied to the font. The default width for missing characters in 1000ths of an M. The length of the text.

Add a Form or Image XObject into the current rectangle - return the layer ID.

The image to be added to the page. The Object ID of the newly added Layer Object.

Add a Form or Image XObject into the current rectangle - return the layer ID.

The image to be added to the page. The Object ID of the newly added Layer Object.

Add a line - return the line ID.

The horizontal offset of the start point. The horizontal offset of the end point. The vertical offset of the start point. The vertical offset of the end point. The line ending to be placed at the start of the line. The line ending to be placed at the end of the line. The Object ID of the newly added Graphic Object.

Add a line - return the line ID.

The horizontal offset of the start point. The horizontal offset of the end point. The vertical offset of the start point. The vertical offset of the end point. The line ending to be placed at the start of the line. The line ending to be placed at the end of the line. The Object ID of the newly added Graphic Object.

Add a line - return the line ID.

The horizontal offset of the start point. The horizontal offset of the end point. The vertical offset of the start point. The vertical offset of the end point. The line ending to be placed at the start of the line. The line ending to be placed at the end of the line. The scaling to be applied to the line ending at the start of the line. The scaling to be applied to the line ending at the end of the line. The Object ID of the newly added Graphic Object.

Add an image - return the image ID.

An XImage containing the image to be added to the page. The ID of the newly added Image Object.

Add an image - return the image ID.

An existing image object ID to be copied to the page again. The ID of the newly added Image Object.

Add an image - return the image ID.

The raw JPEG data to be added to the page. The ID of the newly added Image Object.

Add an image - return the image ID.

The raw JPEG data to be added to the page. The page of the document to be added. The ID of the newly added Image Object.

Add an image - return the image ID.

A file path, URL or html string to be added to the page. The ID of the newly added Image Object.

Add an image - return the image ID.

A file path, URL or html string to be added to the page. The page of the document to be added. The ID of the newly added Image Object.

Add an image - return the image ID.

A .NET Bitmap to be added to the page. The ID of the newly added Image Object.

Add an image - return the image ID.

A PDF document page to be added to the page. The page of the document to be added. The source area of the document page to be added. The ID of the newly added Image Object.

Add an image - return the image ID.

A PDF document page to be added to the page. The page of the document to be added. The ID of the newly added Image Object.

Add a Bitmap to the current page - return the image ID.

A .NET Bitmap to be added to the page. Whether transparency information should be preserved. The ID of the newly added Image Object.

Add a copy of an existing image to the current page - return the image ID.

An existing image object ID to be copied to the page again. The ID of the newly added Image Object.

Extract the first image from a chunk of data and add it to the current page - return the image ID.

The data containing the image in a format such as JPEG or TIFF. The ID of the newly added Image Object.

Extract an image from a chunk of data and add it to the current page - return the image ID.

The data containing the image in a format such as JPEG or TIFF. Some image types support multiple frames or pages. This is the one based index specifying the required frame (default one). The ID of the newly added Image Object.

Draw a page from one PDF document onto the current page of this document - return the image ID.

The document to be used as the source. The page you want drawn. Use one to indicate the first page. The portion of the page you want drawn. Pass null to specify the entire page. The ID of the newly added Image Object.

Draw a page from one PDF document onto the current page of this document - return the image ID. Optionally copy annotations and fields where possible.

The document to be used as the source. The page you want drawn. Use one to indicate the first page. The portion of the page you want drawn. Pass null to specify the entire page. Whether to copy fields and annotations. The ID of the newly added Image Object.

Draw a page from one PDF document onto the current page of this document - return the image ID. Optionally copy annotations and fields where possible.

The document to be used as the source. The page you want drawn. Use one to indicate the first page. The portion of the page you want drawn. Pass null to specify the entire page. Whether to copy fields and annotations. The level of alpha to apply to the drawn page from transparent through to fully opaque (0 to 255). The ID of the newly added Image Object.

Extract the first image from a file and add it to the current page - return the image ID.

A file path, URL or html string to be added to the page. The Object ID of the newly added Image Object.

Extract an image from a file and add it to the current page - return the image ID.

A file path, URL or html string to be added to the page. Some image types support multiple frames or pages. This is the one based index specifying the required frame (default one). The Object ID of the newly added Image Object.

Adds an image to the current page - return the image ID.

An XImage containing the image to be added to the page. The ID of the newly added Image.

Adds an image to the current page - return the image ID.

An XImage containing the image to be added to the page. Whether transparency information should be preserved. The ID of the newly added Image.

Add a new page from a paged HTML or PostScript render - return the image ID.

The ID of the previous object in the chain. The ID of the newly added object.

Renders a web page specified by URL - return the image ID.

The HTML to be rendered. The ID of the newly added object.

Renders a web page specified as HTML - return the image ID.

The HTML to be rendered. Allows you to override the default XHtmlOptions.Paged property. Allows you to override the default XHtmlOptions.BrowserWidth property. Allows you to override and disable the page cache. The ID of the newly added object.

Renders a web page specified by URL - return the image ID.

The URL for the page to be rendered. The ID of the newly added object.

Renders a web page specified by URL - return the image ID.

The URL for the page to be rendered. Allows you to override the default XHtmlOptions.Paged property. Allows you to override the default XHtmlOptions.BrowserWidth property. Allows you to override and disable the page cache. The ID of the newly added object.

Get a particular type of information about an object.

The Object ID of the object to be queried. The type of information to be retrieved. The returned information.

Get numeric information about an object.

The Object ID of the object to be queried. The type of information to be retrieved. The returned integer.

Get numeric information about an object.

The Object ID of the object to be queried. The type of information to be retrieved. The returned integer.

Get numeric information about an object.

The Object ID of the object to be queried. The type of information to be retrieved. The returned value.

Get date and time information about an object.

The Object ID of the object to be queried. The type of information to be retrieved. The returned value.

Get date and time information about an object.

The Object ID of the object to be queried. The type of information to be retrieved. The returned value will be in local time if the date includes time zone information, otherwise it will be in UTC. The returned value.

Add a framed rectangle - return the line ID.

The Object ID of the newly added Graphic Object.

Add a framed rounded rectangle - return the line ID.

The horizontal radius to use for rounded corners. The vertical radius to use for rounded corners. The Object ID of the newly added Graphic Object.

Add a framed rounded rectangle - return the line ID.

The horizontal radius to use for rounded corners. The vertical radius to use for rounded corners. Whether to draw the frame inside the rectangle. The Object ID of the newly added Graphic Object.

Add a framed rounded rectangle - return the line ID.

Whether to draw the frame inside the rectangle. The Object ID of the newly added Graphic Object.

Add a filled rectangle - return the line ID.

The Object ID of the newly added Graphic Object.

Add a filled rounded rectangle - return the line ID.

The horizontal radius to use for rounded corners. The vertical radius to use for rounded corners. The Object ID of the newly added Graphic Object.

Delete a specified object.

The Object ID of the object to be deleted.

Save the PDF as a file.

The destination file path.

Write the PDF to a stream.

The destination stream.

Get the PDF as raw data.

The PDF document as an array of bytes.

Get the PDF as raw data stream.

The PDF document as a stream.

Read an existing document from file.

The file path to the PDF, OpenOffice.org, SVG, or XPS document.

Read an existing document from file.

The file path to the PDF, OpenOffice.org, SVG, or XPS document. Any password needed to open the document.

Read an existing document from file.

The file path to the PDF, OpenOffice.org, SVG, or XPS document. The settings for the read.

Read an existing PDF from data.

The source PDF data.

Read an existing PDF from data.

The source PDF data. Any password needed to open the document.

Read an existing PDF from data.

The source PDF data. The settings for the read.

Read an existing PDF from stream.

The source PDF or document stream.

Read an existing PDF from stream.

The source PDF or document stream. Any password needed to open the document.

Read an existing PDF from stream.

The source PDF or document stream. The settings for the read.

Embed a font resource - return the font ID.

The name of the font typeface. The Object ID of the newly embedded Font Object.

Embed a font resource - return the font ID.

The name of the font typeface. The language type to use. The Object ID of the newly embedded Font Object.

Embed a font resource - return the font ID.

The name of the font typeface. The language type to use. Whether the text direction should be vertical. The Object ID of the newly embedded Font Object.

Embed a font resource - return the font ID.

The name of the font typeface. The language type to use. Whether the text direction should be vertical. Whether to subset the font. The Object ID of the newly embedded Font Object.

Embed a font resource - return the font ID.

The name of the font typeface. The language type to use. Whether the text direction should be vertical. Whether to subset the font. Whether to override permissions on the font. The Object ID of the newly embedded Font Object.

Embed a font resource - return the font ID.

The name of the font typeface. LanguageType enumeration value. The Object ID of the newly embedded Font Object.

Embed a font resource - return the font ID.

The name of the font typeface. LanguageType enumeration value. Whether the text direction should be vertical. The Object ID of the newly embedded Font Object.

Embed a font resource - return the font ID.

The name of the font typeface. LanguageType enumeration value. Whether the text direction should be vertical. Whether to subset the font. The Object ID of the newly embedded Font Object.

Embed a font resource - return the font ID.

The name of the font typeface. LanguageType enumeration value. Whether the text direction should be vertical. Whether to subset the font. Whether to override permissions on the font. The Object ID of the newly embedded Font Object.

Alters an aspect of an existing object.

The Object ID of the object to be modified. The type of value to insert. The string value to insert.

Alters an aspect of an existing object.

The Object ID of the object to be modified. The type of value to insert. The integer value to insert.

Alters an aspect of an existing object.

The Object ID of the object to be modified. The type of value to insert. The long value to insert.

Alters an aspect of an existing object.

The Object ID of the object to be modified. The type of value to insert. The double value to insert.

Alters an aspect of an existing object.

The Object ID of the object to be modified. The type of value to insert. The DateTime value to insert.

Alters an aspect of an existing object.

The Object ID of the object to be modified. The type of value to insert. The boolean value to insert.

Adds a bookmark for the current page.

The path to the bookmark. Whether the bookmark should be displayed open (expanded) or closed (collapsed). The Object ID of the newly added Bookmark Object.

Adds a native PDF object to the document.

The raw native object to be added. The Object ID of the newly added Object.

Flattens and compresses the current page.

n/a.

Clears the document freeing up resources.

Clears the cached, decompressed data for stream objects.

Clears the cached, decompressed data for stream objects.

The types of stream objects whose cached, decompressed data are discarded. The default value is All.

Adds an alignment grid to help position objects.

The Object ID of the newly added Grid Object.

The page number (one is the first page).

The number of pages in the document.

Appends a PDF document to the end of the current document.

The document to add to the end of this one.

Add an arc - return the line ID.

The start angle of the arc in degrees. The end angle of the arc in degrees. The horizontal center of the arc. The vertical center of the arc. The horizontal radius of the arc. The vertical radius of the arc. The Object ID of the newly added Graphic Object

Add an arc - return the arc ID.

The start angle of the arc in degrees. The end angle of the arc in degrees. The horizontal center of the arc. The vertical center of the arc. The horizontal radius of the arc. The vertical radius of the arc. Whether to fill the arc rather than simply drawing it. The Object ID of the newly added Graphic Object

The current line options.

The current measurement units.

Whether to measure from the top of the page.

The ID of the current color space.

Add an ICC based color space - return the ID.

The path to the ICC color space file. The Object ID of the newly added ColorSpace Object.

Add a separation color space - return the ID.

The name of the color. The display representation of the color. This should be supplied in the same format as the XColor.String uses. The Object ID of the newly added ColorSpace Object.

Add an oval - return the line ID.

Whether to fill the oval rather than simply outline it. The Object ID of the newly added Graphic Object.

Add a pie slice - return the line ID.

The start angle of the pie slice in degrees. The end angle of the pie slice in degrees. Whether to fill the pie slice rather than simply outline it. The Object ID of the newly added Graphic Object.

Add a polygon - return the line ID.

The coordinates of the vertices of the polygon. Whether to fill the polygon rather than simply outline it. The Object ID of the newly added Graphic Object.

Add a polygon - return the line ID.

The coordinates of the vertices of the polygon. Whether to fill the polygon rather than simply outline it. The Object ID of the newly added Graphic Object.

Add a polygon - return the line ID.

The coordinates of the vertices of the polygon. The index of the first coordinate into the array points. The number of coordinates in the array points to use. Whether to fill the polygon rather than simply outline it. The Object ID of the newly added Graphic Object.

Add a rectangle - return the line ID. Note that this is subtly different from the way that FrameRect works. When a rectangle is framed the line goes around the ouside of the rectangle. When a rectangle is added the line is centered on the rectangle - so half is inside and half is outside.

Whether to fill the rectangle rather than simply outline it. The Object ID of the newly added Graphic Object.

Determine if an object is chainable.

The Object ID of the object to be tested. Whether the object is chainable or not.

Extract content from the current page in a specified format. Prefer the overload accepting a Page.TextType enumeration.

Extract content from the current page in a specified format.

The format in which to return the content. The returned content.

Remap pages for reordering, copying and deletion.

The list of page numbers.

Remap pages for reordering, copying and deletion.

The list of page numbers.

Remap pages for reordering, copying and deletion.

The list of page numbers. The index of the first page number into the array pages. The number of page numbers in the array pages to use.

The PDF Indirect Object Collection.

The HTML and URL rendering options and control.

The save options and control.

The PDF rendering options and control.

The document form and fields.

The top level bookmark for the document.

XColor Class.

Create an XColor from an array of NumAtoms containing PDF color values. PDF color values typically range between 0 and 1, representing zero and 100% intensity respectively. If the array indexes selected are invalid or do not contain NumAtoms then an exception will be raised.

The toms containing the parameters for the color operator. The PDF color operator. The newly created XColor object.

Create an XColor from an ArrayAtom of NumAtoms containing PDF color values. PDF color values typically range between 0 and 1, representing zero and 100% intensity respectively. If the array is null or the array indexes selected are invalid or do not contain NumAtoms then an exception will be raised.

The ArrayAtom containing the components of the color. The newly created XColor object.

Create an XColor from a grayscale value.

The amount of black (0 to 255) The newly created XColor object.

Create an XColor from a set of RGB component values.

The amount of red (0 to 255) The amount of green (0 to 255) The amount of blue (0 to 255) The newly created XColor object.

Create an XColor from a set of CMYK component values.

Set the color to an opaque CMYK value.

The amount of cyan (0 to 100) The amount of magenta (0 to 100) The amount of yellow (0 to 100) The amount of black (0 to 100) The newly created XColor object.

Create an XColor from a set of ColorSpace PDF components.

The intensity of the first component (typically 0 to 1)

Create an XColor from a set of ColorSpace PDF components.

The intensity of the first component (typically 0 to 1) The intensity of the second component (typically 0 to 1)

Create an XColor from a set of ColorSpace PDF components.

The intensity of the first component (typically 0 to 1) The intensity of the second component (typically 0 to 1) The intensity of the third component (typically 0 to 1)

Create an XColor from a set of ColorSpace PDF components.

The intensity of the first component (typically 0 to 1) The intensity of the second component (typically 0 to 1) The intensity of the third component (typically 0 to 1) The intensity of the fourth component (typically 0 to 1)

XColor constructor.

Creates a deep copy of the current XColor.

XColor destructor.

Dispose of the XColor.

Dispose of the XColor.

A string representation of the color.

The string representation of the object.

An ArrayAtom representation of the components of the color.

An ArrayAtom containing the components of the color.

A string representation of the color.

The red intensity of the color (0 to 255).

The green intensity of the color (0 to 255).

The blue intensity of the color (0 to 255).

The gray intensity of the color (0 to 255).

The cyan intensity of the color (0 to 100).

The magenta intensity of the color (0 to 100).

The yellow intensity of the color (0 to 100).

The black intensity of the color (0 to 100).

The alpha opacity of the color (0 to 255).

The components of the color in native PDF format.

The native color space for the set color operator.

Any name that may be associated with this color. Most commonly this is used for pattern names.

The color as a System.Drawing.Color.

Set the color.

The source color.

Set the color to an opaque grayscale value.

The amount of black (0 to 255)

Set the color to a transparent grayscale value.

The amount of black (0 to 255) The level of opacity from transparent through to fully opaque (0 to 255)

Set the color to an opaque RGB value.

The amount of red (0 to 255) The amount of green (0 to 255) The amount of blue (0 to 255)

Set the color to a transparent RGB value.

The amount of red (0 to 255) The amount of green (0 to 255) The amount of blue (0 to 255) The level of opacity from transparent through to fully opaque (0 to 255)

Set the color to an opaque CMYK value.

The amount of cyan (0 to 100) The amount of magenta (0 to 100) The amount of yellow (0 to 100) The amount of black (0 to 100)

Set the color to a transparent CMYK value.

The amount of cyan (0 to 100) The amount of magenta (0 to 100) The amount of yellow (0 to 100) The amount of black (0 to 100) The level of opacity from transparent through to fully opaque (0 to 255)

Set the color to a set of ColorSpace PDF components.

The intensity of the first component (typically 0 to 1)

Set the color to a set of ColorSpace PDF components.

The intensity of the first component (typically 0 to 1) The intensity of the second component (typically 0 to 1)

Set the color to a set of ColorSpace PDF components.

The intensity of the first component (typically 0 to 1) The intensity of the second component (typically 0 to 1) The intensity of the third component (typically 0 to 1)

Set the color to a set of ColorSpace PDF components.

The intensity of the first component (typically 0 to 1) The intensity of the second component (typically 0 to 1) The intensity of the third component (typically 0 to 1) The intensity of the fourth component (typically 0 to 1)

Set the color to a random opaque value in the current color space.

Test whether the two colors are the same.

The XColor to test against. Whether the XColors are equal.

Test whether the two colors are the same.

The object to test against. Whether the objects are equal.

A hash code for the XColor.

The returned hash code.

Compares this instance of an XColor to another and returns an indication of their relative values.

A System.Object that evaluates to an XColor. A signed number indicating the relative value of this instance.

XEncryption class.

XEncryption destructor.

Dispose of the XEncryption.

Dispose of the XEncryption.

The level of encryption to use.

The crypt method for strings.

The crypt method for streams.

Sets the crypt methods.

The crypt method for strings and streams.

Sets the crypt methods.

The crypt method for strings. The crypt method for streams.

The user password.

The owner password.

Whether to encrypt the document metadata.

Whether a user can print the document.

Whether a user can modify the document.

Whether a user can copy from the document.

Whether a user can edit the document.

Whether a user can fill forms in the document.

Whether a user can extract detail from the document.

Whether a user can assemble the document.

Whether a user can print a high resolution copy of the document.

A string representation of the encryption state.

The string representation of the object.

A string representation of the encryption state. This covers all the properties of this object.

XForm Class.

All top level fields in the form.

Whether values should be formatted before insertion into fields.

The format provider for formatting dates and times.

Whether field appearances should be pre-generated.

Whether the viewer should automatically regenerate field appearances.

Whether the viewer should run JavaScript field calculations.

The full names of all the fields in the document.

The full names of all the fields in the document.

Returns a particular field referenced by full name.

Stamp all fields into the document.

Refresh and reload the document fields.

Make fields unique across pages, duplicating fields if necessary.

Make fields unique across pages, duplicating fields if necessary.

The token to append to existing field names.

Add a particular type of resource to the form.

The resource to be added. The type of resource. The format of the name that should be used. The actual name that was used.

XHtmlOptions Class.

An object that provides access to only the HTML options supported by the MSHTML engine.

An object that provides access to only the HTML options supported by the Gecko HTML engine.

An object that provides access to only the HTML options supported by the ABCChrome engine.

A helper filter to give only the HtmlOptions supported by the MSHTML engine.

A helper filter to give only the HtmlOptions supported by the Gecko engine.

The width of the virtual browser in pixels.

A user name to be used for authentication.

A password to be used for authentication.

Whether hyperlinks should be live.

Whether form fields should be live.

Whether movies and other active content should be live.

Whether the location of certain tags should be noted.

Whether hyperlinks with targets should be allowed to open in a new browser window.

Whether the values of form elements, except radio buttons, with the same name are distinct.

Whether font substitution should be used to reduce file size.

Whether fonts should be embedded rather than referenced.

Whether embedded fonts should be subset.

Whether fonts with restricted licensing should be protected from embedding.

The quality of compression acceptable for continuous tone images such as JPEGs.

The maximum amount of time allowed for obtaining a page (ms).

The minimum number of content items required for a page to be valid.

The number of times a page should be retried if unavailable or invalid.

Whether content should be rendered in multipaged format.

Whether to hide the background color of a page.

Additional HTTP headers to send in the request.

The user-agent string.

A script to be run after the page is loaded.

The request method for URL.

Whether to disable automatic cookies.

Whether to reload page.

The rendering engine to use for HTML conversion.

The CSS media to use.

The conditions under which to coerce a vector output.

The conditions under which to disable vector-output coercion.

Whether to host a WebBrowser control.

Whether to deactivate the WebBrowser.

The method for loading URI/HTML.

The module for obtaining URI/HTML data.

Whether to enable JavaScript and VBScript.

Whether to enable ActiveX.

Whether to enable Java.

Whether to enable Video.

Whether to resynchronize page.

Whether any proxy servers should re-request items of content.

Whether to use theme.

Whether not to use theme.

Whether the page cache should be searched first.

The length of time that pages can be held in the cache (ms).

The number of pages that can be held in the cache.

The maximum size at which an image may be regarded as atomic.

Whether HTML pages are marked up before conversion to PDF.

Whether HTML layout is checked and adjusted for optimal output to PDF.

Whether to automatically clip redundant content at the end of the page.

Whether to improve the support for page-break-inside of avoid.

Whether to improve the support for page break in table to prevent missing rows.

Whether to disable the default background color.

Whether to disable the snap rounding of coordinates and lengths.

The minimum width to be used for auto-sized pages.

The percentage of the current drawing area in which HTML breaks can occur.

The page break logic for HTML.

Greatest interval we should wait for paint calls before rendering the page. Measured in ms.

The maximum amount of time to wait for repaints when using RepaintDelay (ms).

Ignore certificate-related errors. Defaults to true.

The FireShield settings that dynamically determine the file access that should be allowed for HTML conversion.

The options for new worker processes.

The delegate called during HTML rendering.

The delegate called when embedding an object during HTML rendering.

Sets whether to use theme or not.

Whether to use theme or not.

Sets whether to use theme or not.

Whether to use theme. Whether not to use theme.

Clear all items from the page cache.

Clear all expired items from the page cache.

Convert external links to internal links wherever possible.

Convert external links to internal links.

Specifies both linkIDs and destIDs. The number of links converted.

Convert external links to internal links.

The list of IDs of view objects containing links (anchor tags with href attributes). The list of IDs of view objects containing destinations (anchor tags with name attributes). Whether links pointing to the URLs of HTML pages (URLs without fragments) are converted to internal links. The number of links converted.

Gets an array of the HTML IDs of tagged visible items.

The Object ID of the object. The IDs of tagged visible HTML objects.

Gets an array of the locations of tagged visible items.

The Object ID of the object. The location of tagged visible HTML objects.

Gets an array of the locations of tagged visible items before Doc.Transform is applied.

The Object ID of the object. The location (before Doc.Transform is applied) of tagged visible HTML objects.

Retrieves the HTTP status code.

The Object ID of the web page to be accessed. The HTTP status code or zero if not available.

Retrieves the client side onload script return value.

The Object ID of the web page to be accessed. The return value.

Ends any HTML Engine worker threads or processes.

The way in which to select threads or processes that should be ended. The number of selected threads or processes.

A helper filter to give only the HtmlOptions supported by Gecko HTML engine.

Whether hyperlinks should be live.

Whether movies and other active content should be live.

Whether form fields should be live.

Whether the location of certain tags should be noted.

Whether the values of form elements, except radio buttons, with the same name are distinct.

Whether font substitution should be used to reduce file size.

Whether fonts should be embedded rather than referenced.

Whether embedded fonts should be subset.

Whether fonts with restricted licensing should be protected from embedding.

The quality of compression acceptable for continuous tone images such as JPEGs.

The maximum amount of time allowed for obtaining a page (ms).

A user name to be used for authentication.

A password to be used for authentication.

The minimum width to be used for auto-sized pages.

The number of times a page should be retried if unavailable or invalid.

A script to be run after the page is loaded.

The request method for URL.

Whether to enable JavaScript and VBScript.

The CSS media to use.

Gets an array of the HTML IDs of tagged visible items.

The Object ID of the object. The IDs of tagged visible HTML objects.

Gets an array of the locations of tagged visible items.

The Object ID of the object. The location of tagged visible HTML objects.

A helper filter to give only the HtmlOptions supported by Internet Explorer HTML engine.

The width of the virtual browser in pixels.

A user name to be used for authentication.

A password to be used for authentication.

Whether hyperlinks should be live.

Whether form fields should be live.

Whether movies and other active content should be live.

Whether the location of certain tags should be noted.

Whether hyperlinks with targets should be allowed to open in a new browser window.

Whether the values of form elements, except radio buttons, with the same name are distinct.

Whether font substitution should be used to reduce file size.

Whether fonts should be embedded rather than referenced.

Whether embedded fonts should be subset.

Whether fonts with restricted licensing should be protected from embedding.

The quality of compression acceptable for continuous tone images such as JPEGs.

The maximum amount of time allowed for obtaining a page (ms).

The minimum number of content items required for a page to be valid.

The number of times a page should be retried if unavailable or invalid.

Whether content should be rendered in multipaged format.

Whether to hide the background color of a page.

Additional HTTP headers to send in the request.

A script to be run after the page is loaded.

The request method for URL.

Whether to disable automatic cookies.

The conditions under which to coerce a vector output.

The conditions under which to disable vector-output coercion.

Whether to host a WebBrowser control.

Whether to deactivate the WebBrowser.

Whether to enable JavaScript and VBScript.

Whether to enable ActiveX.

Whether to enable Java.

Whether to enable Video.

Whether to resynchronize page.

Whether any proxy servers should re-request items of content.

Whether the page cache should be searched first.

The length of time that pages can be held in the cache (ms).

The number of pages that can be held in the cache.

The maximum size at which an image may be regarded as atomic.

Whether HTML pages are marked up before conversion to PDF.

Whether to automatically clip redundant content at the end of the page.

The minimum width to be used for auto-sized pages.

The percentage of the current drawing area in which HTML breaks can occur.

The page break logic for HTML.

The delegate called during HTML rendering.

The delegate called when embedding an object during HTML rendering.

Clear all items from the page cache.

Clear all expired items from the page cache.

Convert external links to internal links wherever possible.

Convert external links to internal links.

Specifies both linkIDs and destIDs. The number of links converted.

Convert external links to internal links.

The list of IDs of view objects containing links (anchor tags with href attributes). The list of IDs of view objects containing destinations (anchor tags with name attributes). Whether links pointing to the URLs of HTML pages (URLs without fragments) are converted to internal links. The default value is false. The number of links converted.

Gets an array of the HTML IDs of tagged visible items.

The Object ID of the object. The IDs of tagged visible HTML objects.

Gets an array of the locations of tagged visible items.

The Object ID of the object. The location of tagged visible HTML objects.

Gets an array of the locations of tagged visible items before Doc.Transform is applied.

The Object ID of the object. The location (before Doc.Transform is applied) of tagged visible HTML objects.

Retrieves the HTTP status code.

The Object ID of the web page to be accessed. The HTTP status code or zero if not available.

Retrieves the client side onload script return value.

The Object ID of the web page to be accessed. The return value.

Image class.

Image constructor.

XPoint destructor.

Dispose of the XImage.

Dispose of the XImage.

The XReadOptions used to create the object. The Stream used to create the object if NeedsStream is true.

Dispose of the XImage.

Load an image from a file.

The path to the graphic file. The settings for the read. The resulting IndirectObject.

Load an image from data.

The data containing the graphic. The settings for the read. The resulting IndirectObject.

Load an image from a stream.

The stream containing the graphic. The settings for the read. The resulting IndirectObject.

Load an image from a file.

The path to the graphic file.

Load an image from data.

The data containing the graphic.

Load an image from a stream.

The stream containing the graphic.

Assign a soft mask to the image.

The image containing the soft mask. Whether to invert the mask.

The type of image.

The number of frames in the image.

The default frame rate for a moving image.

The currently selected frame.

The width of the current frame (pixels).

The height of the current frame (pixels).

Whether the image specifies the resolution.

The horizontal resolution of the current frame (DPI).

The vertical resolution of the current frame (DPI).

The orientation of the current frame.

The applied orientation of the current frame.

The current selection rectangle.

The physical bounds of the image in points.

Whether the image can be added indirect.

Whether the file needs to exist.

Whether the stream needs be kept open.

Clears the image freeing up resources.

Clears the image freeing up resources.

The XReadOptions used to create the object. The Stream used to create the object if NeedsStream is true.

XPoint class.

XPoint constructor.

XPoint constructor.

A string defining the initial point in the format "x y".

XPoint constructor.

Creates a deep copy of the current XPoint.

XPoint destructor.

Dispose of the XPoint.

Dispose of the XPoint.

A string representation of the point.

The string representation of the object.

A string representation of the point.

The horizontal offset of the point from the bottom left.

The vertical offset of the point from the bottom left.

The point as a System.Drawing Point.

Set the point.

The source point.

Test whether two points are the same.

The XPoint to test against. Whether the two XPoints are equal.

Test whether the two points are the same.

The object to test against. Whether the objects are equal.

Determines if two points are effectively the same.

The point to be compared against this one. The largest difference in coordinates which will still be defined as equal.

A hash code for the XPoint.

The returned hash code.

Compares this instance of an XPoint to another and returns an indication of their relative values.

A System.Object that evaluates to an XPoint. A signed number indicating the relative value of this instance.

Copies a series of X and Y coordinates from an array of XPoints to an array of doubles. The array of doubles is represented as a series of pairs of X and Y coordinates. So the double array should be twice the length of the XPoint array.

An array of XPoints to be copied from. An array of doubles to be copied to. The number of points in the source array to copy.

Copies a series of X and Y coordinates from an array of XPoints to an array of doubles. The array of doubles is represented as a series of pairs of X and Y coordinates. So the double array should be twice the length of the XPoint array. Any null XPoint entries in the array will be assumed to be 0,0.

An array of XPoints to be copied from. The index in the source array at which copying begins. An array of doubles to be copied to. The index in the destination array at which copying begins. The number of points in the source array to copy.

Copies a series of X and Y coordinates from an array of doubles to an array of XPoints. The array of doubles is represented as a series of pairs of X and Y coordinates. So the double array should be twice the length of the XPoint array.

An array of doubles to be copied from. An array of XPoints to be copied to. The number of points (ie pairs of doubles) in the source array to copy.

Copies a series of X and Y coordinates from an array of doubles to an array of XPoints. The array of doubles is represented as a series of pairs of X and Y coordinates. So the double array should be twice the length of the XPoint array. Each XPoint in the destination array will be newly created from the source array values.

An array of doubles to be copied from. The index in the source array at which copying begins. An array of XPoints to be copied to. The index in the destination array at which copying begins. The number of points (ie pairs of doubles) in the source array to copy.

XRect class.

Corner Enumeration.

Bottom Left Corner.

Top Left Corner.

Bottom Right Corner.

Top Right Corner.

Create an XRect from the coordinates of two diagonally opposite corners.

The minimum x coordinate. The minimum y coordinate. The maximum x coordinate. The maximum y coordinate. The newly created XRect object.

Create an XRect from a bottom left corner, a width and a height.

The left coordinate. The bottom coordinate. The width of the rectangle. The height of the rectangle. The newly created XRect object.

Create an XRect from a top left corner, a width and a height.

The left coordinate. The top coordinate. The width of the rectangle. The height of the rectangle. The newly created XRect object.

Create the smallest XRect that encloses all the XPoints supplied. If no points or null is supplied then the return value is null.

An array containing points. The newly created XRect object.

Create an XRect from a standard PDF Rectangle ArrayAtom. Such arrays typically contain four numbers - lower left x and y coordinates followed by upper right x and y. However this is a convention and any two diagonally opposite points are acceptable. If the array is null or the entries do not resolve to four NumAtoms then the return value will be null.

An ArrayAtom containing four NumAtoms. Any IndirectObject from the document. The newly created XRect object.

Create an XRect from a list of four doubles. Such arrays typically contain lower left x and y coordinates followed by upper right x and y. However this is a convention and any two diagonally opposite points are acceptable. If the array is null or does not contain four items then the return will be null.

An IList containing four doubles. The newly created XRect object.

Create an XRect from an array of four doubles. Such arrays typically contain lower left x and y coordinates followed by upper right x and y. However this is a convention and any two diagonally opposite points are acceptable. If the array is null or does not contain four items then the return will be null.

An array containing four doubles. The newly created XRect object.

XRect constructor. To construct an XRect with initial values use one of the static constructors such as XRect.FromSides, XRect.FromLbwh or XRect.FromPoints.

XRect constructor using a string initializer.

A string defining the initial rectangle in the format "left bottom right top".

Creates a deep copy of the current XRect.

XRect destructor.

Dispose of the XPoint.

Dispose of the XPoint.

A string representation of the rectangle.

The string representation of the object.

A string representation of the rectangle.

The offset of the top edge from the bottom left.

The offset of the left edge from the bottom left.

The offset of the bottom edge from the bottom left.

The offset of the right edge from the bottom left.

The width of the rectangle.

The height of the rectangle.

Translate the rectangle up and right.

The horizontal distance to move the rectangle. The vertical distance to move the rectangle.

Scale the rectangle, pinning the bottom left corner.

The horizontal scale factor. The vertical scale factor.

Move the rectangle, preserving width and height.

The new left position. The new bottom position.

Move the specified corner of the rectangle to a position, preserving width and height.

The new left position. The new bottom position. The corner to position.

Inset the rectangle horizontally and vertically.

The amount to inset the left and right edges. The amount to inset the top and bottom edges.

Get the four corners of the rectangle from the bottom left going clockwise.

The rectangle as a System.Drawing Rectangle.

The corner of the rectangle to pin.

Resize the rectangle preserving position.

The new width. The new height.

Resize the rectangle preserving the position of the specified corner.

The new width. The new height. The corner to pin.

Set the position and size of the rectangle.

The new left position. The new bottom position. The new width. The new height.

Set the position and size of the rectangle.

The source rectangle.

Set the sides of the rectangle.

The new left position. The new bottom position. The new right position. The new top position.

Intersect this rectangle with another rectangle.

The other rectangle to intersect with.

Determine if this rectangle intersects with another.

Union the rectangle with another rectangle. This rectangle becomes the smallest rectangle that encloses both rectangles. Rectangles with no area are ignored.

The rectangle to add to this one. The supplied rectangle is left unchanged by this function.

Union the rectangle with another rectangle. This rectangle becomes the smallest rectangle that encloses both rectangles.

The rectangle to add to this one. The supplied rectangle is left unchanged by this function. Whether rectangles with no area should be ignored.

Determine if the rectangle encloses any area.

Determine if the rectangle contains a point.

Determine if the rectangle contains a point.

Determine if the rectangle contains a point.

Determine if the rectangle contains a point.

Determine if the rectangle contains a point.

Determine if this rectangle fully contains another rectangle.

Test whether two rects are the same.

The XRect to test against. Whether the two XRects are equal.

Test whether the two rects are the same.

The object to test against. Whether the objects are equal.

Determines if two rects are effectively the same.

The rect to be compared against this one. The largest difference in coordinates which will still be defined as equal.

A hash code for the XRect.

The returned hash code.

Compares this instance of an XRect to another and returns an indication of their relative values.

A System.Object that evaluates to an XRect. A signed number indicating the relative value of this instance.

Fit the rectangle as content inside another rectangle.

XRendering Class.

Rendering Compression Enumeration.

Uncompressed

G3 Black and White Fax Compression

G4 Black and White Fax Compression

LZW Compression

JPEG Compression

Adobe Flate Compression

Flate Compression

Macintosh PackBits

Rendering Colorspace Enumeration.

Red, green and blue

Grayscale

Cyan, magenta, yellow and black

Lab - a device independent color space

Indexed RGB - see the PaletteSize property

The output resolution in dots per inch.

The horizontal output resolution in dots per inch.

The vertical output resolution in dots per inch.

The output colorspace.

The output bits per color channel.

The number of colors in the palette for indexed color output.

Whether to anti-alias text.

Whether to anti-alias polygons.

Whether to anti-alias images.

Whether to apply entire scene anti-aliasing.

Whether to save the alpha channel.

Whether to resize images for vector (emf, ps, etc.) output.

The output file quality factor for lossy compression (0 to 100).

The type of compression to prefer when saving.

The minimum stroked line width for output.

The minimum stroked line width for output.

Whether to append to (rather than overwrite) existing image files.

The path to the default Gray ICC color profile.

The path to the default RGB ICC color profile.

The path to the default CMYK ICC color profile.

The path to the default CMYK ICC color profile.

Whether to apply overprint.

Whether to render fields and annotations.

The named separation.

Halftone type and options.

Whether to use embedded halftones.

Whether pages should be automatically rotated.

Number of strips to generate when writing a tiff file.

The log for the last render.

A collection of TIFF tags that should be written to the output file.

The palette used when reducing colors.

When reducing colors, there are different ways to choose such colors. This property controls how colors are chosen. We provide the following options: Adaptive. This palette uses fewer colors than specified if the image has limited colors. It uses an optimized Octree algorithm for fast, high quality color reduction.WebSafe. This palette uses a fixed number of colors. is ignored.Windows. This palette uses a fixed number of colors. is ignored.Macintosh. This palette uses a fixed number of colors. is ignored.Uniform. This palette specified a set of uniformly distributed colors. It only exists for 8, 27, 64, 125 and 216 colors and so the number you specify with may be reduced to accommodate this.Grayscale. This palette uses the exact number of gray values specified in - minimum two.Black&White. This palette always uses two colors - black and white.Exact. This is similar to Adaptive except it is optimized to ensure an exact color match wherever possible.When using Exact or Adaptive, you can append colors separated by colons or semicolons. These colors are fixed colors, which will always by added to the palette. See the example below.

Whether JPEG output should use progressive compression.

Renders and saves the current area of the current page as data.

A dummy file name used to determine the type of image required. The image as an array of bytes.

Renders and saves the current area of the current page to a Bitmap.

The Bitmap containing the image.

Renders and saves the current area of the current page as a file.

The destination file path.

Renders and saves the current area of the current page to a stream.

A dummy file name used to determine the type of image required. The destination stream.

XSaveOptions Class.

Whether to reduce size by remapping objects.

Whether to linearize the output for fast web viewing.

Whether to use incremental update to preserve the validity of signature fields.

Whether to use object stream compression to reduce the size of documents.

Whether to update the file version identifier.

Whether to assign a constant file version identifier.

Whether to assign non-ASCII file identifiers.

The file extension when the target is specified not with a path or a file name.

The path to the template file.

The template data.

The folder where to save additional files (images, fonts, etc).

The XPS output quality for lossy compression (0 to 100).

Specify the type of graphic paths.

Use a sensible default type for the exporter.

Do not embed graphics in the final output.

Render graphics using images, valid for MS Word and HTML exporters.

Render graphics via VML, valid for MS Word exporter.

Render graphics via HTML 5 Canvas, valid for HTML exporter.

Render graphics via HTML 5 Canvas using WebGL, valid for HTML exporter.

How to implement paths, valid values depend on exporter format.

//@HTML and MS Word Exporters only, throw on invalid format

The font substitution type.

Use a sensible default font substituion type.

Always substitute fonts with those installed on the machine.

Only substitute fonts which are missing or could not be converted to open type.

The font substitution type.

//@HTML and MS Word Exporters only

Whether duplicate objects should be detected and factored out.

Whether to preflight objects in the document.

The delegate called to write the page separator for export.

The arguments passed to WritePageSeparator.

The writer. It is an XmlWriter for HTML export.

Writes the default page separator.

The page number, which starts at 1.

The delegate called to write the page separator for export.

//@HTML Exporter only

XSaveTemplateData Class.

The template that specifies one page per frame.

XSaveTemplateData constructor.

The horizontal measurement resolution.

The vertical measurement resolution.

The smoothing for displaying images.

The JPEG quality level.

Whether JPEG images are re-encoded in JPEG.

Sets the measurement resolutions.

The new measurement resolution in DPI.

Sets the measurement resolutions.

The new horizontal measurement resolution in DPI. The new vertical measurement resolution in DPI.

XTextStyle class.

KerningType Enumeration.

No kerning.

Uses the default kerning.

DirectionType Enumeration.

No preferred reading direction.

Prefer left to right reading direction (eg English).

Prefer right to left reading directiong (eg Hebrew).

XTextStyle constructor.

XTextStyle destructor.

Dispose of the XTextStyle.

Dispose of the XTextStyle.

A string representation of the style.

The string representation of the object.

A string representation of the style.

The text size (points).

The first line of paragraph indent (points).

The inter-character spacing (points).

The inter-word spacing (points).

The inter-line spacing (points).

The inter-paragraph spacing (points).

The distance between the line spacing below the top of the text frame and the first baseline (1000ths of em).

The horizontal justification factor (0 to 1).

Whether to apply an underline.

Whether to apply a strikethrough.

Whether to apply a double strikethrough.

The width of outline to use.

Whether to synthesize and apply an italic style.

Whether to synthesize and apply a bold style.

Whether to preserve white space characters for plain text.

The kerning of type.

The default kerning is based on the glyph indexes and the kerning table which applies to them. This is sometimes known as format zero. There are other other types of kerning based on classes of glyphs and the relationship between ther classes. This is sometimes known as format two. In theory the two formats will produce the same result. However this depends on the accuracy with which the fonts are constructed. There are no formats one or three. As well as the standard kerning there are other forms which allow shifts perpendicular to the text flow. However this is unusual and little used and is not currently supported.

The usage of characters.

The paragraph indent (points).

The default text direction.

Most Western languages have a default reading direction of left-to-right. However some other languages, notably Hebrew and Arabic, read right-to left. To further complicate matters it is quite common for languages like Hebrew to read bi-directionally - to have sections which are read left-to-right against the normal flow of text. The most common case in which this occurs is the use of numbers in text. Numbers are always read left-to-right. However it is also quite common to quote English names and again these are read in the standard English direction. This property allows you to set the default or predominant direction to be assumed for text.

The ID of the current font.

The horizontal positioning factor (0 to 1).

The vertical positioning factor (0 to 1).

XTransform class.

AngleUnitType Enumeration.

Degrees.

Radians.

XTransform constructor.

Matrix entry 1,1. Matrix entry 1,2. Matrix entry 2,1. Matrix entry 2,2. The x translation to be applied. The y translation to be applied.

XTransform constructor.

An array of doubles specifying the values for the matrix. These are in the order m11, m12, m21, m22, tx and ty.

XTransform constructor.

A string defining the initial transform in the format returned by the String property.

XTransform constructor.

XTransform constructor.

XTransform constructor.

Creates a deep copy of the current XTransform.

XTransform destructor.

Dispose of the XTransform.

Dispose of the XTransform.

A string representation of the transform.

The string representation of the object.

A string representation of the transform.

The x translation.

The y translation.

Reset to the identity.

Invert the transform.

Translate horizontally and vertically.

The distance to translate to the right. The distance to translate upwards.

Rotate about a locked anchor point (angle according to AngleUnit property).

The angle to rotate in degrees. The horizontal coordinate about which the rotation should be applied. The vertical coordinate about which the rotation should be applied.

Scale about a locked anchor point.

The amount of horizontal scaling to apply. The amount of vertical scaling to apply. The horizontal coordinate about which the stretch should be applied. The vertical coordinate about which the stretch should be applied.

Skew horizontally and vertically about a locked anchor point.

The amount of horizontal skewing to apply. The amount of vertical skewing to apply. The horizontal coordinate about which the stretch should be applied. The vertical coordinate about which the stretch should be applied.

Set the transform.

The new horizontal scale. The new vertical skew. The new horizontal skew. The new vertical scale. The new horizontal translation. The new vertical translation.

Set the transform.

The source transform.

Pre-multiplies this tranformation matrix by the supplied transform, by prepending the specified transform matrix.

The transform to be prepended.

Multiplies this tranformation matrix by the supplied transform, by appending the specified transform matrix.

The transform to be appended.

Determines if two transforms are effectively the same.

The transform to be compared against this one. The largest difference in values which will still be defined as equal.

Applies this transform to a specified array of points.

The array of points to be transformed.

Applies this transform to a specified array of points.

The array of points to be transformed.

Applies this transform to a specified array of points.

The array of points to be transformed.

Applies this transform to a specified point.

The point to be transformed.

Applies this transform to a specified point.

The point to be transformed.

Applies this transform to a specified point.

The point to be transformed.

Applies this transform to a specified point.

The point to be transformed.

Check if it is an identity matrix

Check if it contains a translation component

The transform as an array of floating-point values.

The transform as a System.Drawing Matrix.

The transform as a System.Windows.Media Matrix.

The angle units, degrees or radians.

Test whether two transforms are the same.

The XTransform to test against. Whether the two XTransform are equal.

Test whether the two transforms are the same.

The object to test against. Whether the objects are equal.

A hash code for the XTransform.

The returned hash code.

Compares this instance of an XTransform to another and returns an indication of their relative values.

A System.Object that evaluates to an XTransform. A signed number indicating the relative value of this instance.

Class ArrayElement. This class represents an array of typed Elements. Since it is an array, the core Atom it is created from should be an ArrayAtom.

The type of Element that this ArrayElement contains.

Create an empty ArrayElement<T>. The Element created by this default constructor is empty - it has no Atom within it. Before use an Atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a ArrayElement<T> wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a ArrayElement<T> wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a ArrayElement<T> containing a new Atom. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the indirect parameter is true, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

The Type of elements within the Array.

Whether elements within the Array are required to be indirect.

Whether NullAtom values are acceptable within the array. In most cases null values are not appropriate within an ArrayElement. In occasional cases it is possible to represent missing elements using a NullAtom. This property allows you to determine if this should be the case.

Gets or sets the Element at the specified index. In C# this property is the indexer for the class. The Item property is used to access Elements within the Array. The ArrayAtom is accessed and used to create an Element of type T. In the case that T has multiple sub-types, default factories will result in an item of the correct subtype being created. The precise factory that should be used is determined at the point the ArrayElement is assigned to a property of another Element. So since different properties may use different factories, you should not share one ArrayElement between more than one property. Most ArrayElements cannot hold null values in a meaningful way. So in general, if you provide a null value this will result in an exception being raised. Occasionally it is appropriate for ArrayElements to hold null values represented as NullAtoms. You can indicate this is acceptable, by setting the Nullable property.

The index. An Element of type T. Thrown if the index provided is not valid. Thrown if an attempt is made to assign a null value in a non-Nullable array.

Determines the index of a specific Element.

The Element to locate in the Collection If found, the index of value, otherwise -1.

Inserts an Element into the array at the specified position. If the index equals the number of items in the array then the Element is appended to the end. Most ArrayElements cannot hold null values in a meaningful way. So in general, if you provide a null value this will result in an exception being raised. Occasionally it is appropriate for ArrayElements to hold null values represented as NullAtoms. You can indicate this is acceptable, by setting the Nullable property.

The zero-based index at which value should be inserted. The Element to insert into the array. Thrown if the index provided is not valid. Thrown if an attempt is made to insert a null value in a non-Nullable array.

Removes the Element at the specified index. When an Element is removed the items that follow the removed item, move up to occupy the vacated spot.

The zero-based index of the item to remove. Thrown if the index provided is not valid.

Gets the number of Elements contained in the array. As Elements are added to the array the Count will increase. As they are removed, it will decrease.

The number of Elements in the array.

Add an Element to the end of the array. This method adds an Element to the array. Most ArrayElements cannot hold null values in a meaningful way. So in general, if you provide a null value this will result in an exception being raised. Occasionally it is appropriate for ArrayElements to hold null values represented as NullAtoms. You can indicate this is acceptable, by setting the Nullable property.

The value. Thrown if an attempt is made to insert a null value in a non-Nullable array.

Removes all Elements from the array.

Determines whether the array contains a specific Element.

The Element to locate. True if the object is found, otherwise false.

Copies the Elements into an array. Copies the elements of the collection to an array starting at a particular index.

The array that is the destination for the elements. The zero-based index at which copying begins.

Removes an Element from the array. When an Element is removed, the items that follow the removed item move up to occupy the vacated spot.

The Element to remove. True if the Element is removed, otherwise false.

Returns an enumerator that iterates through the collection. Gets an Element enumerator for the Collection.

An enumerator for the collection.

Enum AtomicTypes. This indicates the types of Atom that are acceptable in this Array. For example an AtomicArray of strings may accept NameAtoms, or StringAtoms or indeed both. This is a flags based enum so more than one type may be indicated by combining values.

Class AtomicArrayElement. This class represents an array of atomic elements. By atomic, we mean elements that can be directly represented using a .NET equivalent such as a string or int. On the PDF side the elements that are acceptable may be types such as StringAtom or NameAtom. The set of acceptable types may be indicated using the AtomicTypes property. Since it is an array, the core Atom this class is created from should be an ArrayAtom.

Can be string, int, double, double? or bool.

Create an empty ArrayElement<T>. The Element created by this default constructor is empty - it has no Atom within it. Before use an Atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create an AtomicArrayElement wrapping an Atom. The Atom that is provided should be an ArrayAtom or a RefAtom referring to an ArrayAtom. If it is not an exception will be thrown. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom. Thrown if the Atom provided is not an ArrayAtom or a RefAtom pointing to an ArrayAtom.

Create an AtomicArrayElement wrapping an IndirectObject. The IndirectObject that is provided should contain an ArrayAtom. If it does not an exception will be thrown. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element. Thrown if the Atom provided is not an ArrayAtom or a RefAtom pointing to an ArrayAtom.

Create an AtomicArrayElement containing a new Atom. This constructor creates an Element and then Assigns a new ArrayAtom to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

The Type of elements within the Array. This indicates the types of Atom that are acceptable in this Array. For example an AtomicArray of strings may accept NameAtoms, or StringAtoms or indeed both. This is a flags based enum so more than one type may be indicated by combining values. The possible values are: NoneNamesStringsNumbersBooleans

Gets or sets the items at the specified index. In C# this property is the indexer for the class. The Item property is used to access items within the Array. The ArrayAtom is accessed and used to create a value of type T. If the type indicated is string then a null string will be interpreted as an empty string. If the type indicated is a double? then a null value will be interpreted as a NullAtom. All other types are non-nullable.

The index. An items of type T. Thrown if the index provided is not valid.

Determines the first index matching a specific value.

The value to locate in the Collection If found, the index of value, otherwise -1.

Inserts an item into the array at the specified position. If the index equals the number of items in the array then the items is appended to the end. If the type indicated is string then a null string will be interpreted as an empty string. If the type indicated is a double? then a null value will be interpreted as a NullAtom. All other types are non-nullable.

The zero-based index at which the value should be inserted. The items to insert into the array. Thrown if the index provided is not valid.

Removes the item at the specified index. When an item is removed the items that follow the removed item, move up to occupy the vacated spot.

The zero-based index of the item to remove. Thrown if the index provided is not valid.

Gets the number of items contained in the array. As items are added to the array the Count will increase. As they are removed, it will decrease.

The number of items in the array.

Add an item to the end of the array. This method adds an item to the array. If the type indicated is string then a null string will be interpreted as an empty string. If the type indicated is a double? then a null value will be interpreted as a NullAtom. All other types are non-nullable.

The value.

Removes all items from the array.

Determines whether the array contains a specific value.

The value to locate. True if the object is found, otherwise false.

Copies the items into an array. Copies the items of the collection to an array starting at a particular index.

The array that is the destination for the elements. The zero-based index at which copying begins.

Removes the first matching value from the array. When an item is removed, the items that follow the removed item move up to occupy the vacated spot.

The value to remove. True if the value is removed, otherwise false.

Returns an enumerator that iterates through the collection. Gets a value enumerator for the Collection.

An enumerator for the collection.

The collection of Dictionary Atom names and values.

Create an empty DictElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an Atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a DictElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a DictElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a DictElement containing a new Atom. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the indirect parameter is true, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

The Type of elements within the Array.

Whether elements within the Array are required to be indirect.

Gets a collection containing the keys. DictElement.KeyCollection implements ICollection<string> and ICollection.

Gets a collection containing the values. DictElement.KeyCollection implements ICollection<T> and ICollection.

Determines whether the DictElement contains a specific value.

The value to locate. True if the DictElement contains an element with the specified value otherwise false.

The collection of names in a DictElement.

Initializes a new instance that reflects the keys in the specified DictElement.

The DictElement whose keys are reflected.

Gets the number of elements contained.

Copies the DictElement.KeyCollection elements to an existing one-dimensional Array, starting at the specified array index.

The one-dimensional Array that is the destination of the elements copied. The zero-based index in array at which copying begins.

Enumerates the elements of a DictElement.KeyCollection.

Releases all resources used by the DictElement.KeyCollection.Enumerator.

Gets the element at the current position of the enumerator.

Advances the enumerator to the next element of the DictElement.KeyCollection.

true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection.

Returns an enumerator that iterates through the DictElement.KeyCollection.

A DictElement.KeyCollection.Enumerator.

The collection of values in a DictElement.

Initializes a new instance that reflects the values in the specified DictElement.

The DictElement whose values are reflected.

Gets the number of elements contained.

Copies the DictElement.ValueCollection elements to an existing one-dimensional Array, starting at the specified array index.

The one-dimensional Array that is the destination of the elements copied. The zero-based index in array at which copying begins.

Enumerates the elements of a DictElement.ValueCollection.

Releases all resources used by the DictElement.ValueCollection.Enumerator.

Gets the element at the current position of the enumerator.

Advances the enumerator to the next element of the DictElement.ValueCollection.

true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection.

Returns an enumerator that iterates through the DictElement.ValueCollection.

A DictElement.ValueCollection.Enumerator.

Gets or sets the Element at the specified index. In C# this property is the indexer for the class. The Item property is used to access Elements within the dictionary. The DictAtom is accessed and used to create an Element of type T. In the case that T has multiple sub-types, default factories will result in an item of the correct subtype being created. The precise factory that should be used is determined at the point the DictElement is assigned to a property of another Element. So since different properties may use different factories, you should not share one DictElement between more than one property. DictElements cannot hold null values in a meaningful way. So if you provide a null value, this will result in an exception being raised. If the specified key is not found, a get operation throws a KeyNotFoundException, and a set operation creates a new element with the specified key.

The name of the entry. An Element of type T. Thrown if getting an item, but the specified key was not found. Thrown if an attempt is made to assign a null value.

Determines whether the DictElement contains the specified key.

The key to locate. True if the DictElement contains the specified key otherwise false.

Gets the value associated with the specified key.

The key of the value to get. When this method returns this contains the value associated with the specified key. If the key was not found this contains the default value for the type of the value. True if the DictElement contains the specified key otherwise false.

Adds the specified key and value to the dictionary. This method adds an item to the dictionary. If the key or value is null then this method will throw an ArgumentNullException. If the key is already present in the dictionary then this method will throw an ArgumentException.

The key of the element to add. The value of the element to add. Thrown if the key was already present. Thrown if the key or value was null.

Remove an element from the dictionary. Removes the value with the specified name from the dictionary.

The name of the element to remove. True if the element is successfully found and removed otherwise false. Thrown if the key was null.

Gets the number of key/value pairs contained in the dictionary. As pairs are added to the array the Count will increase. As they are removed, it will decrease.

The number of key/value pairs in the dictionary.

Removes all keys and values from the dictionary.

Enumerates the elements of a DictElement.

Releases all resources used by the DictElement.Enumerator.

Gets the element at the current position of the enumerator.

Advances the enumerator to the next element of the DictElement.

true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection.

Returns an enumerator that iterates through the DictElement. Get a KeyValuePair<string, T> enumerator for the dictionary. DictAtom.Enumerator is a value type that implements IEnumerator<KeyValuePair<string, T>> and IDictionaryEnumerator.

An enumerator for the collection.

Enum CreationOptions. This indicates the way that new Elements may be created. The default behavior is to create a new Atom to hold the information in the Element. However you can specify that a new IndirectObject containing an Atom should be used.

Default creation options for this particular type of Element.

Create Element containing an IndirectObject.

Create Element containing an Atom.

Enum Version flags. This flags enumeration is used to indicates the version associated with a specified feature. Typically the flags will indicate the version in which a feature was introduced. However they may also indicate the version in which it was deprecated. Some features are introduced in a PDF variant extension and then claimed in a later ISO version. In this case the feature may have more than one version flag.

No version information available.

Introduced in PDF 1.0.

Introduced in PDF 1.1.

Introduced in PDF 1.2.

Introduced in PDF 1.3.

Introduced in PDF 1.4.

Introduced in PDF 1.5.

Introduced in PDF 1.6.

Introduced in PDF 1.7.

Obsolescent in PDF 1.7.

Adobe undocumented extension.

Introduced in PDF 1.7 Adobe Extension Level 3.

Introduced in PDF 1.7 Adobe Extension Level 5.

Introduced in PDF 2.0.

Deprecated in PDF 2.0.

An Element is a specialization wrapper around an Atom designed to expose aspects of that Atom in a structured manner. Different subclasses of Element are used to represent the different objects defined in the Adobe PDF Specification. In general there is one Element subclass for each object table in the PDF Specification.

Delegate Factory. This delegate is used for the creation of specific types of Element. The particular type which is created may vary depending on the content of the Atom and the context of the call. For example one might create a Factory to create different types of Annotation based on the 'Type' entry found in the supplied Atom. Most of the factories that are needed are already present in the ElementFactories class.

The atom from which the Element should be created. The host object. This can be any IndirectObject in the document but it is useful to specify one with which the atom is closely associated. A reference which may be used to pass context. Element.

Create a new Element. The different constructors allow different ways of creating an Element. Some are used for wrapping existing Atoms or IndirectObjects and others are for creating new ones. The constructor taking a relation Element creates a new object in the document - it is typically the constructor you will want to use. Do not specify creation options unless you have very specific needs. However for your first Element - one you can use as a relation for the others - you will need to wrap an existing IndirectObject inside an Element. For this you might use code of the following form "CatalogElement root = new CatalogElement(doc.ObjectSoup.Catalog)". The parameterless constructor allows you to create an empty Element. By empty we mean it has no contents - no Atom within it. So before use an Atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors. The atom and host constructor is used to wrap an existing Atom. It creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

Create a new Element. The different constructors allow different ways of creating an Element. Some are used for wrapping existing Atoms or IndirectObjects and others are for creating new ones. The constructor taking a relation Element creates a new object in the document - it is typically the constructor you will want to use. Do not specify creation options unless you have very specific needs. However for your first Element - one you can use as a relation for the others - you will need to wrap an existing IndirectObject inside an Element. For this you might use code of the following form "CatalogElement root = new CatalogElement(doc.ObjectSoup.Catalog)". The parameterless constructor allows you to create an empty Element. By empty we mean it has no contents - no Atom within it. So before use an Atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors. The atom and host constructor is used to wrap an existing Atom. It creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a new Element. The different constructors allow different ways of creating an Element. Some are used for wrapping existing Atoms or IndirectObjects and others are for creating new ones. The constructor taking a relation Element creates a new object in the document - it is typically the constructor you will want to use. Do not specify creation options unless you have very specific needs. However for your first Element - one you can use as a relation for the others - you will need to wrap an existing IndirectObject inside an Element. For this you might use code of the following form "CatalogElement root = new CatalogElement(doc.ObjectSoup.Catalog)". The parameterless constructor allows you to create an empty Element. By empty we mean it has no contents - no Atom within it. So before use an Atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors. The atom and host constructor is used to wrap an existing Atom. It creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The IndirectObject to be assigned to this Element. Thrown if the atom is not of correct type for this type of Element.

Create a new Element. The different constructors allow different ways of creating an Element. Some are used for wrapping existing Atoms or IndirectObjects and others are for creating new ones. The constructor taking a relation Element creates a new object in the document - it is typically the constructor you will want to use. Do not specify creation options unless you have very specific needs. However for your first Element - one you can use as a relation for the others - you will need to wrap an existing IndirectObject inside an Element. For this you might use code of the following form "CatalogElement root = new CatalogElement(doc.ObjectSoup.Catalog)". The parameterless constructor allows you to create an empty Element. By empty we mean it has no contents - no Atom within it. So before use an Atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors. The atom and host constructor is used to wrap an existing Atom. It creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Create a new Atom for this Element. The process of Element creation works in three stages. First the Element needs to be created using the default constructor. Secondly an Atom needs to be provided for the Element. Finally the values of the Element need to be assigned. The Create method creates a new Atom of appropriate type. This is distinct from the Assign method which allows for the adoption of an existing Atom obtained via some other source. Each Element has its own properties, some of which may be mandatory. The creation of an Atom does not provide any of these properties. After creation the values of the Element need to be appropriately assigned using the properties prefixed with 'Item'. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is created is of the correct type.

An IndirectObject closely associated with this Element.

Assign an IndirectObject to this Element. The process of assignment allows an existing IndirectObject to be viewed through the lens of a particular type of Element. It is important to ensure that IndirectObjects are assigned to appropriate types of Element. For example, while is is possible to assign a Page Indirect Object to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign an IndirectObject which contains a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

The IndirectObject to be assigned to this Element. Whether the assignment was made successfully.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Gets the host IndirectObject. The host is specified during construction or in a later call to Assign. The host is primarily used to indicate the document to which the Element belongs. As such it can be any IndirectObject in the document. However it is often useful to choose one which is closely associated with the Atom provided. For example, if you create an Element from an IndirectObject, the Host can be itself.

The host IndirectObject.

Gets any RefAtom that is part of this Element. When an Atom is provided during construction, this may be a reference to an IndirectObject rather than a direct reference to an Atom. If this is the case then the reference needs to be resolved through to an Atom. This property stores the original RefAtom and the Atom property stores the resolved Atom - usually a DictAtom. If the provided Atom is not a RefAtom then this property will be null.

The RefAtom.

Gets any Atom that is part of this Element. When an Atom is provided during construction, this may be a reference to an IndirectObject rather than a direct reference to an Atom. If this is the case then the reference needs to be resolved through to an Atom. This property stores the resolved Atom - usually a DictAtom but occasionally other types for some specific types of Element. However this property will never be a RefAtom as all references have been resolved.

The RefAtom.

Gets the Atom that was used to create this Element. When an Atom is provided during construction, this may be a reference to an IndirectObject rather than a direct reference to an Atom. If this is the case then the reference needs to be resolved through to an Atom. The Ref property stores the RefAtom, if one was provided. The Atom property stores the resolved Atom. This property will return the Ref if it is not null, or the Atom if it is.

The RefAtom.

Gets the IndirectObject that is part of this Element. When an Atom is provided during construction, this may be a reference to an IndirectObject rather than a direct reference to an Atom. If this is the case then this property stores the referenced IndirectObject. If the provided Atom is not a RefAtom then this property will be null.

The object.

Gets the Atom property as a DictAtom. If the Atom is not a DictAtom then the property will be null.

The dictionary atom.

Gets the Atom property as an ArrayAtom. If the Atom is not an ArrayAtom then the property will be null.

The array atom.

Gets the Atom property as a NameAtom. If the Atom is not a NameAtom then the property will be null.

The name atom.

Gets the Atom property as a NumAtom. If the Atom is not a NumAtom then the property will be null.

The number atom.

Gets the Atom property as a StringAtom. If the Atom is not a StringAtom then the property will be null.

The string atom.

Gets the Atom property as a BoolAtom. If the Atom is not a BoolAtom then the property will be null.

The boolean atom.

Creates a deep copy of the current Element.

The newly created copy.

Creates a deep copy of a specified type of Element.

The element to be cloned. Whether the clone must be an indirect reference. The newly created copy.

Test whether the two Elements are the same.

The Element to test against. Whether the Elements are equal.

Test whether the two Elements are the same.

The Element to test against. Whether the Elements are equal.

Compares this instance of an Element to another and returns an indication of their relative values.

An Element to compare against. A signed number indicating the relative value of this instance.

A hash code for the Element.

The returned hash code.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This property represents the "Metadata" entry of the Element. It is an optional entry for all Dictionaries or Streams as defined as part of the PDF 1.4 specification. A MetadataStreamElement. For definitive details see: ISO 32000-1:2008 PDF 1.7; Table: 30, page 78. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.27, page 23.

Class ElementFactories. This static class contains a set of static factory methods for creating Elements. The reason you may need a factory method is because you may not know the type of Element you want to create at compile time. For example documents often contain annotations which float over the page. Each type of annotation is represented by a different type of Elemment. However, until you read the document, you will not know if those annotations are stamps or lines or fields or any other type of annotation. Using a factory method allows the structure of the object to be examined and a sensible Element type allocated to it. Different factory methods are appropriate at different times. For example the creation of annotations may require a different logic to the creation of actions.

Autodetect Factory. This is used for the creation of specific types of Element based on the content of the Atom. Many Atoms have specific Type or Subtype fields which are used to indicate the precise variant of Element. If these are present, which in many cases they are, then a sensible choice can be made as to the type of Element to create. Even when these are not present sometimes it is possible to detect the type from specific combinations of entries found in the Atom. However not all specializations can be auto-detected as not all require this type of identification element. If this is the case then the return value will be a generic Element.

The atom from which the Element should be created. The host object. This can be any IndirectObject in the document but it is useful to specify one with which the atom is closely associated. A reference which may be used to pass context. An Element or Element subclass.

Name or Number Tree Class.

NameOrNumberTree constructor.

NameOrNumberTree constructor.

The root node for the tree.

The Type of elements within the Tree.

Gets a collection containing the keys. DictElement.KeyCollection implements ICollection<TKey> and ICollection.

Gets a collection containing the values. DictElement.KeyCollection implements ICollection<TVal> and ICollection.

Determines whether the Tree contains a specific value.

The value to locate. True if the Tree contains an element with the specified value otherwise false.

The collection of names in a Tree.

Initializes a new instance that reflects the keys in the specified Tree.

The Tree whose keys are reflected.

Gets the number of elements contained.

Copies the Tree.KeyCollection elements to an existing one-dimensional Array, starting at the specified array index.

The one-dimensional Array that is the destination of the elements copied. The zero-based index in array at which copying begins.

Enumerates the elements of a Tree.KeyCollection.

Releases all resources used by the Tree.KeyCollection.Enumerator.

Gets the element at the current position of the enumerator.

Advances the enumerator to the next element of the Tree.KeyCollection.

true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection.

Returns an enumerator that iterates through the Tree.KeyCollection.

A Tree.KeyCollection.Enumerator.

The collection of values in a Tree.

Initializes a new instance that reflects the values in the specified Tree.

The Tree whose values are reflected.

Gets the number of elements contained.

Copies the Tree.ValueCollection elements to an existing one-dimensional Array, starting at the specified array index.

The one-dimensional Array that is the destination of the elements copied. The zero-based index in array at which copying begins.

Enumerates the elements of a Tree.ValueCollection.

Releases all resources used by the Tree.ValueCollection.Enumerator.

Gets the element at the current position of the enumerator.

Advances the enumerator to the next element of the Tree.ValueCollection.

true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection.

Returns an enumerator that iterates through the Tree.ValueCollection.

A Tree.ValueCollection.Enumerator.

Gets or sets the value associated with the specified key. In C# this property is the indexer for the class. The Item property is used to access Elements within the tree. The tree is searched for a matching entry and used to create an Element of type T. Note that no factories are used here so the element will always be type T - not a subclass. Trees cannot hold null values in a meaningful way. So if you provide a null value, this will result in an exception being raised. If the specified key is not found, a get operation throws a KeyNotFoundException, and a set operation creates a new element with the specified key.

The key for the entry. An Element of type T. Thrown if getting an item, but the specified key was not found. Thrown if an attempt is made to assign a null value.

Determines whether the Tree contains the specified key.

The key to locate. True if the Tree contains an element with the specified key otherwise false.

Gets the value associated with the specified key.

The key of the value to get. When this method returns this contains the value associated with the specified key. If the key was not found this contains the default value for the type of the value. True if the DictElement contains the specified key otherwise false.

Adds the specified key and value to the dictionary. This method adds an item to the dictionary. If the key or value is null then this method will throw an ArgumentNullException. If the key is already present in the dictionary then this method will throw an ArgumentException.

The key of the element to add. The value of the element to add. Thrown if the key was already present. Thrown if the key or value was null.

Remove an element from the dictionary. Removes the value with the specified key from the dictionary.

The key of the element to remove. True if the element is successfully found and removed otherwise false. Thrown if the key was null.

Gets the number of key/value pairs contained in the dictionary. As pairs are added to the array the Count will increase. As they are removed, it will decrease.

The number of key/value pairs in the dictionary.

Removes all keys and values from the dictionary.

Enumerates the elements of a Tree.

Releases all resources used by the Tree.Enumerator.

Gets the element at the current position of the enumerator.

Advances the enumerator to the next element of the Tree.

true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection.

Returns an enumerator that iterates through the tree. Get a KeyValuePair<TKey, TVal> enumerator for the dictionary. DictAtom.Enumerator is a value type that implements IEnumerator<KeyValuePair<TKey, TVal>> and IDictionaryEnumerator.

An enumerator for the collection.

Validation class. This is the base pure abstract class that stores and reports the validation status of Elements that are being validated. For custom validation reports you may derive from this class and implement any abstract methods. However generally you will want to derive from ValidationBase as it includes a number of useful housekeeping routines.

Initializes a new instance of the Validation class.

Called at the point each Element starts validation. If the Element has already been seen then this function should return false to indicate that it has already been validated. If not then the function should return true to indicate that validation should go ahead. Subclasses should keep track of elements that they have seen so as to avoid recursive loops.

The element. true if the element should be validated, false otherwise.

Called for DictAtoms for each key in the dictionary. Dictionaries are validated item by item for each of the key value pairs. This function is called at the point each key starts validation.

The new key or entry.

Called for ArrayAtoms for each item in the array. Arrays are validated item by item for each of the items contained in the sequence. This function is called at the point each item starts validation.

The new index.

Called at the point each Element finishes validation.

The element.

Called to indicate that a particular RefAtom has been seen. Most of the time the Start method can be used to keep track of which IndirectObjects have been seen. However occasionally a RefAtom may not resolve to an Element that can be validated. For example the Length entry in a StreamElement is a number indicating the number of bytes of data in the stream. In most cases this is a simple number embedded as the value of the Length entry in the dictionary. However some PDFs represent this as a reference to an IndirectObject containing a number. Since it is a reference to a number there is no Element type for it and it will not get validated. For the basic validation process this will not matter since the reference is automatically resolved and a simple number provided. However if you are keeping track of which IndirectObjects have been validated, it is important to know about these cases. You can do so by overriding this function.

The RefAtom.

Called to report the entry version. Dictionaries are validated item by item for each of the key value pairs. Each key is associated with a particular PDF Version in which it was introduced. This function is called for each entry, with a number indicating the minimum version required.

The entry name. The PDF version.

Called to report an entry with an unrecognized name.

The entry name.

Called to report an entry with an incorrect value. Many entries have values which are constrained. For example some numbers may have a range between which they must fall. Some numbers may be cardinal only. Names are often used to indicated enumerated options. In the event that a value is incorrect this function will be called.

The incorrect value.

Called to report a missing required entry. Some entries are required to be present. In the event that the entry is not provided, this function will be called.

Called to report an object which should be indirect but is not. Some entries are required to be indirect - to refer to an IndirectObject. For example Page objects are always indirect and a reference to a Page will always be made via a RefAtom. In the event that an object which is supposed to be indirect, is not, this function will be called.

Called to report an object which is of the wrong type. Some entries are required to specific types of object. For example a Page Node has children which must be either other Page Nodes or Pages. If an item like this is retrieved, and turns out to be a different type, this function will be called.

The expected type name. The actual type name. The atom which was found.

Called to report an array with an incorrect number of entries. Some arrays have a set number of items. For example a value range may be represented as an array with two elements indicating higher and lower bounds. In the event that the number of entries is incorrect, this function will be called.

The value which was expected. The value which was found.

Called to report an Exception that was thrown during validation. In general you do not want the validation of one Element to affect another. So if an Exception is thrown during the validation of one Element, you want this to be reported, but then for validation to continue. In the event that this happens, this function will be called.

The Element which was being processed. The Exception which was thrown.

Called to report detection of a recursive structure. Recursive structures are unusual but they can exist. For example a Page object might contain a reference to itself. This needs to be detected to avoid a recursive loop in which the Page validates itself over and over again. In the event that this type of recursion is detected, this function will be called.

StackNode class. Validation is a recursive process. One Element validates each of its child Elements. Each of those in turn validate their children. In the event that an inconsistency is found, it useful to know how the current Element was arrived at. The Stack consists of a sequence of ValidationStackNode. Each node indicates the state of validation at the point at which a child element was asked to validate itself. There may be apparent duplicates on the stack as sub-classes may result in multiple calls to the Start function.

Initializes a new instance of the ValidationStackNode class.

The current element.

Gets the element to which this node refers.

Gets or sets the entry - the DictAtom key - which represents the current item being validated.

Gets or sets the item - the ArrayAtom index - which represents the current item being validated.

ValidationBase class. This is a class derived from Validation that stores and reports the validation status of Elements that are being validated. It implements a variety of useful features like the detection and resolution of recursive loops, a stack trace and a coverage option. For custom validation reports you will generally want to derive from this class and implement any abstract methods.

Gets all types that may be recorded in the Coverage. By removing covered types from the all types set, you can determine which types have not been covered.

All types of Elements.

Gets or sets the coverage. The coverage is a set of the names of the types of Elements that have been created during validation. The default value of this property is null which means that coverage information will not be recorded. To record coverage information, assign a HashSet to this property. The values in the HashSet are preserved so you can use one HashSet to determine the coverage of a group of documents.

The coverage.

Gets or sets the stack. Validation is a recursive process. One Element validates each of its child Elements. Each of those in turn validate their children. In the event that an inconsistency is found, it useful to know how the current Element was arrived at. This property allows you to examine the current state of the stack including all parent StackNodes up to the root. There may be apparent duplicates on the stack as sub-classes may result in multiple calls to the Start function. For this reason, for a stack trace, you will generally want to use the GetStackTrace function. However you may also find that you want to Peek at the top - current - item for added detail when reporting errors.

The stack.

Gets the set of IDs which have been processed. During validation many IndirectObjects will be encountered. Each time this happens, the ID value is added to this property. The result is a set of IDs which allows you to determine the Objects that were validated. If some are not validated this will be generally because they were not referenced anywhere. However it may also be that they were referenced but that the references were not part of the PDF specification and thus could not be followed.

The done.

Initializes a new instance of the ValidationBase class.

Gets the stack trace. Validation is a recursive process. One Element validates each of its child Elements. Each of those in turn validate their children. In the event that an inconsistency is found, it useful to know how the current Element was arrived at. This property allows you to get the current stack trace stack including all parents up to the root.

A string containing the stack trace.

This class represents a color. A color consists of an array of component values. For example an RGB color has three values between zero and one, a CMYK color has four between zero and one. Colors only make sense in the context of a color space that specifies what the components represent. Most components range between zero and one. However some color spaces such as Lab have components with values outside this range. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; page 139.

Create an empty ColorElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an Atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a ColorElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a ColorElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a ColorElement containing a new Atom. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the indirect parameter is true, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

The component intensities for the color. For example an RGB color has three values between zero and one, a CMYK color has four between zero and one. Colors only make sense in the context of a color space that specifies what the components represent. Most components range between zero and one. However some color spaces such as Lab have components with values outside this range.

Get the contents of this ColorElement as an XColor.

A new XColor with values corresponding to the contents of this ColorElement.

Set the contents of this ColorElement using an XColor.

The XColor containing values to be inserted into this ColorElement The XColor that was passed in.

This class represents a hybrid destination and action dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; 12.3.2.3 Named Destinations, page 367.

Create an empty DestinationActionElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an Atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a DestinationActionElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a DestinationActionElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a DestinationActionElement containing a new Atom. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the indirect parameter is true, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

This property represents the "D" entry of the object. It is a required entry and defined as part of the PDF 1.0 specification. This property contains a DestinationElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; 12.3.2.3 Named Destinations, page 367.

DestinationType Enumeration.

Unknown or undefined.

Display page with a particular point pinned to the top left of the window, at a specified zoom level.

Display page so that it fits into the window.

Display page so that it fits into the window, with a particular horizontal point pinned to the left of the page.

Display page so that it fits into the window, with a particular vertical point pinned to the top of the page.

Display page so that a specified rectangle fits into the window.

Display page so that the page bounding box fits into the window.

Display page so that the page width fits into the window, with a particular horizontal point pinned to the left of the page.

Display page so that the page height fits into the window, with a particular vertical point pinned to the top of the page.

This class represents a destination. A destination is a location within this document or sometimes in a different document. Along with the location, a destination carries extra information to state how the destination should be viewed. For example it may specify a page size, or zoom level or pinned point. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 151, page 366.

Create an empty DestinationElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an Atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a DestinationElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a DestinationElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a DestinationElement containing a new Atom. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the indirect parameter is true, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

This property represents the destination target. It is a required entry and defined as part of the PDF 1.0 specification. The Target may be a PageObjectElement or, in the case of a remote destination, an Element containing a NumAtom indicating a page number. In this case page numbers use a zero rather than one based index. In a PDF 2.0 document this property may be a StructureElementElement indicating the part of the document to which the destination refers. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 151, page 366.

This property represents the type of destination. It is a required entry and defined as part of the PDF 1.0 specification. It is a Name and may take one of the following valid values: XYZFitFitHFitVFitRFitBFitBHFitBV For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 151, page 366.

This property represents the first parameter associated with the destination. The number of parameters and purpose of each varies depending on the EntryType of the Destination. However in general they represent coordinates on the page which need be visible or aligned in some way. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 151, page 366.

This property represents the first parameter associated with the destination. The number of parameters and purpose of each varies depending on the EntryType of the Destination. However in general they represent coordinates on the page which need be visible or aligned in some way. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 151, page 366.

This property represents the first parameter associated with the destination. The number of parameters and purpose of each varies depending on the EntryType of the Destination. However in general they represent coordinates on the page which need be visible or aligned in some way. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 151, page 366.

This property represents the first parameter associated with the destination. The number of parameters and purpose of each varies depending on the EntryType of the Destination. However in general they represent coordinates on the page which need be visible or aligned in some way. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 151, page 366.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents link structure attributes. These are attributes associated with links in tagged PDF documents. This is not part of the offical PDF specification, but it is used in Adobe produced documents.

Create an empty LinkAttributesElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an Atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a LinkAttributesElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a LinkAttributesElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a LinkAttributesElement containing a new Atom. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the indirect parameter is true, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

This property represents the "ID" entry of the link structure attributes object.

This property represents the "S" entry of the link structure attributes object.

This class represents a tranformation matrix. Transformation matrices can be used to produce affine transforms such as translations, scales, rotations and skews. A transformation matrix consists of an array of six values. Coordinates are expressed as a three element matrix: [x, y, 1] The transformation matrix is expressed as a three by three matrix: [a, b, 0] [c, d, 0] [e, f, 1] So to apply a matrix to a point or set of points one simply multiplies the point matrix by the transformation matrix. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; page 119.

Create an empty MatrixElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an Atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a MatrixElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a MatrixElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a MatrixElement containing a new Atom. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the indirect parameter is true, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

The six elements in this list represent the following elements of the three by three transformation matrix: [a, b, 0] [c, d, 0] [e, f, 1]

This class represents a name tree node. A name tree is a way of representing a mapping from strings to other Elements. The standard PDF dictionary object does something similar, but it works natively in terms of shorter, non-Unicode strings and the PDF specification implies that it might not have been well optimized for large numbers of items. As such the PDF specification uses this type of tree structure, in areas where there may be large numbers of keys and values. This class is always an indirect object because CollectionElement.EntryResources, EntryKids, NavigatorElement.EntryResources and NavigatorElement.EntryStrings require it to be so. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 36, page 89.

Create an empty NameTreeNodeElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a NameTreeNodeElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a NameTreeNodeElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a NameTreeNodeElement containing a new Atom. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the indirect parameter is true, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

This property represents the "Kids" entry of the name tree node dictionary object. It is defined as part of the PDF 1.0 specification. An Array containing child NameTreeNodeElements which may be intermediate or leaf nodes. This entry is always null in leaf nodes. In intermediate nodes it must always be non-null. In the root node either this entry or the EntryNames entry should be non-null. But not both. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 36, page 89.

This property represents the "Names" entry of the name tree node dictionary object. It is defined as part of the PDF 1.0 specification. An Array containing alternate keys and values. For this reason the number of items in they array is always a multiple of two. So to find the 10th key and value you would use a zero based index of 20 and 21 respectively. The pairs in this array should be sorted in ascending order by key value. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 36, page 89.

This property represents the "Limits" entry of the name tree node dictionary object. It is defined as part of the PDF 1.0 specification. It is an Array containing two strings representing the lower and upper bounds of the tree. The first string represents the lowest key in the EntryNames entry of this or any child nodes. The second string represents the highest key in the EntryNames entry of this or any child nodes. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 36, page 89.

This class represents a number tree node. A number tree is a way of representing a mapping from integers to other Elements. The standard PDF dictionary object does something similar, but it works natively in terms of strings rather than numbers and the PDF specification implies that it might not have been optimized for large numbers of items. As such the PDF specification uses this type of tree structure, in areas where there may be large numbers of keys and values. This class is always an indirect object because EntryKids requires it to be so. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 37, page 91.

Create an empty NumberTreeNodeElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an Atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a NumberTreeNodeElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a NumberTreeNodeElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a NumberTreeNodeElement containing a new Atom. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the indirect parameter is true, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

This property represents the "Kids" entry of the number tree node dictionary object. It is defined as part of the PDF 1.0 specification. An Array containing child NumberTreeNodeElements which may be intermediate or leaf nodes. This entry is always null in leaf nodes. In intermediate nodes it must always be non-null. In the root node either this entry or the EntryNums entry should be non-null. But not both. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 37, page 91.

This property represents the "Nums" entry of the number tree node dictionary object. It is defined as part of the PDF 1.0 specification. An Array containing alternate keys and values. For this reason the number of items in they array is always a multiple of two. So to find the 10th key and value you would use a zero based index of 20 and 21 respectively. The pairs in this array should be sorted in ascending order by key value. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 37, page 91.

This property represents the "Limits" entry of the number tree node dictionary object. It is defined as part of the PDF 1.0 specification. It is an Array containing two integer representing the lower and upper bounds of the tree. The first int represents the lowest key in the EntryNums entry of this or any child nodes. The second int represents the highest key in the EntryNums entry of this or any child nodes. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 37, page 91.

This class represents a rectangle. A rectangle consists of an array of four values - two pairs of pairs. The first pair represent the x and y coordinates of the lower left of the rectangle, the second pair represent the x and y coordinates of the upper right of the rectangle. So [lx, ly, ux, uy]. Although the pairs conventially represent the lower left and upper right corners, it is in fact legal to represent any diagaonally opposed corners and PDF applications will automatically normalize these when they are found. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; page 88.

Create an empty RectangleElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an Atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a RectangleElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a RectangleElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a RectangleElement containing a new Atom. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the indirect parameter is true, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

A rectangle consists of an array of four values - two pairs of pairs. The first pair represent the x and y coordinates of the lower left of the rectangle, the second pair represent the x and y coordinates of the upper right of the rectangle. So [lx, ly, ux, uy]. Although the pairs conventially represent the lower left and upper right corners, it is in fact legal to represent any diagaonally opposed corners and PDF applications will automatically normalize these when they are found.

Get the contents of this RectangleElement as an XRect.

A new XRect with values corresponding to the contents of this RectangleElement.

Set the contents of this RectangleElement using an XRect.

The XRect containing values to be inserted into this RectangleElement The XRect that was passed in.

This class represents the string file specification. File specifications can be provided as a simple string or as a full dictionary containing cross platform path information. This class represents the former. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; page 100.

Create an empty StringFileSpecificationElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an Atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a StringFileSpecificationElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a StringFileSpecificationElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a StringFileSpecificationElement containing a new Atom. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the indirect parameter is true, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

This property represents the path to the file. It is an required entry and defined as part of the PDF 1.0 specification. This type of file specification always uses the forward slash character for directory separation. Because different platforms use different directory separator characters, it is necessary to translate this string for use on different platforms. If a file name or directory actually contains a forward slash, this needs to be indicated by using a backslash to escape it. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; page 100.

This class represents a text stream. PDF streams are simply stores of raw data. So a text stream is simply a PDF stream that contains text data. This class is always an indirect object because CollectionElement.EntryResources, NameTreeNodeElement<T>.EntryKids, NumberTreeNodeElement<T>.EntryKids, NavigatorElement.EntryResources and NavigatorElement.EntryStrings require it to be so. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Section 7.9.3, page 87.

Create an empty TextStreamElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an Atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a TextStreamElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a TextStreamElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a TextStreamElement containing a new Atom. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the indirect parameter is true, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

This class represents a name or number tree node dictionary. This class is always an indirect object because CollectionElement.EntryResources, NameTreeNodeElement<T>.EntryKids, NumberTreeNodeElement<T>.EntryKids, NavigatorElement.EntryResources and NavigatorElement.EntryStrings require it to be so. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 36, page 89.

Create an empty TreeNodeElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a TreeNodeElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a TreeNodeElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a TreeNodeElement containing a new Atom. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the indirect parameter is true, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Factory method for creation of T elements within the tree.

Nodes in a tree may be root, intermediate or leaf This property indicates if the node is a root node or not. We can know this because only the root node has no "Limits" entry.

Nodes in a tree may be root, intermediate or leaf This property indicates if the node is an intermediate node or not. We can know this because an intermediate node has a "Kids" entry and is not a root node.

Nodes in a tree may be root, intermediate or leaf This property indicates if the node is a leaf node or not. We can know this because a leaf node does not have a "Kids" entry and is not a root node.

This class represents the catalog dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 28, page 73. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 29, page 97. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.25, page 23. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 242, page 458. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 245, page 555. This class is always an indirect object because CrossReferenceStreamElement.EntryRoot and FileTrailerElement.EntryRoot require it to be so.

Create an empty CatalogElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a CatalogElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a CatalogElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new CatalogElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the catalog dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. This item must always be provided and must always take the value "Catalog". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 28, page 73. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.25, page 23. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 29, page 97. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 242, page 458. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 245, page 555.

Represents the "Version" entry of the catalog dictionary object. It is an optional entry defined as part of the PDF 1.4 specification. It contains a string representing a PDF name object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 28, page 73. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.25, page 23. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 29, page 98. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 242, page 458. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 245, page 555.

Represents the "Extensions" entry of the catalog dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an ExtensionsElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 28, page 73. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.25, page 23. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 29, page 98. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 242, page 458. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 245, page 555.

Represents the "Pages" entry of the catalog dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a PageTreeNodeElement. The PageTreeNodeElement represents the root node for all the pages in the document. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 28, page 73. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.25, page 23. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 29, page 98. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 242, page 458. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 245, page 555.

Represents the "PageLabels" entry of the catalog dictionary object. It is an optional entry defined as part of the PDF 1.3 specification. It contains a NumberTreeNodeElement containing PageLabelElements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 28, page 73. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.25, page 23. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 29, page 98. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 242, page 458. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 245, page 555.

Represents the "Names" entry of the catalog dictionary object. It is an optional entry defined as part of the PDF 1.2 specification. It contains a NameDictionaryElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 28, page 73. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.25, page 23. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 29, page 98. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 242, page 458. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 245, page 555.

Represents the "Dests" entry of the catalog dictionary object. It is an optional entry defined as part of the PDF 1.1 specification. It contains an Element. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 28, page 73. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.25, page 23. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 29, page 98. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 242, page 458. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 245, page 555.

Represents the "ViewerPreferences" entry of the catalog dictionary object. It is an optional entry defined as part of the PDF 1.2 specification. It contains a ViewerPreferencesElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 28, page 73. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.25, page 23. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 29, page 98. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 242, page 458. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 245, page 555.

Represents the "PageLayout" entry of the catalog dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. The PDF specification states that this item assumes a value of "SinglePage" if no value has been provided. This item may take one of the following valid values: SinglePageOneColumnTwoColumnLeftTwoColumnRightTwoPageLeftTwoPageRight For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 28, page 73. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.25, page 23. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 29, page 99. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 242, page 458. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 245, page 555.

Represents the "PageMode" entry of the catalog dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. The PDF specification states that this item assumes a value of "UseNone" if no value has been provided. This item may take one of the following valid values: UseNoneUseOutlinesUseThumbsFullScreenUseOCUseAttachments For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 28, page 74. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.25, page 23. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 29, page 99. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 242, page 458. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 245, page 555.

Represents the "Outlines" entry of the catalog dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an OutlineElement. The document outline is the bookmark hierarchy visible in the Acrobat navigation panel This property holds the root of the document outline. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 28, page 74. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.25, page 23. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 29, page 99. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 242, page 458. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 245, page 555.

Represents the "Threads" entry of the catalog dictionary object. It is an optional entry defined as part of the PDF 1.1 specification. It contains an array which contains ThreadElements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 28, page 74. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.25, page 23. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 29, page 99. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 242, page 458. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 245, page 555.

Represents the "OpenAction" entry of the catalog dictionary object. It is an optional entry defined as part of the PDF 1.1 specification. This property may contain one of two different types: 1) An ActionElement. 2) A DestinationElement. When the document is opened the specified action or destination will be triggered. This can be useful if you would like the document to open at a specific page or with a particular view. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 28, page 74. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.25, page 23. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 29, page 99. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 242, page 458. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 245, page 555.

Represents the "AA" entry of the catalog dictionary object. It is an optional entry defined as part of the PDF 1.4 specification. It contains a DocumentCatalogAdditionalActionsElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 28, page 74. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.25, page 23. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 29, page 99. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 242, page 458. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 245, page 555.

Represents the "URI" entry of the catalog dictionary object. It is an optional entry defined as part of the PDF 1.1 specification. It contains a CatalogUriElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 28, page 74. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.25, page 23. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 29, page 99. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 242, page 458. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 245, page 555.

Represents the "AcroForm" entry of the catalog dictionary object. It is an optional entry defined as part of the PDF 1.2 specification. It contains an InteractiveFormElement. The InteractiveFormElement contains the root of any field information for the document. Fields are represented as an abstract tree structure of FieldElements, spanning the entire document. Each field has a name and also a full name (like a file path) which tells you how to get to that field from the top level of the tree. Fields are abstract - they hold a name and value - but they do not explictly have any ability to display themselves. So to make them visible, leaf FieldElements need to be linked to WidgetAnnotationElements placed on individual pages of the document. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 28, page 74. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.25, page 23. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 29, page 99. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 242, page 458. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 245, page 555.

Represents the "StructTreeRoot" entry of the catalog dictionary object. It is an optional entry defined as part of the PDF 1.3 specification. It contains a StructureTreeRootElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 28, page 74. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.25, page 23. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 29, page 100. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 242, page 458. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 245, page 555.

Represents the "MarkInfo" entry of the catalog dictionary object. It is an optional entry defined as part of the PDF 1.4 specification. It contains a MarkInformationElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 28, page 74. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.25, page 23. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 29, page 100. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 242, page 458. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 245, page 555.

Represents the "Lang" entry of the catalog dictionary object. It is an optional entry defined as part of the PDF 1.4 specification. It contains a string representing a PDF string object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 28, page 74. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.25, page 23. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 29, page 100. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 242, page 458. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 245, page 555.

Represents the "SpiderInfo" entry of the catalog dictionary object. It is an optional entry defined as part of the PDF 1.3 specification. It contains a WebCaptureInformationElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 28, page 74. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.25, page 23. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 29, page 100. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 242, page 458. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 245, page 555.

Represents the "OutputIntents" entry of the catalog dictionary object. It is an optional entry defined as part of the PDF 1.4 specification. It contains an array which contains OutputIntentElements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 28, page 75. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.25, page 23. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 29, page 100. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 242, page 458. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 245, page 555.

Represents the "PieceInfo" entry of the catalog dictionary object. It is an optional entry defined as part of the PDF 1.4 specification. It contains an Element. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 28, page 75. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.25, page 23. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 29, page 100. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 242, page 458. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 245, page 555.

Represents the "OCProperties" entry of the catalog dictionary object. It is an optional entry defined as part of the PDF 1.5 specification. It contains an OptionalContentPropertiesElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 28, page 75. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.25, page 23. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 29, page 100. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 242, page 458. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 245, page 555.

Represents the "Perms" entry of the catalog dictionary object. It is an optional entry defined as part of the PDF 1.5 specification. It contains a PermissionsElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 28, page 75. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.25, page 23. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 29, page 100. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 242, page 458. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 245, page 555.

Represents the "Legal" entry of the catalog dictionary object. It is an optional entry defined as part of the PDF 1.5 specification. It contains an Element. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 28, page 75. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.25, page 23. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 29, page 100. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 242, page 458. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 245, page 555.

Represents the "Requirements" entry of the catalog dictionary object. It is an optional entry defined as part of the PDF 1.7 specification. It contains an array which contains RequirementElements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 28, page 75. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.25, page 23. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 29, page 100. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 242, page 458. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 245, page 555.

Represents the "Collection" entry of the catalog dictionary object. It is an optional entry defined as part of the PDF 1.7 specification. It contains a CollectionElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 28, page 75. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.25, page 23. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 29, page 100. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 242, page 458. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 245, page 555.

Represents the "NeedsRendering" entry of the catalog dictionary object. It is an optional entry defined as part of the PDF 1.7 specification. It was deprecated in PDF 2.0. It contains a bool representing a PDF boolean object. The PDF specification states that this item assumes a value of false if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 28, page 75. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.25, page 23. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 29, page 101. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 242, page 458. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 245, page 555.

Represents the "DSS" entry of the catalog dictionary object. It is an optional entry defined as part of the PDF 2.0 specification. It contains a DocumentSecurityStoreElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 28, page 73. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.25, page 23. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 29, page 101. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 242, page 458. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 245, page 555.

Represents the "AF" entry of the catalog dictionary object. It is an optional entry defined as part of the PDF 2.0 specification. It contains an array which contains FileSpecificationElements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 28, page 73. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.25, page 23. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 29, page 101. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 242, page 458. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 245, page 555.

Represents the "DPartRoot" entry of the catalog dictionary object. It is an optional entry defined as part of the PDF 2.0 specification. It contains a DocumentPartRootElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 28, page 73. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.25, page 23. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 29, page 101. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 242, page 458. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 245, page 555.

Represents the "FDF" entry of the catalog dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a FDFElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 28, page 73. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.25, page 23. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 29, page 97. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 242, page 458. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 245, page 555.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the ccittfax parameters. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 11, page 30. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 11, page 43.

Create an empty CcittParametersElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a CcittParametersElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a CcittParametersElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new CcittParametersElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "K" entry of the ccittfax parameters object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. The PDF specification states that this item assumes a value of 0 if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 11, page 30. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 11, page 43.

Represents the "EndOfLine" entry of the ccittfax parameters object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a bool representing a PDF boolean object. The PDF specification states that this item assumes a value of false if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 11, page 31. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 11, page 43.

Represents the "EncodedByteAlign" entry of the ccittfax parameters object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a bool representing a PDF boolean object. The PDF specification states that this item assumes a value of false if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 11, page 31. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 11, page 43.

Represents the "Columns" entry of the ccittfax parameters object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. The PDF specification states that this item assumes a value of 1728 if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 11, page 31. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 11, page 44.

Represents the "Rows" entry of the ccittfax parameters object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. The PDF specification states that this item assumes a value of 0 if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 11, page 31. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 11, page 44.

Represents the "EndOfBlock" entry of the ccittfax parameters object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a bool representing a PDF boolean object. The PDF specification states that this item assumes a value of true if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 11, page 31. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 11, page 44.

Represents the "BlackIs1" entry of the ccittfax parameters object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a bool representing a PDF boolean object. The PDF specification states that this item assumes a value of false if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 11, page 31. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 11, page 44.

Represents the "DamagedRowsBeforeError" entry of the ccittfax parameters object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. It should have a minimum value of 0. The PDF specification states that this item assumes a value of 0 if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 11, page 31. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 11, page 44.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the collection item dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 48, page 106. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 46, page 138. This class is always an indirect object because FullFileSpecificationElement.EntryCI requires it to be so.

Create an empty CollectionItemElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a CollectionItemElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a CollectionItemElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new CollectionItemElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the collection item dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. If provided, this item must always take the value "CollectionItem". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 48, page 106. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 46, page 138.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the collection subitem dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 49, page 107. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 47, page 139.

Create an empty CollectionSubItemElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a CollectionSubItemElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a CollectionSubItemElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new CollectionSubItemElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the collection subitem dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. If provided, this item must always take the value "CollectionSubitem". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 49, page 107. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 47, page 139.

Represents the "D" entry of the collection subitem dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. This property may contain one of two different types: 1) A double representing a PDF numeric object. 2) A string representing a PDF string object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 49, page 107. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 47, page 139.

Represents the "P" entry of the collection subitem dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 49, page 107. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 47, page 139.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the cross-reference stream dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 17, page 50. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 17, page 65. This class is always an indirect object because it is also a StreamElement and these are always indirect objects.

Create an empty CrossReferenceStreamElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a CrossReferenceStreamElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a CrossReferenceStreamElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new CrossReferenceStreamElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

The StreamElement associated with this class.

Represents the "Type" entry of the cross-reference stream dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. This item must always be provided and must always take the value "XRef". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 17, page 50. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 17, page 65.

Represents the "Size" entry of the cross-reference stream dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 17, page 50. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 17, page 65.

Represents the "Index" entry of the cross-reference stream dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains integers, representing PDF numeric objects. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 17, page 50. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 17, page 65.

Represents the "Prev" entry of the cross-reference stream dictionary object. It is defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 17, page 50. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 17, page 65.

Represents the "W" entry of the cross-reference stream dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains an array which contains integers, representing PDF numeric objects. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 17, page 50. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 17, page 66.

Represents the "Root" entry of the cross-reference stream dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a CatalogElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 17, page 50. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 17, page 65.

Represents the "Encrypt" entry of the cross-reference stream dictionary object. It is defined as part of the PDF 1.1 specification. It contains an EncryptionElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 17, page 50. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 17, page 65.

Represents the "Info" entry of the cross-reference stream dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a DocumentInformationElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 17, page 50. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 17, page 65.

Represents the "ID" entry of the cross-reference stream dictionary object. It is defined as part of the PDF 1.1 specification. It contains an array which contains strings, representing PDF string objects. This string contains raw byte data. So it looks like a string but really it is just a wrapper for data. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 17, page 50. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 17, page 65.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the crypt filter dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 25, page 68. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 25, page 89. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.22, page 22.

Create an empty CryptFilterElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a CryptFilterElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a CryptFilterElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new CryptFilterElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the crypt filter dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. If provided, this item must always take the value "CryptFilter". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 25, page 68. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.22, page 22. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 25, page 89.

Represents the "CFM" entry of the crypt filter dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. The PDF specification states that this item assumes a value of "None" if no value has been provided. This item may take one of the following valid values: NoneV2AESV2AESV3 For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 25, page 68. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.22, page 22. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 25, page 90.

Represents the "AuthEvent" entry of the crypt filter dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. The PDF specification states that this item assumes a value of "DocOpen" if no value has been provided. This item may take one of the following valid values: DocOpenEFOpen For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 25, page 68. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.22, page 22. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 25, page 90.

Represents the "Length" entry of the crypt filter dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It was deprecated in PDF 2.0. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 25, page 68. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.22, page 22. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 25, page 91.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the crypt parameters. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 14, page 38. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 14, page 52.

Create an empty CryptParametersElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a CryptParametersElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a CryptParametersElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new CryptParametersElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the crypt parameters object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. If provided, this item must always take the value "CryptFilterDecodeParms". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 14, page 38. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 14, page 52.

Represents the "Name" entry of the crypt parameters object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. The PDF specification states that this item assumes a value of "Identity" if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 14, page 38. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 14, page 52.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the dct parameters. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 13, page 35. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 13, page 48.

Create an empty DctParametersElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a DctParametersElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a DctParametersElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new DctParametersElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "ColorTransform" entry of the dct parameters object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 13, page 35. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 13, page 48.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the developer extensions dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 50, page 108. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 49, page 140. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.25b, page 25.

Create an empty DeveloperExtensionsElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a DeveloperExtensionsElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a DeveloperExtensionsElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new DeveloperExtensionsElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the developer extensions dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. If provided, this item must always take the value "DeveloperExtensions". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 50, page 108. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.25b, page 25. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 49, page 140.

Represents the "BaseVersion" entry of the developer extensions dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 50, page 108. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.25b, page 25. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 49, page 140.

Represents the "ExtensionLevel" entry of the developer extensions dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 50, page 108. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.25b, page 25. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 49, page 140.

Represents the "URL" entry of the developer extensions dictionary object. It is an optional entry defined as part of the PDF 2.0 specification. It contains a string representing a PDF string object. The specification defines this as exensible which means that it may contain entries in addition to those defined in the specification. In fact almost all objects are extensible but the fact that it is explicitly mentioned, implies that extra entries should be regarded as normal rather than exceptional. For further details see The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: Annex E, page 673.. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 50, page 108. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.25b, page 25. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 49, page 140.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the embedded file parameter dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 46, page 104. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 45, page 137.

Create an empty EmbeddedFileParameterElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a EmbeddedFileParameterElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a EmbeddedFileParameterElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new EmbeddedFileParameterElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Size" entry of the embedded file parameter dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 46, page 104. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 45, page 137.

Represents the "CreationDate" entry of the embedded file parameter dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. This is encoded as a date string. For details see the StringAtom.DateToString and StringAtom.StringToDate functions. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 46, page 104. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 45, page 137.

Represents the "ModDate" entry of the embedded file parameter dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. This is encoded as a date string. For details see the StringAtom.DateToString and StringAtom.StringToDate functions. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 46, page 104. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 45, page 137.

Represents the "Mac" entry of the embedded file parameter dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It was deprecated in PDF 2.0. It contains a MacOSFileInformationElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 46, page 104. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 45, page 137.

Represents the "CheckSum" entry of the embedded file parameter dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 46, page 104. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 45, page 137.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the embedded file set dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; page 103.

Create an empty EmbeddedFileSetElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a EmbeddedFileSetElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a EmbeddedFileSetElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new EmbeddedFileSetElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "F" entry of the embedded file set dictionary object. It is an optional entry defined as part of the PDF 1.3 specification. It contains an EmbeddedFileStreamElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; page 103.

Represents the "UF" entry of the embedded file set dictionary object. It is an optional entry defined as part of the PDF 1.7 specification. It contains an EmbeddedFileStreamElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; page 103.

Represents the "DOS" entry of the embedded file set dictionary object. It is an optional entry defined as part of the PDF 1.3 specification. It was marked obsolescent in PDF 1.7 and deprecated in PDF 2.0. It contains an EmbeddedFileStreamElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; page 103.

Represents the "Mac" entry of the embedded file set dictionary object. It is an optional entry defined as part of the PDF 1.3 specification. It was marked obsolescent in PDF 1.7 and deprecated in PDF 2.0. It contains an EmbeddedFileStreamElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; page 103.

Represents the "Unix" entry of the embedded file set dictionary object. It is an optional entry defined as part of the PDF 1.3 specification. It was marked obsolescent in PDF 1.7 and deprecated in PDF 2.0. It contains an EmbeddedFileStreamElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; page 103.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the embedded file stream dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 45, page 104. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 44, page 136. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 244, page 460. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 247, page 558. This class is always an indirect object because it is also a StreamElement and these are always indirect objects.

Create an empty EmbeddedFileStreamElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a EmbeddedFileStreamElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a EmbeddedFileStreamElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new EmbeddedFileStreamElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

The StreamElement associated with this class.

Represents the "Type" entry of the embedded file stream dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. If provided, this item must always take the value "EmbeddedFile". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 45, page 104. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 44, page 136. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 244, page 460. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 247, page 558.

Represents the "Subtype" entry of the embedded file stream dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. The specification defines this as exensible which means that it may contain entries in addition to those defined in the specification. In fact almost all objects are extensible but the fact that it is explicitly mentioned, implies that extra entries should be regarded as normal rather than exceptional. For further details see The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: Annex E, page 673.. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 45, page 104. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 44, page 136. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 244, page 460. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 247, page 558.

Represents the "Params" entry of the embedded file stream dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an EmbeddedFileParameterElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 45, page 104. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 44, page 136. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 244, page 460. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 247, page 558.

Represents the "EncryptionRevision" entry of the embedded file stream dictionary object. It is defined as part of the PDF 1.4 specification. It was deprecated in PDF 2.0. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 45, page 104. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 44, page 136. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 244, page 460. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 247, page 558.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the encrypted payload dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 28, page 94.

Create an empty EncryptedPayloadElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a EncryptedPayloadElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a EncryptedPayloadElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new EncryptedPayloadElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the encrypted payload dictionary object. It is an optional entry defined as part of the PDF 2.0 specification. It contains a string representing a PDF name object. If provided, this item must always take the value "EncryptedPayload". For definitive details see: The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 28, page 94.

Represents the "Subtype" entry of the encrypted payload dictionary object. It is a required entry defined as part of the PDF 2.0 specification. It contains a string representing a PDF name object. For definitive details see: The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 28, page 94.

Represents the "Version" entry of the encrypted payload dictionary object. It is an optional entry defined as part of the PDF 2.0 specification. It contains a string representing a PDF name object. For definitive details see: The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 28, page 94.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the encryption dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 20, page 56. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 20, page 71. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.18, page 14.

Create an empty EncryptionElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a EncryptionElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a EncryptionElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new EncryptionElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Filter" entry of the encryption dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. The specification defines this as exensible which means that it may contain entries in addition to those defined in the specification. In fact almost all objects are extensible but the fact that it is explicitly mentioned, implies that extra entries should be regarded as normal rather than exceptional. For further details see The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: Annex E, page 673.. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 20, page 56. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.18, page 14. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 20, page 71.

Represents the "SubFilter" entry of the encryption dictionary object. It is an optional entry defined as part of the PDF 1.3 specification. It contains a string representing a PDF name object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 20, page 56. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.18, page 14. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 20, page 71.

Represents the "V" entry of the encryption dictionary object. It is defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 20, page 56. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.18, page 14. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 20, page 72.

Represents the "Length" entry of the encryption dictionary object. It is an optional entry defined as part of the PDF 1.4 specification. It was deprecated in PDF 2.0. It contains an integer representing a PDF numeric object. The PDF specification states that this item assumes a value of 40 if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 20, page 56. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.18, page 14. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 20, page 72.

Represents the "CF" entry of the encryption dictionary object. It is an optional entry defined as part of the PDF 1.5 specification. It contains an Element. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 20, page 56. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.18, page 14. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 20, page 72.

Represents the "StmF" entry of the encryption dictionary object. It is an optional entry defined as part of the PDF 1.5 specification. It contains a string representing a PDF name object. The PDF specification states that this item assumes a value of "Identity" if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 20, page 56. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.18, page 14. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 20, page 72.

Represents the "StrF" entry of the encryption dictionary object. It is an optional entry defined as part of the PDF 1.5 specification. It contains a string representing a PDF name object. The PDF specification states that this item assumes a value of "Identity" if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 20, page 57. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.18, page 14. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 20, page 72.

Represents the "EFF" entry of the encryption dictionary object. It is an optional entry defined as part of the PDF 1.6 specification. It contains a string representing a PDF name object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 20, page 57. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.18, page 14. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 20, page 73.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the extensions dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 48, page 140. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.25a, page 24.

Create an empty ExtensionsElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a ExtensionsElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a ExtensionsElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new ExtensionsElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the extensions dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. If provided, this item must always take the value "Extensions". For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.25a, page 24. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 48, page 140.

Represents the "ADBE" entry of the extensions dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a DeveloperExtensionsElement. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.25a, page 24. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 48, page 140.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the file specification dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; page 97. This class is always an indirect object because RichMediaActivationElement.EntryScripts, RichMediaInstanceElement.EntryAsset and StructureTreeRootElement.EntryPronunciationLexicon require it to be so.

Create an empty FileSpecificationElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a FileSpecificationElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a FileSpecificationElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new FileSpecificationElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the file trailer dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 15, page 43. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 15, page 57.

Create an empty FileTrailerElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a FileTrailerElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a FileTrailerElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new FileTrailerElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Size" entry of the file trailer dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 15, page 43. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 15, page 57.

Represents the "Prev" entry of the file trailer dictionary object. It is defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 15, page 43. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 15, page 57.

Represents the "Root" entry of the file trailer dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a CatalogElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 15, page 43. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 15, page 57.

Represents the "Encrypt" entry of the file trailer dictionary object. It is defined as part of the PDF 1.1 specification. It contains an EncryptionElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 15, page 43. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 15, page 57.

Represents the "Info" entry of the file trailer dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a DocumentInformationElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 15, page 43. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 15, page 57.

Represents the "ID" entry of the file trailer dictionary object. It is defined as part of the PDF 1.1 specification. It contains an array which contains strings, representing PDF string objects. This string contains raw byte data. So it looks like a string but really it is just a wrapper for data. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 15, page 43. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 15, page 58.

Represents the "XRefStm" entry of the file trailer dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 15, page 43. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 15, page 57.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the flate parameters. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 8, page 27. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 8, page 40.

Create an empty FlateParametersElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a FlateParametersElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a FlateParametersElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new FlateParametersElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Predictor" entry of the flate parameters object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. The PDF specification states that this item assumes a value of 1 if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 8, page 27. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 8, page 40.

Represents the "Colors" entry of the flate parameters object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. The PDF specification states that this item assumes a value of 1 if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 8, page 27. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 8, page 40.

Represents the "BitsPerComponent" entry of the flate parameters object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. The PDF specification states that this item assumes a value of 8 if no value has been provided. This item may take one of the following valid values: 124816 For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 8, page 28. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 8, page 40.

Represents the "Columns" entry of the flate parameters object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. The PDF specification states that this item assumes a value of 1 if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 8, page 28. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 8, page 40.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the full file specification dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 44, page 102. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 43, page 132. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.41, page 26. This class is always an indirect object because it inherits from FileSpecificationElement which is always an indirect object.

Create an empty FullFileSpecificationElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a FullFileSpecificationElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a FullFileSpecificationElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new FullFileSpecificationElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the full file specification dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. If provided, this item must always take the value "Filespec". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 44, page 102. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.41, page 26. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 43, page 132.

Represents the "FS" entry of the full file specification dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. The specification defines this as exensible which means that it may contain entries in addition to those defined in the specification. In fact almost all objects are extensible but the fact that it is explicitly mentioned, implies that extra entries should be regarded as normal rather than exceptional. For further details see The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: Annex E, page 673.. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 44, page 102. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.41, page 26. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 43, page 132.

Represents the "F" entry of the full file specification dictionary object. It is defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 44, page 102. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.41, page 26. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 43, page 133.

Represents the "UF" entry of the full file specification dictionary object. It is defined as part of the PDF 1.7 specification. It contains a string representing a PDF string object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 44, page 102. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.41, page 26. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 43, page 133.

Represents the "DOS" entry of the full file specification dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It was marked obsolescent in PDF 1.7 and deprecated in PDF 2.0. It contains a string representing a PDF string object. This string contains raw byte data. So it looks like a string but really it is just a wrapper for data. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 44, page 102. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.41, page 26. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 43, page 133.

Represents the "Mac" entry of the full file specification dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It was marked obsolescent in PDF 1.7 and deprecated in PDF 2.0. It contains a string representing a PDF string object. This string contains raw byte data. So it looks like a string but really it is just a wrapper for data. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 44, page 102. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.41, page 26. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 43, page 133.

Represents the "Unix" entry of the full file specification dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It was marked obsolescent in PDF 1.7 and deprecated in PDF 2.0. It contains a string representing a PDF string object. This string contains raw byte data. So it looks like a string but really it is just a wrapper for data. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 44, page 102. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.41, page 26. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 43, page 133.

Represents the "ID" entry of the full file specification dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains strings, representing PDF string objects. This string contains raw byte data. So it looks like a string but really it is just a wrapper for data. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 44, page 103. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.41, page 26. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 43, page 133.

Represents the "V" entry of the full file specification dictionary object. It is an optional entry defined as part of the PDF 1.2 specification. It contains a bool representing a PDF boolean object. The PDF specification states that this item assumes a value of false if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 44, page 103. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.41, page 26. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 43, page 133.

Represents the "EF" entry of the full file specification dictionary object. It is defined as part of the PDF 1.3 specification. It contains an EmbeddedFileSetElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 44, page 103. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.41, page 26. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 43, page 134.

Represents the "RF" entry of the full file specification dictionary object. It is an optional entry defined as part of the PDF 1.3 specification. It contains a RelatedFileSetElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 44, page 103. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.41, page 26. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 43, page 134.

Represents the "Desc" entry of the full file specification dictionary object. It is an optional entry defined as part of the PDF 1.6 specification. It contains a string representing a PDF string object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 44, page 103. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.41, page 26. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 43, page 134.

Represents the "CI" entry of the full file specification dictionary object. It is an optional entry defined as part of the PDF 1.7 specification. It contains a CollectionItemElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 44, page 103. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.41, page 26. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 43, page 134.

Represents the "Thumb" entry of the full file specification dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains an ImageXObjectElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 44, page 102. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.41, page 26. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 43, page 134.

Represents the "EP" entry of the full file specification dictionary object. It is defined as part of the PDF 2.0 specification. It contains an EncryptedPayloadElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 44, page 102. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.41, page 26. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 43, page 134.

Represents the "AFRelationship" entry of the full file specification dictionary object. It is an optional entry defined as part of the PDF 2.0 specification. It contains a string representing a PDF name object. The PDF specification states that this item assumes a value of "Unspecified" if no value has been provided. This item may take one of the following valid values: DataAlternativeSupplementEncryptedPayloadFormDataSchemaUnspecified The specification defines this as exensible which means that it may contain entries in addition to those defined in the specification. In fact almost all objects are extensible but the fact that it is explicitly mentioned, implies that extra entries should be regarded as normal rather than exceptional. For further details see The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: Annex E, page 673.. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 44, page 102. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.41, page 26. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 43, page 135.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the function dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 38, page 93. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 38, page 122.

Create an empty FunctionElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a FunctionElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a FunctionElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new FunctionElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "FunctionType" entry of the function dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 38, page 93. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 38, page 122.

Represents the "Domain" entry of the function dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains an array which contains doubles, representing PDF numeric objects. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 38, page 93. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 38, page 123.

Represents the "Range" entry of the function dictionary object. It is defined as part of the PDF 1.0 specification. It contains an array which contains doubles, representing PDF numeric objects. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 38, page 93. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 38, page 123.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the jbig2 parameters. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 12, page 32. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 12, page 46.

Create an empty Jbig2ParametersElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a Jbig2ParametersElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a Jbig2ParametersElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new Jbig2ParametersElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "JBIG2Globals" entry of the jbig2 parameters object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a StreamElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 12, page 32. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 12, page 46.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the lzw parameters. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 8, page 27. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 8, page 40.

Create an empty LzwParametersElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a LzwParametersElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a LzwParametersElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new LzwParametersElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Predictor" entry of the lzw parameters object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. The PDF specification states that this item assumes a value of 1 if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 8, page 27. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 8, page 40.

Represents the "Colors" entry of the lzw parameters object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. It should have a minimum value of 1. The PDF specification states that this item assumes a value of 1 if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 8, page 27. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 8, page 40.

Represents the "BitsPerComponent" entry of the lzw parameters object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. The PDF specification states that this item assumes a value of 8 if no value has been provided. This item may take one of the following valid values: 124816 For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 8, page 28. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 8, page 40.

Represents the "Columns" entry of the lzw parameters object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. The PDF specification states that this item assumes a value of 1 if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 8, page 28. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 8, page 40.

Represents the "EarlyChange" entry of the lzw parameters object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. The PDF specification states that this item assumes a value of 1 if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 8, page 28. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 8, page 40.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the mac os file information dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 47, page 105.

Create an empty MacOSFileInformationElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a MacOSFileInformationElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a MacOSFileInformationElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new MacOSFileInformationElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Subtype" entry of the mac os file information dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 47, page 105.

Represents the "Creator" entry of the mac os file information dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 47, page 105.

Represents the "ResFork" entry of the mac os file information dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a StreamElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 47, page 105.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the name dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 31, page 80. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 32, page 108. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.28, page 23.

Create an empty NameDictionaryElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a NameDictionaryElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a NameDictionaryElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new NameDictionaryElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Dests" entry of the name dictionary object. It is an optional entry defined as part of the PDF 1.2 specification. It contains a NameTreeNodeElement containing Elements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 31, page 80. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.28, page 23. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 32, page 108.

Represents the "AP" entry of the name dictionary object. It is an optional entry defined as part of the PDF 1.3 specification. It contains a NameTreeNodeElement containing FormXObjectElements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 31, page 80. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.28, page 23. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 32, page 108.

Represents the "JavaScript" entry of the name dictionary object. It is an optional entry defined as part of the PDF 1.3 specification. It contains a NameTreeNodeElement containing JavaScriptActionElements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 31, page 81. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.28, page 23. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 32, page 108.

Represents the "Pages" entry of the name dictionary object. It is an optional entry defined as part of the PDF 1.3 specification. It contains a NameTreeNodeElement containing PageObjectElements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 31, page 81. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.28, page 23. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 32, page 108.

Represents the "Templates" entry of the name dictionary object. It is an optional entry defined as part of the PDF 1.3 specification. It contains a NameTreeNodeElement containing PageObjectElements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 31, page 81. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.28, page 23. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 32, page 108.

Represents the "IDS" entry of the name dictionary object. It is an optional entry defined as part of the PDF 1.3 specification. It contains a NameTreeNodeElement containing WebCaptureContentSetElements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 31, page 81. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.28, page 23. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 32, page 108.

Represents the "URLS" entry of the name dictionary object. It is an optional entry defined as part of the PDF 1.3 specification. It contains a NameTreeNodeElement containing WebCaptureContentSetElements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 31, page 81. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.28, page 23. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 32, page 108.

Represents the "EmbeddedFiles" entry of the name dictionary object. It is an optional entry defined as part of the PDF 1.4 specification. It contains a NameTreeNodeElement containing FileSpecificationElements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 31, page 81. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.28, page 23. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 32, page 109.

Represents the "AlternatePresentations" entry of the name dictionary object. It is an optional entry defined as part of the PDF 1.4 specification. It was deprecated in PDF 2.0. It contains a NameTreeNodeElement containing SlideshowElements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 31, page 81. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.28, page 23. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 32, page 109.

Represents the "Renditions" entry of the name dictionary object. It is an optional entry defined as part of the PDF 1.5 specification. It contains a NameTreeNodeElement containing RenditionElements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 31, page 81. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.28, page 23. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 32, page 109.

Represents the "XFAResources" entry of the name dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a NameTreeNodeElement containing StreamElements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 31, page 80. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.28, page 23. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 32, page 108.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the object stream dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 16, page 46. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 16, page 61. This class is always an indirect object because it is also a StreamElement and these are always indirect objects.

Create an empty ObjectStreamElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a ObjectStreamElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a ObjectStreamElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new ObjectStreamElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

The StreamElement associated with this class.

Represents the "Type" entry of the object stream dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. This item must always be provided and must always take the value "ObjStm". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 16, page 46. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 16, page 61.

Represents the "N" entry of the object stream dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 16, page 46. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 16, page 61.

Represents the "First" entry of the object stream dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 16, page 46. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 16, page 61.

Represents the "Extends" entry of the object stream dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an ObjectStreamElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 16, page 46. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 16, page 61.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the page object. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 30, page 77. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 31, page 103. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.27, page 23. This class is always an indirect object because AnnotationElement.EntryP, BeadElement.EntryP, DpartElement.EntryEnd, DpartElement.EntryStart, MarkedContentReferenceElement.EntryPg, ObjectReferenceElement.EntryPg, PageTreeNodeElement.EntryKids, SeparationElement.EntryPages, StructureElementElement.EntryPg and StructureTreeRootElement.EntryParentTree require it to be so.

Create an empty PageObjectElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a PageObjectElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a PageObjectElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new PageObjectElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the page object object. It is a required entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. This item must always be provided and must always take the value "Page". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 30, page 77. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.27, page 23. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 31, page 103.

Represents the "Parent" entry of the page object object. It is a required entry defined as part of the PDF 1.0 specification. It contains a PageTreeNodeElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 30, page 77. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.27, page 23. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 31, page 103.

Represents the "LastModified" entry of the page object object. It is defined as part of the PDF 1.3 specification. It contains a string representing a PDF string object. This is encoded as a date string. For details see the StringAtom.DateToString and StringAtom.StringToDate functions. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 30, page 77. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.27, page 23. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 31, page 103.

Represents the "Resources" entry of the page object object. It is a required entry defined as part of the PDF 1.0 specification. It contains a ResourceElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 30, page 77. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.27, page 23. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 31, page 103.

Represents the "MediaBox" entry of the page object object. It is a required entry defined as part of the PDF 1.0 specification. It contains a RectangleElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 30, page 77. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.27, page 23. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 31, page 103.

Represents the "CropBox" entry of the page object object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a RectangleElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 30, page 77. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.27, page 23. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 31, page 103.

Represents the "BleedBox" entry of the page object object. It is an optional entry defined as part of the PDF 1.3 specification. It contains a RectangleElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 30, page 77. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.27, page 23. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 31, page 104.

Represents the "TrimBox" entry of the page object object. It is an optional entry defined as part of the PDF 1.3 specification. It contains a RectangleElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 30, page 77. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.27, page 23. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 31, page 104.

Represents the "ArtBox" entry of the page object object. It is an optional entry defined as part of the PDF 1.3 specification. It contains a RectangleElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 30, page 77. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.27, page 23. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 31, page 104.

Represents the "BoxColorInfo" entry of the page object object. It is an optional entry defined as part of the PDF 1.4 specification. It contains a BoxColorInformationElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 30, page 77. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.27, page 23. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 31, page 104.

Represents the "Contents" entry of the page object object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains StreamElements. If you read the specification you will see that an array of one StreamElement may be represented as a single StreamElement rather than an array. However we always present this property as an array to simplify the interface. It is only if you add or remove items in the array, that the underlying representation will be changed. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 30, page 78. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.27, page 23. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 31, page 104.

Represents the "Rotate" entry of the page object object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. The PDF specification states that this item assumes a value of 0 if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 30, page 78. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.27, page 23. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 31, page 104.

Represents the "Group" entry of the page object object. It is an optional entry defined as part of the PDF 1.4 specification. It contains a GroupAttributesElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 30, page 78. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.27, page 23. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 31, page 104.

Represents the "Thumb" entry of the page object object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an ImageXObjectElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 30, page 78. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.27, page 23. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 31, page 104.

Represents the "B" entry of the page object object. It is an optional entry defined as part of the PDF 1.1 specification. It contains an array which contains BeadElements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 30, page 78. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.27, page 23. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 31, page 105.

Represents the "Dur" entry of the page object object. It is an optional entry defined as part of the PDF 1.1 specification. It contains a double representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 30, page 78. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.27, page 23. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 31, page 105.

Represents the "Trans" entry of the page object object. It is an optional entry defined as part of the PDF 1.1 specification. It contains a TransitionElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 30, page 78. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.27, page 23. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 31, page 105.

Represents the "Annots" entry of the page object object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains AnnotationElements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 30, page 78. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.27, page 23. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 31, page 105.

Represents the "AA" entry of the page object object. It is an optional entry defined as part of the PDF 1.2 specification. It contains a PageObjectAdditionalActionsElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 30, page 78. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.27, page 23. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 31, page 105.

Represents the "PieceInfo" entry of the page object object. It is an optional entry defined as part of the PDF 1.3 specification. It contains an Element. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 30, page 78. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.27, page 23. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 31, page 105.

Represents the "StructParents" entry of the page object object. It is defined as part of the PDF 1.3 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 30, page 79. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.27, page 23. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 31, page 105.

Represents the "ID" entry of the page object object. It is an optional entry defined as part of the PDF 1.3 specification. It contains a string representing a PDF string object. This string contains raw byte data. So it looks like a string but really it is just a wrapper for data. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 30, page 79. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.27, page 23. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 31, page 105.

Represents the "PZ" entry of the page object object. It is an optional entry defined as part of the PDF 1.3 specification. It contains a double representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 30, page 79. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.27, page 23. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 31, page 105.

Represents the "SeparationInfo" entry of the page object object. It is an optional entry defined as part of the PDF 1.3 specification. It contains a SeparationElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 30, page 79. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.27, page 23. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 31, page 105.

Represents the "Tabs" entry of the page object object. It is an optional entry defined as part of the PDF 1.5 specification. It contains a string representing a PDF name object. This item may take one of the following valid values: RCSAW For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 30, page 79. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.27, page 23. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 31, page 106.

Represents the "TemplateInstantiated" entry of the page object object. It is defined as part of the PDF 1.5 specification. It contains a string representing a PDF name object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 30, page 79. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.27, page 23. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 31, page 106.

Represents the "PresSteps" entry of the page object object. It is an optional entry defined as part of the PDF 1.5 specification. It contains a NavigationNodeElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 30, page 79. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.27, page 23. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 31, page 106.

Represents the "UserUnit" entry of the page object object. It is an optional entry defined as part of the PDF 1.6 specification. It contains a double representing a PDF numeric object. It should have a positive value. The PDF specification states that this item assumes a value of 1 if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 30, page 79. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.27, page 23. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 31, page 106.

Represents the "VP" entry of the page object object. It is an optional entry defined as part of the PDF 1.6 specification. It contains an array which contains ViewportElements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 30, page 79. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.27, page 23. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 31, page 106.

Represents the "AF" entry of the page object object. It is an optional entry defined as part of the PDF 2.0 specification. It contains an array which contains FileSpecificationElements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 30, page 77. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.27, page 23. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 31, page 106.

Represents the "OutputIntents" entry of the page object object. It is an optional entry defined as part of the PDF 2.0 specification. It contains an array which contains OutputIntentElements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 30, page 77. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.27, page 23. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 31, page 106.

Represents the "DPart" entry of the page object object. It is defined as part of the PDF 2.0 specification. It contains a DocumentPartElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 30, page 77. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.27, page 23. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 31, page 106.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the page tree node. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 29, page 76. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 30, page 102. This class is always an indirect object because CatalogElement.EntryPages, PageObjectElement.EntryParent, PageTreeNodeElement.EntryKids and PageTreeNodeElement.EntryParent require it to be so.

Create an empty PageTreeNodeElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a PageTreeNodeElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a PageTreeNodeElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new PageTreeNodeElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the page tree node object. It is a required entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. This item must always be provided and must always take the value "Pages". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 29, page 76. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 30, page 102.

Represents the "Parent" entry of the page tree node object. It is defined as part of the PDF 1.0 specification. It contains a PageTreeNodeElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 29, page 76. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 30, page 102.

Represents the "Kids" entry of the page tree node object. It is a required entry defined as part of the PDF 1.0 specification. It contains an array which contains PageTreeNodeElements or PageObjectElements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 29, page 76. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 30, page 102.

Represents the "Count" entry of the page tree node object. It is a required entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 29, page 76. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 30, page 102.

Represents the "Resources" entry of the page tree node object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a ResourceElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 29, page 76. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 30, page 102.

Represents the "MediaBox" entry of the page tree node object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a RectangleElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 29, page 76. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 30, page 102.

Represents the "CropBox" entry of the page tree node object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a RectangleElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 29, page 76. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 30, page 102.

Represents the "Rotate" entry of the page tree node object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. The PDF specification states that this item assumes a value of 0 if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 29, page 76. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 30, page 102.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the parameter dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; page 22.

Create an empty ParameterElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a ParameterElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a ParameterElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new ParameterElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the public-key security handler crypt filter. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 27, page 69. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 27, page 91.

Create an empty PublicKeyCryptFilterElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a PublicKeyCryptFilterElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a PublicKeyCryptFilterElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new PublicKeyCryptFilterElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Recipients" entry of the public-key security handler crypt filter object. It is a required entry defined as part of the PDF 1.0 specification. It contains an array which contains strings, representing PDF string objects. If you read the specification you will see that an array of one string may be represented as a single string rather than an array. However we always present this property as an array to simplify the interface. It is only if you add or remove items in the array, that the underlying representation will be changed. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 27, page 69. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 27, page 91.

Represents the "EncryptMetadata" entry of the public-key security handler crypt filter object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a bool representing a PDF boolean object. The PDF specification states that this item assumes a value of true if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 27, page 69. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 27, page 92.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the public-key security handler encryption dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 23, page 65. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 23, page 86.

Create an empty PublicKeyEncryptionElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a PublicKeyEncryptionElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a PublicKeyEncryptionElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new PublicKeyEncryptionElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Recipients" entry of the public-key security handler encryption dictionary object. It is defined as part of the PDF 1.3 specification. It contains an array which contains strings, representing PDF string objects. This string contains raw byte data. So it looks like a string but really it is just a wrapper for data. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 23, page 65. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 23, page 86.

Represents the "P" entry of the public-key security handler encryption dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 23, page 65. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 23, page 86.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the related file set dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; page 103.

Create an empty RelatedFileSetElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a RelatedFileSetElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a RelatedFileSetElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new RelatedFileSetElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "F" entry of the related file set dictionary object. It is an optional entry defined as part of the PDF 1.3 specification. It contains an array which contains Elements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; page 103.

Represents the "UF" entry of the related file set dictionary object. It is an optional entry defined as part of the PDF 1.7 specification. It contains an array which contains Elements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; page 103.

Represents the "DOS" entry of the related file set dictionary object. It is an optional entry defined as part of the PDF 1.3 specification. It was marked obsolescent in PDF 1.7 and deprecated in PDF 2.0. It contains an array which contains Elements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; page 103.

Represents the "Mac" entry of the related file set dictionary object. It is an optional entry defined as part of the PDF 1.3 specification. It was marked obsolescent in PDF 1.7 and deprecated in PDF 2.0. It contains an array which contains Elements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; page 103.

Represents the "Unix" entry of the related file set dictionary object. It is an optional entry defined as part of the PDF 1.3 specification. It was marked obsolescent in PDF 1.7 and deprecated in PDF 2.0. It contains an array which contains Elements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; page 103.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the resource dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 33, page 83. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 34, page 112.

Create an empty ResourceElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a ResourceElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a ResourceElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new ResourceElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "ExtGState" entry of the resource dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an Element. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 33, page 83. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 34, page 112.

Represents the "ColorSpace" entry of the resource dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an Element. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 33, page 83. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 34, page 112.

Represents the "Pattern" entry of the resource dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an Element. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 33, page 83. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 34, page 112.

Represents the "Shading" entry of the resource dictionary object. It is an optional entry defined as part of the PDF 1.3 specification. It contains an Element. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 33, page 83. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 34, page 112.

Represents the "XObject" entry of the resource dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an Element. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 33, page 83. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 34, page 112.

Represents the "Font" entry of the resource dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an Element. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 33, page 83. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 34, page 112.

Represents the "ProcSet" entry of the resource dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It was deprecated in PDF 2.0. It contains an array which contains strings, representing PDF name objects. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 33, page 83. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 34, page 112.

Represents the "Properties" entry of the resource dictionary object. It is an optional entry defined as part of the PDF 1.2 specification. It contains an Element. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 33, page 84. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 34, page 112.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the standard security handler encryption dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 21, page 60. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 21, page 77. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.19, page 16.

Create an empty StandardEncryptionElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a StandardEncryptionElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a StandardEncryptionElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new StandardEncryptionElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "R" entry of the standard security handler encryption dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. This item may take one of the following valid values: 2345 For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 21, page 60. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.19, page 16. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 21, page 77.

Represents the "O" entry of the standard security handler encryption dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 21, page 60. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.19, page 16. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 21, page 77.

Represents the "U" entry of the standard security handler encryption dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 21, page 60. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.19, page 16. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 21, page 77.

Represents the "OE" entry of the standard security handler encryption dictionary object. It is defined as part of the PDF 1.7 Extension Level 3 specification. It contains a string representing a PDF string object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 21, page 60. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.19, page 16. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 21, page 77.

Represents the "UE" entry of the standard security handler encryption dictionary object. It is defined as part of the PDF 1.7 Extension Level 3 specification. It contains a string representing a PDF string object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 21, page 60. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.19, page 16. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 21, page 77.

Represents the "P" entry of the standard security handler encryption dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 21, page 60. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.19, page 16. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 21, page 77.

Represents the "Perms" entry of the standard security handler encryption dictionary object. It is defined as part of the PDF 1.7 Extension Level 3 specification. It contains a string representing a PDF string object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 21, page 60. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.19, page 16. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 21, page 77.

Represents the "EncryptMetadata" entry of the standard security handler encryption dictionary object. It is an optional entry defined as part of the PDF 1.5 specification. It contains a bool representing a PDF boolean object. The PDF specification states that this item assumes a value of true if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 21, page 60. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 3.19, page 16. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 21, page 77.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the stream. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 5, page 20. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 5, page 32. This class is always an indirect object because it is also a StreamElement and these are always indirect objects.

Create an empty StreamElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a StreamElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a StreamElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new StreamElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Length" entry of the stream object. It is a required entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. It describes the number of bytes of data in the stream. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 5, page 20. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 5, page 32.

Represents the "Filter" entry of the stream object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains strings, representing PDF name objects. Items in this array may take one of the following valid values: ASCIIHexDecodeASCII85DecodeLZWDecodeFlateDecodeRunLengthDecodeCCITTFaxDecodeJBIG2DecodeDCTDecodeJPXDecodeCrypt If you read the specification you will see that an array of one string may be represented as a single string rather than an array. However we always present this property as an array to simplify the interface. It is only if you add or remove items in the array, that the underlying representation will be changed. The array controls decompression settings. Each item in the array represents a filter, a compression type, applied to the data in the stream. Mutiple filters can be applied to chain compression types. For example you might wish to apply first Flate compression and then ASCII85 encoding. As new filters are applied to the data, the names are added at the start of the array. So the array represents the order required to decode For example if you applied Flate and then ASCII85 encoding, the first item would be ASCII85Decode and the second FlateDecode. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 5, page 20. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 5, page 32.

Represents the "DecodeParms" entry of the stream object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains ParameterElements. If you read the specification you will see that an array of one ParameterElement may be represented as a single ParameterElement rather than an array. However we always present this property as an array to simplify the interface. It is only if you add or remove items in the array, that the underlying representation will be changed. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 5, page 20. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 5, page 32.

Represents the "F" entry of the stream object. It is an optional entry defined as part of the PDF 1.2 specification. It contains a FileSpecificationElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 5, page 20. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 5, page 32.

Represents the "FFilter" entry of the stream object. It is an optional entry defined as part of the PDF 1.2 specification. It contains an array which contains strings, representing PDF name objects. Items in this array may take one of the following valid values: ASCIIHexDecodeASCII85DecodeLZWDecodeFlateDecodeRunLengthDecodeCCITTFaxDecodeJBIG2DecodeDCTDecodeJPXDecodeCrypt If you read the specification you will see that an array of one string may be represented as a single string rather than an array. However we always present this property as an array to simplify the interface. It is only if you add or remove items in the array, that the underlying representation will be changed. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 5, page 20. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 5, page 32.

Represents the "FDecodeParms" entry of the stream object. It is an optional entry defined as part of the PDF 1.2 specification. It contains an array which contains ParameterElements. If you read the specification you will see that an array of one ParameterElement may be represented as a single ParameterElement rather than an array. However we always present this property as an array to simplify the interface. It is only if you add or remove items in the array, that the underlying representation will be changed. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 5, page 20. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 5, page 32.

Represents the "DL" entry of the stream object. It is an optional entry defined as part of the PDF 1.5 specification. It contains an integer representing a PDF numeric object. It should have a minimum value of 0. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 5, page 21. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 5, page 32.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the type 0 function dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 39, page 94. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 39, page 124. This class is always an indirect object because it is also a StreamElement and these are always indirect objects.

Create an empty Type0FunctionElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a Type0FunctionElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a Type0FunctionElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new Type0FunctionElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

The StreamElement associated with this class.

Represents the "Size" entry of the type 0 function dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains an array which contains integers, representing PDF numeric objects. Items in this array should have a minimum value of 1. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 39, page 94. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 39, page 124.

Represents the "BitsPerSample" entry of the type 0 function dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 39, page 94. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 39, page 124.

Represents the "Order" entry of the type 0 function dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. It should have a minimum value of 1 and a maximum of 3. The PDF specification states that this item assumes a value of 1 if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 39, page 94. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 39, page 124.

Represents the "Encode" entry of the type 0 function dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains doubles, representing PDF numeric objects. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 39, page 94. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 39, page 124.

Represents the "Decode" entry of the type 0 function dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains doubles, representing PDF numeric objects. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 39, page 94. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 39, page 124.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the type 2 function dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 40, page 96. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 40, page 126.

Create an empty Type2FunctionElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a Type2FunctionElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a Type2FunctionElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new Type2FunctionElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "C0" entry of the type 2 function dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains doubles, representing PDF numeric objects. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 40, page 96. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 40, page 126.

Represents the "C1" entry of the type 2 function dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains doubles, representing PDF numeric objects. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 40, page 96. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 40, page 126.

Represents the "N" entry of the type 2 function dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a double representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 40, page 96. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 40, page 126.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the type 3 function dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 41, page 97. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 41, page 127.

Create an empty Type3FunctionElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a Type3FunctionElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a Type3FunctionElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new Type3FunctionElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Functions" entry of the type 3 function dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains an array which contains FunctionElements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 41, page 97. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 41, page 127.

Represents the "Bounds" entry of the type 3 function dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains an array which contains doubles, representing PDF numeric objects. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 41, page 97. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 41, page 127.

Represents the "Encode" entry of the type 3 function dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains an array which contains doubles, representing PDF numeric objects. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 41, page 97. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 41, page 127.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the type 4 function dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; page 97. This class is always an indirect object because it is also a StreamElement and these are always indirect objects.

Create an empty Type4FunctionElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a Type4FunctionElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a Type4FunctionElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new Type4FunctionElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

The StreamElement associated with this class.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the calibrated gray color space. Calibrated color spaces specify values which are device independent and more akin to the way we perceive colors. The result is that, within the limits of an output device, calibrated colors will appear the same even when displayed on different devices. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 63, page 145.

Create an empty CalGrayColorSpaceElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an Atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a CalGrayColorSpaceElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a CalGrayColorSpaceElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a CalGrayColorSpaceElement containing a new Atom. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the indirect parameter is true, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

This property represents the parameters that characterize this device independent color space. It is defined as part of the PDF 1.1 specification. A CalGrayColorSpaceAttributesElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; page 145.

This class represents the calibrated RGB color space. Calibrated color spaces specify values which are device independent and more akin to the way we perceive colors. The result is that, within the limits of an ouput device, calibrated colors will appear the same even when displayed on different devices. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 64, page 146.

Create an empty CalRGBColorSpaceElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an Atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a CalRGBColorSpaceElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a CalRGBColorSpaceElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a CalRGBColorSpaceElement containing a new Atom. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the indirect parameter is true, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

This property represents the parameters that characterize this device independent color space. It is defined as part of the PDF 1.0 specification. A CalRGBColorSpaceAttributesElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; page 146.

This class represents a color space. Sub-classes represent different types of color spaces. Internally within a PDF document color spaces are represented as an array of values with the first element being the type of color space. However as a shorthand, if there is only one element in the array, the name can be used without an enclosing array. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 62, page 139.

Create an empty ColorSpaceElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an Atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a ColorSpaceElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a ColorSpaceElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a ColorSpaceElement containing a new Atom. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the indirect parameter is true, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

This property represents the type of color space. It is a property of type ColorSpaceType.

This class represents a device color space. Device color spaces represent generic grayscale, RGB or CMYK outputs. These types of color spaces represent physical quanties. So a grayscale value represents a literal amount of black ink on paper. Because no color profile information is contained, device colors may vary between different outputs. For example 50% copverage of one type of black ink on gloss paper may look different to 50% of another black ink on matte. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Section 8.6.4: 62, page 124.

Create an empty DeviceColorSpaceElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an Atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a DeviceColorSpaceElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a DeviceColorSpaceElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a DeviceColorSpaceElement containing a new Atom. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the indirect parameter is true, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

This class represents a DeviceN or multi-separation color space. A DeviceN color space represents a set of custom colors. Most typically these are spot colors used in printing. For example the conventional color space for printing is CMYK and for that you can use the DeviceCMYK color space. However processes like Hexachrome added orange and green inks to better represent a wider range of colors. Using a DeviceN color space you can specify a CMYKOG color space which will print correctly on a Hexachrome printer. The DeviceN color space includes a conversion function so that it will also provide a good representation on screen and on normal CMYK printers. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Section: 8.6.6.5, page 159.

Create an empty DeviceNColorSpaceElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an Atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a DeviceNColorSpaceElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a DeviceNColorSpaceElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a DeviceNColorSpaceElement containing a new Atom. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the indirect parameter is true, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

This property represents the names of the colors within the DeviceN color space. The names are arbitrary values such as "Seabreeze" which are intended for human readability. These may include the special value "None" which indicates no color, but may not include the special value "All". Each name should be unique, with the exception of the special value "None" which may be repeated. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; page 160.

This property represents the alternate color space for this DeviceN color space. A ColorSpaceElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; page 160.

This property represents the tint transform function. The function is used to map color values in the DeviceN color space into color values in the EntryAlternateColorSpace color space. The function should be called with the tint value and should return a number of components in the alternate color space. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; page 160.

This property represents addition attributes specific to this color space. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; page 160.

This class represents an ICC calibrated color space. Calibrated color spaces specify values which are device independent and more akin to the way we perceive colors. The result is that, within the limits of an output device, calibrated colors will appear the same even when displayed on different devices. The International Color Consortium (ICC) defines standards for cross-platform, standardized, calibrated color spaces. ICC color spaces encompass a wide range of color spaces with characteristics contained in a color profile data package. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 66, page 149.

Create an empty ICCBasedColorSpaceElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an Atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a ICCBasedColorSpaceElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a ICCBasedColorSpaceElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a ICCBasedColorSpaceElement containing a new Atom. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the indirect parameter is true, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

This property represents the parameters that characterize this device independent color space. It is defined as part of the PDF 1.3 specification. A ICCBasedColorSpaceAttributesElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; page 148.

This class represents an indexed color space. Indexed color spaces represent a set of colors from a palette. Each color is identified using an index into the palette. The palette itself needs to be defined in terms of another color space such as DeviceRGB or DeviceCMYK. So in many ways an indexed color space is a meta color space. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Section: 8.6.6.3, page 156.

Create an empty IndexedColorSpaceElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an Atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a IndexedColorSpaceElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a IndexedColorSpaceElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a IndexedColorSpaceElement containing a new Atom. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the indirect parameter is true, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

This property represents the underlying color space for this Indexed color space. It is defined as part of the PDF 1.0 specification. A ColorSpaceElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; page 156.

This property represents the highest number used to index into the palette. It is defined as part of the PDF 1.0 specification. An positive integer no higher than 255. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; page 156.

This property represents the lookup table for the palette. The lookup may be represented as a StreamElement or (in PDF 1.2) a byte string. The table shall contain a number of colors one higher than the EntryHiVal. Each color shall contain a number of byes equal to the number of components in the EntryBaseColorSpace. Each byte represents an intensity of color from 0 to 255 - 0% to 100% respectively. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; page 156.

This class represents the Lab color space - a CIE based calibrated space. Calibrated color spaces specify values which are device independent and more akin to the way we perceive colors. The result is that, within the limits of an output device, calibrated colors will appear the same even when displayed on different devices. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 65, page 148.

Create an empty LabColorSpaceElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an Atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a LabColorSpaceElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a LabColorSpaceElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a LabColorSpaceElement containing a new Atom. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the indirect parameter is true, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

This property represents the parameters that characterize this device independent color space. It is defined as part of the PDF 1.0 specification. A LabColorSpaceAttributesElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; page 148.

This class represents a pattern color space. A pattern color space allows an area to be painted using a pattern of multiple colors rather than one single color. Tiling patterns allow one image to be tiled across the area that needs painting. Shading patterns allow a gradient to be painted across the area. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Section: 8.6.6.2, page 156.

Create an empty PatternColorSpaceElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an Atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a PatternColorSpaceElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a PatternColorSpaceElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a PatternColorSpaceElement containing a new Atom. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the indirect parameter is true, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

This property represents the underlying color space for this pattern. It is defined as part of the PDF 1.2 specification. A ColorSpaceElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; page 178.

This class represents a separation color space. A separation color space represents a single custom color. Most typically these are spot colors used in printing. For example the conventional color space for printing is CMYK and for that you can use the DeviceCMYK color space. However you might wish to add support for a custom ink like gold or silver which will print correctly when passed to a printer which supports this ink. The separation color space includes a conversion function so that it will also provide a good representation on screen and on normal CMYK printers. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Section: 8.6.6.4, page 157.

Create an empty SeparationColorSpaceElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an Atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a SeparationColorSpaceElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a SeparationColorSpaceElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a SeparationColorSpaceElement containing a new Atom. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the indirect parameter is true, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

This property represents the name of the separation color space. The name is an arbitrary value such as "Flame" which intended for human readability. It may also take the special values "All" or "None". The former means all available colorants on an output device while the latter means none of them. As such the value "All" will typically output rich black and the latter will output nothing. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; page 157.

This property represents the alternate color space for this Separation color space. A ColorSpaceElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; page 156.

This property represents the tint transform function. The function is used to map color values in the Separation color space into color values in the EntryAlternateColorSpace color space. The function should be called with the tint value and should return a number of components in the alternate color space. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; page 156.

This class represents the alternate image dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 91, page 212. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 89, page 261.

Create an empty AlternateImageElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a AlternateImageElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a AlternateImageElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new AlternateImageElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Image" entry of the alternate image dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains an ImageXObjectElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 91, page 212. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 89, page 261.

Represents the "DefaultForPrinting" entry of the alternate image dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a bool representing a PDF boolean object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 91, page 212. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 89, page 261.

Represents the "OC" entry of the alternate image dictionary object. It is an optional entry defined as part of the PDF 1.5 specification. It contains an OptionalContentGroupElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 91, page 212. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 89, page 261.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the calgray colour space dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 63, page 145. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 62, page 183.

Create an empty CalGrayColorSpaceAttributesElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a CalGrayColorSpaceAttributesElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a CalGrayColorSpaceAttributesElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new CalGrayColorSpaceAttributesElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "WhitePoint" entry of the calgray colour space dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains an array which contains doubles, representing PDF numeric objects. Items in this array should have a positive value. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 63, page 145. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 62, page 183.

Represents the "BlackPoint" entry of the calgray colour space dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains doubles, representing PDF numeric objects. Items in this array should have a minimum value of 0. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 63, page 145. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 62, page 183.

Represents the "Gamma" entry of the calgray colour space dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a double representing a PDF numeric object. It should have a positive value. The PDF specification states that this item assumes a value of 1 if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 63, page 145. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 62, page 183.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the calrgb colour space dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 64, page 146. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 63, page 184.

Create an empty CalRGBColorSpaceAttributesElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a CalRGBColorSpaceAttributesElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a CalRGBColorSpaceAttributesElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new CalRGBColorSpaceAttributesElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "WhitePoint" entry of the calrgb colour space dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains an array which contains doubles, representing PDF numeric objects. Items in this array should have a positive value. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 64, page 146. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 63, page 184.

Represents the "BlackPoint" entry of the calrgb colour space dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains doubles, representing PDF numeric objects. Items in this array should have a minimum value of 0. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 64, page 146. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 63, page 184.

Represents the "Gamma" entry of the calrgb colour space dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains doubles, representing PDF numeric objects. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 64, page 146. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 63, page 184.

Represents the "Matrix" entry of the calrgb colour space dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains doubles, representing PDF numeric objects. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 64, page 146. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 63, page 184.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the devicen colour space attributes dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 71, page 161. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 70, page 203.

Create an empty DeviceNColorSpaceAttributesElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a DeviceNColorSpaceAttributesElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a DeviceNColorSpaceAttributesElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new DeviceNColorSpaceAttributesElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Subtype" entry of the devicen colour space attributes dictionary object. It is an optional entry defined as part of the PDF 1.6 specification. It contains a string representing a PDF name object. The PDF specification states that this item assumes a value of "DeviceN" if no value has been provided. This item may take one of the following valid values: DeviceNNChannel For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 71, page 161. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 70, page 203.

Represents the "Colorants" entry of the devicen colour space attributes dictionary object. It is defined as part of the PDF 1.0 specification. It contains an Element. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 71, page 162. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 70, page 204.

Represents the "Process" entry of the devicen colour space attributes dictionary object. It is defined as part of the PDF 1.6 specification. It contains a DeviceNProcessElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 71, page 162. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 70, page 204.

Represents the "MixingHints" entry of the devicen colour space attributes dictionary object. It is an optional entry defined as part of the PDF 1.6 specification. It contains a DeviceNMixingHintsElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 71, page 162. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 70, page 204.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the devicen mixing hints dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 73, page 163. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 72, page 206.

Create an empty DeviceNMixingHintsElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a DeviceNMixingHintsElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a DeviceNMixingHintsElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new DeviceNMixingHintsElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Solidities" entry of the devicen mixing hints dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an Element. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 73, page 163. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 72, page 206.

Represents the "PrintingOrder" entry of the devicen mixing hints dictionary object. It is defined as part of the PDF 1.0 specification. It contains an array which contains strings, representing PDF name objects. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 73, page 163. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 72, page 206.

Represents the "DotGain" entry of the devicen mixing hints dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an Element. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 73, page 164. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 72, page 206.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the devicen process dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 72, page 163. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 71, page 205.

Create an empty DeviceNProcessElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a DeviceNProcessElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a DeviceNProcessElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new DeviceNProcessElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "ColorSpace" entry of the devicen process dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a ColorSpaceElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 72, page 163. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 71, page 205.

Represents the "Components" entry of the devicen process dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains an array which contains strings, representing PDF name objects. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 72, page 163. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 71, page 205.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the type 1 form dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 95, page 218. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 93, page 269. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 4.45, page 27. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 363, page 632. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 399, page 812. This class is always an indirect object because it is also a StreamElement and these are always indirect objects.

Create an empty FormXObjectElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a FormXObjectElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a FormXObjectElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new FormXObjectElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Subtype" entry of the type 1 form dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. This item must always be provided and must always take the value "Form". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 95, page 218. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 4.45, page 27. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 93, page 269. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 363, page 632. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 399, page 812.

Represents the "FormType" entry of the type 1 form dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. The PDF specification states that this item assumes a value of 1 if no value has been provided. If provided, this item must always take the value "1". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 95, page 218. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 4.45, page 27. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 93, page 269. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 363, page 632. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 399, page 812.

Represents the "BBox" entry of the type 1 form dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a RectangleElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 95, page 218. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 4.45, page 27. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 93, page 269. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 363, page 632. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 399, page 812.

Represents the "Matrix" entry of the type 1 form dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains doubles, representing PDF numeric objects. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 95, page 218. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 4.45, page 27. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 93, page 269. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 363, page 632. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 399, page 812.

Represents the "Resources" entry of the type 1 form dictionary object. It is defined as part of the PDF 1.2 specification. It contains a ResourceElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 95, page 218. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 4.45, page 27. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 93, page 269. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 363, page 632. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 399, page 812.

Represents the "Group" entry of the type 1 form dictionary object. It is an optional entry defined as part of the PDF 1.4 specification. It contains a GroupAttributesElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 95, page 219. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 4.45, page 27. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 93, page 269. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 363, page 632. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 399, page 812.

Represents the "Ref" entry of the type 1 form dictionary object. It is an optional entry defined as part of the PDF 1.4 specification. It contains a ReferenceElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 95, page 219. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 4.45, page 27. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 93, page 269. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 363, page 632. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 399, page 812.

Represents the "PieceInfo" entry of the type 1 form dictionary object. It is an optional entry defined as part of the PDF 1.3 specification. It contains an Element. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 95, page 219. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 4.45, page 27. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 93, page 270. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 363, page 632. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 399, page 812.

Represents the "LastModified" entry of the type 1 form dictionary object. It is defined as part of the PDF 1.3 specification. It contains a string representing a PDF string object. This is encoded as a date string. For details see the StringAtom.DateToString and StringAtom.StringToDate functions. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 95, page 219. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 4.45, page 27. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 93, page 270. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 363, page 632. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 399, page 812.

Represents the "StructParent" entry of the type 1 form dictionary object. It is defined as part of the PDF 1.3 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 95, page 219. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 4.45, page 27. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 93, page 270. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 363, page 632. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 399, page 812.

Represents the "StructParents" entry of the type 1 form dictionary object. It is defined as part of the PDF 1.3 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 95, page 219. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 4.45, page 27. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 93, page 270. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 363, page 632. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 399, page 812.

Represents the "OPI" entry of the type 1 form dictionary object. It is an optional entry defined as part of the PDF 1.2 specification. It was deprecated in PDF 2.0. It contains an OpiVersionElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 95, page 219. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 4.45, page 27. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 93, page 270. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 363, page 632. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 399, page 812.

Represents the "OC" entry of the type 1 form dictionary object. It is an optional entry defined as part of the PDF 1.5 specification. This property may contain one of two different types: 1) An OptionalContentGroupElement. 2) An OptionalContentMembershipElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 95, page 219. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 4.45, page 27. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 93, page 270. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 363, page 632. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 399, page 812.

Represents the "Name" entry of the type 1 form dictionary object. It is defined as part of the PDF 1.0 specification. It was marked obsolescent in PDF 1.7 and deprecated in PDF 2.0. It contains a string representing a PDF name object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 95, page 219. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 4.45, page 27. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 93, page 270. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 363, page 632. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 399, page 812.

Represents the "Measure" entry of the type 1 form dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a MeasureElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 95, page 218. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 4.45, page 27. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 93, page 270. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 363, page 632. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 399, page 812.

Represents the "PtData" entry of the type 1 form dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a PointDataElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 95, page 218. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 4.45, page 27. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 93, page 270. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 363, page 632. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 399, page 812.

Represents the "MarkStyle" entry of the type 1 form dictionary object. It is an optional entry defined as part of the PDF 1.4 specification. It contains a string representing a PDF string object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 95, page 218. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 4.45, page 27. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 93, page 269. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 363, page 632. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 399, page 812.

Represents the "Colorants" entry of the type 1 form dictionary object. It is an optional entry defined as part of the PDF 1.4 specification. It contains an Element. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 95, page 218. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 4.45, page 27. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 93, page 269. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 363, page 632. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 399, page 812.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the graphics state parameter dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 58, page 128. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 57, page 162.

Create an empty GraphicsStateParameterElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a GraphicsStateParameterElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a GraphicsStateParameterElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new GraphicsStateParameterElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the graphics state parameter dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. If provided, this item must always take the value "ExtGState". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 58, page 128. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 57, page 162.

Represents the "LW" entry of the graphics state parameter dictionary object. It is an optional entry defined as part of the PDF 1.3 specification. It contains a double representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 58, page 128. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 57, page 162.

Represents the "LC" entry of the graphics state parameter dictionary object. It is an optional entry defined as part of the PDF 1.3 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 58, page 128. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 57, page 162.

Represents the "LJ" entry of the graphics state parameter dictionary object. It is an optional entry defined as part of the PDF 1.3 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 58, page 128. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 57, page 162.

Represents the "ML" entry of the graphics state parameter dictionary object. It is an optional entry defined as part of the PDF 1.3 specification. It contains a double representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 58, page 128. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 57, page 162.

Represents the "D" entry of the graphics state parameter dictionary object. It is an optional entry defined as part of the PDF 1.3 specification. It contains an array which contains Elements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 58, page 128. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 57, page 162.

Represents the "RI" entry of the graphics state parameter dictionary object. It is an optional entry defined as part of the PDF 1.3 specification. It contains a string representing a PDF name object. This item may take one of the following valid values: AbsoluteColorimetricRelativeColorimetricSaturationPerceptual For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 58, page 128. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 57, page 162.

Represents the "OP" entry of the graphics state parameter dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a bool representing a PDF boolean object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 58, page 129. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 57, page 162.

Represents the "op" entry of the graphics state parameter dictionary object. It is an optional entry defined as part of the PDF 1.3 specification. It contains a bool representing a PDF boolean object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 58, page 129. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 57, page 162.

Represents the "OPM" entry of the graphics state parameter dictionary object. It is an optional entry defined as part of the PDF 1.3 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 58, page 129. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 57, page 162.

Represents the "Font" entry of the graphics state parameter dictionary object. It is an optional entry defined as part of the PDF 1.3 specification. It contains an array which contains Elements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 58, page 129. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 57, page 163.

Represents the "BG" entry of the graphics state parameter dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a FunctionElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 58, page 129. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 57, page 163.

Represents the "BG2" entry of the graphics state parameter dictionary object. It is an optional entry defined as part of the PDF 1.3 specification. This property may contain one of two different types: 1) A string representing a PDF name object. If provided, this item must always take the value "Default". 2) A FunctionElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 58, page 129. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 57, page 163.

Represents the "UCR" entry of the graphics state parameter dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a FunctionElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 58, page 129. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 57, page 163.

Represents the "UCR2" entry of the graphics state parameter dictionary object. It is an optional entry defined as part of the PDF 1.3 specification. This property may contain one of two different types: 1) A string representing a PDF name object. If provided, this item must always take the value "Default". 2) A FunctionElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 58, page 129. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 57, page 163.

Represents the "TR" entry of the graphics state parameter dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It was deprecated in PDF 2.0. This property may contain one of two different types: 1) A string representing a PDF name object. If provided, this item must always take the value "Identity". 2) An array which contains FunctionElements. If you read the specification you will see that an array of one FunctionElement may be represented as a single FunctionElement rather than an array. However we always present this property as an array to simplify the interface. It is only if you add or remove items in the array, that the underlying representation will be changed. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 58, page 129. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 57, page 163.

Represents the "TR2" entry of the graphics state parameter dictionary object. It is an optional entry defined as part of the PDF 1.3 specification. It was deprecated in PDF 2.0. This property may contain one of two different types: 1) A string representing a PDF name object. This item may take one of the following valid values: IdentityDefault 2) An array which contains FunctionElements. If you read the specification you will see that an array of one FunctionElement may be represented as a single FunctionElement rather than an array. However we always present this property as an array to simplify the interface. It is only if you add or remove items in the array, that the underlying representation will be changed. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 58, page 129. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 57, page 163.

Represents the "HT" entry of the graphics state parameter dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. This property may contain one of two different types: 1) A string representing a PDF name object. If provided, this item must always take the value "Default". 2) An HalftoneElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 58, page 129. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 57, page 163.

Represents the "FL" entry of the graphics state parameter dictionary object. It is an optional entry defined as part of the PDF 1.3 specification. It contains a double representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 58, page 129. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 57, page 163.

Represents the "SM" entry of the graphics state parameter dictionary object. It is an optional entry defined as part of the PDF 1.3 specification. It contains a double representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 58, page 129. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 57, page 163.

Represents the "SA" entry of the graphics state parameter dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a bool representing a PDF boolean object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 58, page 130. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 57, page 163.

Represents the "BM" entry of the graphics state parameter dictionary object. It is an optional entry defined as part of the PDF 1.4 specification. It contains an array which contains strings, representing PDF name objects. Items in this array may take one of the following valid values: NormalCompatibleMultiplyScreenOverlayDarkenLightenColorDodgeColorBurnHardLightSoftLightDifferenceExclusionHueSaturationColorLuminosity If you read the specification you will see that an array of one string may be represented as a single string rather than an array. However we always present this property as an array to simplify the interface. It is only if you add or remove items in the array, that the underlying representation will be changed. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 58, page 130. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 57, page 163.

Represents the "SMask" entry of the graphics state parameter dictionary object. It is an optional entry defined as part of the PDF 1.4 specification. This property may contain one of two different types: 1) A string representing a PDF name object. 2) A SoftMaskElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 58, page 130. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 57, page 164.

Represents the "CA" entry of the graphics state parameter dictionary object. It is an optional entry defined as part of the PDF 1.4 specification. It contains a double representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 58, page 130. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 57, page 164.

Represents the "ca" entry of the graphics state parameter dictionary object. It is an optional entry defined as part of the PDF 1.4 specification. It contains a double representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 58, page 130. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 57, page 164.

Represents the "AIS" entry of the graphics state parameter dictionary object. It is an optional entry defined as part of the PDF 1.4 specification. It contains a bool representing a PDF boolean object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 58, page 130. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 57, page 164.

Represents the "TK" entry of the graphics state parameter dictionary object. It is an optional entry defined as part of the PDF 1.4 specification. It contains a bool representing a PDF boolean object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 58, page 130. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 57, page 164.

Represents the "UseBlackPtComp" entry of the graphics state parameter dictionary object. It is an optional entry defined as part of the PDF 2.0 specification. It contains a string representing a PDF name object. The PDF specification states that this item assumes a value of "Default" if no value has been provided. This item may take one of the following valid values: ONOFFDefault For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 58, page 128. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 57, page 164.

Represents the "HTO" entry of the graphics state parameter dictionary object. It is an optional entry defined as part of the PDF 2.0 specification. It contains an array which contains doubles, representing PDF numeric objects. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 58, page 128. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 57, page 164.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the icc profile stream dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 66, page 149. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 65, page 188. This class is always an indirect object because it is also a StreamElement and these are always indirect objects.

Create an empty ICCProfileStreamElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a ICCProfileStreamElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a ICCProfileStreamElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new ICCProfileStreamElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

The StreamElement associated with this class.

Represents the "N" entry of the icc profile stream dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 66, page 149. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 65, page 188.

Represents the "Alternate" entry of the icc profile stream dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a ColorSpaceElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 66, page 150. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 65, page 188.

Represents the "Range" entry of the icc profile stream dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains doubles, representing PDF numeric objects. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 66, page 150. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 65, page 188.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the image dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 89, page 206. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 87, page 255. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 4.39, page 27. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 146, page 349. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 144, page 418. This class is always an indirect object because it is also a StreamElement and these are always indirect objects.

Create an empty ImageXObjectElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a ImageXObjectElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a ImageXObjectElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new ImageXObjectElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Subtype" entry of the image dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. This item must always be provided and must always take the value "Image". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 89, page 206. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 4.39, page 27. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 87, page 255. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 146, page 349. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 144, page 418.

Represents the "Width" entry of the image dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 89, page 206. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 4.39, page 27. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 87, page 255. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 146, page 349. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 144, page 418.

Represents the "Height" entry of the image dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 89, page 206. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 4.39, page 27. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 87, page 255. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 146, page 349. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 144, page 418.

Represents the "ColorSpace" entry of the image dictionary object. It is defined as part of the PDF 1.0 specification. It contains a ColorSpaceElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 89, page 206. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 4.39, page 27. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 87, page 255. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 146, page 349. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 144, page 418.

Represents the "BitsPerComponent" entry of the image dictionary object. It is defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 89, page 207. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 4.39, page 27. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 87, page 256. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 146, page 349. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 144, page 418.

Represents the "Intent" entry of the image dictionary object. It is an optional entry defined as part of the PDF 1.1 specification. It contains a string representing a PDF name object. This item may take one of the following valid values: AbsoluteColorimetricRelativeColorimetricSaturationPerceptual For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 89, page 207. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 4.39, page 27. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 87, page 256. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 146, page 349. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 144, page 418.

Represents the "ImageMask" entry of the image dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a bool representing a PDF boolean object. The PDF specification states that this item assumes a value of false if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 89, page 207. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 4.39, page 27. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 87, page 256. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 146, page 349. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 144, page 418.

Represents the "Mask" entry of the image dictionary object. It is defined as part of the PDF 1.3 specification. This property may contain one of two different types: 1) An array which contains doubles, representing PDF numeric objects. 2) An ImageXObjectElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 89, page 207. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 4.39, page 27. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 87, page 256. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 146, page 349. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 144, page 418.

Represents the "Decode" entry of the image dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains doubles, representing PDF numeric objects. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 89, page 207. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 4.39, page 27. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 87, page 256. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 146, page 349. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 144, page 418.

Represents the "Interpolate" entry of the image dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a bool representing a PDF boolean object. The PDF specification states that this item assumes a value of false if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 89, page 207. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 4.39, page 27. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 87, page 256. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 146, page 349. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 144, page 418.

Represents the "Alternates" entry of the image dictionary object. It is an optional entry defined as part of the PDF 1.3 specification. It contains an array which contains AlternateImageElements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 89, page 207. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 4.39, page 27. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 87, page 256. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 146, page 349. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 144, page 418.

Represents the "SMask" entry of the image dictionary object. It is an optional entry defined as part of the PDF 1.4 specification. It contains an ImageXObjectElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 89, page 208. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 4.39, page 27. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 87, page 257. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 146, page 349. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 144, page 418.

Represents the "SMaskInData" entry of the image dictionary object. It is defined as part of the PDF 1.5 specification. It contains an integer representing a PDF numeric object. The PDF specification states that this item assumes a value of 0 if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 89, page 208. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 4.39, page 27. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 87, page 257. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 146, page 349. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 144, page 418.

Represents the "Name" entry of the image dictionary object. It is defined as part of the PDF 1.0 specification. It was deprecated in PDF 2.0. It contains a string representing a PDF name object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 89, page 208. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 4.39, page 27. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 87, page 257. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 146, page 349. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 144, page 418.

Represents the "StructParent" entry of the image dictionary object. It is defined as part of the PDF 1.3 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 89, page 208. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 4.39, page 27. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 87, page 257. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 146, page 349. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 144, page 418.

Represents the "ID" entry of the image dictionary object. It is an optional entry defined as part of the PDF 1.3 specification. It contains a string representing a PDF string object. This string contains raw byte data. So it looks like a string but really it is just a wrapper for data. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 89, page 208. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 4.39, page 27. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 87, page 257. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 146, page 349. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 144, page 418.

Represents the "OPI" entry of the image dictionary object. It is an optional entry defined as part of the PDF 1.2 specification. It was deprecated in PDF 2.0. It contains an OpiVersionElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 89, page 208. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 4.39, page 27. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 87, page 257. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 146, page 349. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 144, page 418.

Represents the "OC" entry of the image dictionary object. It is an optional entry defined as part of the PDF 1.5 specification. This property may contain one of two different types: 1) An OptionalContentGroupElement. 2) An OptionalContentMembershipElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 89, page 208. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 4.39, page 27. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 87, page 258. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 146, page 349. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 144, page 418.

Represents the "Measure" entry of the image dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a MeasureElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 89, page 206. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 4.39, page 27. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 87, page 258. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 146, page 349. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 144, page 418.

Represents the "PtData" entry of the image dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a PointDataElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 89, page 206. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 4.39, page 27. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 87, page 258. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 146, page 349. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 144, page 418.

Represents the "Matte" entry of the image dictionary object. It is an optional entry defined as part of the PDF 1.4 specification. It contains an array which contains doubles, representing PDF numeric objects. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 89, page 206. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 4.39, page 27. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 87, page 255. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 146, page 349. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 144, page 418.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the lab colour space dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 65, page 148. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 64, page 186.

Create an empty LabColorSpaceAttributesElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a LabColorSpaceAttributesElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a LabColorSpaceAttributesElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new LabColorSpaceAttributesElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "WhitePoint" entry of the lab colour space dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains an array which contains doubles, representing PDF numeric objects. Items in this array should have a positive value. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 65, page 148. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 64, page 186.

Represents the "BlackPoint" entry of the lab colour space dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains doubles, representing PDF numeric objects. Items in this array should have a minimum value of 0. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 65, page 148. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 64, page 186.

Represents the "Range" entry of the lab colour space dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains doubles, representing PDF numeric objects. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 65, page 148. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 64, page 186.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the optional content configuration dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 101, page 229. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 99, page 281.

Create an empty OptionalContentConfigElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a OptionalContentConfigElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a OptionalContentConfigElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new OptionalContentConfigElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Name" entry of the optional content configuration dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 101, page 229. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 99, page 281.

Represents the "Creator" entry of the optional content configuration dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 101, page 229. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 99, page 281.

Represents the "BaseState" entry of the optional content configuration dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. The PDF specification states that this item assumes a value of "ON" if no value has been provided. This item may take one of the following valid values: ONOFFUnchanged For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 101, page 229. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 99, page 281.

Represents the "ON" entry of the optional content configuration dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains OptionalContentGroupElements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 101, page 229. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 99, page 281.

Represents the "OFF" entry of the optional content configuration dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains OptionalContentGroupElements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 101, page 229. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 99, page 282.

Represents the "Intent" entry of the optional content configuration dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains strings, representing PDF name objects. The PDF specification states that items in this array assume a value of "View" if no value has been provided. Items in this array may take one of the following valid values: ViewDesignAll If you read the specification you will see that an array of one string may be represented as a single string rather than an array. However we always present this property as an array to simplify the interface. It is only if you add or remove items in the array, that the underlying representation will be changed. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 101, page 229. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 99, page 282.

Represents the "AS" entry of the optional content configuration dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains UsageApplicationElements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 101, page 230. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 99, page 282.

Represents the "Order" entry of the optional content configuration dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains Elements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 101, page 230. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 99, page 282.

Represents the "ListMode" entry of the optional content configuration dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. The PDF specification states that this item assumes a value of "AllPages" if no value has been provided. This item may take one of the following valid values: AllPagesVisiblePages For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 101, page 230. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 99, page 282.

Represents the "RBGroups" entry of the optional content configuration dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains Elements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 101, page 230. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 99, page 283.

Represents the "Locked" entry of the optional content configuration dictionary object. It is an optional entry defined as part of the PDF 1.6 specification. It contains an array which contains OptionalContentGroupElements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 101, page 231. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 99, page 283.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the optional content group dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 98, page 222. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 96, page 273. This class is always an indirect object because OptionalContentPropertiesElement.EntryOCGs requires it to be so.

Create an empty OptionalContentGroupElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a OptionalContentGroupElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a OptionalContentGroupElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new OptionalContentGroupElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the optional content group dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. This item must always be provided and must always take the value "OCG". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 98, page 222. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 96, page 273.

Represents the "Name" entry of the optional content group dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 98, page 222. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 96, page 274.

Represents the "Intent" entry of the optional content group dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains strings, representing PDF name objects. The PDF specification states that items in this array assume a value of "View" if no value has been provided. Items in this array may take one of the following valid values: ViewDesign If you read the specification you will see that an array of one string may be represented as a single string rather than an array. However we always present this property as an array to simplify the interface. It is only if you add or remove items in the array, that the underlying representation will be changed. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 98, page 222. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 96, page 274.

Represents the "Usage" entry of the optional content group dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an OptionalContentUsageElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 98, page 222. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 96, page 274.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the optional content membership dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 99, page 223. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 97, page 275.

Create an empty OptionalContentMembershipElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a OptionalContentMembershipElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a OptionalContentMembershipElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new OptionalContentMembershipElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the optional content membership dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. This item must always be provided and must always take the value "OCMD". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 99, page 223. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 97, page 275.

Represents the "OCGs" entry of the optional content membership dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains OptionalContentGroupElements. If you read the specification you will see that an array of one OptionalContentGroupElement may be represented as a single OptionalContentGroupElement rather than an array. However we always present this property as an array to simplify the interface. It is only if you add or remove items in the array, that the underlying representation will be changed. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 99, page 223. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 97, page 275.

Represents the "P" entry of the optional content membership dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. The PDF specification states that this item assumes a value of "AnyOn" if no value has been provided. This item may take one of the following valid values: AllOnAnyOnAnyOffAllOff For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 99, page 223. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 97, page 275.

Represents the "VE" entry of the optional content membership dictionary object. It is an optional entry defined as part of the PDF 1.6 specification. It contains an array which contains Elements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 99, page 223. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 97, page 275.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the optional content properties dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 100, page 228. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 98, page 281.

Create an empty OptionalContentPropertiesElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a OptionalContentPropertiesElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a OptionalContentPropertiesElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new OptionalContentPropertiesElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "OCGs" entry of the optional content properties dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains an array which contains OptionalContentGroupElements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 100, page 228. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 98, page 281.

Represents the "D" entry of the optional content properties dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains an OptionalContentConfigElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 100, page 229. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 98, page 281.

Represents the "Configs" entry of the optional content properties dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains OptionalContentConfigElements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 100, page 229. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 98, page 281.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the optional content usage creator dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 102, page 232. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 100, page 284.

Create an empty OptionalContentUsageCreatorElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a OptionalContentUsageCreatorElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a OptionalContentUsageCreatorElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new OptionalContentUsageCreatorElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Creator" entry of the optional content usage creator dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 102, page 232. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 100, page 284.

Represents the "Subtype" entry of the optional content usage creator dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 102, page 232. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 100, page 284.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the optional content usage dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 102, page 232. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 100, page 284.

Create an empty OptionalContentUsageElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a OptionalContentUsageElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a OptionalContentUsageElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new OptionalContentUsageElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "CreatorInfo" entry of the optional content usage dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an OptionalContentUsageCreatorElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 102, page 232. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 100, page 284.

Represents the "Language" entry of the optional content usage dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an OptionalContentUsageLanguageElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 102, page 232. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 100, page 285.

Represents the "Export" entry of the optional content usage dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an OptionalContentUsageExportElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 102, page 232. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 100, page 285.

Represents the "Zoom" entry of the optional content usage dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an OptionalContentUsageZoomElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 102, page 232. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 100, page 285.

Represents the "Print" entry of the optional content usage dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an OptionalContentUsagePrintElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 102, page 233. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 100, page 285.

Represents the "View" entry of the optional content usage dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an OptionalContentUsageViewElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 102, page 233. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 100, page 285.

Represents the "User" entry of the optional content usage dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an OptionalContentUsageUserElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 102, page 233. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 100, page 285.

Represents the "PageElement" entry of the optional content usage dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an OptionalContentUsagePageElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 102, page 233. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 100, page 285.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the optional content usage export dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 102, page 232. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 100, page 284.

Create an empty OptionalContentUsageExportElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a OptionalContentUsageExportElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a OptionalContentUsageExportElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new OptionalContentUsageExportElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "ExportState" entry of the optional content usage export dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. The PDF specification states that this item assumes a value of "OFF" if no value has been provided. This item may take one of the following valid values: ONOFF For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 102, page 232. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 100, page 284.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the optional content usage language dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 102, page 232. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 100, page 284.

Create an empty OptionalContentUsageLanguageElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a OptionalContentUsageLanguageElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a OptionalContentUsageLanguageElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new OptionalContentUsageLanguageElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Lang" entry of the optional content usage language dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 102, page 232. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 100, page 284.

Represents the "Preferred" entry of the optional content usage language dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. The PDF specification states that this item assumes a value of "OFF" if no value has been provided. This item may take one of the following valid values: ONOFF For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 102, page 232. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 100, page 284.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the optional content usage page dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 102, page 232. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 100, page 284.

Create an empty OptionalContentUsagePageElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a OptionalContentUsagePageElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a OptionalContentUsagePageElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new OptionalContentUsagePageElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Subtype" entry of the optional content usage page dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. This item may take one of the following valid values: HFFGBGL For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 102, page 232. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 100, page 284.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the optional content usage print dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 102, page 232. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 100, page 284.

Create an empty OptionalContentUsagePrintElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a OptionalContentUsagePrintElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a OptionalContentUsagePrintElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new OptionalContentUsagePrintElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Subtype" entry of the optional content usage print dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 102, page 232. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 100, page 284.

Represents the "PrintState" entry of the optional content usage print dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. This item may take one of the following valid values: ONOFF For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 102, page 232. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 100, page 284.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the optional content usage user dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 102, page 232. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 100, page 284.

Create an empty OptionalContentUsageUserElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a OptionalContentUsageUserElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a OptionalContentUsageUserElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new OptionalContentUsageUserElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the optional content usage user dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. This item may take one of the following valid values: IndTtlOrg For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 102, page 232. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 100, page 284.

Represents the "Name" entry of the optional content usage user dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains an array which contains strings, representing PDF string objects. If you read the specification you will see that an array of one string may be represented as a single string rather than an array. However we always present this property as an array to simplify the interface. It is only if you add or remove items in the array, that the underlying representation will be changed. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 102, page 232. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 100, page 284.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the optional content usage view dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 102, page 232. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 100, page 284.

Create an empty OptionalContentUsageViewElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a OptionalContentUsageViewElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a OptionalContentUsageViewElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new OptionalContentUsageViewElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "ViewState" entry of the optional content usage view dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. The PDF specification states that this item assumes a value of "OFF" if no value has been provided. This item may take one of the following valid values: ONOFF For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 102, page 232. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 100, page 284.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the optional content usage zoom dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 102, page 232. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 100, page 284.

Create an empty OptionalContentUsageZoomElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a OptionalContentUsageZoomElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a OptionalContentUsageZoomElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new OptionalContentUsageZoomElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "min" entry of the optional content usage zoom dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a double representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 102, page 232. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 100, page 284.

Represents the "max" entry of the optional content usage zoom dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a double representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 102, page 232. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 100, page 284.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the pattern dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; page 173.

Create an empty PatternElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a PatternElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a PatternElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new PatternElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the pattern dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. If provided, this item must always take the value "Pattern". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; page 173.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the postscript xobject dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 88, page 202. This class is always an indirect object because it is also a StreamElement and these are always indirect objects.

Create an empty PostScriptXObjectElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a PostScriptXObjectElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a PostScriptXObjectElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new PostScriptXObjectElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Subtype" entry of the postscript xobject dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. This item must always be provided and must always take the value "PS". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 88, page 202.

Represents the "Level1" entry of the postscript xobject dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a StreamElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 88, page 202.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the reference dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 97, page 221. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 95, page 272.

Create an empty ReferenceElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a ReferenceElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a ReferenceElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new ReferenceElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "F" entry of the reference dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a FileSpecificationElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 97, page 221. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 95, page 272.

Represents the "Page" entry of the reference dictionary object. It is a required entry defined as part of the PDF 1.0 specification. This property may contain one of two different types: 1) An integer representing a PDF numeric object. 2) A string representing a PDF string object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 97, page 221. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 95, page 272.

Represents the "ID" entry of the reference dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains strings, representing PDF string objects. This string contains raw byte data. So it looks like a string but really it is just a wrapper for data. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 97, page 221. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 95, page 272.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the shading dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 78, page 183. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 77, page 227.

Create an empty ShadingElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a ShadingElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a ShadingElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new ShadingElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "ShadingType" entry of the shading dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. This item may take one of the following valid values: 1234567 For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 78, page 183. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 77, page 227.

Represents the "ColorSpace" entry of the shading dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a ColorSpaceElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 78, page 183. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 77, page 227.

Represents the "Background" entry of the shading dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains doubles, representing PDF numeric objects. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 78, page 183. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 77, page 228.

Represents the "BBox" entry of the shading dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a RectangleElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 78, page 183. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 77, page 228.

Represents the "AntiAlias" entry of the shading dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a bool representing a PDF boolean object. The PDF specification states that this item assumes a value of false if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 78, page 183. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 77, page 228.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the type 1 pattern dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 75, page 174. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 74, page 218. This class is always an indirect object because it is also a StreamElement and these are always indirect objects.

Create an empty Type1PatternElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a Type1PatternElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a Type1PatternElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new Type1PatternElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

The StreamElement associated with this class.

Represents the "PatternType" entry of the type 1 pattern dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. This item must always be provided and must always take the value "1". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 75, page 174. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 74, page 218.

Represents the "PaintType" entry of the type 1 pattern dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 75, page 175. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 74, page 218.

Represents the "TilingType" entry of the type 1 pattern dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 75, page 175. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 74, page 218.

Represents the "BBox" entry of the type 1 pattern dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a RectangleElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 75, page 175. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 74, page 218.

Represents the "XStep" entry of the type 1 pattern dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a double representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 75, page 175. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 74, page 218.

Represents the "YStep" entry of the type 1 pattern dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a double representing a PDF numeric object. It should have a positive value. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 75, page 175. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 74, page 218.

Represents the "Resources" entry of the type 1 pattern dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a ResourceElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 75, page 175. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 74, page 219.

Represents the "Matrix" entry of the type 1 pattern dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains doubles, representing PDF numeric objects. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 75, page 175. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 74, page 219.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the type 1 shading dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 79, page 185. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 78, page 230.

Create an empty Type1ShadingElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a Type1ShadingElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a Type1ShadingElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new Type1ShadingElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Domain" entry of the type 1 shading dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains doubles, representing PDF numeric objects. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 79, page 185. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 78, page 230.

Represents the "Matrix" entry of the type 1 shading dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains doubles, representing PDF numeric objects. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 79, page 185. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 78, page 230.

Represents the "Function" entry of the type 1 shading dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains an array which contains FunctionElements. If you read the specification you will see that an array of one FunctionElement may be represented as a single FunctionElement rather than an array. However we always present this property as an array to simplify the interface. It is only if you add or remove items in the array, that the underlying representation will be changed. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 79, page 185. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 78, page 230.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the type 2 pattern dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 76, page 181. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 75, page 225.

Create an empty Type2PatternElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a Type2PatternElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a Type2PatternElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new Type2PatternElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "PatternType" entry of the type 2 pattern dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. This item must always be provided and must always take the value "2". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 76, page 181. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 75, page 225.

Represents the "Shading" entry of the type 2 pattern dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a ShadingElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 76, page 181. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 75, page 225.

Represents the "Matrix" entry of the type 2 pattern dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains doubles, representing PDF numeric objects. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 76, page 181. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 75, page 225.

Represents the "ExtGState" entry of the type 2 pattern dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a GraphicsStateParameterElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 76, page 181. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 75, page 225.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the type 2 shading dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 80, page 186. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 79, page 231.

Create an empty Type2ShadingElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a Type2ShadingElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a Type2ShadingElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new Type2ShadingElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Coords" entry of the type 2 shading dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains an array which contains doubles, representing PDF numeric objects. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 80, page 186. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 79, page 231.

Represents the "Domain" entry of the type 2 shading dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains doubles, representing PDF numeric objects. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 80, page 186. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 79, page 231.

Represents the "Function" entry of the type 2 shading dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains an array which contains FunctionElements. If you read the specification you will see that an array of one FunctionElement may be represented as a single FunctionElement rather than an array. However we always present this property as an array to simplify the interface. It is only if you add or remove items in the array, that the underlying representation will be changed. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 80, page 186. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 79, page 231.

Represents the "Extend" entry of the type 2 shading dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains bool representing a PDF boolean objects. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 80, page 186. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 79, page 231.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the type 3 shading dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 81, page 187. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 80, page 233.

Create an empty Type3ShadingElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a Type3ShadingElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a Type3ShadingElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new Type3ShadingElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Coords" entry of the type 3 shading dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains an array which contains doubles, representing PDF numeric objects. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 81, page 187. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 80, page 233.

Represents the "Domain" entry of the type 3 shading dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains doubles, representing PDF numeric objects. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 81, page 187. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 80, page 233.

Represents the "Function" entry of the type 3 shading dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains an array which contains FunctionElements. If you read the specification you will see that an array of one FunctionElement may be represented as a single FunctionElement rather than an array. However we always present this property as an array to simplify the interface. It is only if you add or remove items in the array, that the underlying representation will be changed. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 81, page 187. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 80, page 233.

Represents the "Extend" entry of the type 3 shading dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains bool representing a PDF boolean objects. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 81, page 187. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 80, page 233.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the type 4 shading dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 82, page 189. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 81, page 236. This class is always an indirect object because it is also a StreamElement and these are always indirect objects.

Create an empty Type4ShadingElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a Type4ShadingElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a Type4ShadingElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new Type4ShadingElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

The StreamElement associated with this class.

Represents the "BitsPerCoordinate" entry of the type 4 shading dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 82, page 189. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 81, page 236.

Represents the "BitsPerComponent" entry of the type 4 shading dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 82, page 189. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 81, page 236.

Represents the "Decode" entry of the type 4 shading dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains an array which contains doubles, representing PDF numeric objects. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 82, page 189. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 81, page 237.

Represents the "Function" entry of the type 4 shading dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains FunctionElements. If you read the specification you will see that an array of one FunctionElement may be represented as a single FunctionElement rather than an array. However we always present this property as an array to simplify the interface. It is only if you add or remove items in the array, that the underlying representation will be changed. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 82, page 190. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 81, page 237.

Represents the "BitsPerFlag" entry of the type 4 shading dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 82, page 189. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 81, page 237.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the type 5 shading dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 83, page 193. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 82, page 240. This class is always an indirect object because it is also a StreamElement and these are always indirect objects.

Create an empty Type5ShadingElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a Type5ShadingElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a Type5ShadingElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new Type5ShadingElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

The StreamElement associated with this class.

Represents the "BitsPerCoordinate" entry of the type 5 shading dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 83, page 193. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 82, page 240.

Represents the "BitsPerComponent" entry of the type 5 shading dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 83, page 193. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 82, page 240.

Represents the "Decode" entry of the type 5 shading dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains an array which contains doubles, representing PDF numeric objects. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 83, page 193. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 82, page 240.

Represents the "Function" entry of the type 5 shading dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains FunctionElements. If you read the specification you will see that an array of one FunctionElement may be represented as a single FunctionElement rather than an array. However we always present this property as an array to simplify the interface. It is only if you add or remove items in the array, that the underlying representation will be changed. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 83, page 193. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 82, page 241.

Represents the "VerticesPerRow" entry of the type 5 shading dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 83, page 193. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 82, page 240.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the type 6 shading dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 84, page 196. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 83, page 244. This class is always an indirect object because it is also a StreamElement and these are always indirect objects.

Create an empty Type6ShadingElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a Type6ShadingElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a Type6ShadingElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new Type6ShadingElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

The StreamElement associated with this class.

Represents the "BitsPerCoordinate" entry of the type 6 shading dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 84, page 196. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 83, page 244.

Represents the "BitsPerComponent" entry of the type 6 shading dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 84, page 196. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 83, page 244.

Represents the "Decode" entry of the type 6 shading dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains an array which contains doubles, representing PDF numeric objects. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 84, page 196. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 83, page 244.

Represents the "Function" entry of the type 6 shading dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains FunctionElements. If you read the specification you will see that an array of one FunctionElement may be represented as a single FunctionElement rather than an array. However we always present this property as an array to simplify the interface. It is only if you add or remove items in the array, that the underlying representation will be changed. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 84, page 196. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 83, page 245.

Represents the "BitsPerFlag" entry of the type 6 shading dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. It should have a minimum value of 0 and a maximum of 3. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 84, page 196. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 83, page 244.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the type 7 shading dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; page 198. This class is always an indirect object because it is also a StreamElement and these are always indirect objects.

Create an empty Type7ShadingElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a Type7ShadingElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a Type7ShadingElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new Type7ShadingElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

The StreamElement associated with this class.

Represents the "BitsPerCoordinate" entry of the type 7 shading dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; page 198.

Represents the "BitsPerComponent" entry of the type 7 shading dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; page 198.

Represents the "Decode" entry of the type 7 shading dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains an array which contains doubles, representing PDF numeric objects. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; page 198.

Represents the "Function" entry of the type 7 shading dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains FunctionElements. If you read the specification you will see that an array of one FunctionElement may be represented as a single FunctionElement rather than an array. However we always present this property as an array to simplify the interface. It is only if you add or remove items in the array, that the underlying representation will be changed. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; page 198.

Represents the "BitsPerFlag" entry of the type 7 shading dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. It should have a minimum value of 0 and a maximum of 3. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; page 198.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the usage application dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 103, page 233. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 101, page 286.

Create an empty UsageApplicationElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a UsageApplicationElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a UsageApplicationElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new UsageApplicationElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Event" entry of the usage application dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. This item may take one of the following valid values: ViewPrintExport For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 103, page 233. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 101, page 286.

Represents the "OCGs" entry of the usage application dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains OptionalContentGroupElements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 103, page 233. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 101, page 286.

Represents the "Category" entry of the usage application dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains an array which contains strings, representing PDF name objects. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 103, page 233. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 101, page 286.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the xobject. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; page 201. This class is always an indirect object because it is also a StreamElement and these are always indirect objects.

Create an empty XObjectElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a XObjectElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a XObjectElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new XObjectElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

The StreamElement associated with this class.

Represents the "Type" entry of the xobject object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. If provided, this item must always take the value "XObject". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; page 201.

Represents the "AF" entry of the xobject object. It is an optional entry defined as part of the PDF 2.0 specification. It contains an array which contains FileSpecificationElements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; page 201.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the cidfont dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 117, page 269. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 115, page 327. This class is always an indirect object because it inherits from FontElement which is always an indirect object.

Create an empty CIDFontElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a CIDFontElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a CIDFontElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new CIDFontElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Subtype" entry of the cidfont dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. This item may take one of the following valid values: CIDFontType0CIDFontType2 For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 117, page 269. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 115, page 327.

Represents the "BaseFont" entry of the cidfont dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 117, page 269. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 115, page 327.

Represents the "CIDSystemInfo" entry of the cidfont dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a CIDSystemInfoElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 117, page 269. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 115, page 327.

Represents the "FontDescriptor" entry of the cidfont dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a FontDescriptorElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 117, page 269. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 115, page 327.

Represents the "DW" entry of the cidfont dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. The PDF specification states that this item assumes a value of 1000 if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 117, page 269. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 115, page 327.

Represents the "W" entry of the cidfont dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains Elements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 117, page 270. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 115, page 327.

Represents the "DW2" entry of the cidfont dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains doubles, representing PDF numeric objects. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 117, page 270. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 115, page 327.

Represents the "W2" entry of the cidfont dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains Elements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 117, page 270. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 115, page 327.

Represents the "CIDToGIDMap" entry of the cidfont dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. This property may contain one of two different types: 1) A string representing a PDF name object. The PDF specification states that this item assumes a value of "Identity" if no value has been provided. If provided, this item must always take the value "Identity". 2) A StreamElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 117, page 270. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 115, page 327.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the cidsysteminfo dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 116, page 268. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 114, page 326.

Create an empty CIDSystemInfoElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a CIDSystemInfoElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a CIDSystemInfoElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new CIDSystemInfoElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Registry" entry of the cidsysteminfo dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. This is encoded as a string using single byte ASCII encoding. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 116, page 268. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 114, page 326.

Represents the "Ordering" entry of the cidsysteminfo dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. This is encoded as a string using single byte ASCII encoding. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 116, page 269. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 114, page 326.

Represents the "Supplement" entry of the cidsysteminfo dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 116, page 269. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 114, page 326.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the cmap stream dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 120, page 277. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 118, page 336. This class is always an indirect object because it is also a StreamElement and these are always indirect objects.

Create an empty CMapStreamElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a CMapStreamElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a CMapStreamElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new CMapStreamElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

The StreamElement associated with this class.

Represents the "Type" entry of the cmap stream dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. This item must always be provided and must always take the value "CMap". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 120, page 277. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 118, page 336.

Represents the "CMapName" entry of the cmap stream dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 120, page 277. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 118, page 336.

Represents the "CIDSystemInfo" entry of the cmap stream dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains an Element. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 120, page 277. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 118, page 336.

Represents the "WMode" entry of the cmap stream dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. The PDF specification states that this item assumes a value of 0 if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 120, page 277. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 118, page 336.

Represents the "UseCMap" entry of the cmap stream dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. This property may contain one of two different types: 1) A string representing a PDF name object. 2) A StreamElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 120, page 277. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 118, page 336.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the embedded font stream dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 127, page 290. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 125, page 350. This class is always an indirect object because it is also a StreamElement and these are always indirect objects.

Create an empty EmbeddedFontStreamElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a EmbeddedFontStreamElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a EmbeddedFontStreamElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new EmbeddedFontStreamElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

The StreamElement associated with this class.

Represents the "Length1" entry of the embedded font stream dictionary object. It is defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 127, page 290. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 125, page 350.

Represents the "Length2" entry of the embedded font stream dictionary object. It is defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 127, page 290. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 125, page 350.

Represents the "Length3" entry of the embedded font stream dictionary object. It is defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 127, page 290. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 125, page 350.

Represents the "Subtype" entry of the embedded font stream dictionary object. It is defined as part of the PDF 1.2 specification. It contains a string representing a PDF name object. This item may take one of the following valid values: Type1CCIDFontType0COpenType For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 127, page 290. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 125, page 351.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the encoding dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 114, page 263. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 112, page 319.

Create an empty EncodingElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a EncodingElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a EncodingElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new EncodingElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the encoding dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. If provided, this item must always take the value "Encoding". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 114, page 263. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 112, page 319.

Represents the "BaseEncoding" entry of the encoding dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. This item may take one of the following valid values: MacRomanEncodingMacExpertEncodingWinAnsiEncoding For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 114, page 263. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 112, page 320.

Represents the "Differences" entry of the encoding dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains Elements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 114, page 263. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 112, page 320.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the font descriptor. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 122, page 281. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 120, page 341. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 124, page 285. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 122, page 345. This class is always an indirect object because CIDFontElement.EntryFontDescriptor, TrueTypeFontElement.EntryFontDescriptor, Type1FontElement.EntryFontDescriptor and Type3FontElement.EntryFontDescriptor require it to be so.

Create an empty FontDescriptorElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a FontDescriptorElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a FontDescriptorElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new FontDescriptorElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the font descriptor object. It is a required entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. This item must always be provided and must always take the value "FontDescriptor". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 122, page 281. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 120, page 341. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 124, page 285.

Represents the "FontName" entry of the font descriptor object. It is a required entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 122, page 281. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 120, page 341. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 124, page 285.

Represents the "FontFamily" entry of the font descriptor object. It is an optional entry defined as part of the PDF 1.5 specification. It contains a string representing a PDF string object. This string contains raw byte data. So it looks like a string but really it is just a wrapper for data. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 122, page 281. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 120, page 341. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 124, page 285.

Represents the "FontStretch" entry of the font descriptor object. It is an optional entry defined as part of the PDF 1.5 specification. It contains a string representing a PDF name object. This item may take one of the following valid values: (orderedUltraCondensedExtraCondensedCondensedSemiCondensedNormalSemiExpandedExpandedExtraExpandedUltraExpanded For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 122, page 282. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 120, page 341. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 124, page 285.

Represents the "FontWeight" entry of the font descriptor object. It is an optional entry defined as part of the PDF 1.5 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 122, page 282. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 120, page 341. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 124, page 285.

Represents the "Flags" entry of the font descriptor object. It is a required entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 122, page 282. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 120, page 341. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 124, page 285.

Represents the "FontBBox" entry of the font descriptor object. It is defined as part of the PDF 1.0 specification. It contains a RectangleElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 122, page 282. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 120, page 341. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 124, page 285.

Represents the "ItalicAngle" entry of the font descriptor object. It is a required entry defined as part of the PDF 1.0 specification. It contains a double representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 122, page 282. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 120, page 341. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 124, page 285.

Represents the "Ascent" entry of the font descriptor object. It is defined as part of the PDF 1.0 specification. It contains a double representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 122, page 282. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 120, page 341. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 124, page 285.

Represents the "Descent" entry of the font descriptor object. It is defined as part of the PDF 1.0 specification. It contains a double representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 122, page 282. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 120, page 342. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 124, page 285.

Represents the "Leading" entry of the font descriptor object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a double representing a PDF numeric object. The PDF specification states that this item assumes a value of 0 if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 122, page 282. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 120, page 342. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 124, page 285.

Represents the "CapHeight" entry of the font descriptor object. It is defined as part of the PDF 1.0 specification. It contains a double representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 122, page 282. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 120, page 342. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 124, page 285.

Represents the "XHeight" entry of the font descriptor object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a double representing a PDF numeric object. The PDF specification states that this item assumes a value of 0 if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 122, page 282. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 120, page 342. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 124, page 285.

Represents the "StemV" entry of the font descriptor object. It is defined as part of the PDF 1.0 specification. It contains a double representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 122, page 282. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 120, page 342. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 124, page 285.

Represents the "StemH" entry of the font descriptor object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a double representing a PDF numeric object. The PDF specification states that this item assumes a value of 0 if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 122, page 282. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 120, page 342. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 124, page 285.

Represents the "AvgWidth" entry of the font descriptor object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a double representing a PDF numeric object. The PDF specification states that this item assumes a value of 0 if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 122, page 283. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 120, page 342. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 124, page 285.

Represents the "MaxWidth" entry of the font descriptor object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a double representing a PDF numeric object. The PDF specification states that this item assumes a value of 0 if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 122, page 283. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 120, page 342. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 124, page 285.

Represents the "MissingWidth" entry of the font descriptor object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a double representing a PDF numeric object. The PDF specification states that this item assumes a value of 0 if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 122, page 283. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 120, page 342. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 124, page 285.

Represents the "FontFile" entry of the font descriptor object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an EmbeddedFontStreamElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 122, page 283. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 120, page 342. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 124, page 285.

Represents the "FontFile2" entry of the font descriptor object. It is an optional entry defined as part of the PDF 1.1 specification. It contains an EmbeddedFontStreamElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 122, page 283. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 120, page 342. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 124, page 285.

Represents the "FontFile3" entry of the font descriptor object. It is an optional entry defined as part of the PDF 1.2 specification. It contains an EmbeddedFontStreamElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 122, page 283. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 120, page 342. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 124, page 285.

Represents the "CharSet" entry of the font descriptor object. It is an optional entry defined as part of the PDF 1.1 specification. It was deprecated in PDF 2.0. It contains a string representing a PDF string object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 122, page 283. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 120, page 342. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 124, page 285.

Represents the "Style" entry of the font descriptor object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an Element. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 122, page 281. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 120, page 341. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 124, page 285.

Represents the "Lang" entry of the font descriptor object. It is an optional entry defined as part of the PDF 1.5 specification. It contains a string representing a PDF name object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 122, page 281. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 120, page 341. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 124, page 285.

Represents the "FD" entry of the font descriptor object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an Element. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 122, page 281. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 120, page 341. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 124, page 285.

Represents the "CIDSet" entry of the font descriptor object. It is an optional entry defined as part of the PDF 1.0 specification. It was deprecated in PDF 2.0. It contains a StreamElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 122, page 281. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 120, page 341. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 124, page 285.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the font dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; page 254. This class is always an indirect object because GraphicsStateParameterElement.EntryFont requires it to be so.

Create an empty FontElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a FontElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a FontElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new FontElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the font dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. This item must always be provided and must always take the value "Font". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; page 254.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the truetype font dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; page 257. This class is always an indirect object because it inherits from FontElement which is always an indirect object.

Create an empty TrueTypeFontElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a TrueTypeFontElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a TrueTypeFontElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new TrueTypeFontElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Subtype" entry of the truetype font dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. This item must always be provided and must always take the value "TrueType". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; page 257.

Represents the "Name" entry of the truetype font dictionary object. It is defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; page 257.

Represents the "BaseFont" entry of the truetype font dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; page 257.

Represents the "FirstChar" entry of the truetype font dictionary object. It is defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; page 257.

Represents the "LastChar" entry of the truetype font dictionary object. It is defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; page 257.

Represents the "Widths" entry of the truetype font dictionary object. It is defined as part of the PDF 1.0 specification. It contains an array which contains doubles, representing PDF numeric objects. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; page 257.

Represents the "FontDescriptor" entry of the truetype font dictionary object. It is defined as part of the PDF 1.0 specification. It contains a FontDescriptorElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; page 257.

Represents the "Encoding" entry of the truetype font dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. This property may contain one of two different types: 1) A string representing a PDF name object. This item may take one of the following valid values: MacRomanEncodingMacExpertEncodingWinAnsiEncoding 2) An EncodingElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; page 257.

Represents the "ToUnicode" entry of the truetype font dictionary object. It is an optional entry defined as part of the PDF 1.2 specification. It contains a StreamElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; page 257.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the type 0 font dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 121, page 279. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 119, page 338. This class is always an indirect object because it inherits from FontElement which is always an indirect object.

Create an empty Type0FontElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a Type0FontElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a Type0FontElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new Type0FontElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Subtype" entry of the type 0 font dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. This item must always be provided and must always take the value "Type0". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 121, page 279. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 119, page 338.

Represents the "BaseFont" entry of the type 0 font dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 121, page 279. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 119, page 338.

Represents the "Encoding" entry of the type 0 font dictionary object. It is a required entry defined as part of the PDF 1.0 specification. This property may contain one of two different types: 1) A string representing a PDF name object. 2) A StreamElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 121, page 279. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 119, page 338.

Represents the "DescendantFonts" entry of the type 0 font dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains an array which contains CIDFontElements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 121, page 280. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 119, page 338.

Represents the "ToUnicode" entry of the type 0 font dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a StreamElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 121, page 280. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 119, page 338.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the type 1 font dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 111, page 254. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 109, page 310. This class is always an indirect object because it inherits from FontElement which is always an indirect object.

Create an empty Type1FontElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a Type1FontElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a Type1FontElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new Type1FontElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Subtype" entry of the type 1 font dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. This item must always be provided and must always take the value "Type1". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 111, page 254. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 109, page 310.

Represents the "Name" entry of the type 1 font dictionary object. It is defined as part of the PDF 1.0 specification. It was marked obsolescent in PDF 1.7 and deprecated in PDF 2.0. It contains a string representing a PDF name object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 111, page 254. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 109, page 310.

Represents the "BaseFont" entry of the type 1 font dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 111, page 254. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 109, page 310.

Represents the "FirstChar" entry of the type 1 font dictionary object. It is defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 111, page 255. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 109, page 310.

Represents the "LastChar" entry of the type 1 font dictionary object. It is defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 111, page 255. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 109, page 310.

Represents the "Widths" entry of the type 1 font dictionary object. It is defined as part of the PDF 1.0 specification. It contains an array which contains doubles, representing PDF numeric objects. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 111, page 255. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 109, page 310.

Represents the "FontDescriptor" entry of the type 1 font dictionary object. It is defined as part of the PDF 1.0 specification. It contains a FontDescriptorElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 111, page 255. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 109, page 311.

Represents the "Encoding" entry of the type 1 font dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. This property may contain one of two different types: 1) A string representing a PDF name object. This item may take one of the following valid values: MacRomanEncodingMacExpertEncodingWinAnsiEncoding 2) An EncodingElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 111, page 255. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 109, page 311.

Represents the "ToUnicode" entry of the type 1 font dictionary object. It is an optional entry defined as part of the PDF 1.2 specification. It contains a StreamElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 111, page 255. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 109, page 311.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the type 3 font dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 112, page 258. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 110, page 314. This class is always an indirect object because it inherits from FontElement which is always an indirect object.

Create an empty Type3FontElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a Type3FontElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a Type3FontElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new Type3FontElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Subtype" entry of the type 3 font dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. This item must always be provided and must always take the value "Type3". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 112, page 258. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 110, page 314.

Represents the "Name" entry of the type 3 font dictionary object. It is defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 112, page 258. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 110, page 314.

Represents the "FontBBox" entry of the type 3 font dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a RectangleElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 112, page 259. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 110, page 314.

Represents the "FontMatrix" entry of the type 3 font dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains an array which contains doubles, representing PDF numeric objects. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 112, page 259. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 110, page 314.

Represents the "CharProcs" entry of the type 3 font dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains an Element. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 112, page 259. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 110, page 314.

Represents the "Encoding" entry of the type 3 font dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains an EncodingElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 112, page 259. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 110, page 315.

Represents the "FirstChar" entry of the type 3 font dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 112, page 259. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 110, page 315.

Represents the "LastChar" entry of the type 3 font dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 112, page 259. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 110, page 315.

Represents the "Widths" entry of the type 3 font dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains an array which contains doubles, representing PDF numeric objects. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 112, page 259. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 110, page 315.

Represents the "FontDescriptor" entry of the type 3 font dictionary object. It is defined as part of the PDF 1.0 specification. It contains a FontDescriptorElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 112, page 259. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 110, page 315.

Represents the "Resources" entry of the type 3 font dictionary object. It is defined as part of the PDF 1.2 specification. It contains a ResourceElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 112, page 259. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 110, page 315.

Represents the "ToUnicode" entry of the type 3 font dictionary object. It is an optional entry defined as part of the PDF 1.2 specification. It contains a StreamElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 112, page 259. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 110, page 315.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the halftone dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; page 308.

Create an empty HalftoneElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a HalftoneElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a HalftoneElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new HalftoneElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the halftone dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. If provided, this item must always take the value "Halftone". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; page 308.

Represents the "HalftoneType" entry of the halftone dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; page 308.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the type 10 halftone dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 132, page 313. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 130, page 375.

Create an empty Type10HalftoneElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a Type10HalftoneElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a Type10HalftoneElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new Type10HalftoneElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "HalftoneName" entry of the type 10 halftone dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. This string contains raw byte data. So it looks like a string but really it is just a wrapper for data. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 132, page 313. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 130, page 375.

Represents the "Xsquare" entry of the type 10 halftone dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 132, page 313. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 130, page 375.

Represents the "Ysquare" entry of the type 10 halftone dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 132, page 313. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 130, page 375.

Represents the "TransferFunction" entry of the type 10 halftone dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. This property may contain one of two different types: 1) A string representing a PDF name object. If provided, this item must always take the value "Identity". 2) A FunctionElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 132, page 313. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 130, page 375.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the type 16 halftone dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 133, page 314. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 131, page 376.

Create an empty Type16HalftoneElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a Type16HalftoneElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a Type16HalftoneElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new Type16HalftoneElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "HalftoneName" entry of the type 16 halftone dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. This string contains raw byte data. So it looks like a string but really it is just a wrapper for data. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 133, page 314. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 131, page 376.

Represents the "Width" entry of the type 16 halftone dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 133, page 314. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 131, page 376.

Represents the "Height" entry of the type 16 halftone dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 133, page 314. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 131, page 376.

Represents the "Width2" entry of the type 16 halftone dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 133, page 314. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 131, page 376.

Represents the "Height2" entry of the type 16 halftone dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 133, page 314. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 131, page 376.

Represents the "TransferFunction" entry of the type 16 halftone dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. This property may contain one of two different types: 1) A string representing a PDF name object. If provided, this item must always take the value "Identity". 2) A FunctionElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 133, page 314. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 131, page 377.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the type 1 halftone dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 130, page 309. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 128, page 371.

Create an empty Type1HalftoneElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a Type1HalftoneElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a Type1HalftoneElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new Type1HalftoneElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "HalftoneName" entry of the type 1 halftone dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. This string contains raw byte data. So it looks like a string but really it is just a wrapper for data. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 130, page 309. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 128, page 371.

Represents the "Frequency" entry of the type 1 halftone dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a double representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 130, page 309. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 128, page 371.

Represents the "Angle" entry of the type 1 halftone dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a double representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 130, page 309. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 128, page 371.

Represents the "SpotFunction" entry of the type 1 halftone dictionary object. It is a required entry defined as part of the PDF 1.0 specification. This property may contain one of two different types: 1) A string representing a PDF name object. This item may take one of the following valid values: SimpleDotInvertedSimpleDotDoubleDotInvertedDoubleDotCosineDotDoubleInvertedDoubleLineLineXLineYRoundEllipseEllipseAInvertedEllipseAEllipseBEllipseCInvertedEllipseCSquareCrossRhomboidDiamond 2) A FunctionElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 130, page 309. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 128, page 371.

Represents the "AccurateScreens" entry of the type 1 halftone dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a bool representing a PDF boolean object. The PDF specification states that this item assumes a value of false if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 130, page 309. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 128, page 371.

Represents the "TransferFunction" entry of the type 1 halftone dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. This property may contain one of two different types: 1) A string representing a PDF name object. If provided, this item must always take the value "Identity". 2) A FunctionElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 130, page 310. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 128, page 371.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the type 5 halftone dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 134, page 315. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 132, page 377.

Create an empty Type5HalftoneElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a Type5HalftoneElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a Type5HalftoneElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new Type5HalftoneElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "HalftoneName" entry of the type 5 halftone dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. This string contains raw byte data. So it looks like a string but really it is just a wrapper for data. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 134, page 315. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 132, page 377.

Represents the "Default" entry of the type 5 halftone dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains an HalftoneElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 134, page 315. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 132, page 377.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the type 6 halftone dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 131, page 310. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 129, page 372.

Create an empty Type6HalftoneElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a Type6HalftoneElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a Type6HalftoneElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new Type6HalftoneElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "HalftoneName" entry of the type 6 halftone dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. This string contains raw byte data. So it looks like a string but really it is just a wrapper for data. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 131, page 310. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 129, page 372.

Represents the "Width" entry of the type 6 halftone dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 131, page 310. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 129, page 372.

Represents the "Height" entry of the type 6 halftone dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 131, page 310. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 129, page 372.

Represents the "TransferFunction" entry of the type 6 halftone dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. This property may contain one of two different types: 1) A string representing a PDF name object. If provided, this item must always take the value "Identity". 2) A FunctionElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 131, page 311. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 129, page 373.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the group attributes dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 147, page 349. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 145, page 419.

Create an empty GroupAttributesElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a GroupAttributesElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a GroupAttributesElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new GroupAttributesElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the group attributes dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. If provided, this item must always take the value "Group". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 147, page 349. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 145, page 419.

Represents the "S" entry of the group attributes dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. This item must always be provided and must always take the value "Transparency". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 147, page 349. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 145, page 419.

Represents the "CS" entry of the group attributes dictionary object. It is defined as part of the PDF 1.0 specification. It contains a ColorSpaceElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 147, page 350. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 145, page 419.

Represents the "I" entry of the group attributes dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a bool representing a PDF boolean object. The PDF specification states that this item assumes a value of false if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 147, page 350. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 145, page 419.

Represents the "K" entry of the group attributes dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a bool representing a PDF boolean object. The PDF specification states that this item assumes a value of false if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 147, page 351. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 145, page 419.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the soft-mask dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 144, page 347. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 142, page 416.

Create an empty SoftMaskElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a SoftMaskElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a SoftMaskElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new SoftMaskElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the soft-mask dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. If provided, this item must always take the value "Mask". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 144, page 347. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 142, page 416.

Represents the "S" entry of the soft-mask dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. This item may take one of the following valid values: AlphaLuminosity For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 144, page 347. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 142, page 416.

Represents the "G" entry of the soft-mask dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a XObjectElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 144, page 347. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 142, page 416.

Represents the "BC" entry of the soft-mask dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains doubles, representing PDF numeric objects. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 144, page 347. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 142, page 416.

Represents the "TR" entry of the soft-mask dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. This property may contain one of two different types: 1) A string representing a PDF name object. The PDF specification states that this item assumes a value of "Identity" if no value has been provided. If provided, this item must always take the value "Identity". 2) A FunctionElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 144, page 347. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 142, page 416.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the action dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 193, page 414. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 196, page 502.

Create an empty ActionElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a ActionElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a ActionElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new ActionElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the action dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. If provided, this item must always take the value "Action". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 193, page 414. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 196, page 502.

Represents the "S" entry of the action dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. This item may take one of the following valid values: GoToGoToRGoToELaunchThreadURISoundMovieHideNamedSubmitFormResetFormImportDataJavaScriptSetOCGStateRenditionTransGoTo3DViewRichMediaExecuteGoToDp For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 193, page 414. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 196, page 502.

Represents the "Next" entry of the action dictionary object. It is an optional entry defined as part of the PDF 1.2 specification. It contains an array which contains ActionElements. If you read the specification you will see that an array of one ActionElement may be represented as a single ActionElement rather than an array. However we always present this property as an array to simplify the interface. It is only if you add or remove items in the array, that the underlying representation will be changed. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 193, page 414. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 196, page 503.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the annotation additional-actions dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 194, page 415. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 197, page 504.

Create an empty AnnotationAdditionalActionsElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a AnnotationAdditionalActionsElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a AnnotationAdditionalActionsElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new AnnotationAdditionalActionsElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "E" entry of the annotation additional-actions dictionary object. It is an optional entry defined as part of the PDF 1.2 specification. It contains an ActionElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 194, page 415. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 197, page 504.

Represents the "X" entry of the annotation additional-actions dictionary object. It is an optional entry defined as part of the PDF 1.2 specification. It contains an ActionElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 194, page 415. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 197, page 504.

Represents the "D" entry of the annotation additional-actions dictionary object. It is an optional entry defined as part of the PDF 1.2 specification. It contains an ActionElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 194, page 415. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 197, page 504.

Represents the "U" entry of the annotation additional-actions dictionary object. It is an optional entry defined as part of the PDF 1.2 specification. It contains an ActionElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 194, page 415. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 197, page 504.

Represents the "Fo" entry of the annotation additional-actions dictionary object. It is an optional entry defined as part of the PDF 1.2 specification. It contains an ActionElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 194, page 415. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 197, page 504.

Represents the "Bl" entry of the annotation additional-actions dictionary object. It is an optional entry defined as part of the PDF 1.2 specification. It contains an ActionElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 194, page 415. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 197, page 504.

Represents the "PO" entry of the annotation additional-actions dictionary object. It is an optional entry defined as part of the PDF 1.5 specification. It contains an ActionElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 194, page 415. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 197, page 504.

Represents the "PC" entry of the annotation additional-actions dictionary object. It is an optional entry defined as part of the PDF 1.5 specification. It contains an ActionElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 194, page 416. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 197, page 504.

Represents the "PV" entry of the annotation additional-actions dictionary object. It is an optional entry defined as part of the PDF 1.5 specification. It contains an ActionElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 194, page 416. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 197, page 504.

Represents the "PI" entry of the annotation additional-actions dictionary object. It is an optional entry defined as part of the PDF 1.5 specification. It contains an ActionElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 194, page 416. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 197, page 504.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the annotation dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 164, page 383. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 252, page 467. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 166, page 464. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 255, page 565. This class is always an indirect object because HideActionElement.EntryT, MarkupAnnotationElement.EntryIRT, PageObjectElement.EntryAnnots and PopUpAnnotationElement.EntryParent require it to be so.

Create an empty AnnotationElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a AnnotationElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a AnnotationElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new AnnotationElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the annotation dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. If provided, this item must always take the value "Annot". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 164, page 383. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 166, page 464. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 252, page 467. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 255, page 565.

Represents the "Subtype" entry of the annotation dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 164, page 383. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 166, page 464. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 252, page 467. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 255, page 565.

Represents the "Rect" entry of the annotation dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a RectangleElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 164, page 383. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 166, page 464. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 252, page 467. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 255, page 565.

Represents the "Contents" entry of the annotation dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 164, page 383. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 166, page 464. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 252, page 467. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 255, page 565.

Represents the "P" entry of the annotation dictionary object. It is defined as part of the PDF 1.3 specification. It contains a PageObjectElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 164, page 383. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 166, page 464. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 252, page 467. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 255, page 565.

Represents the "NM" entry of the annotation dictionary object. It is an optional entry defined as part of the PDF 1.4 specification. It contains a string representing a PDF string object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 164, page 383. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 166, page 464. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 252, page 467. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 255, page 565.

Represents the "M" entry of the annotation dictionary object. It is an optional entry defined as part of the PDF 1.1 specification. It contains a string representing a PDF string object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 164, page 383. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 166, page 464. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 252, page 467. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 255, page 565.

Represents the "F" entry of the annotation dictionary object. It is an optional entry defined as part of the PDF 1.1 specification. It contains an integer representing a PDF numeric object. The PDF specification states that this item assumes a value of 0 if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 164, page 383. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 166, page 464. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 252, page 467. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 255, page 565.

Represents the "AP" entry of the annotation dictionary object. It is an optional entry defined as part of the PDF 1.2 specification. It contains an AppearanceElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 164, page 383. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 166, page 465. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 252, page 467. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 255, page 565.

Represents the "AS" entry of the annotation dictionary object. It is defined as part of the PDF 1.2 specification. It contains a string representing a PDF name object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 164, page 383. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 166, page 465. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 252, page 467. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 255, page 565.

Represents the "Border" entry of the annotation dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains Elements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 164, page 384. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 166, page 465. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 252, page 467. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 255, page 565.

Represents the "C" entry of the annotation dictionary object. It is an optional entry defined as part of the PDF 1.1 specification. It contains an array which contains doubles, representing PDF numeric objects. Items in this array should have a minimum value of 0 and a maximum of 1. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 164, page 384. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 166, page 465. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 252, page 467. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 255, page 565.

Represents the "StructParent" entry of the annotation dictionary object. It is defined as part of the PDF 1.3 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 164, page 384. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 166, page 466. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 252, page 467. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 255, page 565.

Represents the "OC" entry of the annotation dictionary object. It is an optional entry defined as part of the PDF 1.5 specification. This property may contain one of two different types: 1) An OptionalContentGroupElement. 2) An OptionalContentMembershipElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 164, page 384. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 166, page 466. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 252, page 467. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 255, page 565.

Represents the "Page" entry of the annotation dictionary object. It is defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 164, page 383. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 166, page 464. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 252, page 467. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 255, page 565.

Represents the "AF" entry of the annotation dictionary object. It is an optional entry defined as part of the PDF 2.0 specification. It contains an array which contains FileSpecificationElements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 164, page 383. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 166, page 466. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 252, page 467. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 255, page 565.

Represents the "ca" entry of the annotation dictionary object. It is an optional entry defined as part of the PDF 2.0 specification. It contains a double representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 164, page 383. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 166, page 466. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 252, page 467. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 255, page 565.

Represents the "CA" entry of the annotation dictionary object. It is an optional entry defined as part of the PDF 2.0 specification. It contains a double representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 164, page 383. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 166, page 466. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 252, page 467. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 255, page 565.

Represents the "BM" entry of the annotation dictionary object. It is an optional entry defined as part of the PDF 2.0 specification. It contains a string representing a PDF name object. The PDF specification states that this item assumes a value of "Normal" if no value has been provided. This item may take one of the following valid values: NormalCompatibleMultiplyScreenOverlayDarkenLightenColorDodgeColorBurnHardLightSoftLightDifferenceExclusionHueSaturationColorLuminosity For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 164, page 383. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 166, page 467. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 252, page 467. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 255, page 565.

Represents the "Lang" entry of the annotation dictionary object. It is an optional entry defined as part of the PDF 2.0 specification. It contains a string representing a PDF string object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 164, page 383. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 166, page 467. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 252, page 467. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 255, page 565.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the appearance characteristics dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 189, page 409. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 192, page 496.

Create an empty AppearanceCharacteristicsElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a AppearanceCharacteristicsElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a AppearanceCharacteristicsElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new AppearanceCharacteristicsElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "R" entry of the appearance characteristics dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. The PDF specification states that this item assumes a value of 0 if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 189, page 409. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 192, page 496.

Represents the "BC" entry of the appearance characteristics dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains doubles, representing PDF numeric objects. Items in this array should have a minimum value of 0 and a maximum of 1. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 189, page 409. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 192, page 496.

Represents the "BG" entry of the appearance characteristics dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains doubles, representing PDF numeric objects. Items in this array should have a minimum value of 0 and a maximum of 1. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 189, page 409. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 192, page 496.

Represents the "CA" entry of the appearance characteristics dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 189, page 409. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 192, page 496.

Represents the "RC" entry of the appearance characteristics dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 189, page 409. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 192, page 496.

Represents the "AC" entry of the appearance characteristics dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 189, page 409. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 192, page 496.

Represents the "I" entry of the appearance characteristics dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a FormXObjectElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 189, page 410. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 192, page 497.

Represents the "RI" entry of the appearance characteristics dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a FormXObjectElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 189, page 410. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 192, page 497.

Represents the "IX" entry of the appearance characteristics dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a FormXObjectElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 189, page 410. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 192, page 497.

Represents the "IF" entry of the appearance characteristics dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an IconFitElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 189, page 410. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 192, page 497.

Represents the "TP" entry of the appearance characteristics dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. The PDF specification states that this item assumes a value of 0 if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 189, page 410. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 192, page 497.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the appearance dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 168, page 389. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 170, page 472.

Create an empty AppearanceElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a AppearanceElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a AppearanceElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new AppearanceElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "N" entry of the appearance dictionary object. It is a required entry defined as part of the PDF 1.0 specification. This property may contain one of two different types: 1) An Element. 2) A FormXObjectElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 168, page 389. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 170, page 472.

Represents the "R" entry of the appearance dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. This property may contain one of two different types: 1) An Element. 2) A FormXObjectElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 168, page 389. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 170, page 472.

Represents the "D" entry of the appearance dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. This property may contain one of two different types: 1) An Element. 2) A FormXObjectElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 168, page 389. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 170, page 472.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the bead dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 161, page 376. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 163, page 457. This class is always an indirect object because BeadElement.EntryN, BeadElement.EntryV, PageObjectElement.EntryB, ThreadActionElement.EntryB and ThreadElement.EntryF require it to be so.

Create an empty BeadElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a BeadElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a BeadElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new BeadElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the bead dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. If provided, this item must always take the value "Bead". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 161, page 376. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 163, page 457.

Represents the "T" entry of the bead dictionary object. It is defined as part of the PDF 1.0 specification. It contains a ThreadElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 161, page 376. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 163, page 457.

Represents the "N" entry of the bead dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a BeadElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 161, page 376. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 163, page 457.

Represents the "V" entry of the bead dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a BeadElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 161, page 376. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 163, page 457.

Represents the "P" entry of the bead dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a PageObjectElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 161, page 376. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 163, page 457.

Represents the "R" entry of the bead dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a RectangleElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 161, page 376. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 163, page 457.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the border effect dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 167, page 387. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 169, page 470.

Create an empty BorderEffectElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a BorderEffectElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a BorderEffectElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new BorderEffectElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "S" entry of the border effect dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. The PDF specification states that this item assumes a value of "S" if no value has been provided. This item may take one of the following valid values: SC For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 167, page 387. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 169, page 470.

Represents the "I" entry of the border effect dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a double representing a PDF numeric object. It should have a minimum value of 0 and a maximum of 2. The PDF specification states that this item assumes a value of 0 if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 167, page 387. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 169, page 470.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the border style dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 166, page 386. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 168, page 469.

Create an empty BorderStyleElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a BorderStyleElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a BorderStyleElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new BorderStyleElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the border style dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. If provided, this item must always take the value "Border". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 166, page 386. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 168, page 469.

Represents the "W" entry of the border style dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a double representing a PDF numeric object. The PDF specification states that this item assumes a value of 1 if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 166, page 386. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 168, page 469.

Represents the "S" entry of the border style dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. This item may take one of the following valid values: SDBIU For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 166, page 387. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 168, page 470.

Represents the "D" entry of the border style dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains Elements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 166, page 387. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 168, page 470.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the caret annotation. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 180, page 404. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 183, page 489. This class is always an indirect object because it inherits from MarkupAnnotationElement which is always an indirect object.

Create an empty CaretAnnotationElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a CaretAnnotationElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a CaretAnnotationElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new CaretAnnotationElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "RD" entry of the caret annotation object. It is an optional entry defined as part of the PDF 1.5 specification. It contains a RectangleElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 180, page 404. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 183, page 490.

Represents the "Sy" entry of the caret annotation object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. The PDF specification states that this item assumes a value of "None" if no value has been provided. This item may take one of the following valid values: PNone For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 180, page 404. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 183, page 490.

Represents the "IT" entry of the caret annotation object. It is an optional entry defined as part of the PDF 1.6 specification. It contains a string representing a PDF name object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 180, page 404. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 183, page 489.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the catalog uri dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 207, page 424. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 211, page 515.

Create an empty CatalogUriElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a CatalogUriElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a CatalogUriElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new CatalogUriElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Base" entry of the catalog uri dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. This is encoded as a string using single byte ASCII encoding. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 207, page 424. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 211, page 515.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the certificate seed value dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 235, page 449. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 238, page 545.

Create an empty CertificateSeedValueElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a CertificateSeedValueElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a CertificateSeedValueElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new CertificateSeedValueElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the certificate seed value dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. If provided, this item must always take the value "SVCert". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 235, page 449. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 238, page 545.

Represents the "Ff" entry of the certificate seed value dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. The PDF specification states that this item assumes a value of 0 if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 235, page 449. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 238, page 545.

Represents the "Subject" entry of the certificate seed value dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains strings, representing PDF string objects. This string contains raw byte data. So it looks like a string but really it is just a wrapper for data. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 235, page 449. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 238, page 545.

Represents the "SubjectDN" entry of the certificate seed value dictionary object. It is an optional entry defined as part of the PDF 1.7 specification. It contains an array which contains Elements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 235, page 450. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 238, page 546.

Represents the "KeyUsage" entry of the certificate seed value dictionary object. It is an optional entry defined as part of the PDF 1.7 specification. It contains an array which contains strings, representing PDF string objects. This is encoded as a string using single byte ASCII encoding. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 235, page 450. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 238, page 546.

Represents the "Issuer" entry of the certificate seed value dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains strings, representing PDF string objects. This string contains raw byte data. So it looks like a string but really it is just a wrapper for data. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 235, page 450. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 238, page 547.

Represents the "OID" entry of the certificate seed value dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains strings, representing PDF string objects. This string contains raw byte data. So it looks like a string but really it is just a wrapper for data. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 235, page 450. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 238, page 547.

Represents the "URL" entry of the certificate seed value dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. This is encoded as a string using single byte ASCII encoding. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 235, page 451. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 238, page 547.

Represents the "URLType" entry of the certificate seed value dictionary object. It is an optional entry defined as part of the PDF 1.7 specification. It contains a string representing a PDF name object. The PDF specification states that this item assumes a value of "Browser" if no value has been provided. The specification defines this as exensible which means that it may contain entries in addition to those defined in the specification. In fact almost all objects are extensible but the fact that it is explicitly mentioned, implies that extra entries should be regarded as normal rather than exceptional. For further details see The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: Annex E, page 673.. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 235, page 451. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 238, page 547.

Represents the "SignaturePolicyOID" entry of the certificate seed value dictionary object. It is defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. This is encoded as a string using single byte ASCII encoding. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 235, page 449. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 238, page 545.

Represents the "SignaturePolicyHashValue" entry of the certificate seed value dictionary object. It is defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 235, page 449. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 238, page 545.

Represents the "SignaturePolicyHashAlgorithm" entry of the certificate seed value dictionary object. It is defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 235, page 449. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 238, page 545.

Represents the "SignaturePolicyCommitmentType" entry of the certificate seed value dictionary object. It is defined as part of the PDF 1.0 specification. It contains an array which contains strings, representing PDF string objects. This is encoded as a string using single byte ASCII encoding. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 235, page 449. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 238, page 545.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the checkbox field dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 227, page 441. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 230, page 534. This class is always an indirect object because it inherits from FieldElement which is always an indirect object.

Create an empty CheckboxFieldElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a CheckboxFieldElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a CheckboxFieldElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new CheckboxFieldElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the circle annotation. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 177, page 401. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 180, page 486. This class is always an indirect object because it inherits from MarkupAnnotationElement which is always an indirect object.

Create an empty CircleAnnotationElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a CircleAnnotationElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a CircleAnnotationElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new CircleAnnotationElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "BS" entry of the circle annotation object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a BorderStyleElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 177, page 401. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 180, page 486.

Represents the "IC" entry of the circle annotation object. It is an optional entry defined as part of the PDF 1.4 specification. It contains an array which contains doubles, representing PDF numeric objects. Items in this array should have a minimum value of 0 and a maximum of 1. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 177, page 402. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 180, page 487.

Represents the "BE" entry of the circle annotation object. It is an optional entry defined as part of the PDF 1.5 specification. It contains a BorderEffectElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 177, page 402. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 180, page 487.

Represents the "RD" entry of the circle annotation object. It is an optional entry defined as part of the PDF 1.5 specification. It contains a RectangleElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 177, page 402. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 180, page 487.

Represents the "IT" entry of the circle annotation object. It is an optional entry defined as part of the PDF 1.6 specification. It contains a string representing a PDF name object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 177, page 401. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 180, page 486.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the collection colors dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 157, page 449. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.6a, page 31.

Create an empty CollectionColorsElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a CollectionColorsElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a CollectionColorsElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new CollectionColorsElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the collection colors dictionary object. It is an optional entry defined as part of the PDF 2.0 specification. It contains a string representing a PDF name object. If provided, this item must always take the value "CollectionColors". For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.6a, page 31. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 157, page 449.

Represents the "Background" entry of the collection colors dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains an array which contains doubles, representing PDF numeric objects. Items in this array should have a minimum value of 0 and a maximum of 1. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.6a, page 31. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 157, page 449.

Represents the "CardBackground" entry of the collection colors dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains an array which contains doubles, representing PDF numeric objects. Items in this array should have a minimum value of 0 and a maximum of 1. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.6a, page 31. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 157, page 449.

Represents the "CardBorder" entry of the collection colors dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains an array which contains doubles, representing PDF numeric objects. Items in this array should have a minimum value of 0 and a maximum of 1. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.6a, page 31. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 157, page 449.

Represents the "PrimaryText" entry of the collection colors dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains an array which contains doubles, representing PDF numeric objects. Items in this array should have a minimum value of 0 and a maximum of 1. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.6a, page 31. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 157, page 450.

Represents the "SecondaryText" entry of the collection colors dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains an array which contains doubles, representing PDF numeric objects. Items in this array should have a minimum value of 0 and a maximum of 1. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.6a, page 31. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 157, page 450.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the collection dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 155, page 371. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 153, page 445. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.6, page 29.

Create an empty CollectionElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a CollectionElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a CollectionElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new CollectionElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the collection dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. If provided, this item must always take the value "Collection". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 155, page 371. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.6, page 29. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 153, page 445.

Represents the "Schema" entry of the collection dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a CollectionSchemaElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 155, page 371. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.6, page 29. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 153, page 446.

Represents the "D" entry of the collection dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. This string contains raw byte data. So it looks like a string but really it is just a wrapper for data. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 155, page 371. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.6, page 29. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 153, page 446.

Represents the "Sort" entry of the collection dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a CollectionSortElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 155, page 371. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.6, page 29. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 153, page 447.

Represents the "View" entry of the collection dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. The PDF specification states that this item assumes a value of "D" if no value has been provided. This item may take one of the following valid values: DTHC For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 155, page 371. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.6, page 29. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 153, page 446.

Represents the "Navigator" entry of the collection dictionary object. It is defined as part of the PDF 1.7 Extension Level 3 specification. It contains a NavigatorElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 155, page 371. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.6, page 29. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 153, page 446.

Represents the "Resources" entry of the collection dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a NameTreeNodeElement containing StreamElements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 155, page 371. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.6, page 29. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 153, page 445.

Represents the "Colors" entry of the collection dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a CollectionColorsElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 155, page 371. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.6, page 29. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 153, page 446.

Represents the "Folders" entry of the collection dictionary object. It is defined as part of the PDF 1.7 Extension Level 3 specification. It contains a FolderElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 155, page 371. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.6, page 29. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 153, page 447.

Represents the "Split" entry of the collection dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a CollectionSplitElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 155, page 371. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.6, page 29. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 153, page 447.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the collection field dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 157, page 372. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 155, page 448. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.8, page 30.

Create an empty CollectionFieldElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a CollectionFieldElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a CollectionFieldElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new CollectionFieldElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the collection field dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. If provided, this item must always take the value "CollectionField". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 157, page 372. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.8, page 30. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 155, page 448.

Represents the "Subtype" entry of the collection field dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. This item may take one of the following valid values: SDNFDescModDateCreationDateSizeCompressedSize For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 157, page 372. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.8, page 30. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 155, page 448.

Represents the "N" entry of the collection field dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 157, page 372. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.8, page 30. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 155, page 448.

Represents the "O" entry of the collection field dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 157, page 372. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.8, page 30. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 155, page 448.

Represents the "V" entry of the collection field dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a bool representing a PDF boolean object. The PDF specification states that this item assumes a value of true if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 157, page 372. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.8, page 30. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 155, page 448.

Represents the "E" entry of the collection field dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a bool representing a PDF boolean object. The PDF specification states that this item assumes a value of false if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 157, page 372. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.8, page 30. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 155, page 448.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the collection schema dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 156, page 371. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 154, page 447.

Create an empty CollectionSchemaElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a CollectionSchemaElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a CollectionSchemaElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new CollectionSchemaElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the collection schema dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. If provided, this item must always take the value "CollectionSchema". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 156, page 371. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 154, page 447.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the collection sort dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 158, page 373. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 156, page 449.

Create an empty CollectionSortElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a CollectionSortElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a CollectionSortElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new CollectionSortElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the collection sort dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. If provided, this item must always take the value "CollectionSort". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 158, page 373. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 156, page 449.

Represents the "S" entry of the collection sort dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains an array which contains strings, representing PDF name objects. If you read the specification you will see that an array of one string may be represented as a single string rather than an array. However we always present this property as an array to simplify the interface. It is only if you add or remove items in the array, that the underlying representation will be changed. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 158, page 373. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 156, page 449.

Represents the "A" entry of the collection sort dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains bool representing a PDF boolean objects. The PDF specification states that items in this array assume a value of true if no value has been provided. If you read the specification you will see that an array of one bool may be represented as a single bool rather than an array. However we always present this property as an array to simplify the interface. It is only if you add or remove items in the array, that the underlying representation will be changed. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 158, page 373. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 156, page 449.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the collection split dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 158, page 450. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.6b, page 31.

Create an empty CollectionSplitElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a CollectionSplitElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a CollectionSplitElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new CollectionSplitElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the collection split dictionary object. It is an optional entry defined as part of the PDF 2.0 specification. It contains a string representing a PDF name object. If provided, this item must always take the value "CollectionSplit". For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.6b, page 31. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 158, page 450.

Represents the "Direction" entry of the collection split dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a string representing a PDF name object. This item may take one of the following valid values: HVN For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.6b, page 31. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 158, page 450.

Represents the "Position" entry of the collection split dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a double representing a PDF numeric object. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.6b, page 31. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 158, page 450.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the combo field. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 231, page 445. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 234, page 539. This class is always an indirect object because it inherits from FieldElement which is always an indirect object.

Create an empty ComboFieldElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a ComboFieldElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a ComboFieldElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new ComboFieldElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "TI" entry of the combo field object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 231, page 445. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 234, page 539.

Represents the "I" entry of the combo field object. It is defined as part of the PDF 1.4 specification. It contains an array which contains integers, representing PDF numeric objects. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 231, page 445. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 234, page 539.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the cuepoint dictionary. This is definitively detailed in: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.51e, page 92.

Create an empty CuePointElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a CuePointElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a CuePointElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new CuePointElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the cuepoint dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a string representing a PDF name object. If provided, this item must always take the value "CuePoint". For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.51e, page 92.

Represents the "Subtype" entry of the cuepoint dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a string representing a PDF name object. This item may take one of the following valid values: NavigationEvent For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.51e, page 92.

Represents the "Name" entry of the cuepoint dictionary object. It is a required entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a string representing a PDF string object. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.51e, page 92.

Represents the "Time" entry of the cuepoint dictionary object. It is a required entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a double representing a PDF numeric object. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.51e, page 92.

Represents the "A" entry of the cuepoint dictionary object. It is a required entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains an ActionElement. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.51e, page 92.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the docmdp transform parameters dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 254, page 471. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 257, page 569.

Create an empty DocMDPTransformParametersElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a DocMDPTransformParametersElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a DocMDPTransformParametersElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new DocMDPTransformParametersElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "P" entry of the docmdp transform parameters dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. It should have a minimum value of 1 and a maximum of 3. The PDF specification states that this item assumes a value of 2 if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 254, page 471. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 257, page 570.

Represents the "V" entry of the docmdp transform parameters dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. The PDF specification states that this item assumes a value of "1.2" if no value has been provided. This item may take one of the following valid values: 1.21 For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 254, page 471. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 257, page 570.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the document catalog additional-actions dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 197, page 417. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 200, page 505.

Create an empty DocumentCatalogAdditionalActionsElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a DocumentCatalogAdditionalActionsElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a DocumentCatalogAdditionalActionsElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new DocumentCatalogAdditionalActionsElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "WC" entry of the document catalog additional-actions dictionary object. It is an optional entry defined as part of the PDF 1.4 specification. It contains a JavaScriptActionElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 197, page 417. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 200, page 505.

Represents the "WS" entry of the document catalog additional-actions dictionary object. It is an optional entry defined as part of the PDF 1.4 specification. It contains a JavaScriptActionElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 197, page 417. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 200, page 505.

Represents the "DS" entry of the document catalog additional-actions dictionary object. It is an optional entry defined as part of the PDF 1.4 specification. It contains a JavaScriptActionElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 197, page 417. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 200, page 505.

Represents the "WP" entry of the document catalog additional-actions dictionary object. It is an optional entry defined as part of the PDF 1.4 specification. It contains a JavaScriptActionElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 197, page 417. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 200, page 505.

Represents the "DP" entry of the document catalog additional-actions dictionary object. It is an optional entry defined as part of the PDF 1.4 specification. It contains a JavaScriptActionElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 197, page 417. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 200, page 506.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the document part go-to action. This is definitively detailed in: The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 206, page 512.

Create an empty DocumentPartGoToActionElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a DocumentPartGoToActionElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a DocumentPartGoToActionElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new DocumentPartGoToActionElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Dp" entry of the document part go-to action object. It is a required entry defined as part of the PDF 2.0 specification. It contains a DocumentPartElement. For definitive details see: The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 206, page 512.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the document security store dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 261, page 582. This class is always an indirect object because SignatureValidationRelatedInformationElement.EntryCRL and SignatureValidationRelatedInformationElement.EntryOCSP require it to be so.

Create an empty DocumentSecurityStoreElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a DocumentSecurityStoreElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a DocumentSecurityStoreElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new DocumentSecurityStoreElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the document security store dictionary object. It is an optional entry defined as part of the PDF 2.0 specification. It contains a string representing a PDF name object. If provided, this item must always take the value "DSS". For definitive details see: The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 261, page 582.

Represents the "VRI" entry of the document security store dictionary object. It is an optional entry defined as part of the PDF 2.0 specification. It contains an Element. For definitive details see: The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 261, page 583.

Represents the "Certs" entry of the document security store dictionary object. It is an optional entry defined as part of the PDF 2.0 specification. It contains an array which contains StreamElements. For definitive details see: The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 261, page 583.

Represents the "OCSPs" entry of the document security store dictionary object. It is an optional entry defined as part of the PDF 2.0 specification. It contains an array which contains StreamElements. For definitive details see: The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 261, page 583.

Represents the "CRLs" entry of the document security store dictionary object. It is an optional entry defined as part of the PDF 2.0 specification. It contains an array which contains StreamElements. For definitive details see: The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 261, page 583.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the embedded go-to action. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 201, page 420. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 204, page 510.

Create an empty EmbeddedGoToActionElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a EmbeddedGoToActionElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a EmbeddedGoToActionElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new EmbeddedGoToActionElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "F" entry of the embedded go-to action object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a FileSpecificationElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 201, page 420. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 204, page 510.

Represents the "D" entry of the embedded go-to action object. It is a required entry defined as part of the PDF 1.0 specification. This property may contain one of three different types: 1) A string representing a PDF name object. 2) A string representing a PDF string object. This string contains raw byte data. So it looks like a string but really it is just a wrapper for data. 3) A DestinationElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 201, page 420. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 204, page 510.

Represents the "NewWindow" entry of the embedded go-to action object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a bool representing a PDF boolean object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 201, page 420. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 204, page 510.

Represents the "T" entry of the embedded go-to action object. It is defined as part of the PDF 1.0 specification. It contains a TargetElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 201, page 420. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 204, page 510.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the external data dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 170, page 391. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 332, page 695. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 173, page 477. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.21, page 38. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39g, page 76.

Create an empty ExternalDataElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a ExternalDataElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a ExternalDataElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new ExternalDataElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the external data dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. If provided, this item must always take the value "ExData". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 170, page 391. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.21, page 38. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 332, page 695. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 173, page 477. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39g, page 76.

Represents the "Subtype" entry of the external data dictionary object. It is defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 170, page 391. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.21, page 38. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 332, page 695. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 173, page 477. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39g, page 76.

Represents the "M3DREF" entry of the external data dictionary object. It is a required entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a D3DMeasurementElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 170, page 391. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.21, page 38. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 332, page 695. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 173, page 477. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39g, page 76.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the fdf dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 243, page 459. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 246, page 556.

Create an empty FDFElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a FDFElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a FDFElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new FDFElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "F" entry of the fdf dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a FileSpecificationElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 243, page 459. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 246, page 556.

Represents the "ID" entry of the fdf dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains strings, representing PDF string objects. This string contains raw byte data. So it looks like a string but really it is just a wrapper for data. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 243, page 459. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 246, page 556.

Represents the "Fields" entry of the fdf dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains FDFFieldElements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 243, page 459. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 246, page 556.

Represents the "Status" entry of the fdf dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. This is encoded as a string using single byte PDFDocEncoding. This is broadly similar to ASCII but with different values above 127. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 243, page 459. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 246, page 556.

Represents the "Pages" entry of the fdf dictionary object. It is an optional entry defined as part of the PDF 1.3 specification. It contains an array which contains FDFPageElements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 243, page 459. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 246, page 556.

Represents the "Encoding" entry of the fdf dictionary object. It is an optional entry defined as part of the PDF 1.3 specification. It contains a string representing a PDF name object. The PDF specification states that this item assumes a value of "PDFDocEncoding" if no value has been provided. This item may take one of the following valid values: PDFDocEncodingShiftBigFiveGBKUHCutf For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 243, page 459. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 246, page 556.

Represents the "Annots" entry of the fdf dictionary object. It is an optional entry defined as part of the PDF 1.3 specification. It contains an array which contains AnnotationElements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 243, page 459. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 246, page 556.

Represents the "Differences" entry of the fdf dictionary object. It is an optional entry defined as part of the PDF 1.4 specification. It contains a StreamElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 243, page 460. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 246, page 557.

Represents the "Target" entry of the fdf dictionary object. It is an optional entry defined as part of the PDF 1.4 specification. It contains a string representing a PDF string object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 243, page 460. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 246, page 557.

Represents the "EmbeddedFDFs" entry of the fdf dictionary object. It is an optional entry defined as part of the PDF 1.4 specification. It contains an array which contains FileSpecificationElements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 243, page 460. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 246, page 557.

Represents the "JavaScript" entry of the fdf dictionary object. It is an optional entry defined as part of the PDF 1.4 specification. It contains a FDFJavaScriptElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 243, page 460. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 246, page 557.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the fdf field dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 246, page 461. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 249, page 559.

Create an empty FDFFieldElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a FDFFieldElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a FDFFieldElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new FDFFieldElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Kids" entry of the fdf field dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains FieldElements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 246, page 461. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 249, page 559.

Represents the "T" entry of the fdf field dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 246, page 461. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 249, page 559.

Represents the "V" entry of the fdf field dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. This property may contain one of five different types: 1) A string representing a PDF name object. 2) An array which contains strings, representing PDF string objects. If you read the specification you will see that an array of one string may be represented as a single string rather than an array. However we always present this property as an array to simplify the interface. It is only if you add or remove items in the array, that the underlying representation will be changed. 3) A Null. 4) A SignatureElement. 5) A StreamElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 246, page 461. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 249, page 559.

Represents the "Ff" entry of the fdf field dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 246, page 461. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 249, page 559.

Represents the "SetFf" entry of the fdf field dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 246, page 461. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 249, page 559.

Represents the "ClrFf" entry of the fdf field dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 246, page 462. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 249, page 559.

Represents the "F" entry of the fdf field dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 246, page 462. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 249, page 559.

Represents the "SetF" entry of the fdf field dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 246, page 462. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 249, page 559.

Represents the "ClrF" entry of the fdf field dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 246, page 462. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 249, page 559.

Represents the "AP" entry of the fdf field dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an AppearanceElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 246, page 462. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 249, page 560.

Represents the "APRef" entry of the fdf field dictionary object. It is an optional entry defined as part of the PDF 1.3 specification. It contains an AppearanceElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 246, page 462. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 249, page 560.

Represents the "IF" entry of the fdf field dictionary object. It is an optional entry defined as part of the PDF 1.3 specification. It contains an IconFitElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 246, page 462. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 249, page 560.

Represents the "Opt" entry of the fdf field dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains an array which contains Elements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 246, page 462. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 249, page 560.

Represents the "A" entry of the fdf field dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an ActionElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 246, page 462. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 249, page 560.

Represents the "AA" entry of the fdf field dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a FormFieldAdditionalActionsElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 246, page 462. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 249, page 560.

Represents the "RV" entry of the fdf field dictionary object. It is an optional entry defined as part of the PDF 1.5 specification. This property may contain one of two different types: 1) A string representing a PDF string object. 2) A TextStreamElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 246, page 462. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 249, page 560.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the fdf javascript dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 245, page 461. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 248, page 558.

Create an empty FDFJavaScriptElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a FDFJavaScriptElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a FDFJavaScriptElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new FDFJavaScriptElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Before" entry of the fdf javascript dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. This property may contain one of two different types: 1) A string representing a PDF string object. 2) A TextStreamElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 245, page 461. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 248, page 558.

Represents the "After" entry of the fdf javascript dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. This property may contain one of two different types: 1) A string representing a PDF string object. 2) A TextStreamElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 245, page 461. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 248, page 558.

Represents the "AfterPermsReady" entry of the fdf javascript dictionary object. It is an optional entry defined as part of the PDF 1.6 specification. This property may contain one of two different types: 1) A string representing a PDF string object. 2) A TextStreamElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 245, page 461. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 248, page 558.

Represents the "Doc" entry of the fdf javascript dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains Elements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 245, page 461. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 248, page 558.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the fdf named page reference dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 250, page 464. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 253, page 562.

Create an empty FDFNamedPageReferenceElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a FDFNamedPageReferenceElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a FDFNamedPageReferenceElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new FDFNamedPageReferenceElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Name" entry of the fdf named page reference dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 250, page 464. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 253, page 562.

Represents the "F" entry of the fdf named page reference dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a FileSpecificationElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 250, page 464. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 253, page 562.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the fdf page dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 248, page 463. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 251, page 561.

Create an empty FDFPageElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a FDFPageElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a FDFPageElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new FDFPageElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Templates" entry of the fdf page dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains an array which contains FDFTemplateElements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 248, page 463. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 251, page 561.

Represents the "Info" entry of the fdf page dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an Element. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 248, page 463. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 251, page 561.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the fdf template dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 249, page 464. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 252, page 562.

Create an empty FDFTemplateElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a FDFTemplateElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a FDFTemplateElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new FDFTemplateElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "TRef" entry of the fdf template dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a FDFNamedPageReferenceElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 249, page 464. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 252, page 562.

Represents the "Fields" entry of the fdf template dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains FieldElements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 249, page 464. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 252, page 562.

Represents the "Rename" entry of the fdf template dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a bool representing a PDF boolean object. The PDF specification states that this item assumes a value of true if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 249, page 464. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 252, page 562.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the field dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 220, page 432. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 222, page 434. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 226, page 527. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 228, page 529. This class is always an indirect object because FDFFieldElement.EntryKids, FDFTemplateElement.EntryFields, FieldElement.EntryKids, InteractiveFormElement.EntryCO, InteractiveFormElement.EntryFields, ResetFormActionElement.EntryFields, SubmitFormActionElement.EntryFields and WidgetAnnotationElement.EntryParent require it to be so.

Create an empty FieldElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a FieldElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a FieldElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new FieldElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Any WidgetAnnotationElement associated with this Field.

Represents the "FT" entry of the field dictionary object. It is defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. This item may take one of the following valid values: BtnTxChSig For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 220, page 432. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 226, page 527. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 222, page 434. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 228, page 529.

Represents the "Parent" entry of the field dictionary object. It is defined as part of the PDF 1.0 specification. It contains a FieldElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 220, page 432. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 226, page 527. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 222, page 434. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 228, page 529.

Represents the "Kids" entry of the field dictionary object. It is defined as part of the PDF 1.0 specification. It contains an array which contains FieldElements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 220, page 433. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 226, page 527. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 222, page 434. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 228, page 529.

Represents the "T" entry of the field dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 220, page 433. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 226, page 527. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 222, page 434. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 228, page 529.

Represents the "TU" entry of the field dictionary object. It is an optional entry defined as part of the PDF 1.3 specification. It contains a string representing a PDF string object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 220, page 433. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 226, page 527. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 222, page 434. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 228, page 529.

Represents the "TM" entry of the field dictionary object. It is an optional entry defined as part of the PDF 1.3 specification. It contains a string representing a PDF string object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 220, page 433. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 226, page 527. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 222, page 434. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 228, page 529.

Represents the "Ff" entry of the field dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. The PDF specification states that this item assumes a value of 0 if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 220, page 433. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 226, page 527. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 222, page 434. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 228, page 529.

Represents the "V" entry of the field dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. This property may contain one of five different types: 1) A string representing a PDF name object. 2) An array which contains strings, representing PDF string objects. If you read the specification you will see that an array of one string may be represented as a single string rather than an array. However we always present this property as an array to simplify the interface. It is only if you add or remove items in the array, that the underlying representation will be changed. 3) A Null. 4) A SignatureElement. 5) A StreamElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 220, page 433. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 226, page 527. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 222, page 434. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 228, page 529.

Represents the "DV" entry of the field dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. This property may contain one of five different types: 1) A string representing a PDF name object. 2) An array which contains strings, representing PDF string objects. If you read the specification you will see that an array of one string may be represented as a single string rather than an array. However we always present this property as an array to simplify the interface. It is only if you add or remove items in the array, that the underlying representation will be changed. 3) A Null. 4) A SignatureElement. 5) A StreamElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 220, page 433. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 226, page 527. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 222, page 434. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 228, page 529.

Represents the "AA" entry of the field dictionary object. It is an optional entry defined as part of the PDF 1.2 specification. It contains a FormFieldAdditionalActionsElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 220, page 433. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 226, page 528. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 222, page 434. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 228, page 529.

Represents the "DA" entry of the field dictionary object. It is defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 220, page 432. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 226, page 527. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 222, page 434. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 228, page 529.

Represents the "Q" entry of the field dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. It should have a minimum value of 0 and a maximum of 2. The PDF specification states that this item assumes a value of 0 if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 220, page 432. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 226, page 527. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 222, page 434. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 228, page 529.

Represents the "DS" entry of the field dictionary object. It is an optional entry defined as part of the PDF 1.5 specification. It contains a string representing a PDF string object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 220, page 432. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 226, page 527. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 222, page 434. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 228, page 529.

Represents the "RV" entry of the field dictionary object. It is an optional entry defined as part of the PDF 1.5 specification. This property may contain one of two different types: 1) A string representing a PDF string object. 2) A TextStreamElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 220, page 432. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 226, page 527. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 222, page 434. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 228, page 529.

Represents the "Opt" entry of the field dictionary object. It is an optional entry defined as part of the PDF 1.4 specification. It contains an array which contains Elements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 220, page 432. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 226, page 527. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 222, page 434. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 228, page 529.

Represents the "MaxLen" entry of the field dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 220, page 432. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 226, page 527. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 222, page 434. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 228, page 529.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the fieldmdp transform parameters dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 256, page 473. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 259, page 572.

Create an empty FieldMDPTransformParametersElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a FieldMDPTransformParametersElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a FieldMDPTransformParametersElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new FieldMDPTransformParametersElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Action" entry of the fieldmdp transform parameters dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. This item may take one of the following valid values: AllIncludeExclude For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 256, page 473. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 259, page 573.

Represents the "Fields" entry of the fieldmdp transform parameters dictionary object. It is defined as part of the PDF 1.0 specification. It contains an array which contains strings, representing PDF string objects. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 256, page 473. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 259, page 573.

Represents the "V" entry of the fieldmdp transform parameters dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. The PDF specification states that this item assumes a value of "1.2" if no value has been provided. This item may take one of the following valid values: 1.21 For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 256, page 474. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 259, page 573.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the file attachment annotation. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 184, page 406. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 187, page 492. This class is always an indirect object because it inherits from MarkupAnnotationElement which is always an indirect object.

Create an empty FileAttachmentAnnotationElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a FileAttachmentAnnotationElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a FileAttachmentAnnotationElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new FileAttachmentAnnotationElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "FS" entry of the file attachment annotation object. It is a required entry defined as part of the PDF 1.0 specification. It contains a FileSpecificationElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 184, page 406. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 187, page 492.

Represents the "Name" entry of the file attachment annotation object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. The PDF specification states that this item assumes a value of "PushPin" if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 184, page 406. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 187, page 492.

Represents the "IT" entry of the file attachment annotation object. It is an optional entry defined as part of the PDF 1.6 specification. It contains a string representing a PDF name object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 184, page 406. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 187, page 492.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the fixed print dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 191, page 411. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 194, page 498.

Create an empty FixedPrintElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a FixedPrintElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a FixedPrintElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new FixedPrintElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the fixed print dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. This item must always be provided and must always take the value "FixedPrint". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 191, page 411. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 194, page 498.

Represents the "Matrix" entry of the fixed print dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a MatrixElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 191, page 411. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 194, page 498.

Represents the "H" entry of the fixed print dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a double representing a PDF numeric object. The PDF specification states that this item assumes a value of 0 if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 191, page 411. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 194, page 498.

Represents the "V" entry of the fixed print dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a double representing a PDF numeric object. The PDF specification states that this item assumes a value of 0 if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 191, page 411. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 194, page 499.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the folder dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 159, page 450. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.6c, page 32. This class is always an indirect object because CollectionElement.EntryFolders, FolderElement.EntryChild, FolderElement.EntryNext and FolderElement.EntryParent require it to be so.

Create an empty FolderElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a FolderElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a FolderElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new FolderElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the folder dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a string representing a PDF name object. If provided, this item must always take the value "Folder". For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.6c, page 32. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 159, page 450.

Represents the "ID" entry of the folder dictionary object. It is a required entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains an integer representing a PDF numeric object. It should have a minimum value of 0. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.6c, page 32. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 159, page 451.

Represents the "Name" entry of the folder dictionary object. It is a required entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a string representing a PDF string object. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.6c, page 32. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 159, page 451.

Represents the "Parent" entry of the folder dictionary object. It is defined as part of the PDF 1.7 Extension Level 3 specification. It contains a FolderElement. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.6c, page 32. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 159, page 451.

Represents the "Child" entry of the folder dictionary object. It is defined as part of the PDF 1.7 Extension Level 3 specification. It contains a FolderElement. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.6c, page 32. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 159, page 451.

Represents the "Next" entry of the folder dictionary object. It is defined as part of the PDF 1.7 Extension Level 3 specification. It contains a FolderElement. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.6c, page 32. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 159, page 451.

Represents the "CI" entry of the folder dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a CollectionItemElement. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.6c, page 32. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 159, page 451.

Represents the "Desc" entry of the folder dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a string representing a PDF string object. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.6c, page 32. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 159, page 451.

Represents the "CreationDate" entry of the folder dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a string representing a PDF string object. This is encoded as a date string. For details see the StringAtom.DateToString and StringAtom.StringToDate functions. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.6c, page 32. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 159, page 451.

Represents the "ModDate" entry of the folder dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a string representing a PDF string object. This is encoded as a date string. For details see the StringAtom.DateToString and StringAtom.StringToDate functions. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.6c, page 32. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 159, page 451.

Represents the "Thumb" entry of the folder dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains an ImageXObjectElement. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.6c, page 32. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 159, page 451.

Represents the "Free" entry of the folder dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains an array which contains doubles, representing PDF numeric objects. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.6c, page 32. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 159, page 451.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the form field additional-actions dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 196, page 416. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 199, page 505.

Create an empty FormFieldAdditionalActionsElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a FormFieldAdditionalActionsElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a FormFieldAdditionalActionsElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new FormFieldAdditionalActionsElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "K" entry of the form field additional-actions dictionary object. It is an optional entry defined as part of the PDF 1.3 specification. It contains a JavaScriptActionElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 196, page 416. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 199, page 505.

Represents the "F" entry of the form field additional-actions dictionary object. It is an optional entry defined as part of the PDF 1.3 specification. It contains a JavaScriptActionElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 196, page 416. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 199, page 505.

Represents the "V" entry of the form field additional-actions dictionary object. It is an optional entry defined as part of the PDF 1.3 specification. It contains a JavaScriptActionElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 196, page 416. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 199, page 505.

Represents the "C" entry of the form field additional-actions dictionary object. It is an optional entry defined as part of the PDF 1.3 specification. It contains a JavaScriptActionElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 196, page 416. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 199, page 505.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the free text annotation. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 174, page 396. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 177, page 480. This class is always an indirect object because it inherits from MarkupAnnotationElement which is always an indirect object.

Create an empty FreeTextAnnotationElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a FreeTextAnnotationElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a FreeTextAnnotationElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new FreeTextAnnotationElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "DA" entry of the free text annotation object. It is a required entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 174, page 396. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 177, page 480.

Represents the "Q" entry of the free text annotation object. It is an optional entry defined as part of the PDF 1.4 specification. It contains an integer representing a PDF numeric object. It should have a minimum value of 0 and a maximum of 2. The PDF specification states that this item assumes a value of 0 if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 174, page 396. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 177, page 481.

Represents the "DS" entry of the free text annotation object. It is an optional entry defined as part of the PDF 1.5 specification. It contains a string representing a PDF string object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 174, page 396. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 177, page 481.

Represents the "CL" entry of the free text annotation object. It is an optional entry defined as part of the PDF 1.6 specification. It contains an array which contains doubles, representing PDF numeric objects. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 174, page 396. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 177, page 481.

Represents the "IT" entry of the free text annotation object. It is an optional entry defined as part of the PDF 1.6 specification. It contains a string representing a PDF name object. The PDF specification states that this item assumes a value of "FreeText" if no value has been provided. This item may take one of the following valid values: FreeTextFreeTextCalloutFreeTextTypeWriter For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 174, page 396. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 177, page 481.

Represents the "BE" entry of the free text annotation object. It is an optional entry defined as part of the PDF 1.6 specification. It contains a BorderEffectElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 174, page 396. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 177, page 481.

Represents the "RD" entry of the free text annotation object. It is an optional entry defined as part of the PDF 1.6 specification. It contains a RectangleElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 174, page 397. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 177, page 481.

Represents the "BS" entry of the free text annotation object. It is an optional entry defined as part of the PDF 1.6 specification. It contains a BorderStyleElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 174, page 397. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 177, page 481.

Represents the "LE" entry of the free text annotation object. It is an optional entry defined as part of the PDF 1.6 specification. It contains a string representing a PDF name object. The PDF specification states that this item assumes a value of "None" if no value has been provided. This item may take one of the following valid values: SquareCircleDiamondOpenArrowClosedArrowNoneButtROpenArrowRClosedArrowSlash For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 174, page 397. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 177, page 482.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the geographic coordinate system dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 270, page 600. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.111b, page 51.

Create an empty GeographicCoordinateSystemElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a GeographicCoordinateSystemElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a GeographicCoordinateSystemElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new GeographicCoordinateSystemElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the geographic coordinate system dictionary object. It is a required entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a string representing a PDF name object. This item must always be provided and must always take the value "GEOGCS". For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.111b, page 51. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 270, page 600.

Represents the "EPSG" entry of the geographic coordinate system dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains an integer representing a PDF numeric object. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.111b, page 51. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 270, page 600.

Represents the "WKT" entry of the geographic coordinate system dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a string representing a PDF string object. This is encoded as a string using single byte ASCII encoding. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.111b, page 51. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 270, page 600.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the geospatial measure dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 269, page 598. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.111a, page 50.

Create an empty GeospatialMeasureElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a GeospatialMeasureElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a GeospatialMeasureElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new GeospatialMeasureElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Bounds" entry of the geospatial measure dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains an array which contains doubles, representing PDF numeric objects. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.111a, page 50. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 269, page 598.

Represents the "GCS" entry of the geospatial measure dictionary object. It is a required entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a ProjectedCoordinateSystemElement. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.111a, page 50. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 269, page 598.

Represents the "DCS" entry of the geospatial measure dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a ProjectedCoordinateSystemElement. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.111a, page 50. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 269, page 598.

Represents the "PDU" entry of the geospatial measure dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains an array which contains strings, representing PDF name objects. Items in this array may take one of the following valid values: .MKMFTUSFTMINMSQMHASQKMSQFTASQMIDEGGRD400 For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.111a, page 50. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 269, page 599.

Represents the "GPTS" entry of the geospatial measure dictionary object. It is a required entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains an array which contains doubles, representing PDF numeric objects. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.111a, page 50. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 269, page 599.

Represents the "LPTS" entry of the geospatial measure dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains an array which contains doubles, representing PDF numeric objects. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.111a, page 50. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 269, page 599.

Represents the "PCSM" entry of the geospatial measure dictionary object. It is an optional entry defined as part of the PDF 2.0 specification. It contains an array which contains doubles, representing PDF numeric objects. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.111a, page 50. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 269, page 599.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the go-to-3D-view action. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 216, page 429. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 220, page 522.

Create an empty GoTo3DViewActionElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a GoTo3DViewActionElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a GoTo3DViewActionElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new GoTo3DViewActionElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "TA" entry of the go-to-3d-view action object. It is a required entry defined as part of the PDF 1.0 specification. It contains an AnnotationElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 216, page 429. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 220, page 522.

Represents the "V" entry of the go-to-3d-view action object. It is a required entry defined as part of the PDF 1.0 specification. This property may contain one of four different types: 1) An integer representing a PDF numeric object. 2) A string representing a PDF name object. This item may take one of the following valid values: FLNPD 3) A string representing a PDF string object. 4) A D3DViewElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 216, page 429. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 220, page 522.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the go-to action. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 199, page 418. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 202, page 507.

Create an empty GoToActionElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a GoToActionElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a GoToActionElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new GoToActionElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "D" entry of the go-to action object. It is a required entry defined as part of the PDF 1.0 specification. This property may contain one of three different types: 1) A string representing a PDF name object. 2) A string representing a PDF string object. This string contains raw byte data. So it looks like a string but really it is just a wrapper for data. 3) A DestinationElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 199, page 418. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 202, page 507.

Represents the "SD" entry of the go-to action object. It is an optional entry defined as part of the PDF 2.0 specification. It contains a DestinationElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 199, page 418. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 202, page 508.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the hide action. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 210, page 426. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 214, page 518.

Create an empty HideActionElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a HideActionElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a HideActionElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new HideActionElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "T" entry of the hide action object. It is a required entry defined as part of the PDF 1.0 specification. This property may contain one of three different types: 1) A string representing a PDF string object. 2) An array which contains Elements. 3) An AnnotationElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 210, page 426. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 214, page 518.

Represents the "H" entry of the hide action object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a bool representing a PDF boolean object. The PDF specification states that this item assumes a value of true if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 210, page 426. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 214, page 518.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the icon fit dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 247, page 463. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 250, page 560.

Create an empty IconFitElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a IconFitElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a IconFitElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new IconFitElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "SW" entry of the icon fit dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. The PDF specification states that this item assumes a value of "A" if no value has been provided. This item may take one of the following valid values: ABSN For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 247, page 463. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 250, page 560.

Represents the "S" entry of the icon fit dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. The PDF specification states that this item assumes a value of "P" if no value has been provided. This item may take one of the following valid values: AP For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 247, page 463. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 250, page 561.

Represents the "A" entry of the icon fit dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains doubles, representing PDF numeric objects. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 247, page 463. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 250, page 561.

Represents the "FB" entry of the icon fit dictionary object. It is an optional entry defined as part of the PDF 1.5 specification. It contains a bool representing a PDF boolean object. The PDF specification states that this item assumes a value of false if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 247, page 463. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 250, page 561.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the import-data action. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 240, page 456. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 243, page 552.

Create an empty ImportDataActionElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a ImportDataActionElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a ImportDataActionElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new ImportDataActionElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "F" entry of the import-data action object. It is a required entry defined as part of the PDF 1.0 specification. It contains a FileSpecificationElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 240, page 456. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 243, page 552.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the ink annotation. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 182, page 405. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 185, page 491. This class is always an indirect object because it inherits from MarkupAnnotationElement which is always an indirect object.

Create an empty InkAnnotationElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a InkAnnotationElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a InkAnnotationElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new InkAnnotationElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "InkList" entry of the ink annotation object. It is a required entry defined as part of the PDF 1.0 specification. It contains an array which contains Elements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 182, page 405. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 185, page 491.

Represents the "BS" entry of the ink annotation object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a BorderStyleElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 182, page 405. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 185, page 491.

Represents the "IT" entry of the ink annotation object. It is an optional entry defined as part of the PDF 1.6 specification. It contains a string representing a PDF name object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 182, page 405. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 185, page 491.

Represents the "Path" entry of the ink annotation object. It is an optional entry defined as part of the PDF 2.0 specification. It contains an array which contains Elements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 182, page 405. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 185, page 491.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the interactive form dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 218, page 431. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 224, page 525.

Create an empty InteractiveFormElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a InteractiveFormElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a InteractiveFormElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new InteractiveFormElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Fields" entry of the interactive form dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains an array which contains FieldElements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 218, page 431. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 224, page 525.

Represents the "NeedAppearances" entry of the interactive form dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It was deprecated in PDF 2.0. It contains a bool representing a PDF boolean object. The PDF specification states that this item assumes a value of false if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 218, page 431. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 224, page 525.

Represents the "SigFlags" entry of the interactive form dictionary object. It is an optional entry defined as part of the PDF 1.3 specification. It contains an integer representing a PDF numeric object. The PDF specification states that this item assumes a value of 0 if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 218, page 431. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 224, page 525.

Represents the "CO" entry of the interactive form dictionary object. It is defined as part of the PDF 1.3 specification. It contains an array which contains FieldElements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 218, page 431. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 224, page 525.

Represents the "DR" entry of the interactive form dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a ResourceElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 218, page 431. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 224, page 525.

Represents the "DA" entry of the interactive form dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 218, page 431. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 224, page 525.

Represents the "Q" entry of the interactive form dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 218, page 431. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 224, page 526.

Represents the "XFA" entry of the interactive form dictionary object. It is an optional entry defined as part of the PDF 1.5 specification. It was deprecated in PDF 2.0. This property may contain one of two different types: 1) An array which contains Elements. 2) A StreamElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 218, page 431. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 224, page 526.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the javascript action. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 217, page 430. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 221, page 523.

Create an empty JavaScriptActionElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a JavaScriptActionElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a JavaScriptActionElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new JavaScriptActionElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "JS" entry of the javascript action object. It is a required entry defined as part of the PDF 1.0 specification. This property may contain one of two different types: 1) A string representing a PDF string object. 2) A TextStreamElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 217, page 430. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 221, page 523.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the launch action. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 203, page 422. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 207, page 513.

Create an empty LaunchActionElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a LaunchActionElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a LaunchActionElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new LaunchActionElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "F" entry of the launch action object. It is defined as part of the PDF 1.0 specification. It contains a FileSpecificationElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 203, page 422. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 207, page 513.

Represents the "Win" entry of the launch action object. It is an optional entry defined as part of the PDF 1.0 specification. It was deprecated in PDF 2.0. It contains an Element. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 203, page 422. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 207, page 513.

Represents the "Mac" entry of the launch action object. It is an optional entry defined as part of the PDF 1.0 specification. It was deprecated in PDF 2.0. The specification defines this property as being of undefined type. So the type of atom or data contained is not part of the specification. For practical purposes this means it may be of any type. It contains an Element. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 203, page 422. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 207, page 513.

Represents the "Unix" entry of the launch action object. It is an optional entry defined as part of the PDF 1.0 specification. It was deprecated in PDF 2.0. The specification defines this property as being of undefined type. So the type of atom or data contained is not part of the specification. For practical purposes this means it may be of any type. It contains an Element. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 203, page 422. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 207, page 513.

Represents the "NewWindow" entry of the launch action object. It is an optional entry defined as part of the PDF 1.2 specification. It contains a bool representing a PDF boolean object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 203, page 422. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 207, page 513.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the legal attestation dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 259, page 478. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 264, page 590.

Create an empty LegalAttestationElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a LegalAttestationElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a LegalAttestationElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new LegalAttestationElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "JavaScriptActions" entry of the legal attestation dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 259, page 478. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 264, page 590.

Represents the "LaunchActions" entry of the legal attestation dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 259, page 478. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 264, page 590.

Represents the "URIActions" entry of the legal attestation dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 259, page 478. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 264, page 590.

Represents the "MovieActions" entry of the legal attestation dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It was deprecated in PDF 2.0. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 259, page 478. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 264, page 590.

Represents the "SoundActions" entry of the legal attestation dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It was deprecated in PDF 2.0. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 259, page 478. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 264, page 590.

Represents the "HideAnnotationActions" entry of the legal attestation dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 259, page 478. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 264, page 590.

Represents the "GoToRemoteActions" entry of the legal attestation dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 259, page 478. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 264, page 590.

Represents the "AlternateImages" entry of the legal attestation dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 259, page 478. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 264, page 590.

Represents the "ExternalStreams" entry of the legal attestation dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 259, page 478. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 264, page 590.

Represents the "TrueTypeFonts" entry of the legal attestation dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 259, page 478. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 264, page 590.

Represents the "ExternalRefXobjects" entry of the legal attestation dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 259, page 478. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 264, page 590.

Represents the "ExternalOPIdicts" entry of the legal attestation dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It was deprecated in PDF 2.0. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 259, page 478. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 264, page 590.

Represents the "NonEmbeddedFonts" entry of the legal attestation dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 259, page 478. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 264, page 590.

Represents the "DevDepGS_OP" entry of the legal attestation dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 259, page 478. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 264, page 590.

Represents the "DevDepGS_HT" entry of the legal attestation dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 259, page 478. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 264, page 590.

Represents the "DevDepGS_TR" entry of the legal attestation dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 259, page 478. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 264, page 590.

Represents the "DevDepGS_UCR" entry of the legal attestation dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 259, page 478. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 264, page 590.

Represents the "DevDepGS_BG" entry of the legal attestation dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 259, page 478. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 264, page 591.

Represents the "DevDepGS_FL" entry of the legal attestation dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 259, page 478. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 264, page 591.

Represents the "Annotations" entry of the legal attestation dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 259, page 478. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 264, page 591.

Represents the "OptionalContent" entry of the legal attestation dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a bool representing a PDF boolean object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 259, page 478. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 264, page 591.

Represents the "Attestation" entry of the legal attestation dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 259, page 478. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 264, page 591.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the line annotation. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 175, page 398. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 178, page 482. This class is always an indirect object because it inherits from MarkupAnnotationElement which is always an indirect object.

Create an empty LineAnnotationElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a LineAnnotationElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a LineAnnotationElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new LineAnnotationElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "L" entry of the line annotation object. It is a required entry defined as part of the PDF 1.0 specification. It contains an array which contains doubles, representing PDF numeric objects. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 175, page 398. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 178, page 482.

Represents the "BS" entry of the line annotation object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a BorderStyleElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 175, page 398. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 178, page 482.

Represents the "LE" entry of the line annotation object. It is an optional entry defined as part of the PDF 1.4 specification. It contains an array which contains strings, representing PDF name objects. Items in this array may take one of the following valid values: SquareCircleDiamondOpenArrowClosedArrowNoneButtROpenArrowRClosedArrowSlash For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 175, page 398. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 178, page 482.

Represents the "IC" entry of the line annotation object. It is an optional entry defined as part of the PDF 1.4 specification. It contains an array which contains doubles, representing PDF numeric objects. Items in this array should have a minimum value of 0 and a maximum of 1. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 175, page 398. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 178, page 483.

Represents the "LL" entry of the line annotation object. It is defined as part of the PDF 1.6 specification. It contains a double representing a PDF numeric object. It should have a positive value. The PDF specification states that this item assumes a value of 0 if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 175, page 398. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 178, page 483.

Represents the "LLE" entry of the line annotation object. It is an optional entry defined as part of the PDF 1.6 specification. It contains a double representing a PDF numeric object. It should have a minimum value of 0. The PDF specification states that this item assumes a value of 0 if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 175, page 398. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 178, page 483.

Represents the "Cap" entry of the line annotation object. It is an optional entry defined as part of the PDF 1.6 specification. It contains a bool representing a PDF boolean object. The PDF specification states that this item assumes a value of false if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 175, page 398. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 178, page 483.

Represents the "IT" entry of the line annotation object. It is an optional entry defined as part of the PDF 1.6 specification. It contains a string representing a PDF name object. This item may take one of the following valid values: LineArrowLineDimension For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 175, page 398. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 178, page 483.

Represents the "LLO" entry of the line annotation object. It is an optional entry defined as part of the PDF 1.7 specification. It contains a double representing a PDF numeric object. It should have a minimum value of 0. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 175, page 399. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 178, page 483.

Represents the "CP" entry of the line annotation object. It is an optional entry defined as part of the PDF 1.7 specification. It contains a string representing a PDF name object. The PDF specification states that this item assumes a value of "Inline" if no value has been provided. This item may take one of the following valid values: InlineTop For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 175, page 399. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 178, page 483.

Represents the "Measure" entry of the line annotation object. It is an optional entry defined as part of the PDF 1.7 specification. It contains a MeasureElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 175, page 399. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 178, page 483.

Represents the "CO" entry of the line annotation object. It is an optional entry defined as part of the PDF 1.7 specification. It contains an array which contains doubles, representing PDF numeric objects. Items in this array should have a positive value. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 175, page 399. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 178, page 484.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the link annotation. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 173, page 394. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 176, page 479. This class is always an indirect object because it inherits from AnnotationElement which is always an indirect object.

Create an empty LinkAnnotationElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a LinkAnnotationElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a LinkAnnotationElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new LinkAnnotationElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "A" entry of the link annotation object. It is an optional entry defined as part of the PDF 1.1 specification. It contains an ActionElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 173, page 394. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 176, page 479.

Represents the "Dest" entry of the link annotation object. It is an optional entry defined as part of the PDF 1.0 specification. This property may contain one of three different types: 1) A string representing a PDF name object. 2) A string representing a PDF string object. This string contains raw byte data. So it looks like a string but really it is just a wrapper for data. 3) A DestinationElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 173, page 395. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 176, page 479.

Represents the "H" entry of the link annotation object. It is an optional entry defined as part of the PDF 1.2 specification. It contains a string representing a PDF name object. The PDF specification states that this item assumes a value of "I" if no value has been provided. This item may take one of the following valid values: NIOP For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 173, page 395. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 176, page 479.

Represents the "PA" entry of the link annotation object. It is an optional entry defined as part of the PDF 1.3 specification. It contains an UriActionElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 173, page 395. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 176, page 479.

Represents the "QuadPoints" entry of the link annotation object. It is an optional entry defined as part of the PDF 1.6 specification. It contains an array which contains doubles, representing PDF numeric objects. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 173, page 395. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 176, page 480.

Represents the "BS" entry of the link annotation object. It is an optional entry defined as part of the PDF 1.6 specification. It contains a BorderStyleElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 173, page 395. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 176, page 480.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the list field. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 231, page 445. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 234, page 539. This class is always an indirect object because it inherits from FieldElement which is always an indirect object.

Create an empty ListFieldElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a ListFieldElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a ListFieldElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new ListFieldElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "TI" entry of the list field object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. The PDF specification states that this item assumes a value of 0 if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 231, page 445. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 234, page 539.

Represents the "I" entry of the list field object. It is defined as part of the PDF 1.4 specification. It contains an array which contains integers, representing PDF numeric objects. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 231, page 445. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 234, page 539.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the markup annotation. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 170, page 391. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 332, page 695. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.21, page 38. This class is always an indirect object because it inherits from AnnotationElement which is always an indirect object.

Create an empty MarkupAnnotationElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a MarkupAnnotationElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a MarkupAnnotationElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new MarkupAnnotationElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "T" entry of the markup annotation object. It is an optional entry defined as part of the PDF 1.1 specification. It contains a string representing a PDF string object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 170, page 391. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.21, page 38. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 332, page 695.

Represents the "Popup" entry of the markup annotation object. It is an optional entry defined as part of the PDF 1.3 specification. It contains a PopUpAnnotationElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 170, page 391. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.21, page 38. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 332, page 695.

Represents the "RC" entry of the markup annotation object. It is an optional entry defined as part of the PDF 1.5 specification. This property may contain one of two different types: 1) A string representing a PDF string object. 2) A TextStreamElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 170, page 392. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.21, page 38. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 332, page 695.

Represents the "CreationDate" entry of the markup annotation object. It is an optional entry defined as part of the PDF 1.5 specification. It contains a string representing a PDF string object. This is encoded as a date string. For details see the StringAtom.DateToString and StringAtom.StringToDate functions. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 170, page 392. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.21, page 38. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 332, page 695.

Represents the "IRT" entry of the markup annotation object. It is defined as part of the PDF 1.5 specification. It contains an AnnotationElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 170, page 392. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.21, page 38. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 332, page 695.

Represents the "Subj" entry of the markup annotation object. It is an optional entry defined as part of the PDF 1.5 specification. It contains a string representing a PDF string object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 170, page 392. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.21, page 38. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 332, page 695.

Represents the "RT" entry of the markup annotation object. It is an optional entry defined as part of the PDF 1.6 specification. It contains a string representing a PDF name object. The PDF specification states that this item assumes a value of "R" if no value has been provided. This item may take one of the following valid values: RGroup For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 170, page 392. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.21, page 38. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 332, page 695.

Represents the "ExData" entry of the markup annotation object. It is an optional entry defined as part of the PDF 1.7 specification. It contains an ExternalDataElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 170, page 393. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.21, page 38. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 332, page 695.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the measure dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 261, page 480. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 266, page 593. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.110, page 49.

Create an empty MeasureElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a MeasureElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a MeasureElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new MeasureElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the measure dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. If provided, this item must always take the value "Measure". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 261, page 480. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.110, page 49. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 266, page 593.

Represents the "Subtype" entry of the measure dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. The PDF specification states that this item assumes a value of "RL" if no value has been provided. This item may take one of the following valid values: RLGEO For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 261, page 480. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.110, page 49. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 266, page 593.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the movie action. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 209, page 425. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 213, page 517.

Create an empty MovieActionElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a MovieActionElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a MovieActionElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new MovieActionElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Annotation" entry of the movie action object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a MovieAnnotationElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 209, page 425. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 213, page 517.

Represents the "T" entry of the movie action object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 209, page 425. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 213, page 517.

Represents the "Operation" entry of the movie action object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. The PDF specification states that this item assumes a value of "Play" if no value has been provided. This item may take one of the following valid values: PlayStopPauseResume For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 209, page 426. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 213, page 517.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the movie annotation. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 186, page 407. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 189, page 493. This class is always an indirect object because MovieActionElement.EntryAnnotation requires it to be so.

Create an empty MovieAnnotationElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a MovieAnnotationElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a MovieAnnotationElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new MovieAnnotationElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "T" entry of the movie annotation object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 186, page 407. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 189, page 493.

Represents the "Movie" entry of the movie annotation object. It is a required entry defined as part of the PDF 1.0 specification. It contains a MovieElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 186, page 407. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 189, page 493.

Represents the "A" entry of the movie annotation object. It is an optional entry defined as part of the PDF 1.0 specification. This property may contain one of two different types: 1) A bool representing a PDF boolean object. The PDF specification states that this item assumes a value of true if no value has been provided. 2) A MovieActivationElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 186, page 407. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 189, page 494.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the named action. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 212, page 427. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 216, page 518.

Create an empty NamedActionElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a NamedActionElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a NamedActionElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new NamedActionElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "N" entry of the named action object. It is a required entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. This item may take one of the following valid values: NextPagePrevPageFirstPageLastPage For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 212, page 427. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 216, page 518.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the navigation node dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 163, page 380. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 165, page 461.

Create an empty NavigationNodeElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a NavigationNodeElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a NavigationNodeElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new NavigationNodeElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the navigation node dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. If provided, this item must always take the value "NavNode". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 163, page 380. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 165, page 461.

Represents the "NA" entry of the navigation node dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an ActionElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 163, page 380. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 165, page 461.

Represents the "PA" entry of the navigation node dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an ActionElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 163, page 380. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 165, page 461.

Represents the "Next" entry of the navigation node dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a NavigationNodeElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 163, page 380. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 165, page 461.

Represents the "Prev" entry of the navigation node dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a NavigationNodeElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 163, page 380. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 165, page 461.

Represents the "Dur" entry of the navigation node dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a double representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 163, page 380. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 165, page 461.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the navigator dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 160, page 454. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.6d, page 34. This class is always an indirect object because CollectionElement.EntryNavigator requires it to be so.

Create an empty NavigatorElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a NavigatorElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a NavigatorElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new NavigatorElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the navigator dictionary object. It is an optional entry defined as part of the PDF 2.0 specification. It contains a string representing a PDF name object. If provided, this item must always take the value "Navigator". For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.6d, page 34. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 160, page 454.

Represents the "SWF" entry of the navigator dictionary object. It is a required entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a string representing a PDF string object. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.6d, page 34. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 160, page 454.

Represents the "Name" entry of the navigator dictionary object. It is a required entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a string representing a PDF string object. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.6d, page 34. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 160, page 454.

Represents the "Desc" entry of the navigator dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a string representing a PDF string object. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.6d, page 34. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 160, page 454.

Represents the "Category" entry of the navigator dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a string representing a PDF string object. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.6d, page 34. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 160, page 454.

Represents the "ID" entry of the navigator dictionary object. It is a required entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a string representing a PDF string object. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.6d, page 34. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 160, page 454.

Represents the "Version" entry of the navigator dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a string representing a PDF string object. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.6d, page 34. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 160, page 454.

Represents the "APIVersion" entry of the navigator dictionary object. It is a required entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a string representing a PDF string object. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.6d, page 34. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 160, page 454.

Represents the "LoadType" entry of the navigator dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a string representing a PDF name object. The PDF specification states that this item assumes a value of "Default" if no value has been provided. This item may take one of the following valid values: ModuleDefault For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.6d, page 34. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 160, page 454.

Represents the "Icon" entry of the navigator dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a string representing a PDF string object. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.6d, page 34. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 160, page 454.

Represents the "Locale" entry of the navigator dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a string representing a PDF string object. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.6d, page 34. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 160, page 454.

Represents the "Strings" entry of the navigator dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a NameTreeNodeElement containing strings, representing PDF string objects. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.6d, page 34. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 160, page 454.

Represents the "InitialFields" entry of the navigator dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a CollectionSchemaElement. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.6d, page 34. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 160, page 454.

Represents the "Resources" entry of the navigator dictionary object. It is a required entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a NameTreeNodeElement containing StreamElements. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.6d, page 34. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 160, page 454.

Represents the "Layout" entry of the navigator dictionary object. It is a required entry defined as part of the PDF 2.0 specification. It contains an array which contains strings, representing PDF name objects. If you read the specification you will see that an array of one string may be represented as a single string rather than an array. However we always present this property as an array to simplify the interface. It is only if you add or remove items in the array, that the underlying representation will be changed. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.6d, page 34. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 160, page 454.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the number format dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 263, page 482. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 268, page 595.

Create an empty NumberFormatElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a NumberFormatElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a NumberFormatElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new NumberFormatElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the number format dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. If provided, this item must always take the value "NumberFormat". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 263, page 482. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 268, page 595.

Represents the "U" entry of the number format dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 263, page 482. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 268, page 595.

Represents the "C" entry of the number format dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a double representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 263, page 482. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 268, page 595.

Represents the "F" entry of the number format dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. The PDF specification states that this item assumes a value of "D" if no value has been provided. This item may take one of the following valid values: DFRT For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 263, page 482. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 268, page 595.

Represents the "D" entry of the number format dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. It should have a minimum value of 1. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 263, page 482. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 268, page 596.

Represents the "FD" entry of the number format dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a bool representing a PDF boolean object. The PDF specification states that this item assumes a value of false if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 263, page 482. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 268, page 596.

Represents the "RT" entry of the number format dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. The PDF specification states that this item assumes a value of "COMMA (2Ch)" if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 263, page 483. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 268, page 596.

Represents the "RD" entry of the number format dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. The PDF specification states that this item assumes a value of "PERIOD (2Eh)" if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 263, page 483. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 268, page 596.

Represents the "PS" entry of the number format dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. The PDF specification states that this item assumes a value of "A single ASCII SPACE character (20h)" if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 263, page 483. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 268, page 596.

Represents the "SS" entry of the number format dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. The PDF specification states that this item assumes a value of "A single ASCII SPACE character (20h)" if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 263, page 483. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 268, page 596.

Represents the "O" entry of the number format dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. The PDF specification states that this item assumes a value of "S" if no value has been provided. This item may take one of the following valid values: SP For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 263, page 483. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 268, page 596.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the outline dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 152, page 368. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 150, page 442. This class is always an indirect object because CatalogElement.EntryOutlines and OutlineItemElement.EntryParent require it to be so.

Create an empty OutlineElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a OutlineElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a OutlineElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new OutlineElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the outline dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. If provided, this item must always take the value "Outlines". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 152, page 368. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 150, page 442.

Represents the "First" entry of the outline dictionary object. It is defined as part of the PDF 1.0 specification. It contains an OutlineItemElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 152, page 368. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 150, page 442.

Represents the "Last" entry of the outline dictionary object. It is defined as part of the PDF 1.0 specification. It contains an OutlineItemElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 152, page 368. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 150, page 442.

Represents the "Count" entry of the outline dictionary object. It is defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 152, page 368. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 150, page 442.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the outline item dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 153, page 368. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 151, page 442. This class is always an indirect object because OutlineElement.EntryFirst, OutlineElement.EntryLast, OutlineItemElement.EntryFirst, OutlineItemElement.EntryLast, OutlineItemElement.EntryNext, OutlineItemElement.EntryParent and OutlineItemElement.EntryPrev require it to be so.

Create an empty OutlineItemElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a OutlineItemElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a OutlineItemElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new OutlineItemElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Title" entry of the outline item dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 153, page 368. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 151, page 442.

Represents the "Parent" entry of the outline item dictionary object. It is a required entry defined as part of the PDF 1.0 specification. This property may contain one of two different types: 1) An OutlineElement. 2) An OutlineItemElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 153, page 368. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 151, page 442.

Represents the "Prev" entry of the outline item dictionary object. It is defined as part of the PDF 1.0 specification. It contains an OutlineItemElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 153, page 368. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 151, page 442.

Represents the "Next" entry of the outline item dictionary object. It is defined as part of the PDF 1.0 specification. It contains an OutlineItemElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 153, page 368. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 151, page 442.

Represents the "First" entry of the outline item dictionary object. It is defined as part of the PDF 1.0 specification. It contains an OutlineItemElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 153, page 368. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 151, page 442.

Represents the "Last" entry of the outline item dictionary object. It is defined as part of the PDF 1.0 specification. It contains an OutlineItemElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 153, page 368. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 151, page 442.

Represents the "Count" entry of the outline item dictionary object. It is defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 153, page 368. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 151, page 443.

Represents the "Dest" entry of the outline item dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. This property may contain one of three different types: 1) A string representing a PDF name object. 2) A string representing a PDF string object. This string contains raw byte data. So it looks like a string but really it is just a wrapper for data. 3) A DestinationElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 153, page 369. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 151, page 443.

Represents the "A" entry of the outline item dictionary object. It is an optional entry defined as part of the PDF 1.1 specification. It contains an ActionElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 153, page 369. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 151, page 443.

Represents the "SE" entry of the outline item dictionary object. It is an optional entry defined as part of the PDF 1.3 specification. This property may contain one of two different types: 1) A StructureElementElement. 2) A StructureTreeRootElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 153, page 369. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 151, page 443.

Represents the "C" entry of the outline item dictionary object. It is an optional entry defined as part of the PDF 1.4 specification. It contains an array which contains doubles, representing PDF numeric objects. Items in this array should have a minimum value of 0 and a maximum of 1. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 153, page 369. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 151, page 443.

Represents the "F" entry of the outline item dictionary object. It is an optional entry defined as part of the PDF 1.4 specification. It contains an integer representing a PDF numeric object. The PDF specification states that this item assumes a value of 0 if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 153, page 369. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 151, page 443.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the page label dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 159, page 375. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 161, page 456.

Create an empty PageLabelElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a PageLabelElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a PageLabelElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new PageLabelElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the page label dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. If provided, this item must always take the value "PageLabel". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 159, page 375. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 161, page 456.

Represents the "S" entry of the page label dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. This item may take one of the following valid values: DRrAa For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 159, page 375. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 161, page 456.

Represents the "P" entry of the page label dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 159, page 375. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 161, page 456.

Represents the "St" entry of the page label dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. The PDF specification states that this item assumes a value of 1 if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 159, page 375. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 161, page 456.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the page object additional-actions dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 195, page 416. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 198, page 505.

Create an empty PageObjectAdditionalActionsElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a PageObjectAdditionalActionsElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a PageObjectAdditionalActionsElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new PageObjectAdditionalActionsElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "O" entry of the page object additional-actions dictionary object. It is an optional entry defined as part of the PDF 1.2 specification. It contains an ActionElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 195, page 416. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 198, page 505.

Represents the "C" entry of the page object additional-actions dictionary object. It is an optional entry defined as part of the PDF 1.2 specification. It contains an ActionElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 195, page 416. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 198, page 505.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the papermetadata generation parameters dictionary. This is definitively detailed in: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.39b, page 47.

Create an empty PaperMetaDataGenerationParametersElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a PaperMetaDataGenerationParametersElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a PaperMetaDataGenerationParametersElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new PaperMetaDataGenerationParametersElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the papermetadata generation parameters dictionary object. It is a required entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a string representing a PDF name object. This item must always be provided and must always take the value "PaperMetaData". For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.39b, page 47.

Represents the "Version" entry of the papermetadata generation parameters dictionary object. It is a required entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a double representing a PDF numeric object. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.39b, page 47.

Represents the "Resolution" entry of the papermetadata generation parameters dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a double representing a PDF numeric object. The PDF specification states that this item assumes a value of 300 if no value has been provided. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.39b, page 47.

Represents the "Caption" entry of the papermetadata generation parameters dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a string representing a PDF string object. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.39b, page 47.

Represents the "Symbology" entry of the papermetadata generation parameters dictionary object. It is a required entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a string representing a PDF name object. This item may take one of the following valid values: PDF417QRCodeDataMatrix For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.39b, page 47.

Represents the "Width" entry of the papermetadata generation parameters dictionary object. It is a required entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a double representing a PDF numeric object. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.39b, page 47.

Represents the "Height" entry of the papermetadata generation parameters dictionary object. It is a required entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a double representing a PDF numeric object. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.39b, page 47.

Represents the "XSymWidth" entry of the papermetadata generation parameters dictionary object. It is a required entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a double representing a PDF numeric object. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.39b, page 47.

Represents the "XSymHeight" entry of the papermetadata generation parameters dictionary object. It is a required entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a double representing a PDF numeric object. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.39b, page 47.

Represents the "ECC" entry of the papermetadata generation parameters dictionary object. It is defined as part of the PDF 1.7 Extension Level 3 specification. It contains a double representing a PDF numeric object. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.39b, page 47.

Represents the "nCodeWordRow" entry of the papermetadata generation parameters dictionary object. It is defined as part of the PDF 1.0 specification. It contains a double representing a PDF numeric object. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.39b, page 47.

Represents the "nCodeWordCol" entry of the papermetadata generation parameters dictionary object. It is defined as part of the PDF 1.0 specification. It contains a double representing a PDF numeric object. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.39b, page 47.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the permissions dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 258, page 477. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 263, page 589.

Create an empty PermissionsElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a PermissionsElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a PermissionsElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new PermissionsElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "DocMDP" entry of the permissions dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a SignatureElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 258, page 477. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 263, page 589.

Represents the "UR3" entry of the permissions dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It was deprecated in PDF 2.0. It contains a SignatureElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 258, page 477. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 263, page 589.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the point data dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 272, page 602. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.111d, page 53.

Create an empty PointDataElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a PointDataElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a PointDataElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new PointDataElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the point data dictionary object. It is a required entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a string representing a PDF name object. This item must always be provided and must always take the value "PtData". For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.111d, page 53. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 272, page 602.

Represents the "Subtype" entry of the point data dictionary object. It is a required entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a string representing a PDF name object. This item must always be provided and must always take the value "Cloud". For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.111d, page 53. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 272, page 602.

Represents the "Names" entry of the point data dictionary object. It is a required entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains an array which contains strings, representing PDF name objects. Items in this array may take one of the following valid values: LATLONALT For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.111d, page 53. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 272, page 602.

Represents the "XPTS" entry of the point data dictionary object. It is a required entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains an array which contains Elements. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.111d, page 53. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 272, page 602.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the polygon annotation. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 178, page 402. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 181, page 487. This class is always an indirect object because it inherits from MarkupAnnotationElement which is always an indirect object.

Create an empty PolygonAnnotationElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a PolygonAnnotationElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a PolygonAnnotationElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new PolygonAnnotationElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Vertices" entry of the polygon annotation object. It is a required entry defined as part of the PDF 1.0 specification. It contains an array which contains doubles, representing PDF numeric objects. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 178, page 402. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 181, page 487.

Represents the "LE" entry of the polygon annotation object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains Elements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 178, page 402. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 181, page 487.

Represents the "BS" entry of the polygon annotation object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a BorderStyleElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 178, page 402. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 181, page 488.

Represents the "IC" entry of the polygon annotation object. It is an optional entry defined as part of the PDF 1.4 specification. It contains an array which contains doubles, representing PDF numeric objects. Items in this array should have a minimum value of 0 and a maximum of 1. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 178, page 403. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 181, page 488.

Represents the "BE" entry of the polygon annotation object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a BorderEffectElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 178, page 403. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 181, page 488.

Represents the "IT" entry of the polygon annotation object. It is an optional entry defined as part of the PDF 1.6 specification. It contains a string representing a PDF name object. This item may take one of the following valid values: PolygonCloudPolyLineDimensionPolygonDimension For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 178, page 403. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 181, page 488.

Represents the "Measure" entry of the polygon annotation object. It is an optional entry defined as part of the PDF 1.7 specification. It contains a MeasureElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 178, page 403. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 181, page 488.

Represents the "Path" entry of the polygon annotation object. It is an optional entry defined as part of the PDF 2.0 specification. It contains an array which contains Elements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 178, page 402. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 181, page 488.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the polyline annotation. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 178, page 402. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 181, page 487. This class is always an indirect object because it inherits from MarkupAnnotationElement which is always an indirect object.

Create an empty PolylineAnnotationElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a PolylineAnnotationElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a PolylineAnnotationElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new PolylineAnnotationElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Vertices" entry of the polyline annotation object. It is a required entry defined as part of the PDF 1.0 specification. It contains an array which contains doubles, representing PDF numeric objects. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 178, page 402. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 181, page 487.

Represents the "LE" entry of the polyline annotation object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains strings, representing PDF name objects. Items in this array may take one of the following valid values: SquareCircleDiamondOpenArrowClosedArrowNoneButtROpenArrowRClosedArrowSlash For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 178, page 402. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 181, page 487.

Represents the "BS" entry of the polyline annotation object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a BorderStyleElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 178, page 402. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 181, page 488.

Represents the "IC" entry of the polyline annotation object. It is an optional entry defined as part of the PDF 1.4 specification. It contains an array which contains doubles, representing PDF numeric objects. Items in this array should have a minimum value of 0 and a maximum of 1. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 178, page 403. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 181, page 488.

Represents the "BE" entry of the polyline annotation object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an Element. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 178, page 403. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 181, page 488.

Represents the "IT" entry of the polyline annotation object. It is an optional entry defined as part of the PDF 1.6 specification. It contains a string representing a PDF name object. This item may take one of the following valid values: PolygonCloudPolyLineDimensionPolygonDimension For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 178, page 403. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 181, page 488.

Represents the "Measure" entry of the polyline annotation object. It is an optional entry defined as part of the PDF 1.7 specification. It contains a MeasureElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 178, page 403. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 181, page 488.

Represents the "Path" entry of the polyline annotation object. It is an optional entry defined as part of the PDF 2.0 specification. It contains an array which contains Elements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 178, page 402. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 181, page 488.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the pop-up annotation. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 183, page 406. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 186, page 492. This class is always an indirect object because MarkupAnnotationElement.EntryPopup requires it to be so.

Create an empty PopUpAnnotationElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a PopUpAnnotationElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a PopUpAnnotationElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new PopUpAnnotationElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Parent" entry of the pop-up annotation object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an AnnotationElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 183, page 406. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 186, page 492.

Represents the "Open" entry of the pop-up annotation object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a bool representing a PDF boolean object. The PDF specification states that this item assumes a value of false if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 183, page 406. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 186, page 492.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the projected coordinate system dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 271, page 601. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.111c, page 52.

Create an empty ProjectedCoordinateSystemElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a ProjectedCoordinateSystemElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a ProjectedCoordinateSystemElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new ProjectedCoordinateSystemElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the projected coordinate system dictionary object. It is a required entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a string representing a PDF name object. This item must always be provided and must always take the value "PROJCS". For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.111c, page 52. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 271, page 601.

Represents the "EPSG" entry of the projected coordinate system dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains an integer representing a PDF numeric object. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.111c, page 52. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 271, page 601.

Represents the "WKT" entry of the projected coordinate system dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a string representing a PDF string object. This is encoded as a string using single byte ASCII encoding. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.111c, page 52. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 271, page 601.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the projection annotation. This is definitively detailed in: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: page39, page 39. This class is always an indirect object because D3DAngularMeasurementElement.EntryS, D3DCommentNoteElement.EntryS, D3DLinearMeasurementElement.EntryS, D3DPerpendicularMeasurementElement.EntryS and D3DRadialMeasurementElement.EntryS require it to be so.

Create an empty ProjectionAnnotationElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a ProjectionAnnotationElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a ProjectionAnnotationElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new ProjectionAnnotationElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "IT" entry of the projection annotation object. It is an optional entry defined as part of the PDF 1.6 specification. It contains a string representing a PDF name object. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: page39, page 39.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the pushbutton field dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; page 440. This class is always an indirect object because it inherits from FieldElement which is always an indirect object.

Create an empty PushbuttonFieldElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a PushbuttonFieldElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a PushbuttonFieldElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new PushbuttonFieldElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the radio field dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 227, page 441. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 230, page 534. This class is always an indirect object because it inherits from FieldElement which is always an indirect object.

Create an empty RadioFieldElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a RadioFieldElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a RadioFieldElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new RadioFieldElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the rectilinear measure dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 262, page 481. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 267, page 594.

Create an empty RectilinearMeasureElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a RectilinearMeasureElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a RectilinearMeasureElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new RectilinearMeasureElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "R" entry of the rectilinear measure dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 262, page 481. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 267, page 594.

Represents the "X" entry of the rectilinear measure dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains an array which contains NumberFormatElements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 262, page 481. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 267, page 594.

Represents the "Y" entry of the rectilinear measure dictionary object. It is defined as part of the PDF 1.0 specification. It contains an array which contains NumberFormatElements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 262, page 481. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 267, page 594.

Represents the "D" entry of the rectilinear measure dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains an array which contains NumberFormatElements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 262, page 481. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 267, page 594.

Represents the "A" entry of the rectilinear measure dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains an array which contains NumberFormatElements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 262, page 481. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 267, page 594.

Represents the "T" entry of the rectilinear measure dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains NumberFormatElements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 262, page 481. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 267, page 594.

Represents the "S" entry of the rectilinear measure dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains NumberFormatElements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 262, page 481. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 267, page 594.

Represents the "O" entry of the rectilinear measure dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains doubles, representing PDF numeric objects. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 262, page 481. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 267, page 595.

Represents the "CYX" entry of the rectilinear measure dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a double representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 262, page 482. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 267, page 595.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the redaction annotation. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 192, page 413. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 195, page 500. This class is always an indirect object because it inherits from AnnotationElement which is always an indirect object.

Create an empty RedactionAnnotationElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a RedactionAnnotationElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a RedactionAnnotationElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new RedactionAnnotationElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "QuadPoints" entry of the redaction annotation object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains doubles, representing PDF numeric objects. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 192, page 413. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 195, page 501.

Represents the "IC" entry of the redaction annotation object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains doubles, representing PDF numeric objects. Items in this array should have a minimum value of 0 and a maximum of 1. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 192, page 413. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 195, page 501.

Represents the "RO" entry of the redaction annotation object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a FormXObjectElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 192, page 413. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 195, page 501.

Represents the "OverlayText" entry of the redaction annotation object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 192, page 413. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 195, page 501.

Represents the "Repeat" entry of the redaction annotation object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a bool representing a PDF boolean object. The PDF specification states that this item assumes a value of false if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 192, page 413. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 195, page 501.

Represents the "DA" entry of the redaction annotation object. It is defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. This string contains raw byte data. So it looks like a string but really it is just a wrapper for data. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 192, page 413. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 195, page 501.

Represents the "Q" entry of the redaction annotation object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. It should have a minimum value of 0 and a maximum of 2. The PDF specification states that this item assumes a value of 0 if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 192, page 414. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 195, page 501.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the remote go-to action. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 200, page 419. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 203, page 508.

Create an empty RemoteGoToActionElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a RemoteGoToActionElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a RemoteGoToActionElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new RemoteGoToActionElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "F" entry of the remote go-to action object. It is a required entry defined as part of the PDF 1.0 specification. It contains a FileSpecificationElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 200, page 419. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 203, page 508.

Represents the "D" entry of the remote go-to action object. It is a required entry defined as part of the PDF 1.0 specification. This property may contain one of three different types: 1) A string representing a PDF name object. 2) A string representing a PDF string object. This string contains raw byte data. So it looks like a string but really it is just a wrapper for data. 3) A DestinationElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 200, page 419. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 203, page 508.

Represents the "NewWindow" entry of the remote go-to action object. It is an optional entry defined as part of the PDF 1.2 specification. It contains a bool representing a PDF boolean object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 200, page 419. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 203, page 509.

Represents the "SD" entry of the remote go-to action object. It is an optional entry defined as part of the PDF 2.0 specification. It contains a DestinationElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 200, page 419. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 203, page 509.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the rendition action. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 214, page 428. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 218, page 520.

Create an empty RenditionActionElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a RenditionActionElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a RenditionActionElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new RenditionActionElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "R" entry of the rendition action object. It is defined as part of the PDF 1.0 specification. It contains a RenditionElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 214, page 428. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 218, page 520.

Represents the "AN" entry of the rendition action object. It is defined as part of the PDF 1.0 specification. It contains a ScreenAnnotationElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 214, page 428. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 218, page 520.

Represents the "OP" entry of the rendition action object. It is defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. It should have a minimum value of 0 and a maximum of 4. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 214, page 428. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 218, page 520.

Represents the "JS" entry of the rendition action object. It is defined as part of the PDF 1.0 specification. This property may contain one of two different types: 1) A string representing a PDF string object. 2) A StreamElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 214, page 428. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 218, page 521.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the requirement dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 264, page 484. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 274, page 603.

Create an empty RequirementElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a RequirementElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a RequirementElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new RequirementElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the requirement dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. If provided, this item must always take the value "Requirement". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 264, page 484. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 274, page 603.

Represents the "S" entry of the requirement dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. This item must always be provided and must always take the value "EnableJavaScripts". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 264, page 484. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 274, page 603.

Represents the "RH" entry of the requirement dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains RequirementHandlerElements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 264, page 484. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 274, page 603.

Represents the "V" entry of the requirement dictionary object. It is an optional entry defined as part of the PDF 2.0 specification. This property may contain one of two different types: 1) A string representing a PDF name object. 2) An ExtensionsElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 264, page 484. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 274, page 603.

Represents the "Penalty" entry of the requirement dictionary object. It is an optional entry defined as part of the PDF 2.0 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 264, page 484. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 274, page 603.

Represents the "Encrypt" entry of the requirement dictionary object. It is defined as part of the PDF 1.0 specification. It contains an EncryptionElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 264, page 484. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 274, page 603.

Represents the "DigSig" entry of the requirement dictionary object. It is defined as part of the PDF 2.0 specification. It contains a SignatureElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 264, page 484. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 274, page 603.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the requirement handler dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 265, page 485. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 276, page 608.

Create an empty RequirementHandlerElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a RequirementHandlerElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a RequirementHandlerElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new RequirementHandlerElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the requirement handler dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. If provided, this item must always take the value "ReqHandler". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 265, page 485. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 276, page 608.

Represents the "S" entry of the requirement handler dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. This item may take one of the following valid values: JSNoOp For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 265, page 485. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 276, page 608.

Represents the "Script" entry of the requirement handler dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 265, page 485. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 276, page 608.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the reset-form action. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 238, page 455. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 241, page 552.

Create an empty ResetFormActionElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a ResetFormActionElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a ResetFormActionElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new ResetFormActionElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Fields" entry of the reset-form action object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains FieldElements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 238, page 455. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 241, page 552.

Represents the "Flags" entry of the reset-form action object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. The PDF specification states that this item assumes a value of 0 if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 238, page 455. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 241, page 552.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the richmediaactivation dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 335, page 698. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.50a, page 79.

Create an empty RichMediaActivationElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a RichMediaActivationElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a RichMediaActivationElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new RichMediaActivationElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the richmediaactivation dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a string representing a PDF name object. If provided, this item must always take the value "RichMediaActivation". For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.50a, page 79. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 335, page 698.

Represents the "Condition" entry of the richmediaactivation dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a string representing a PDF name object. The PDF specification states that this item assumes a value of "XA" if no value has been provided. This item may take one of the following valid values: XAPOPV For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.50a, page 79. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 335, page 698.

Represents the "Animation" entry of the richmediaactivation dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a RichMediaAnimationElement. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.50a, page 79. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 335, page 698.

Represents the "View" entry of the richmediaactivation dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a D3DViewElement. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.50a, page 79. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 335, page 698.

Represents the "Configuration" entry of the richmediaactivation dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a RichMediaConfigElement. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.50a, page 79. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 335, page 698.

Represents the "Presentation" entry of the richmediaactivation dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a RichMediaPresentationElement. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.50a, page 79. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 335, page 698.

Represents the "Scripts" entry of the richmediaactivation dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains an array which contains FileSpecificationElements. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.50a, page 79. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 335, page 698.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the richmediaanimation dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 337, page 699. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.50c, page 81.

Create an empty RichMediaAnimationElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a RichMediaAnimationElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a RichMediaAnimationElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new RichMediaAnimationElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the richmediaanimation dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a string representing a PDF name object. If provided, this item must always take the value "RichMediaAnimation". For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.50c, page 81. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 337, page 699.

Represents the "Subtype" entry of the richmediaanimation dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a string representing a PDF name object. The PDF specification states that this item assumes a value of "None" if no value has been provided. This item may take one of the following valid values: NoneLinearOscillating For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.50c, page 81. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 337, page 699.

Represents the "PlayCount" entry of the richmediaanimation dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains an integer representing a PDF numeric object. The PDF specification states that this item assumes a value of -1 if no value has been provided. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.50c, page 81. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 337, page 700.

Represents the "Speed" entry of the richmediaanimation dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a double representing a PDF numeric object. It should have a positive value. The PDF specification states that this item assumes a value of 1 if no value has been provided. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.50c, page 81. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 337, page 700.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the richmedia annotation. This is definitively detailed in: The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 333, page 696. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.49, page 77. This class is always an indirect object because RichMediaExecuteActionElement.EntryTA requires it to be so.

Create an empty RichMediaAnnotationElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a RichMediaAnnotationElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a RichMediaAnnotationElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new RichMediaAnnotationElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "RichMediaSettings" entry of the richmedia annotation object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a RichMediaSettingsElement. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.49, page 77. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 333, page 696.

Represents the "RichMediaContent" entry of the richmedia annotation object. It is a required entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a RichMediaContentElement. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.49, page 77. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 333, page 696.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the richmediacommand dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 223, page 524. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.48b, page 41.

Create an empty RichMediaCommandElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a RichMediaCommandElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a RichMediaCommandElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new RichMediaCommandElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the richmediacommand dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a string representing a PDF name object. If provided, this item must always take the value "RichMediaCommand". For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.48b, page 41. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 223, page 524.

Represents the "C" entry of the richmediacommand dictionary object. It is a required entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a string representing a PDF string object. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.48b, page 41. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 223, page 524.

Represents the "A" entry of the richmediacommand dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. The specification defines this property as being of any type. So any type of atom or data content is valid. It contains an Element. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.48b, page 41. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 223, page 524.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the richmediaconfiguration dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 342, page 706. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.51a, page 88. This class is always an indirect object because RichMediaActivationElement.EntryConfiguration and RichMediaContentElement.EntryConfigurations require it to be so.

Create an empty RichMediaConfigElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a RichMediaConfigElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a RichMediaConfigElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new RichMediaConfigElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the richmediaconfiguration dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a string representing a PDF name object. If provided, this item must always take the value "RichMediaConfiguration". For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.51a, page 88. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 342, page 706.

Represents the "Subtype" entry of the richmediaconfiguration dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a string representing a PDF name object. This item may take one of the following valid values: 3DFlashSoundVideo For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.51a, page 88. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 342, page 706.

Represents the "Name" entry of the richmediaconfiguration dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. The specification defines this property as being of undefined type. So the type of atom or data contained is not part of the specification. For practical purposes this means it may be of any type. It contains an Element. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.51a, page 88. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 342, page 706.

Represents the "Instances" entry of the richmediaconfiguration dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains an array which contains RichMediaInstanceElements. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.51a, page 88. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 342, page 706.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the richmediacontent dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 341, page 704. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.51, page 86.

Create an empty RichMediaContentElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a RichMediaContentElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a RichMediaContentElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new RichMediaContentElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the richmediacontent dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a string representing a PDF name object. If provided, this item must always take the value "RichMediaContent". For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.51, page 86. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 341, page 704.

Represents the "Assets" entry of the richmediacontent dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a NameTreeNodeElement containing FileSpecificationElements. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.51, page 86. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 341, page 704.

Represents the "Configurations" entry of the richmediacontent dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains an array which contains RichMediaConfigElements. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.51, page 86. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 341, page 704.

Represents the "Views" entry of the richmediacontent dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains an array which contains D3DViewElements. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.51, page 86. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 341, page 704.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the richmediadeactivation dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 336, page 699. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.50b, page 80.

Create an empty RichMediaDeactivationElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a RichMediaDeactivationElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a RichMediaDeactivationElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new RichMediaDeactivationElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the richmediadeactivation dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a string representing a PDF name object. If provided, this item must always take the value "RichMediaDeactivation". For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.50b, page 80. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 336, page 699.

Represents the "Condition" entry of the richmediadeactivation dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a string representing a PDF name object. The PDF specification states that this item assumes a value of "XD" if no value has been provided. This item may take one of the following valid values: XDPCPI For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.50b, page 80. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 336, page 699.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the richmediadimensions dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 339, page 702. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.50e, page 84.

Create an empty RichMediaDimensionsElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a RichMediaDimensionsElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a RichMediaDimensionsElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new RichMediaDimensionsElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Default" entry of the richmediadimensions dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a double representing a PDF numeric object. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.50e, page 84. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 339, page 702.

Represents the "Max" entry of the richmediadimensions dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a double representing a PDF numeric object. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.50e, page 84. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 339, page 702.

Represents the "Min" entry of the richmediadimensions dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a double representing a PDF numeric object. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.50e, page 84. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 339, page 702.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the rich-media-execute action. This is definitively detailed in: The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 222, page 523. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.48a, page 40.

Create an empty RichMediaExecuteActionElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a RichMediaExecuteActionElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a RichMediaExecuteActionElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new RichMediaExecuteActionElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "TA" entry of the rich-media-execute action object. It is a required entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a RichMediaAnnotationElement. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.48a, page 40. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 222, page 523.

Represents the "TI" entry of the rich-media-execute action object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a RichMediaInstanceElement. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.48a, page 40. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 222, page 523.

Represents the "CMD" entry of the rich-media-execute action object. It is a required entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a RichMediaCommandElement. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.48a, page 40. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 222, page 523.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the richmediainstance dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 343, page 706. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.51b, page 89. This class is always an indirect object because D3DNodeElement.EntryInstance, RichMediaConfigElement.EntryInstances, RichMediaExecuteActionElement.EntryTI and ViewParamsElement.EntryInstance require it to be so.

Create an empty RichMediaInstanceElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a RichMediaInstanceElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a RichMediaInstanceElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new RichMediaInstanceElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the richmediainstance dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a string representing a PDF name object. If provided, this item must always take the value "RichMediaInstance". For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.51b, page 89. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 343, page 706.

Represents the "Subtype" entry of the richmediainstance dictionary object. It is a required entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a string representing a PDF name object. This item may take one of the following valid values: 3DFlashSoundVideo For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.51b, page 89. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 343, page 706.

Represents the "Params" entry of the richmediainstance dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a RichMediaParamsElement. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.51b, page 89. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 343, page 706.

Represents the "Asset" entry of the richmediainstance dictionary object. It is a required entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a FileSpecificationElement. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.51b, page 89. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 343, page 706.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the richmediaparams dictionary. This is definitively detailed in: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.51c, page 90.

Create an empty RichMediaParamsElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a RichMediaParamsElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a RichMediaParamsElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new RichMediaParamsElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the richmediaparams dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a string representing a PDF name object. If provided, this item must always take the value "RichMediaParams". For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.51c, page 90.

Represents the "FlashVars" entry of the richmediaparams dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. This property may contain one of two different types: 1) A string representing a PDF string object. The PDF specification states that this item assumes a value of "No data is sent to the Flash Player" if no value has been provided. 2) A StreamElement. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.51c, page 90.

Represents the "Binding" entry of the richmediaparams dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a string representing a PDF name object. The PDF specification states that this item assumes a value of "None" if no value has been provided. This item may take one of the following valid values: NoneForegroundBackgroundMaterial For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.51c, page 90.

Represents the "BindingMaterialName" entry of the richmediaparams dictionary object. It is defined as part of the PDF 1.7 Extension Level 3 specification. It contains a string representing a PDF string object. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.51c, page 90.

Represents the "CuePoints" entry of the richmediaparams dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains an array which contains CuePointElements. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.51c, page 90.

Represents the "Settings" entry of the richmediaparams dictionary object. It is defined as part of the PDF 1.0 specification. This property may contain one of two different types: 1) A string representing a PDF string object. The PDF specification states that this item assumes a value of "undefined" if no value has been provided. 2) A StreamElement. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.51c, page 90.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the richmediaposition dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 340, page 703. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.50f, page 85.

Create an empty RichMediaPositionElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a RichMediaPositionElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a RichMediaPositionElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new RichMediaPositionElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the richmediaposition dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a string representing a PDF name object. If provided, this item must always take the value "RichMediaPosition". For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.50f, page 85. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 340, page 703.

Represents the "HAlign" entry of the richmediaposition dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a string representing a PDF name object. The PDF specification states that this item assumes a value of "Far" if no value has been provided. This item may take one of the following valid values: NearCenterFar For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.50f, page 85. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 340, page 703.

Represents the "VAlign" entry of the richmediaposition dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a string representing a PDF name object. The PDF specification states that this item assumes a value of "Near" if no value has been provided. This item may take one of the following valid values: NearCenterFar For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.50f, page 85. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 340, page 703.

Represents the "HOffset" entry of the richmediaposition dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a double representing a PDF numeric object. It should have a positive value. The PDF specification states that this item assumes a value of 18 if no value has been provided. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.50f, page 85. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 340, page 703.

Represents the "VOffset" entry of the richmediaposition dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a double representing a PDF numeric object. It should have a positive value. The PDF specification states that this item assumes a value of 18 if no value has been provided. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.50f, page 85. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 340, page 703.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the richmediapresentation dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 338, page 701. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.50d, page 82.

Create an empty RichMediaPresentationElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a RichMediaPresentationElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a RichMediaPresentationElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new RichMediaPresentationElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the richmediapresentation dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a string representing a PDF name object. If provided, this item must always take the value "RichMediaPresentation". For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.50d, page 82. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 338, page 701.

Represents the "Style" entry of the richmediapresentation dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a string representing a PDF name object. The PDF specification states that this item assumes a value of "Embedded" if no value has been provided. This item may take one of the following valid values: EmbeddedWindowed For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.50d, page 82. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 338, page 701.

Represents the "Window" entry of the richmediapresentation dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a RichMediaWindowElement. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.50d, page 82. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 338, page 701.

Represents the "Transparent" entry of the richmediapresentation dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a bool representing a PDF boolean object. The PDF specification states that this item assumes a value of false if no value has been provided. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.50d, page 82. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 338, page 701.

Represents the "NavigationPane" entry of the richmediapresentation dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a bool representing a PDF boolean object. The PDF specification states that this item assumes a value of false if no value has been provided. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.50d, page 82. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 338, page 701.

Represents the "Toolbar" entry of the richmediapresentation dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a bool representing a PDF boolean object. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.50d, page 82. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 338, page 701.

Represents the "PassContextClick" entry of the richmediapresentation dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a bool representing a PDF boolean object. The PDF specification states that this item assumes a value of false if no value has been provided. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.50d, page 82. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 338, page 702.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the richmediasettings dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 334, page 697. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.50, page 78.

Create an empty RichMediaSettingsElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a RichMediaSettingsElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a RichMediaSettingsElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new RichMediaSettingsElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the richmediasettings dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a string representing a PDF name object. If provided, this item must always take the value "RichMediaSettings". For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.50, page 78. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 334, page 697.

Represents the "Activation" entry of the richmediasettings dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a RichMediaActivationElement. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.50, page 78. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 334, page 697.

Represents the "Deactivation" entry of the richmediasettings dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a RichMediaDeactivationElement. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.50, page 78. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 334, page 697.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the richmediawindow dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 339, page 702. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.50e, page 84.

Create an empty RichMediaWindowElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a RichMediaWindowElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a RichMediaWindowElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new RichMediaWindowElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the richmediawindow dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a string representing a PDF name object. If provided, this item must always take the value "RichMediaWindow". For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.50e, page 84. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 339, page 702.

Represents the "Width" entry of the richmediawindow dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a RichMediaDimensionsElement. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.50e, page 84. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 339, page 702.

Represents the "Height" entry of the richmediawindow dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a RichMediaDimensionsElement. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.50e, page 84. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 339, page 702.

Represents the "Position" entry of the richmediawindow dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a RichMediaPositionElement. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.50e, page 84. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 339, page 702.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the rubber stamp annotation. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 181, page 405. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 184, page 490. This class is always an indirect object because it inherits from MarkupAnnotationElement which is always an indirect object.

Create an empty RubberStampAnnotationElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a RubberStampAnnotationElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a RubberStampAnnotationElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new RubberStampAnnotationElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Name" entry of the rubber stamp annotation object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. The PDF specification states that this item assumes a value of "Draft" if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 181, page 405. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 184, page 490.

Represents the "IT" entry of the rubber stamp annotation object. It is an optional entry defined as part of the PDF 2.0 specification. It contains a string representing a PDF name object. The PDF specification states that this item assumes a value of "Stamp" if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 181, page 405. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 184, page 491.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the screen annotation. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 187, page 407. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 190, page 494. This class is always an indirect object because RenditionActionElement.EntryAN requires it to be so.

Create an empty ScreenAnnotationElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a ScreenAnnotationElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a ScreenAnnotationElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new ScreenAnnotationElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "T" entry of the screen annotation object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 187, page 407. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 190, page 494.

Represents the "MK" entry of the screen annotation object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an AppearanceCharacteristicsElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 187, page 407. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 190, page 494.

Represents the "A" entry of the screen annotation object. It is an optional entry defined as part of the PDF 1.1 specification. It contains an ActionElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 187, page 408. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 190, page 494.

Represents the "AA" entry of the screen annotation object. It is an optional entry defined as part of the PDF 1.2 specification. It contains an AnnotationAdditionalActionsElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 187, page 408. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 190, page 494.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the set-ocg-state action. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 213, page 427. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 217, page 519.

Create an empty SetOcgStateActionElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a SetOcgStateActionElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a SetOcgStateActionElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new SetOcgStateActionElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "State" entry of the set-ocg-state action object. It is a required entry defined as part of the PDF 1.0 specification. It contains an array which contains Elements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 213, page 427. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 217, page 519.

Represents the "PreserveRB" entry of the set-ocg-state action object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a bool representing a PDF boolean object. The PDF specification states that this item assumes a value of true if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 213, page 427. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 217, page 519.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the signature dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 252, page 467. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 255, page 565. This class is always an indirect object because PermissionsElement.EntryDocMDP requires it to be so.

Create an empty SignatureElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a SignatureElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a SignatureElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new SignatureElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the signature dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. If provided, this item must always take the value "Sig". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 252, page 467. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 255, page 565.

Represents the "Filter" entry of the signature dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. The specification defines this as exensible which means that it may contain entries in addition to those defined in the specification. In fact almost all objects are extensible but the fact that it is explicitly mentioned, implies that extra entries should be regarded as normal rather than exceptional. For further details see The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: Annex E, page 673.. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 252, page 467. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 255, page 565.

Represents the "SubFilter" entry of the signature dictionary object. It is an optional entry defined as part of the PDF 1.3 specification. It contains a string representing a PDF name object. The specification defines this as exensible which means that it may contain entries in addition to those defined in the specification. In fact almost all objects are extensible but the fact that it is explicitly mentioned, implies that extra entries should be regarded as normal rather than exceptional. For further details see The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: Annex E, page 673.. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 252, page 467. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 255, page 565.

Represents the "Contents" entry of the signature dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. This string contains raw byte data. So it looks like a string but really it is just a wrapper for data. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 252, page 468. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 255, page 565.

Represents the "Cert" entry of the signature dictionary object. It is defined as part of the PDF 1.0 specification. It contains an array which contains strings, representing PDF string objects. This string contains raw byte data. So it looks like a string but really it is just a wrapper for data. If you read the specification you will see that an array of one string may be represented as a single string rather than an array. However we always present this property as an array to simplify the interface. It is only if you add or remove items in the array, that the underlying representation will be changed. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 252, page 468. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 255, page 566.

Represents the "ByteRange" entry of the signature dictionary object. It is defined as part of the PDF 1.0 specification. It contains an array which contains integers, representing PDF numeric objects. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 252, page 468. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 255, page 566.

Represents the "Reference" entry of the signature dictionary object. It is an optional entry defined as part of the PDF 1.5 specification. It contains an array which contains SignatureReferenceElements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 252, page 468. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 255, page 566.

Represents the "Changes" entry of the signature dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains integers, representing PDF numeric objects. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 252, page 468. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 255, page 566.

Represents the "Name" entry of the signature dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 252, page 468. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 255, page 566.

Represents the "M" entry of the signature dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. This is encoded as a date string. For details see the StringAtom.DateToString and StringAtom.StringToDate functions. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 252, page 468. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 255, page 566.

Represents the "Location" entry of the signature dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 252, page 468. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 255, page 567.

Represents the "Reason" entry of the signature dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 252, page 468. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 255, page 567.

Represents the "ContactInfo" entry of the signature dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 252, page 468. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 255, page 567.

Represents the "R" entry of the signature dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It was deprecated in PDF 2.0. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 252, page 469. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 255, page 567.

Represents the "V" entry of the signature dictionary object. It is an optional entry defined as part of the PDF 1.5 specification. It contains an integer representing a PDF numeric object. The PDF specification states that this item assumes a value of 0 if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 252, page 469. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 255, page 567.

Represents the "Prop_Build" entry of the signature dictionary object. It is an optional entry defined as part of the PDF 1.5 specification. It contains an Element. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 252, page 469. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 255, page 567.

Represents the "Prop_AuthTime" entry of the signature dictionary object. It is an optional entry defined as part of the PDF 1.5 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 252, page 469. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 255, page 567.

Represents the "Prop_AuthType" entry of the signature dictionary object. It is an optional entry defined as part of the PDF 1.5 specification. It contains a string representing a PDF name object. This item may take one of the following valid values: PINPasswordFingerprint For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 252, page 469. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 255, page 567.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the signature field. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 232, page 446. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 235, page 540. This class is always an indirect object because it inherits from FieldElement which is always an indirect object.

Create an empty SignatureFieldElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a SignatureFieldElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a SignatureFieldElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new SignatureFieldElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Lock" entry of the signature field object. It is an optional entry defined as part of the PDF 1.5 specification. It contains a SignatureFieldLockElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 232, page 446. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 235, page 540.

Represents the "SV" entry of the signature field object. It is an optional entry defined as part of the PDF 1.5 specification. It contains a SignatureFieldSeedValueElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 232, page 446. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 235, page 540.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the signature field lock dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 233, page 447. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 236, page 541. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.82, page 43. This class is always an indirect object because SignatureFieldElement.EntryLock requires it to be so.

Create an empty SignatureFieldLockElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a SignatureFieldLockElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a SignatureFieldLockElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new SignatureFieldLockElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the signature field lock dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. If provided, this item must always take the value "SigFieldLock". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 233, page 447. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.82, page 43. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 236, page 541.

Represents the "Action" entry of the signature field lock dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. This item may take one of the following valid values: AllIncludeExcludeAll For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 233, page 447. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.82, page 43. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 236, page 541.

Represents the "Fields" entry of the signature field lock dictionary object. It is defined as part of the PDF 1.0 specification. It contains an array which contains strings, representing PDF string objects. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 233, page 447. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.82, page 43. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 236, page 541.

Represents the "P" entry of the signature field lock dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains an integer representing a PDF numeric object. It should have a minimum value of 1 and a maximum of 3. The PDF specification states that this item assumes a value of 0 if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 233, page 447. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.82, page 43. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 236, page 541.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the signature field seed value dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 234, page 447. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 237, page 542. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.83, page 44. This class is always an indirect object because SignatureFieldElement.EntrySV requires it to be so.

Create an empty SignatureFieldSeedValueElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a SignatureFieldSeedValueElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a SignatureFieldSeedValueElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new SignatureFieldSeedValueElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the signature field seed value dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. If provided, this item must always take the value "SV". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 234, page 447. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.83, page 44. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 237, page 542.

Represents the "Filter" entry of the signature field seed value dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 234, page 447. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.83, page 44. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 237, page 542.

Represents the "SubFilter" entry of the signature field seed value dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains strings, representing PDF name objects. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 234, page 447. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.83, page 44. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 237, page 542.

Represents the "DigestMethod" entry of the signature field seed value dictionary object. It is an optional entry defined as part of the PDF 1.7 specification. It contains an array which contains strings, representing PDF name objects. Items in this array may take one of the following valid values: SHA1SHA256SHA384SHA512RIPEMD160 For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 234, page 447. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.83, page 44. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 237, page 542.

Represents the "Cert" entry of the signature field seed value dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a CertificateSeedValueElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 234, page 448. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.83, page 44. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 237, page 542.

Represents the "Reasons" entry of the signature field seed value dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains strings, representing PDF string objects. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 234, page 448. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.83, page 44. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 237, page 543.

Represents the "MDP" entry of the signature field seed value dictionary object. It is an optional entry defined as part of the PDF 1.6 specification. It contains an Element. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 234, page 448. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.83, page 44. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 237, page 543.

Represents the "TimeStamp" entry of the signature field seed value dictionary object. It is an optional entry defined as part of the PDF 1.6 specification. It contains a SignatureFieldTimeStampElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 234, page 448. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.83, page 44. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 237, page 543.

Represents the "LegalAttestation" entry of the signature field seed value dictionary object. It is an optional entry defined as part of the PDF 1.6 specification. It contains an array which contains strings, representing PDF string objects. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 234, page 448. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.83, page 44. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 237, page 543.

Represents the "AddRevInfo" entry of the signature field seed value dictionary object. It is an optional entry defined as part of the PDF 1.7 specification. It contains a bool representing a PDF boolean object. The PDF specification states that this item assumes a value of false if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 234, page 449. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.83, page 44. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 237, page 544.

Represents the "LockDocument" entry of the signature field seed value dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a string representing a PDF name object. The PDF specification states that this item assumes a value of "auto" if no value has been provided. This item may take one of the following valid values: truefalseauto For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 234, page 447. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.83, page 44. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 237, page 544.

Represents the "AppearanceFilter" entry of the signature field seed value dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a string representing a PDF string object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 234, page 447. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.83, page 44. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 237, page 544.

Represents the "Ff" entry of the signature field seed value dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. The PDF specification states that this item assumes a value of 0 if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 234, page 447. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.83, page 44. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 237, page 542.

Represents the "V" entry of the signature field seed value dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a double representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 234, page 448. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.83, page 44. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 237, page 542.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the signature field time stamp dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 234, page 447. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 237, page 542.

Create an empty SignatureFieldTimeStampElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a SignatureFieldTimeStampElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a SignatureFieldTimeStampElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new SignatureFieldTimeStampElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "URL" entry of the signature field time stamp dictionary object. It is defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. This is encoded as a string using single byte ASCII encoding. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 234, page 447. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 237, page 542.

Represents the "Ff" entry of the signature field time stamp dictionary object. It is defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. The PDF specification states that this item assumes a value of 0 if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 234, page 447. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 237, page 542.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the signature reference dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 253, page 469. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 256, page 568.

Create an empty SignatureReferenceElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a SignatureReferenceElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a SignatureReferenceElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new SignatureReferenceElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the signature reference dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. If provided, this item must always take the value "SigRef". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 253, page 469. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 256, page 568.

Represents the "TransformMethod" entry of the signature reference dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. This item may take one of the following valid values: DocMDPURFieldMDP For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 253, page 469. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 256, page 568.

Represents the "TransformParams" entry of the signature reference dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an Element. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 253, page 469. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 256, page 568.

Represents the "Data" entry of the signature reference dictionary object. It is defined as part of the PDF 1.0 specification. The specification defines this property as being of any type. So any type of atom or data content is valid. It contains an Element. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 253, page 470. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 256, page 568.

Represents the "DigestMethod" entry of the signature reference dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. The PDF specification states that this item assumes a value of "MD5" if no value has been provided. This item may take one of the following valid values: MD5SHA1 For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 253, page 470. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 256, page 568.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the signature validation-related information dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 262, page 584.

Create an empty SignatureValidationRelatedInformationElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a SignatureValidationRelatedInformationElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a SignatureValidationRelatedInformationElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new SignatureValidationRelatedInformationElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the signature validation-related information dictionary object. It is an optional entry defined as part of the PDF 2.0 specification. It contains a string representing a PDF name object. If provided, this item must always take the value "VRI". For definitive details see: The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 262, page 584.

Represents the "Cert" entry of the signature validation-related information dictionary object. It is an optional entry defined as part of the PDF 2.0 specification. It contains an array which contains StreamElements. For definitive details see: The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 262, page 584.

Represents the "CRL" entry of the signature validation-related information dictionary object. It is defined as part of the PDF 2.0 specification. It contains an array which contains StreamElements. For definitive details see: The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 262, page 584.

Represents the "OCSP" entry of the signature validation-related information dictionary object. It is defined as part of the PDF 2.0 specification. It contains an array which contains StreamElements. For definitive details see: The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 262, page 584.

Represents the "TU" entry of the signature validation-related information dictionary object. It is an optional entry defined as part of the PDF 2.0 specification. It contains a string representing a PDF string object. This is encoded as a date string. For details see the StringAtom.DateToString and StringAtom.StringToDate functions. For definitive details see: The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 262, page 584.

Represents the "TS" entry of the signature validation-related information dictionary object. It is an optional entry defined as part of the PDF 2.0 specification. It contains a StreamElement. For definitive details see: The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 262, page 584.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the sound action. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 208, page 425. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 212, page 516.

Create an empty SoundActionElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a SoundActionElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a SoundActionElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new SoundActionElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Sound" entry of the sound action object. It is a required entry defined as part of the PDF 1.0 specification. It contains a SoundObjectStreamElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 208, page 425. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 212, page 516.

Represents the "Volume" entry of the sound action object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a double representing a PDF numeric object. It should have a minimum value of 0 and a maximum of 1. The PDF specification states that this item assumes a value of 1 if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 208, page 425. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 212, page 516.

Represents the "Synchronous" entry of the sound action object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a bool representing a PDF boolean object. The PDF specification states that this item assumes a value of false if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 208, page 425. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 212, page 516.

Represents the "Repeat" entry of the sound action object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a bool representing a PDF boolean object. The PDF specification states that this item assumes a value of false if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 208, page 425. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 212, page 516.

Represents the "Mix" entry of the sound action object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a bool representing a PDF boolean object. The PDF specification states that this item assumes a value of false if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 208, page 425. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 212, page 516.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the sound annotation. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 185, page 407. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 188, page 493. This class is always an indirect object because it inherits from MarkupAnnotationElement which is always an indirect object.

Create an empty SoundAnnotationElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a SoundAnnotationElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a SoundAnnotationElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new SoundAnnotationElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Sound" entry of the sound annotation object. It is a required entry defined as part of the PDF 1.0 specification. It contains a SoundObjectStreamElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 185, page 407. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 188, page 493.

Represents the "Name" entry of the sound annotation object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. The PDF specification states that this item assumes a value of "Speaker" if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 185, page 407. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 188, page 493.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the square annotation. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 177, page 401. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 180, page 486. This class is always an indirect object because it inherits from MarkupAnnotationElement which is always an indirect object.

Create an empty SquareAnnotationElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a SquareAnnotationElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a SquareAnnotationElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new SquareAnnotationElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "BS" entry of the square annotation object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a BorderStyleElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 177, page 401. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 180, page 486.

Represents the "IC" entry of the square annotation object. It is an optional entry defined as part of the PDF 1.4 specification. It contains an array which contains doubles, representing PDF numeric objects. Items in this array should have a minimum value of 0 and a maximum of 1. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 177, page 402. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 180, page 487.

Represents the "BE" entry of the square annotation object. It is an optional entry defined as part of the PDF 1.5 specification. It contains a BorderEffectElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 177, page 402. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 180, page 487.

Represents the "RD" entry of the square annotation object. It is an optional entry defined as part of the PDF 1.5 specification. It contains a RectangleElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 177, page 402. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 180, page 487.

Represents the "IT" entry of the square annotation object. It is an optional entry defined as part of the PDF 1.6 specification. It contains a string representing a PDF name object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 177, page 401. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 180, page 486.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the submit-form action. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 236, page 451. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 239, page 548.

Create an empty SubmitFormActionElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a SubmitFormActionElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a SubmitFormActionElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new SubmitFormActionElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "F" entry of the submit-form action object. It is a required entry defined as part of the PDF 1.0 specification. It contains a FileSpecificationElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 236, page 451. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 239, page 548.

Represents the "Fields" entry of the submit-form action object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains FieldElements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 236, page 452. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 239, page 548.

Represents the "Flags" entry of the submit-form action object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 236, page 452. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 239, page 548.

Represents the "CharSet" entry of the submit-form action object. It is an optional entry defined as part of the PDF 2.0 specification. It contains a string representing a PDF string object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 236, page 451. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 239, page 548.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the target dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 202, page 420. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 205, page 510.

Create an empty TargetElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a TargetElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a TargetElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new TargetElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "R" entry of the target dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. This item may take one of the following valid values: PC For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 202, page 420. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 205, page 510.

Represents the "N" entry of the target dictionary object. It is defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. This string contains raw byte data. So it looks like a string but really it is just a wrapper for data. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 202, page 420. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 205, page 510.

Represents the "P" entry of the target dictionary object. It is defined as part of the PDF 1.0 specification. This property may contain one of two different types: 1) An integer representing a PDF numeric object. 2) A string representing a PDF string object. This string contains raw byte data. So it looks like a string but really it is just a wrapper for data. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 202, page 420. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 205, page 510.

Represents the "A" entry of the target dictionary object. It is defined as part of the PDF 1.0 specification. This property may contain one of two different types: 1) An integer representing a PDF numeric object. 2) A string representing a PDF string object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 202, page 420. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 205, page 510.

Represents the "T" entry of the target dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a TargetElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 202, page 420. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 205, page 510.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the text annotation. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 172, page 394. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 175, page 478. This class is always an indirect object because it inherits from MarkupAnnotationElement which is always an indirect object.

Create an empty TextAnnotationElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a TextAnnotationElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a TextAnnotationElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new TextAnnotationElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Open" entry of the text annotation object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a bool representing a PDF boolean object. The PDF specification states that this item assumes a value of false if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 172, page 394. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 175, page 478.

Represents the "Name" entry of the text annotation object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. The PDF specification states that this item assumes a value of "Note" if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 172, page 394. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 175, page 478.

Represents the "State" entry of the text annotation object. It is an optional entry defined as part of the PDF 1.5 specification. It contains a string representing a PDF string object. The PDF specification states that this item assumes a value of ""Unmarked" if StateModel is "Marked"; "None" if StateModel is "Review"" if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 172, page 394. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 175, page 478.

Represents the "StateModel" entry of the text annotation object. It is defined as part of the PDF 1.5 specification. It contains a string representing a PDF string object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 172, page 394. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 175, page 479.

Represents the "IT" entry of the text annotation object. It is an optional entry defined as part of the PDF 1.6 specification. It contains a string representing a PDF name object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 172, page 394. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 175, page 478.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the text field. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 229, page 444. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 232, page 537. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.39a, page 46. This class is always an indirect object because it inherits from FieldElement which is always an indirect object.

Create an empty TextFieldElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a TextFieldElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a TextFieldElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new TextFieldElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "DataPrep" entry of the text field object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a double representing a PDF numeric object. The PDF specification states that this item assumes a value of 0 if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 229, page 444. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.39a, page 46. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 232, page 537.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the text markup annotation. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 179, page 403. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 182, page 489. This class is always an indirect object because it inherits from MarkupAnnotationElement which is always an indirect object.

Create an empty TextMarkupAnnotationElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a TextMarkupAnnotationElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a TextMarkupAnnotationElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new TextMarkupAnnotationElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "QuadPoints" entry of the text markup annotation object. It is a required entry defined as part of the PDF 1.0 specification. It contains an array which contains doubles, representing PDF numeric objects. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 179, page 403. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 182, page 489.

Represents the "IT" entry of the text markup annotation object. It is an optional entry defined as part of the PDF 1.6 specification. It contains a string representing a PDF name object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 179, page 403. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 182, page 489.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the thread action. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 205, page 423. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 209, page 514.

Create an empty ThreadActionElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a ThreadActionElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a ThreadActionElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new ThreadActionElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "F" entry of the thread action object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a FileSpecificationElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 205, page 423. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 209, page 514.

Represents the "D" entry of the thread action object. It is a required entry defined as part of the PDF 1.0 specification. This property may contain one of three different types: 1) An integer representing a PDF numeric object. 2) A string representing a PDF string object. 3) A ThreadElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 205, page 423. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 209, page 514.

Represents the "B" entry of the thread action object. It is an optional entry defined as part of the PDF 1.0 specification. This property may contain one of two different types: 1) An integer representing a PDF numeric object. 2) A BeadElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 205, page 423. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 209, page 514.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the thread dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 160, page 376. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 162, page 457. This class is always an indirect object because BeadElement.EntryT, CatalogElement.EntryThreads and ThreadActionElement.EntryD require it to be so.

Create an empty ThreadElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a ThreadElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a ThreadElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new ThreadElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the thread dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. If provided, this item must always take the value "Thread". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 160, page 376. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 162, page 457.

Represents the "F" entry of the thread dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a BeadElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 160, page 376. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 162, page 457.

Represents the "I" entry of the thread dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a DocumentInformationElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 160, page 376. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 162, page 457.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the transform parameters dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; page 470.

Create an empty TransformParametersElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a TransformParametersElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a TransformParametersElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new TransformParametersElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the transform parameters dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. If provided, this item must always take the value "TransformParams". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; page 470.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the transition action. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 215, page 429. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 219, page 521.

Create an empty TransitionActionElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a TransitionActionElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a TransitionActionElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new TransitionActionElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Trans" entry of the transition action object. It is a required entry defined as part of the PDF 1.0 specification. It contains a TransitionElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 215, page 429. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 219, page 521.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the transition dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 162, page 378. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 164, page 459.

Create an empty TransitionElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a TransitionElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a TransitionElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new TransitionElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the transition dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. If provided, this item must always take the value "Trans". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 162, page 378. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 164, page 459.

Represents the "S" entry of the transition dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. The PDF specification states that this item assumes a value of "R" if no value has been provided. This item may take one of the following valid values: SplitBlindsBoxWipeDissolveGlitterRFlyPushCoverUncoverFade For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 162, page 378. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 164, page 459.

Represents the "D" entry of the transition dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a double representing a PDF numeric object. The PDF specification states that this item assumes a value of 1 if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 162, page 378. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 164, page 459.

Represents the "Dm" entry of the transition dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. The PDF specification states that this item assumes a value of "H" if no value has been provided. This item may take one of the following valid values: HV For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 162, page 378. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 164, page 459.

Represents the "M" entry of the transition dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. The PDF specification states that this item assumes a value of "I" if no value has been provided. This item may take one of the following valid values: :IO For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 162, page 378. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 164, page 460.

Represents the "Di" entry of the transition dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. This property may contain one of two different types: 1) A double representing a PDF numeric object. The PDF specification states that this item assumes a value of 0 if no value has been provided. 2) A string representing a PDF name object. If provided, this item must always take the value "None". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 162, page 379. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 164, page 460.

Represents the "SS" entry of the transition dictionary object. It is an optional entry defined as part of the PDF 1.5 specification. It contains a double representing a PDF numeric object. The PDF specification states that this item assumes a value of 1 if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 162, page 379. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 164, page 460.

Represents the "B" entry of the transition dictionary object. It is an optional entry defined as part of the PDF 1.5 specification. It contains a bool representing a PDF boolean object. The PDF specification states that this item assumes a value of false if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 162, page 379. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 164, page 460.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the uri action. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 206, page 424. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 210, page 515.

Create an empty UriActionElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a UriActionElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a UriActionElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new UriActionElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "URI" entry of the uri action object. It is a required entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. This is encoded as a string using single byte ASCII encoding. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 206, page 424. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 210, page 515.

Represents the "IsMap" entry of the uri action object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a bool representing a PDF boolean object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 206, page 424. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 210, page 515.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the ur transform parameters dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 255, page 472. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 258, page 571.

Create an empty UrTransformParametersElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a UrTransformParametersElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a UrTransformParametersElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new UrTransformParametersElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Document" entry of the ur transform parameters dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains strings, representing PDF name objects. Items in this array may take one of the following valid values: FullSaveor For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 255, page 472. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 258, page 571.

Represents the "Msg" entry of the ur transform parameters dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 255, page 472. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 258, page 571.

Represents the "V" entry of the ur transform parameters dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. The PDF specification states that this item assumes a value of "2.2" if no value has been provided. This item may take one of the following valid values: 2.22 For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 255, page 472. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 258, page 571.

Represents the "Annots" entry of the ur transform parameters dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains strings, representing PDF name objects. Items in this array may take one of the following valid values: (PDFCreateDeleteModifyCopyImportExportOnlineSummaryView For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 255, page 472. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 258, page 571.

Represents the "Form" entry of the ur transform parameters dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains strings, representing PDF name objects. Items in this array may take one of the following valid values: (PDFAddDeleteFillImportTSVExportSubmitStandaloneSpawnTemplateBarcodePlaintextOnline For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 255, page 473. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 258, page 572.

Represents the "Signature" entry of the ur transform parameters dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains strings, representing PDF name objects. If provided, items in this array must always take the value "Modify". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 255, page 473. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 258, page 572.

Represents the "EF" entry of the ur transform parameters dictionary object. It is an optional entry defined as part of the PDF 1.6 specification. It contains an array which contains strings, representing PDF name objects. If provided, items in this array must always take the value "shall". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 255, page 473. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 258, page 572.

Represents the "P" entry of the ur transform parameters dictionary object. It is an optional entry defined as part of the PDF 1.6 specification. It contains a bool representing a PDF boolean object. The PDF specification states that this item assumes a value of false if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 255, page 473. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 258, page 572.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the viewer preferences dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 150, page 362. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 147, page 435. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.1, page 28.

Create an empty ViewerPreferencesElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a ViewerPreferencesElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a ViewerPreferencesElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new ViewerPreferencesElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "HideToolbar" entry of the viewer preferences dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a bool representing a PDF boolean object. The PDF specification states that this item assumes a value of false if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 150, page 362. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.1, page 28. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 147, page 435.

Represents the "HideMenubar" entry of the viewer preferences dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a bool representing a PDF boolean object. The PDF specification states that this item assumes a value of false if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 150, page 362. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.1, page 28. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 147, page 435.

Represents the "HideWindowUI" entry of the viewer preferences dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a bool representing a PDF boolean object. The PDF specification states that this item assumes a value of false if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 150, page 363. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.1, page 28. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 147, page 435.

Represents the "FitWindow" entry of the viewer preferences dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a bool representing a PDF boolean object. The PDF specification states that this item assumes a value of false if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 150, page 363. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.1, page 28. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 147, page 435.

Represents the "CenterWindow" entry of the viewer preferences dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a bool representing a PDF boolean object. The PDF specification states that this item assumes a value of false if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 150, page 363. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.1, page 28. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 147, page 435.

Represents the "DisplayDocTitle" entry of the viewer preferences dictionary object. It is an optional entry defined as part of the PDF 1.4 specification. It contains a bool representing a PDF boolean object. The PDF specification states that this item assumes a value of false if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 150, page 363. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.1, page 28. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 147, page 435.

Represents the "NonFullScreenPageMode" entry of the viewer preferences dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. The PDF specification states that this item assumes a value of "UseNone" if no value has been provided. This item may take one of the following valid values: UseNoneUseOutlinesUseThumbsUseOC For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 150, page 363. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.1, page 28. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 147, page 435.

Represents the "Direction" entry of the viewer preferences dictionary object. It is an optional entry defined as part of the PDF 1.3 specification. It contains a string representing a PDF name object. The PDF specification states that this item assumes a value of "L2R" if no value has been provided. This item may take one of the following valid values: L2RR2L For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 150, page 363. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.1, page 28. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 147, page 435.

Represents the "ViewArea" entry of the viewer preferences dictionary object. It is an optional entry defined as part of the PDF 1.4 specification. It was deprecated in PDF 2.0. It contains a string representing a PDF name object. The PDF specification states that this item assumes a value of "CropBox" if no value has been provided. This item may take one of the following valid values: MediaBoxCropBoxArtBoxTrimBoxBleedBox For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 150, page 363. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.1, page 28. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 147, page 436.

Represents the "ViewClip" entry of the viewer preferences dictionary object. It is an optional entry defined as part of the PDF 1.4 specification. It was deprecated in PDF 2.0. It contains a string representing a PDF name object. The PDF specification states that this item assumes a value of "CropBox" if no value has been provided. This item may take one of the following valid values: MediaBoxCropBoxArtBoxTrimBoxBleedBox For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 150, page 364. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.1, page 28. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 147, page 436.

Represents the "PrintArea" entry of the viewer preferences dictionary object. It is an optional entry defined as part of the PDF 1.4 specification. It was deprecated in PDF 2.0. It contains a string representing a PDF name object. The PDF specification states that this item assumes a value of "CropBox" if no value has been provided. This item may take one of the following valid values: MediaBoxCropBoxArtBoxTrimBoxBleedBox For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 150, page 364. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.1, page 28. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 147, page 436.

Represents the "PrintClip" entry of the viewer preferences dictionary object. It is an optional entry defined as part of the PDF 1.4 specification. It was deprecated in PDF 2.0. It contains a string representing a PDF name object. The PDF specification states that this item assumes a value of "CropBox" if no value has been provided. This item may take one of the following valid values: MediaBoxCropBoxArtBoxTrimBoxBleedBox For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 150, page 364. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.1, page 28. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 147, page 436.

Represents the "PrintScaling" entry of the viewer preferences dictionary object. It is an optional entry defined as part of the PDF 1.6 specification. It contains a string representing a PDF name object. The PDF specification states that this item assumes a value of "AppDefault" if no value has been provided. This item may take one of the following valid values: NoneAppDefault For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 150, page 364. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.1, page 28. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 147, page 437.

Represents the "Duplex" entry of the viewer preferences dictionary object. It is an optional entry defined as part of the PDF 1.7 specification. It contains a string representing a PDF name object. This item may take one of the following valid values: SimplexDuplexFlipShortEdgeDuplexFlipLongEdge For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 150, page 364. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.1, page 28. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 147, page 437.

Represents the "PickTrayByPDFSize" entry of the viewer preferences dictionary object. It is an optional entry defined as part of the PDF 1.7 specification. It contains a bool representing a PDF boolean object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 150, page 365. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.1, page 28. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 147, page 437.

Represents the "PrintPageRange" entry of the viewer preferences dictionary object. It is an optional entry defined as part of the PDF 1.7 specification. It contains an array which contains integers, representing PDF numeric objects. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 150, page 365. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.1, page 28. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 147, page 437.

Represents the "NumCopies" entry of the viewer preferences dictionary object. It is an optional entry defined as part of the PDF 1.7 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 150, page 365. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.1, page 28. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 147, page 437.

Represents the "Enforce" entry of the viewer preferences dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains an array which contains strings, representing PDF name objects. If provided, items in this array must always take the value "PrintScaling". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 150, page 362. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.1, page 28. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 147, page 437.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the view params dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 345, page 707. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.51g, page 93.

Create an empty ViewParamsElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a ViewParamsElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a ViewParamsElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new ViewParamsElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Instance" entry of the view params dictionary object. It is a required entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a RichMediaInstanceElement. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.51g, page 93. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 345, page 707.

Represents the "Data" entry of the view params dictionary object. It is a required entry defined as part of the PDF 1.7 Extension Level 3 specification. This property may contain one of two different types: 1) A string representing a PDF string object. 2) A StreamElement. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.51g, page 93. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 345, page 707.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the viewport dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 260, page 479. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 265, page 592. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.109, page 48.

Create an empty ViewportElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a ViewportElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a ViewportElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new ViewportElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the viewport dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. If provided, this item must always take the value "Viewport". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 260, page 479. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.109, page 48. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 265, page 592.

Represents the "BBox" entry of the viewport dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a RectangleElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 260, page 479. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.109, page 48. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 265, page 592.

Represents the "Name" entry of the viewport dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 260, page 480. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.109, page 48. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 265, page 592.

Represents the "Measure" entry of the viewport dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a MeasureElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 260, page 480. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.109, page 48. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 265, page 592.

Represents the "PtData" entry of the viewport dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a PointDataElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 260, page 479. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.109, page 48. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 265, page 592.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the watermark annotation. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 190, page 411. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 193, page 498. This class is always an indirect object because it inherits from AnnotationElement which is always an indirect object.

Create an empty WatermarkAnnotationElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a WatermarkAnnotationElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a WatermarkAnnotationElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new WatermarkAnnotationElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "FixedPrint" entry of the watermark annotation object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a FixedPrintElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 190, page 411. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 193, page 498.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the widget annotation. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 188, page 408. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 191, page 495. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.39, page 39. This class is always an indirect object because FieldElement.EntryKids requires it to be so.

Create an empty WidgetAnnotationElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a WidgetAnnotationElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a WidgetAnnotationElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new WidgetAnnotationElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Any FieldElement associated with this Widget Annotation.

Represents the "H" entry of the widget annotation object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. The PDF specification states that this item assumes a value of "I" if no value has been provided. This item may take one of the following valid values: NIOPT For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 188, page 408. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.39, page 39. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 191, page 495.

Represents the "MK" entry of the widget annotation object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an AppearanceCharacteristicsElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 188, page 408. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.39, page 39. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 191, page 495.

Represents the "A" entry of the widget annotation object. It is an optional entry defined as part of the PDF 1.1 specification. It contains an ActionElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 188, page 409. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.39, page 39. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 191, page 495.

Represents the "AA" entry of the widget annotation object. It is an optional entry defined as part of the PDF 1.2 specification. It contains an AnnotationAdditionalActionsElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 188, page 409. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.39, page 39. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 191, page 495.

Represents the "BS" entry of the widget annotation object. It is an optional entry defined as part of the PDF 1.2 specification. It contains a BorderStyleElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 188, page 409. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.39, page 39. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 191, page 496.

Represents the "Parent" entry of the widget annotation object. It is defined as part of the PDF 1.0 specification. It contains a FieldElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 188, page 409. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.39, page 39. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 191, page 496.

Represents the "PMD" entry of the widget annotation object. It is defined as part of the PDF 1.7 Extension Level 3 specification. It contains a PaperMetaDataGenerationParametersElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 188, page 408. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 8.39, page 39. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 191, page 495.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the windows launch parameter dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 204, page 422. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 208, page 513.

Create an empty WindowsLaunchParameterElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a WindowsLaunchParameterElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a WindowsLaunchParameterElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new WindowsLaunchParameterElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "F" entry of the windows launch parameter dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. This string contains raw byte data. So it looks like a string but really it is just a wrapper for data. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 204, page 422. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 208, page 513.

Represents the "D" entry of the windows launch parameter dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. This string contains raw byte data. So it looks like a string but really it is just a wrapper for data. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 204, page 423. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 208, page 513.

Represents the "O" entry of the windows launch parameter dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. This is encoded as a string using single byte ASCII encoding. The PDF specification states that this item assumes a value of "open" if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 204, page 423. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 208, page 513.

Represents the "P" entry of the windows launch parameter dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. This string contains raw byte data. So it looks like a string but really it is just a wrapper for data. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 204, page 423. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 208, page 514.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the 3D activation dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 299, page 514. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 310, page 642. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.34, page 56.

Create an empty D3DActivationElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a D3DActivationElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a D3DActivationElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new D3DActivationElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "A" entry of the 3d activation dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. The PDF specification states that this item assumes a value of "XA" if no value has been provided. This item may take one of the following valid values: POPVXA For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 299, page 514. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.34, page 56. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 310, page 642.

Represents the "AIS" entry of the 3d activation dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. The PDF specification states that this item assumes a value of "L" if no value has been provided. This item may take one of the following valid values: IL For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 299, page 514. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.34, page 56. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 310, page 642.

Represents the "D" entry of the 3d activation dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. The PDF specification states that this item assumes a value of "PI" if no value has been provided. This item may take one of the following valid values: PCPIXD For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 299, page 514. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.34, page 56. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 310, page 642.

Represents the "DIS" entry of the 3d activation dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. The PDF specification states that this item assumes a value of "U" if no value has been provided. This item may take one of the following valid values: UIL For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 299, page 514. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.34, page 56. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 310, page 643.

Represents the "TB" entry of the 3d activation dictionary object. It is an optional entry defined as part of the PDF 1.7 specification. It contains a bool representing a PDF boolean object. The PDF specification states that this item assumes a value of true if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 299, page 515. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.34, page 56. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 310, page 643.

Represents the "NP" entry of the 3d activation dictionary object. It is an optional entry defined as part of the PDF 1.7 specification. It contains a bool representing a PDF boolean object. The PDF specification states that this item assumes a value of false if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 299, page 515. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.34, page 56. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 310, page 643.

Represents the "Style" entry of the 3d activation dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a string representing a PDF name object. The PDF specification states that this item assumes a value of "Embedded" if no value has been provided. This item may take one of the following valid values: EmbeddedWindowed For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 299, page 514. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.34, page 56. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 310, page 643.

Represents the "Window" entry of the 3d activation dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a RichMediaWindowElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 299, page 514. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.34, page 56. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 310, page 643.

Represents the "Transparent" entry of the 3d activation dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a bool representing a PDF boolean object. The PDF specification states that this item assumes a value of false if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 299, page 514. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.34, page 56. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 310, page 643.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the 3D angular dimension measurement. This is definitively detailed in: The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 329, page 689. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39d, page 68.

Create an empty D3DAngularMeasurementElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a D3DAngularMeasurementElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a D3DAngularMeasurementElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new D3DAngularMeasurementElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "AP" entry of the 3d angular dimension measurement object. It is a required entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains an array which contains doubles, representing PDF numeric objects. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39d, page 68. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 329, page 689.

Represents the "A1" entry of the 3d angular dimension measurement object. It is a required entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains an array which contains doubles, representing PDF numeric objects. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39d, page 68. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 329, page 689.

Represents the "D1" entry of the 3d angular dimension measurement object. It is a required entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains an array which contains doubles, representing PDF numeric objects. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39d, page 68. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 329, page 689.

Represents the "N1" entry of the 3d angular dimension measurement object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a string representing a PDF string object. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39d, page 68. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 329, page 689.

Represents the "A2" entry of the 3d angular dimension measurement object. It is a required entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains an array which contains doubles, representing PDF numeric objects. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39d, page 68. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 329, page 689.

Represents the "D2" entry of the 3d angular dimension measurement object. It is a required entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains an array which contains doubles, representing PDF numeric objects. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39d, page 68. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 329, page 689.

Represents the "N2" entry of the 3d angular dimension measurement object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a string representing a PDF string object. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39d, page 68. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 329, page 689.

Represents the "TP" entry of the 3d angular dimension measurement object. It is a required entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains an array which contains doubles, representing PDF numeric objects. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39d, page 68. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 329, page 689.

Represents the "TX" entry of the 3d angular dimension measurement object. It is a required entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains an array which contains doubles, representing PDF numeric objects. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39d, page 68. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 329, page 689.

Represents the "TY" entry of the 3d angular dimension measurement object. It is a required entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains an array which contains doubles, representing PDF numeric objects. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39d, page 68. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 329, page 689.

Represents the "TS" entry of the 3d angular dimension measurement object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a double representing a PDF numeric object. The PDF specification states that this item assumes a value of 12 if no value has been provided. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39d, page 68. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 329, page 690.

Represents the "C" entry of the 3d angular dimension measurement object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains an array which contains doubles, representing PDF numeric objects. Items in this array should have a minimum value of 0 and a maximum of 1. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39d, page 68. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 329, page 690.

Represents the "V" entry of the 3d angular dimension measurement object. It is a required entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a double representing a PDF numeric object. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39d, page 68. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 329, page 690.

Represents the "P" entry of the 3d angular dimension measurement object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains an integer representing a PDF numeric object. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39d, page 68. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 329, page 690.

Represents the "UT" entry of the 3d angular dimension measurement object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a string representing a PDF string object. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39d, page 68. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 329, page 690.

Represents the "DR" entry of the 3d angular dimension measurement object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a bool representing a PDF boolean object. The PDF specification states that this item assumes a value of true if no value has been provided. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39d, page 68. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 329, page 690.

Represents the "S" entry of the 3d angular dimension measurement object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a ProjectionAnnotationElement. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39d, page 68. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 329, page 690.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the 3D animation style dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 301, page 517. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 312, page 646.

Create an empty D3DAnimationStyleElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a D3DAnimationStyleElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a D3DAnimationStyleElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new D3DAnimationStyleElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the 3d animation style dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. If provided, this item must always take the value "3DAnimationStyle". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 301, page 517. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 312, page 646.

Represents the "Subtype" entry of the 3d animation style dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. The PDF specification states that this item assumes a value of "None" if no value has been provided. This item may take one of the following valid values: NoneLinearOscillating For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 301, page 517. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 312, page 646.

Represents the "PC" entry of the 3d animation style dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. The PDF specification states that this item assumes a value of 0 if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 301, page 517. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 312, page 646.

Represents the "TM" entry of the 3d animation style dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a double representing a PDF numeric object. It should have a positive value. The PDF specification states that this item assumes a value of 1 if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 301, page 517. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 312, page 647.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the 3D annotation. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 298, page 512. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 309, page 639. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.33, page 55. This class is always an indirect object because it inherits from AnnotationElement which is always an indirect object.

Create an empty D3DAnnotationElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a D3DAnnotationElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a D3DAnnotationElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new D3DAnnotationElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "3DD" entry of the 3d annotation object. It is a required entry defined as part of the PDF 1.0 specification. This property may contain one of two different types: 1) A D3DReferenceElement. 2) A D3DStreamElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 298, page 512. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.33, page 55. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 309, page 639.

Represents the "3DV" entry of the 3d annotation object. It is an optional entry defined as part of the PDF 1.0 specification. This property may contain one of four different types: 1) An integer representing a PDF numeric object. 2) A string representing a PDF name object. This item may take one of the following valid values: FLD 3) A string representing a PDF string object. 4) A D3DViewElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 298, page 512. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.33, page 55. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 309, page 640.

Represents the "3DA" entry of the 3d annotation object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a D3DActivationElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 298, page 512. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.33, page 55. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 309, page 640.

Represents the "3DI" entry of the 3d annotation object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a bool representing a PDF boolean object. The PDF specification states that this item assumes a value of true if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 298, page 512. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.33, page 55. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 309, page 640.

Represents the "3DB" entry of the 3d annotation object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a RectangleElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 298, page 513. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.33, page 55. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 309, page 640.

Represents the "3DU" entry of the 3d annotation object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a D3DUnitsElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 298, page 512. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.33, page 55. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 309, page 640.

Represents the "GEO" entry of the 3d annotation object. It is an optional entry defined as part of the PDF 2.0 specification. It contains an Element. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 298, page 512. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.33, page 55. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 309, page 640.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the external data dictionary used to markup 3D annotations. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 313, page 543. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 324, page 675.

Create an empty D3DAnnotationExternalDataElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a D3DAnnotationExternalDataElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a D3DAnnotationExternalDataElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new D3DAnnotationExternalDataElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "3DA" entry of the external data dictionary used to markup 3d annotations object. It is a required entry defined as part of the PDF 1.0 specification. This property may contain one of two different types: 1) A string representing a PDF string object. 2) A D3DAnnotationElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 313, page 543. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 324, page 676.

Represents the "3DV" entry of the external data dictionary used to markup 3d annotations object. It is a required entry defined as part of the PDF 1.0 specification. It contains a D3DViewElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 313, page 543. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 324, page 676.

Represents the "MD5" entry of the external data dictionary used to markup 3d annotations object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. This string contains raw byte data. So it looks like a string but really it is just a wrapper for data. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 313, page 543. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 324, page 676.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the 3D background dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 306, page 527. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 317, page 659.

Create an empty D3DBackgroundElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a D3DBackgroundElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a D3DBackgroundElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new D3DBackgroundElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the 3d background dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. If provided, this item must always take the value "3DBG". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 306, page 527. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 317, page 659.

Represents the "Subtype" entry of the 3d background dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. The PDF specification states that this item assumes a value of "SC" if no value has been provided. If provided, this item must always take the value "SC". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 306, page 527. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 317, page 659.

Represents the "CS" entry of the 3d background dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. The PDF specification states that this item assumes a value of "DeviceRGB" if no value has been provided. If provided, this item must always take the value "DeviceRGB". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 306, page 527. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 317, page 659.

Represents the "C" entry of the 3d background dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains doubles, representing PDF numeric objects. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 306, page 527. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 317, page 659.

Represents the "EA" entry of the 3d background dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a bool representing a PDF boolean object. The PDF specification states that this item assumes a value of false if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 306, page 527. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 317, page 659.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the 3D comment note. This is definitively detailed in: The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 331, page 694. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39f, page 74.

Create an empty D3DCommentNoteElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a D3DCommentNoteElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a D3DCommentNoteElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new D3DCommentNoteElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "A1" entry of the 3d comment note object. It is a required entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains an array which contains doubles, representing PDF numeric objects. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39f, page 74. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 331, page 694.

Represents the "N1" entry of the 3d comment note object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a string representing a PDF string object. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39f, page 74. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 331, page 694.

Represents the "TP" entry of the 3d comment note object. It is a required entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains an array which contains doubles, representing PDF numeric objects. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39f, page 74. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 331, page 694.

Represents the "TB" entry of the 3d comment note object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains an array which contains integers, representing PDF numeric objects. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39f, page 74. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 331, page 695.

Represents the "TS" entry of the 3d comment note object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a double representing a PDF numeric object. The PDF specification states that this item assumes a value of 12 if no value has been provided. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39f, page 74. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 331, page 695.

Represents the "C" entry of the 3d comment note object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains an array which contains doubles, representing PDF numeric objects. Items in this array should have a minimum value of 0 and a maximum of 1. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39f, page 74. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 331, page 695.

Represents the "UT" entry of the 3d comment note object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a string representing a PDF string object. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39f, page 74. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 331, page 695.

Represents the "S" entry of the 3d comment note object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a ProjectionAnnotationElement. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39f, page 74. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 331, page 695.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the 3D cross section dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 311, page 532. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 322, page 664.

Create an empty D3DCrossSectionElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a D3DCrossSectionElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a D3DCrossSectionElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new D3DCrossSectionElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the 3d cross section dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. If provided, this item must always take the value "3DCrossSection". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 311, page 532. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 322, page 664.

Represents the "C" entry of the 3d cross section dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains doubles, representing PDF numeric objects. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 311, page 532. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 322, page 665.

Represents the "O" entry of the 3d cross section dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains an array which contains doubles, representing PDF numeric objects. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 311, page 532. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 322, page 665.

Represents the "PO" entry of the 3d cross section dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a double representing a PDF numeric object. It should have a minimum value of 0 and a maximum of 1. The PDF specification states that this item assumes a value of 0.5 if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 311, page 532. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 322, page 665.

Represents the "PC" entry of the 3d cross section dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains Elements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 311, page 532. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 322, page 665.

Represents the "IV" entry of the 3d cross section dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a bool representing a PDF boolean object. The PDF specification states that this item assumes a value of false if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 311, page 532. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 322, page 665.

Represents the "IC" entry of the 3d cross section dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains Elements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 311, page 532. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 322, page 665.

Represents the "ST" entry of the 3d cross section dictionary object. It is an optional entry defined as part of the PDF 2.0 specification. It contains a bool representing a PDF boolean object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 311, page 532. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 322, page 665.

Represents the "SC" entry of the 3d cross section dictionary object. It is an optional entry defined as part of the PDF 2.0 specification. It contains a bool representing a PDF boolean object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 311, page 532. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 322, page 665.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the 3D lighting scheme dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 309, page 530. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 320, page 662.

Create an empty D3DLightingSchemeElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a D3DLightingSchemeElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a D3DLightingSchemeElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new D3DLightingSchemeElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the 3d lighting scheme dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. If provided, this item must always take the value "3DLightingScheme". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 309, page 530. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 320, page 662.

Represents the "Subtype" entry of the 3d lighting scheme dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. This item may take one of the following valid values: ArtworkNoneWhiteDayNightHardPrimaryBlueRedCubeCADHeadlamp For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 309, page 530. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 320, page 662.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the 3D linear dimension measurement. This is definitively detailed in: The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 327, page 684. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39b, page 63.

Create an empty D3DLinearMeasurementElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a D3DLinearMeasurementElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a D3DLinearMeasurementElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new D3DLinearMeasurementElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "AP" entry of the 3d linear dimension measurement object. It is a required entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains an array which contains doubles, representing PDF numeric objects. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39b, page 63. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 327, page 684.

Represents the "A1" entry of the 3d linear dimension measurement object. It is a required entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains an array which contains doubles, representing PDF numeric objects. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39b, page 63. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 327, page 684.

Represents the "N1" entry of the 3d linear dimension measurement object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a string representing a PDF string object. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39b, page 63. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 327, page 684.

Represents the "A2" entry of the 3d linear dimension measurement object. It is a required entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains an array which contains doubles, representing PDF numeric objects. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39b, page 63. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 327, page 684.

Represents the "N2" entry of the 3d linear dimension measurement object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a string representing a PDF string object. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39b, page 63. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 327, page 684.

Represents the "TP" entry of the 3d linear dimension measurement object. It is a required entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains an array which contains doubles, representing PDF numeric objects. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39b, page 63. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 327, page 684.

Represents the "TY" entry of the 3d linear dimension measurement object. It is a required entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains an array which contains doubles, representing PDF numeric objects. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39b, page 63. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 327, page 685.

Represents the "TS" entry of the 3d linear dimension measurement object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a double representing a PDF numeric object. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39b, page 63. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 327, page 685.

Represents the "C" entry of the 3d linear dimension measurement object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains an array which contains doubles, representing PDF numeric objects. Items in this array should have a minimum value of 0 and a maximum of 1. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39b, page 63. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 327, page 685.

Represents the "V" entry of the 3d linear dimension measurement object. It is a required entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a double representing a PDF numeric object. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39b, page 63. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 327, page 685.

Represents the "U" entry of the 3d linear dimension measurement object. It is a required entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a string representing a PDF string object. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39b, page 63. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 327, page 685.

Represents the "P" entry of the 3d linear dimension measurement object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains an integer representing a PDF numeric object. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39b, page 63. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 327, page 685.

Represents the "UT" entry of the 3d linear dimension measurement object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a string representing a PDF string object. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39b, page 63. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 327, page 685.

Represents the "S" entry of the 3d linear dimension measurement object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a ProjectionAnnotationElement. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39b, page 63. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 327, page 685.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the 3D measurement dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 326, page 682. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39a, page 62.

Create an empty D3DMeasurementElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a D3DMeasurementElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a D3DMeasurementElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new D3DMeasurementElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the 3d measurement dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a string representing a PDF name object. If provided, this item must always take the value "3DMeasure". For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39a, page 62. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 326, page 682.

Represents the "Subtype" entry of the 3d measurement dictionary object. It is a required entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a string representing a PDF name object. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39a, page 62. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 326, page 683.

Represents the "TRL" entry of the 3d measurement dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a string representing a PDF string object. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39a, page 62. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 326, page 683.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the 3D node dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 312, page 538. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 9.47, page 58. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 323, page 670.

Create an empty D3DNodeElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a D3DNodeElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a D3DNodeElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new D3DNodeElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the 3d node dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. If provided, this item must always take the value "3DNode". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 312, page 538. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 323, page 670. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 9.47, page 58.

Represents the "N" entry of the 3d node dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 312, page 538. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 323, page 671. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 9.47, page 58.

Represents the "Instance" entry of the 3d node dictionary object. It is defined as part of the PDF 1.7 Extension Level 3 specification. It contains a RichMediaInstanceElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 312, page 538. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 323, page 671. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 9.47, page 58.

Represents the "Data" entry of the 3d node dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. This property may contain one of two different types: 1) A string representing a PDF string object. 2) A StreamElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 312, page 538. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 323, page 671. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 9.47, page 58.

Represents the "RM" entry of the 3d node dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a RenderModeElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 312, page 538. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 323, page 671. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 9.47, page 58.

Represents the "O" entry of the 3d node dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a double representing a PDF numeric object. It should have a minimum value of 0 and a maximum of 1. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 312, page 538. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 323, page 671. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 9.47, page 58.

Represents the "V" entry of the 3d node dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a bool representing a PDF boolean object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 312, page 538. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 323, page 671. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 9.47, page 58.

Represents the "M" entry of the 3d node dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains doubles, representing PDF numeric objects. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 312, page 538. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 323, page 671. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 9.47, page 58.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the 3D perpendicular dimension measurement. This is definitively detailed in: The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 328, page 686. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39c, page 65.

Create an empty D3DPerpendicularMeasurementElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a D3DPerpendicularMeasurementElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a D3DPerpendicularMeasurementElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new D3DPerpendicularMeasurementElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "AP" entry of the 3d perpendicular dimension measurement object. It is a required entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains an array which contains doubles, representing PDF numeric objects. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39c, page 65. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 328, page 686.

Represents the "A1" entry of the 3d perpendicular dimension measurement object. It is a required entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains an array which contains doubles, representing PDF numeric objects. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39c, page 65. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 328, page 686.

Represents the "N1" entry of the 3d perpendicular dimension measurement object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a string representing a PDF string object. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39c, page 65. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 328, page 686.

Represents the "A2" entry of the 3d perpendicular dimension measurement object. It is a required entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains an array which contains doubles, representing PDF numeric objects. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39c, page 65. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 328, page 687.

Represents the "N2" entry of the 3d perpendicular dimension measurement object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a string representing a PDF string object. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39c, page 65. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 328, page 687.

Represents the "D1" entry of the 3d perpendicular dimension measurement object. It is a required entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains an array which contains doubles, representing PDF numeric objects. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39c, page 65. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 328, page 687.

Represents the "TP" entry of the 3d perpendicular dimension measurement object. It is a required entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains an array which contains doubles, representing PDF numeric objects. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39c, page 65. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 328, page 687.

Represents the "TY" entry of the 3d perpendicular dimension measurement object. It is a required entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains an array which contains doubles, representing PDF numeric objects. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39c, page 65. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 328, page 687.

Represents the "TS" entry of the 3d perpendicular dimension measurement object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a double representing a PDF numeric object. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39c, page 65. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 328, page 687.

Represents the "C" entry of the 3d perpendicular dimension measurement object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains an array which contains doubles, representing PDF numeric objects. Items in this array should have a minimum value of 0 and a maximum of 1. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39c, page 65. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 328, page 687.

Represents the "V" entry of the 3d perpendicular dimension measurement object. It is a required entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a double representing a PDF numeric object. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39c, page 65. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 328, page 687.

Represents the "U" entry of the 3d perpendicular dimension measurement object. It is a required entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a string representing a PDF string object. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39c, page 65. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 328, page 687.

Represents the "P" entry of the 3d perpendicular dimension measurement object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains an integer representing a PDF numeric object. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39c, page 65. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 328, page 687.

Represents the "UT" entry of the 3d perpendicular dimension measurement object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a string representing a PDF string object. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39c, page 65. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 328, page 687.

Represents the "S" entry of the 3d perpendicular dimension measurement object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a ProjectionAnnotationElement. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39c, page 65. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 328, page 687.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the 3D radial dimension measurement. This is definitively detailed in: The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 330, page 692. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39e, page 71.

Create an empty D3DRadialMeasurementElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a D3DRadialMeasurementElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a D3DRadialMeasurementElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new D3DRadialMeasurementElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "AP" entry of the 3d radial dimension measurement object. It is a required entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains an array which contains doubles, representing PDF numeric objects. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39e, page 71. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 330, page 692.

Represents the "A1" entry of the 3d radial dimension measurement object. It is a required entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains an array which contains doubles, representing PDF numeric objects. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39e, page 71. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 330, page 692.

Represents the "A2" entry of the 3d radial dimension measurement object. It is a required entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains an array which contains doubles, representing PDF numeric objects. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39e, page 71. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 330, page 692.

Represents the "N2" entry of the 3d radial dimension measurement object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a string representing a PDF string object. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39e, page 71. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 330, page 692.

Represents the "A3" entry of the 3d radial dimension measurement object. It is defined as part of the PDF 1.7 Extension Level 3 specification. It contains an array which contains doubles, representing PDF numeric objects. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39e, page 71. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 330, page 692.

Represents the "A4" entry of the 3d radial dimension measurement object. It is defined as part of the PDF 1.7 Extension Level 3 specification. It contains an array which contains doubles, representing PDF numeric objects. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39e, page 71. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 330, page 692.

Represents the "TP" entry of the 3d radial dimension measurement object. It is a required entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains an array which contains doubles, representing PDF numeric objects. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39e, page 71. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 330, page 692.

Represents the "TX" entry of the 3d radial dimension measurement object. It is a required entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains an array which contains doubles, representing PDF numeric objects. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39e, page 71. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 330, page 692.

Represents the "TY" entry of the 3d radial dimension measurement object. It is a required entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains an array which contains doubles, representing PDF numeric objects. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39e, page 71. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 330, page 692.

Represents the "EL" entry of the 3d radial dimension measurement object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a double representing a PDF numeric object. The PDF specification states that this item assumes a value of 60 if no value has been provided. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39e, page 71. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 330, page 692.

Represents the "TS" entry of the 3d radial dimension measurement object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a double representing a PDF numeric object. The PDF specification states that this item assumes a value of 12 if no value has been provided. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39e, page 71. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 330, page 692.

Represents the "C" entry of the 3d radial dimension measurement object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains an array which contains doubles, representing PDF numeric objects. Items in this array should have a minimum value of 0 and a maximum of 1. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39e, page 71. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 330, page 692.

Represents the "V" entry of the 3d radial dimension measurement object. It is a required entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a double representing a PDF numeric object. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39e, page 71. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 330, page 692.

Represents the "U" entry of the 3d radial dimension measurement object. It is a required entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a string representing a PDF string object. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39e, page 71. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 330, page 693.

Represents the "P" entry of the 3d radial dimension measurement object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains an integer representing a PDF numeric object. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39e, page 71. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 330, page 693.

Represents the "UT" entry of the 3d radial dimension measurement object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a string representing a PDF string object. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39e, page 71. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 330, page 693.

Represents the "SC" entry of the 3d radial dimension measurement object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a bool representing a PDF boolean object. The PDF specification states that this item assumes a value of false if no value has been provided. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39e, page 71. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 330, page 693.

Represents the "R" entry of the 3d radial dimension measurement object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a bool representing a PDF boolean object. The PDF specification states that this item assumes a value of true if no value has been provided. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39e, page 71. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 330, page 693.

Represents the "S" entry of the 3d radial dimension measurement object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a ProjectionAnnotationElement. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39e, page 71. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 330, page 693.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the 3D reference dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 303, page 519. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 314, page 648.

Create an empty D3DReferenceElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a D3DReferenceElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a D3DReferenceElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new D3DReferenceElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the 3d reference dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. If provided, this item must always take the value "3DRef". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 303, page 519. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 314, page 648.

Represents the "3DD" entry of the 3d reference dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a D3DStreamElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 303, page 519. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 314, page 648.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the 3D stream dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 300, page 516. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 311, page 645. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.35, page 56. This class is always an indirect object because it is also a StreamElement and these are always indirect objects.

Create an empty D3DStreamElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a D3DStreamElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a D3DStreamElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new D3DStreamElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

The StreamElement associated with this class.

Represents the "Type" entry of the 3d stream dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. If provided, this item must always take the value "3D". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 300, page 516. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.35, page 56. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 311, page 645.

Represents the "Subtype" entry of the 3d stream dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. This item may take one of the following valid values: U3DPRC For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 300, page 516. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.35, page 56. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 311, page 645.

Represents the "VA" entry of the 3d stream dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains D3DViewElements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 300, page 516. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.35, page 56. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 311, page 645.

Represents the "DV" entry of the 3d stream dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. This property may contain one of four different types: 1) An integer representing a PDF numeric object. 2) A string representing a PDF name object. This item may take one of the following valid values: FLD 3) A string representing a PDF string object. 4) A D3DViewElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 300, page 516. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.35, page 56. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 311, page 645.

Represents the "Resources" entry of the 3d stream dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a NameTreeNodeElement containing Elements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 300, page 516. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.35, page 56. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 311, page 645.

Represents the "OnInstantiate" entry of the 3d stream dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a StreamElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 300, page 516. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.35, page 56. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 311, page 645.

Represents the "AN" entry of the 3d stream dictionary object. It is an optional entry defined as part of the PDF 1.7 specification. It contains a D3DAnimationStyleElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 300, page 516. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.35, page 56. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 311, page 645.

Represents the "ColorSpace" entry of the 3d stream dictionary object. It is defined as part of the PDF 1.0 specification. It contains a ColorSpaceElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 300, page 516. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.35, page 56. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 311, page 645.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the 3D units dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 325, page 680. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.33a, page 60.

Create an empty D3DUnitsElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a D3DUnitsElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a D3DUnitsElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new D3DUnitsElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "TSm" entry of the 3d units dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a double representing a PDF numeric object. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.33a, page 60. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 325, page 680.

Represents the "TSn" entry of the 3d units dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a double representing a PDF numeric object. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.33a, page 60. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 325, page 680.

Represents the "TU" entry of the 3d units dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a string representing a PDF string object. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.33a, page 60. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 325, page 680.

Represents the "USm" entry of the 3d units dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a double representing a PDF numeric object. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.33a, page 60. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 325, page 680.

Represents the "USn" entry of the 3d units dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a double representing a PDF numeric object. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.33a, page 60. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 325, page 680.

Represents the "UU" entry of the 3d units dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a string representing a PDF string object. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.33a, page 60. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 325, page 681.

Represents the "DSm" entry of the 3d units dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a double representing a PDF numeric object. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.33a, page 60. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 325, page 681.

Represents the "DSn" entry of the 3d units dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a double representing a PDF numeric object. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.33a, page 60. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 325, page 681.

Represents the "DU" entry of the 3d units dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains a string representing a PDF string object. For definitive details see: Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.33a, page 60. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 325, page 681.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the 3D view dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 304, page 521. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 344, page 707. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39, page 57. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.51f, page 93. This class is always an indirect object because RichMediaActivationElement.EntryView and RichMediaContentElement.EntryViews require it to be so.

Create an empty D3DViewElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a D3DViewElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a D3DViewElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new D3DViewElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the 3d view dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. If provided, this item must always take the value "3DView". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 304, page 521. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39, page 57. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 344, page 707. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.51f, page 93.

Represents the "XN" entry of the 3d view dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 304, page 521. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39, page 57. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 344, page 707. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.51f, page 93.

Represents the "IN" entry of the 3d view dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 304, page 521. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39, page 57. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 344, page 707. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.51f, page 93.

Represents the "C2W" entry of the 3d view dictionary object. It is defined as part of the PDF 1.0 specification. It contains an array which contains doubles, representing PDF numeric objects. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 304, page 521. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39, page 57. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 344, page 707. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.51f, page 93.

Represents the "U3DPath" entry of the 3d view dictionary object. It is defined as part of the PDF 1.0 specification. It contains an array which contains strings, representing PDF string objects. If you read the specification you will see that an array of one string may be represented as a single string rather than an array. However we always present this property as an array to simplify the interface. It is only if you add or remove items in the array, that the underlying representation will be changed. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 304, page 521. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39, page 57. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 344, page 707. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.51f, page 93.

Represents the "CO" entry of the 3d view dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a double representing a PDF numeric object. It should have a minimum value of 0. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 304, page 522. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39, page 57. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 344, page 707. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.51f, page 93.

Represents the "P" entry of the 3d view dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a ProjectionElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 304, page 522. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39, page 57. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 344, page 707. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.51f, page 93.

Represents the "O" entry of the 3d view dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a FormXObjectElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 304, page 522. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39, page 57. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 344, page 707. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.51f, page 93.

Represents the "BG" entry of the 3d view dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a D3DBackgroundElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 304, page 522. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39, page 57. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 344, page 707. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.51f, page 93.

Represents the "RM" entry of the 3d view dictionary object. It is an optional entry defined as part of the PDF 1.7 specification. It contains a RenderModeElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 304, page 522. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39, page 57. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 344, page 707. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.51f, page 93.

Represents the "LS" entry of the 3d view dictionary object. It is an optional entry defined as part of the PDF 1.7 specification. It contains a D3DLightingSchemeElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 304, page 522. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39, page 57. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 344, page 707. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.51f, page 93.

Represents the "SA" entry of the 3d view dictionary object. It is an optional entry defined as part of the PDF 1.7 specification. It contains an array which contains D3DCrossSectionElements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 304, page 522. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39, page 57. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 344, page 707. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.51f, page 93.

Represents the "NA" entry of the 3d view dictionary object. It is an optional entry defined as part of the PDF 1.7 specification. It contains an array which contains D3DNodeElements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 304, page 522. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39, page 57. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 344, page 707. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.51f, page 93.

Represents the "NR" entry of the 3d view dictionary object. It is an optional entry defined as part of the PDF 1.7 specification. It contains a bool representing a PDF boolean object. The PDF specification states that this item assumes a value of false if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 304, page 522. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39, page 57. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 344, page 707. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.51f, page 93.

Represents the "MS" entry of the 3d view dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. This item may take one of the following valid values: MU3D For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 304, page 521. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39, page 57. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 344, page 707. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.51f, page 93.

Represents the "MA" entry of the 3d view dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains an array which contains D3DMeasurementElements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 304, page 521. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39, page 57. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 344, page 707. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.51f, page 93.

Represents the "Snapshot" entry of the 3d view dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains an ImageXObjectElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 304, page 521. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39, page 57. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 344, page 707. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.51f, page 93.

Represents the "Params" entry of the 3d view dictionary object. It is an optional entry defined as part of the PDF 1.7 Extension Level 3 specification. It contains an array which contains ViewParamsElements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 304, page 521. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.39, page 57. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 344, page 707. Adobe Supplement to the ISO 32000, BaseVersion: 1.7, ExtensionLevel: 3; Table: 9.51f, page 93.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the floating window parameters dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 284, page 500. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 295, page 626.

Create an empty FloatingWindowParametersElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a FloatingWindowParametersElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a FloatingWindowParametersElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new FloatingWindowParametersElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the floating window parameters dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. If provided, this item must always take the value "FWParams". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 284, page 500. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 295, page 626.

Represents the "D" entry of the floating window parameters dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains an array which contains integers, representing PDF numeric objects. Items in this array should have a minimum value of 0. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 284, page 500. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 295, page 626.

Represents the "RT" entry of the floating window parameters dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. The PDF specification states that this item assumes a value of 0 if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 284, page 500. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 295, page 626.

Represents the "P" entry of the floating window parameters dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. The PDF specification states that this item assumes a value of 4 if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 284, page 500. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 295, page 626.

Represents the "O" entry of the floating window parameters dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. The PDF specification states that this item assumes a value of 1 if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 284, page 500. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 295, page 626.

Represents the "T" entry of the floating window parameters dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a bool representing a PDF boolean object. The PDF specification states that this item assumes a value of true if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 284, page 500. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 295, page 626.

Represents the "UC" entry of the floating window parameters dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a bool representing a PDF boolean object. The PDF specification states that this item assumes a value of true if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 284, page 500. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 295, page 626.

Represents the "R" entry of the floating window parameters dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. The PDF specification states that this item assumes a value of 0 if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 284, page 500. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 295, page 627.

Represents the "TT" entry of the floating window parameters dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains strings, representing PDF string objects. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 284, page 501. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 295, page 627.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the media clip data dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 274, page 492. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 285, page 617.

Create an empty MediaClipDataElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a MediaClipDataElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a MediaClipDataElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new MediaClipDataElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "D" entry of the media clip data dictionary object. It is a required entry defined as part of the PDF 1.0 specification. This property may contain one of two different types: 1) A FileSpecificationElement. 2) A FormXObjectElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 274, page 492. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 285, page 617.

Represents the "CT" entry of the media clip data dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. This is encoded as a string using single byte ASCII encoding. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 274, page 492. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 285, page 617.

Represents the "P" entry of the media clip data dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a MediaPermissionsElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 274, page 492. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 285, page 617.

Represents the "Alt" entry of the media clip data dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains strings, representing PDF string objects. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 274, page 492. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 285, page 617.

Represents the "PL" entry of the media clip data dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a MediaPlayersElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 274, page 493. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 285, page 617.

Represents the "MH" entry of the media clip data dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an Element. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 274, page 493. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 285, page 617.

Represents the "BE" entry of the media clip data dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an Element. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 274, page 493. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 285, page 617.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the media clip data mh/be dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 276, page 494. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 287, page 619.

Create an empty MediaClipDataMhBeElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a MediaClipDataMhBeElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a MediaClipDataMhBeElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new MediaClipDataMhBeElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "BU" entry of the media clip data mh/be dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. This is encoded as a string using single byte ASCII encoding. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 276, page 494. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 287, page 619.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the media clip dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 273, page 492. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 284, page 617.

Create an empty MediaClipElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a MediaClipElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a MediaClipElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new MediaClipElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the media clip dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. If provided, this item must always take the value "MediaClip". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 273, page 492. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 284, page 617.

Represents the "S" entry of the media clip dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. This item may take one of the following valid values: MCDMCS For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 273, page 492. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 284, page 617.

Represents the "N" entry of the media clip dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 273, page 492. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 284, page 617.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the media clip section dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 277, page 495. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 288, page 620.

Create an empty MediaClipSectionElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a MediaClipSectionElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a MediaClipSectionElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new MediaClipSectionElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "D" entry of the media clip section dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a MediaClipSectionElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 277, page 495. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 288, page 620.

Represents the "Alt" entry of the media clip section dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains strings, representing PDF string objects. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 277, page 495. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 288, page 620.

Represents the "MH" entry of the media clip section dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an Element. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 277, page 495. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 288, page 620.

Represents the "BE" entry of the media clip section dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an Element. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 277, page 495. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 288, page 620.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the media clip section mh/be dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 278, page 496. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 289, page 621.

Create an empty MediaClipSectionMhBeElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a MediaClipSectionMhBeElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a MediaClipSectionMhBeElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new MediaClipSectionMhBeElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "B" entry of the media clip section mh/be dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a MediaOffsetElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 278, page 496. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 289, page 621.

Represents the "E" entry of the media clip section mh/be dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a MediaOffsetElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 278, page 496. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 289, page 621.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the media criteria dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 268, page 489. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 279, page 613.

Create an empty MediaCriteriaElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a MediaCriteriaElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a MediaCriteriaElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new MediaCriteriaElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the media criteria dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. If provided, this item must always take the value "MediaCriteria". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 268, page 489. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 279, page 613.

Represents the "A" entry of the media criteria dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a bool representing a PDF boolean object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 268, page 489. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 279, page 614.

Represents the "C" entry of the media criteria dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a bool representing a PDF boolean object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 268, page 489. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 279, page 614.

Represents the "O" entry of the media criteria dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a bool representing a PDF boolean object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 268, page 489. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 279, page 614.

Represents the "S" entry of the media criteria dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a bool representing a PDF boolean object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 268, page 489. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 279, page 614.

Represents the "R" entry of the media criteria dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 268, page 490. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 279, page 614.

Represents the "D" entry of the media criteria dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an Element. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 268, page 490. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 279, page 614.

Represents the "Z" entry of the media criteria dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an Element. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 268, page 490. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 279, page 614.

Represents the "V" entry of the media criteria dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains SoftwareIdentifierElements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 268, page 490. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 279, page 614.

Represents the "P" entry of the media criteria dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains strings, representing PDF name objects. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 268, page 490. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 279, page 614.

Represents the "L" entry of the media criteria dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains strings, representing PDF string objects. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 268, page 490. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 279, page 614.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the media duration dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 281, page 498. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 292, page 623.

Create an empty MediaDurationElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a MediaDurationElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a MediaDurationElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new MediaDurationElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the media duration dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. If provided, this item must always take the value "MediaDuration". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 281, page 498. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 292, page 623.

Represents the "S" entry of the media duration dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. This item may take one of the following valid values: IFT For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 281, page 498. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 292, page 623.

Represents the "T" entry of the media duration dictionary object. It is defined as part of the PDF 1.0 specification. It contains a TimespanElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 281, page 498. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 292, page 623.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the media offset dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 285, page 501. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 296, page 627.

Create an empty MediaOffsetElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a MediaOffsetElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a MediaOffsetElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new MediaOffsetElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the media offset dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. If provided, this item must always take the value "MediaOffset". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 285, page 501. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 296, page 627.

Represents the "S" entry of the media offset dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. This item may take one of the following valid values: TFM For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 285, page 501. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 296, page 627.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the media offset frame dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 287, page 501. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 298, page 628.

Create an empty MediaOffsetFrameElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a MediaOffsetFrameElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a MediaOffsetFrameElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new MediaOffsetFrameElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "F" entry of the media offset frame dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 287, page 501. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 298, page 628.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the media offset marker dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 288, page 501. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 299, page 628.

Create an empty MediaOffsetMarkerElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a MediaOffsetMarkerElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a MediaOffsetMarkerElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new MediaOffsetMarkerElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "M" entry of the media offset marker dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 288, page 501. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 299, page 628.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the media offset time dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 286, page 501. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 297, page 627.

Create an empty MediaOffsetTimeElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a MediaOffsetTimeElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a MediaOffsetTimeElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new MediaOffsetTimeElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "T" entry of the media offset time dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a TimespanElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 286, page 501. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 297, page 627.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the media permissions dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 275, page 494. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 286, page 618.

Create an empty MediaPermissionsElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a MediaPermissionsElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a MediaPermissionsElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new MediaPermissionsElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the media permissions dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. If provided, this item must always take the value "MediaPermissions". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 275, page 494. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 286, page 618.

Represents the "TF" entry of the media permissions dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. This is encoded as a string using single byte ASCII encoding. The PDF specification states that this item assumes a value of "TEMPNEVER" if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 275, page 494. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 286, page 619.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the media player info dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 291, page 503. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 302, page 630.

Create an empty MediaPlayerInfoElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a MediaPlayerInfoElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a MediaPlayerInfoElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new MediaPlayerInfoElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the media player info dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. If provided, this item must always take the value "MediaPlayerInfo". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 291, page 503. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 302, page 630.

Represents the "PID" entry of the media player info dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a SoftwareIdentifierElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 291, page 503. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 302, page 630.

Represents the "MH" entry of the media player info dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an Element. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 291, page 503. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 302, page 630.

Represents the "BE" entry of the media player info dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an Element. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 291, page 503. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 302, page 630.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the media players dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 290, page 502. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 301, page 629.

Create an empty MediaPlayersElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a MediaPlayersElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a MediaPlayersElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new MediaPlayersElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the media players dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. If provided, this item must always take the value "MediaPlayers". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 290, page 502. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 301, page 629.

Represents the "MU" entry of the media players dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains MediaPlayerInfoElements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 290, page 502. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 301, page 629.

Represents the "A" entry of the media players dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains MediaPlayerInfoElements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 290, page 502. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 301, page 629.

Represents the "NU" entry of the media players dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains MediaPlayerInfoElements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 290, page 502. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 301, page 629.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the media play parameters dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 279, page 496. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 290, page 621.

Create an empty MediaPlayParametersElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a MediaPlayParametersElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a MediaPlayParametersElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new MediaPlayParametersElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the media play parameters dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. If provided, this item must always take the value "MediaPlayParams". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 279, page 496. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 290, page 621.

Represents the "PL" entry of the media play parameters dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a MediaPlayersElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 279, page 496. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 290, page 621.

Represents the "MH" entry of the media play parameters dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a MediaPlayParametersMhBeElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 279, page 496. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 290, page 621.

Represents the "BE" entry of the media play parameters dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a MediaPlayParametersMhBeElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 279, page 496. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 290, page 621.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the media play parameters mh/be dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 280, page 496. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 291, page 622.

Create an empty MediaPlayParametersMhBeElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a MediaPlayParametersMhBeElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a MediaPlayParametersMhBeElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new MediaPlayParametersMhBeElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "V" entry of the media play parameters mh/be dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. The PDF specification states that this item assumes a value of 100 if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 280, page 496. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 291, page 622.

Represents the "C" entry of the media play parameters mh/be dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a bool representing a PDF boolean object. The PDF specification states that this item assumes a value of false if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 280, page 496. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 291, page 622.

Represents the "F" entry of the media play parameters mh/be dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. The PDF specification states that this item assumes a value of 5 if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 280, page 497. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 291, page 622.

Represents the "D" entry of the media play parameters mh/be dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a MediaDurationElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 280, page 497. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 291, page 622.

Represents the "A" entry of the media play parameters mh/be dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a bool representing a PDF boolean object. The PDF specification states that this item assumes a value of true if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 280, page 497. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 291, page 622.

Represents the "RC" entry of the media play parameters mh/be dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a double representing a PDF numeric object. The PDF specification states that this item assumes a value of 1 if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 280, page 497. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 291, page 623.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the media rendition dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 271, page 491. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 282, page 615.

Create an empty MediaRenditionElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a MediaRenditionElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a MediaRenditionElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new MediaRenditionElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "C" entry of the media rendition dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a MediaClipElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 271, page 491. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 282, page 615.

Represents the "P" entry of the media rendition dictionary object. It is defined as part of the PDF 1.0 specification. It contains a MediaPlayParametersElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 271, page 491. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 282, page 616.

Represents the "SP" entry of the media rendition dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a MediaScreenParametersElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 271, page 491. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 282, page 616.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the media screen parameters dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 282, page 498. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 293, page 624.

Create an empty MediaScreenParametersElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a MediaScreenParametersElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a MediaScreenParametersElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new MediaScreenParametersElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the media screen parameters dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. If provided, this item must always take the value "MediaScreenParams". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 282, page 498. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 293, page 624.

Represents the "MH" entry of the media screen parameters dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an Element. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 282, page 498. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 293, page 624.

Represents the "BE" entry of the media screen parameters dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an Element. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 282, page 498. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 293, page 624.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the media screen parameters mh/be dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 283, page 499. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 294, page 624.

Create an empty MediaScreenParametersMhBeElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a MediaScreenParametersMhBeElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a MediaScreenParametersMhBeElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new MediaScreenParametersMhBeElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "W" entry of the media screen parameters mh/be dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. The PDF specification states that this item assumes a value of 3 if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 283, page 499. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 294, page 624.

Represents the "B" entry of the media screen parameters mh/be dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains doubles, representing PDF numeric objects. Items in this array should have a minimum value of 0 and a maximum of 1. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 283, page 499. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 294, page 625.

Represents the "O" entry of the media screen parameters mh/be dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a double representing a PDF numeric object. It should have a minimum value of 0 and a maximum of 1. The PDF specification states that this item assumes a value of 1 if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 283, page 499. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 294, page 625.

Represents the "M" entry of the media screen parameters mh/be dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. The PDF specification states that this item assumes a value of 0 if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 283, page 499. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 294, page 625.

Represents the "F" entry of the media screen parameters mh/be dictionary object. It is defined as part of the PDF 1.0 specification. It contains a FloatingWindowParametersElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 283, page 499. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 294, page 625.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the minimum bit depth dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 269, page 490. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 280, page 615.

Create an empty MinimumBitDepthElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a MinimumBitDepthElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a MinimumBitDepthElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new MinimumBitDepthElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the minimum bit depth dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. If provided, this item must always take the value "MinBitDepth". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 269, page 490. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 280, page 615.

Represents the "V" entry of the minimum bit depth dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. It should have a minimum value of 1. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 269, page 490. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 280, page 615.

Represents the "M" entry of the minimum bit depth dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. The PDF specification states that this item assumes a value of 0 if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 269, page 490. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 280, page 615.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the minimum screen size dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 270, page 491. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 281, page 615.

Create an empty MinimumScreenSizeElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a MinimumScreenSizeElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a MinimumScreenSizeElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new MinimumScreenSizeElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the minimum screen size dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. If provided, this item must always take the value "MinScreenSize". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 270, page 491. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 281, page 615.

Represents the "V" entry of the minimum screen size dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains an array which contains integers, representing PDF numeric objects. Items in this array should have a minimum value of 0. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 270, page 491. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 281, page 615.

Represents the "M" entry of the minimum screen size dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. The PDF specification states that this item assumes a value of 0 if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 270, page 491. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 281, page 615.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the movie activation dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 296, page 508. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 307, page 635.

Create an empty MovieActivationElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a MovieActivationElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a MovieActivationElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new MovieActivationElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Start" entry of the movie activation dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. This property may contain one of three different types: 1) An integer representing a PDF numeric object. It should have a minimum value of 0. 2) A string representing a PDF string object. This string contains raw byte data. So it looks like a string but really it is just a wrapper for data. 3) An array which contains Elements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 296, page 508. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 307, page 635.

Represents the "Duration" entry of the movie activation dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. This property may contain one of three different types: 1) An integer representing a PDF numeric object. 2) A string representing a PDF string object. This string contains raw byte data. So it looks like a string but really it is just a wrapper for data. 3) An array which contains Elements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 296, page 508. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 307, page 635.

Represents the "Rate" entry of the movie activation dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a double representing a PDF numeric object. The PDF specification states that this item assumes a value of 1 if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 296, page 508. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 307, page 635.

Represents the "Volume" entry of the movie activation dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a double representing a PDF numeric object. It should have a minimum value of 0 and a maximum of 1. The PDF specification states that this item assumes a value of 1 if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 296, page 508. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 307, page 635.

Represents the "ShowControls" entry of the movie activation dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a bool representing a PDF boolean object. The PDF specification states that this item assumes a value of false if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 296, page 508. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 307, page 635.

Represents the "Mode" entry of the movie activation dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. The PDF specification states that this item assumes a value of "Once" if no value has been provided. This item may take one of the following valid values: OnceOpenRepeatPalindrome For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 296, page 509. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 307, page 636.

Represents the "Synchronous" entry of the movie activation dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a bool representing a PDF boolean object. The PDF specification states that this item assumes a value of false if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 296, page 509. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 307, page 636.

Represents the "FWScale" entry of the movie activation dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains integers, representing PDF numeric objects. Items in this array should have a minimum value of 1. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 296, page 509. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 307, page 636.

Represents the "FWPosition" entry of the movie activation dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains doubles, representing PDF numeric objects. Items in this array should have a minimum value of 0 and a maximum of 1. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 296, page 509. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 307, page 636.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the movie dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 295, page 508. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 306, page 635.

Create an empty MovieElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a MovieElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a MovieElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new MovieElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "F" entry of the movie dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a FileSpecificationElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 295, page 508. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 306, page 635.

Represents the "Aspect" entry of the movie dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains integers, representing PDF numeric objects. Items in this array should have a minimum value of 0. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 295, page 508. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 306, page 635.

Represents the "Rotate" entry of the movie dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. The PDF specification states that this item assumes a value of 0 if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 295, page 508. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 306, page 635.

Represents the "Poster" entry of the movie dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. This property may contain one of two different types: 1) A bool representing a PDF boolean object. The PDF specification states that this item assumes a value of false if no value has been provided. 2) An ImageXObjectElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 295, page 508. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 306, page 635.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the projection dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 305, page 524. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 316, page 655.

Create an empty ProjectionElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a ProjectionElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a ProjectionElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new ProjectionElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Subtype" entry of the projection dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. This item may take one of the following valid values: OP For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 305, page 524. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 316, page 655.

Represents the "CS" entry of the projection dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. The PDF specification states that this item assumes a value of "ANF" if no value has been provided. This item may take one of the following valid values: XNFfarANF For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 305, page 524. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 316, page 655.

Represents the "F" entry of the projection dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a double representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 305, page 524. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 316, page 655.

Represents the "N" entry of the projection dictionary object. It is defined as part of the PDF 1.0 specification. It contains a double representing a PDF numeric object. It should have a positive value. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 305, page 524. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 316, page 655.

Represents the "FOV" entry of the projection dictionary object. It is defined as part of the PDF 1.0 specification. It contains a double representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 305, page 524. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 316, page 655.

Represents the "PS" entry of the projection dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. This property may contain one of two different types: 1) A double representing a PDF numeric object. It should have a positive value. 2) A string representing a PDF name object. The PDF specification states that this item assumes a value of "W" if no value has been provided. This item may take one of the following valid values: WHMinMax For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 305, page 524. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 316, page 655.

Represents the "OS" entry of the projection dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a double representing a PDF numeric object. It should have a positive value. The PDF specification states that this item assumes a value of 1 if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 305, page 524. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 316, page 655.

Represents the "OB" entry of the projection dictionary object. It is an optional entry defined as part of the PDF 1.7 specification. It contains a string representing a PDF name object. The PDF specification states that this item assumes a value of "Absolute" if no value has been provided. This item may take one of the following valid values: WHMinMaxAbsolute For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 305, page 524. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 316, page 656.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the render mode dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 307, page 527. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 318, page 659.

Create an empty RenderModeElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a RenderModeElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a RenderModeElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new RenderModeElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the render mode dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. If provided, this item must always take the value "3DRenderMode". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 307, page 527. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 318, page 659.

Represents the "Subtype" entry of the render mode dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. This item may take one of the following valid values: SolidSolidWireframeTransparentTransparentWireframeBoundingBoxTransparentBoundingBoxTransparentBoundingBoxOutlineWireframeShadedWireframeHiddenWireframeVerticesShadedVerticesIllustrationSolidOutlineShadedIllustration For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 307, page 527. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 318, page 659.

Represents the "AC" entry of the render mode dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains Elements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 307, page 528. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 318, page 660.

Represents the "FC" entry of the render mode dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. This property may contain one of two different types: 1) A string representing a PDF name object. The PDF specification states that this item assumes a value of "BG" if no value has been provided. If provided, this item must always take the value "BG". 2) An array which contains Elements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 307, page 528. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 318, page 660.

Represents the "O" entry of the render mode dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a double representing a PDF numeric object. The PDF specification states that this item assumes a value of 0.5 if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 307, page 528. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 318, page 660.

Represents the "CV" entry of the render mode dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a double representing a PDF numeric object. The PDF specification states that this item assumes a value of 45 if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 307, page 528. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 318, page 660.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the rendition dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 266, page 489. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 277, page 613.

Create an empty RenditionElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a RenditionElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a RenditionElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new RenditionElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the rendition dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. If provided, this item must always take the value "Rendition". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 266, page 489. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 277, page 613.

Represents the "S" entry of the rendition dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. This item may take one of the following valid values: MRSR For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 266, page 489. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 277, page 613.

Represents the "N" entry of the rendition dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 266, page 489. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 277, page 613.

Represents the "MH" entry of the rendition dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an Element. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 266, page 489. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 277, page 613.

Represents the "BE" entry of the rendition dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an Element. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 266, page 489. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 277, page 613.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the rendition mh/be dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 267, page 489. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 278, page 613.

Create an empty RenditionMhBeElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a RenditionMhBeElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a RenditionMhBeElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new RenditionMhBeElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "C" entry of the rendition mh/be dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a MediaCriteriaElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 267, page 489. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 278, page 613.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the selector rendition dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 272, page 492. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 283, page 616.

Create an empty SelectorRenditionElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a SelectorRenditionElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a SelectorRenditionElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new SelectorRenditionElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "R" entry of the selector rendition dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains an array which contains RenditionElements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 272, page 492. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 283, page 616.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the slideshow dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 297, page 510. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 308, page 637.

Create an empty SlideshowElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a SlideshowElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a SlideshowElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new SlideshowElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the slideshow dictionary object. It is a required entry defined as part of the PDF 1.4 specification. It contains a string representing a PDF name object. This item must always be provided and must always take the value "SlideShow". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 297, page 510. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 308, page 637.

Represents the "Subtype" entry of the slideshow dictionary object. It is a required entry defined as part of the PDF 1.4 specification. It contains a string representing a PDF name object. This item must always be provided and must always take the value "Embedded". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 297, page 510. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 308, page 637.

Represents the "Resources" entry of the slideshow dictionary object. It is a required entry defined as part of the PDF 1.4 specification. It contains a NameTreeNodeElement containing Elements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 297, page 510. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 308, page 637.

Represents the "StartResource" entry of the slideshow dictionary object. It is a required entry defined as part of the PDF 1.4 specification. It contains a string representing a PDF string object. This string contains raw byte data. So it looks like a string but really it is just a wrapper for data. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 297, page 510. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 308, page 637.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the software identifier dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 292, page 504. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 303, page 631.

Create an empty SoftwareIdentifierElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a SoftwareIdentifierElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a SoftwareIdentifierElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new SoftwareIdentifierElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the software identifier dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. If provided, this item must always take the value "SoftwareIdentifier". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 292, page 504. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 303, page 631.

Represents the "U" entry of the software identifier dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. This is encoded as a string using single byte ASCII encoding. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 292, page 504. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 303, page 631.

Represents the "L" entry of the software identifier dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains integers, representing PDF numeric objects. Items in this array should have a minimum value of 0. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 292, page 504. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 303, page 631.

Represents the "LI" entry of the software identifier dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a bool representing a PDF boolean object. The PDF specification states that this item assumes a value of true if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 292, page 504. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 303, page 631.

Represents the "H" entry of the software identifier dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains integers, representing PDF numeric objects. Items in this array should have a minimum value of 0. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 292, page 504. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 303, page 631.

Represents the "HI" entry of the software identifier dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a bool representing a PDF boolean object. The PDF specification states that this item assumes a value of true if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 292, page 504. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 303, page 631.

Represents the "OS" entry of the software identifier dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains strings, representing PDF string objects. This string contains raw byte data. So it looks like a string but really it is just a wrapper for data. The PDF specification states that items in this array assume a value of "an empty array" if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 292, page 504. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 303, page 631.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the sound object stream. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 294, page 506. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 305, page 633. This class is always an indirect object because it is also a StreamElement and these are always indirect objects.

Create an empty SoundObjectStreamElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a SoundObjectStreamElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a SoundObjectStreamElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new SoundObjectStreamElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

The StreamElement associated with this class.

Represents the "Type" entry of the sound object stream object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. If provided, this item must always take the value "Sound". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 294, page 506. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 305, page 633.

Represents the "R" entry of the sound object stream object. It is a required entry defined as part of the PDF 1.0 specification. It contains a double representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 294, page 506. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 305, page 633.

Represents the "C" entry of the sound object stream object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. The PDF specification states that this item assumes a value of 1 if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 294, page 506. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 305, page 633.

Represents the "B" entry of the sound object stream object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. The PDF specification states that this item assumes a value of 8 if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 294, page 506. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 305, page 633.

Represents the "E" entry of the sound object stream object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. The PDF specification states that this item assumes a value of "Raw" if no value has been provided. This item may take one of the following valid values: RawSignedALaw For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 294, page 506. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 305, page 633.

Represents the "CO" entry of the sound object stream object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 294, page 507. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 305, page 634.

Represents the "CP" entry of the sound object stream object. It is an optional entry defined as part of the PDF 1.0 specification. The specification defines this property as being of undefined type. So the type of atom or data contained is not part of the specification. For practical purposes this means it may be of any type. It contains an Element. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 294, page 507. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 305, page 634.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the timespan dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 289, page 502. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 300, page 628.

Create an empty TimespanElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a TimespanElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a TimespanElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new TimespanElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the timespan dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. If provided, this item must always take the value "Timespan". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 289, page 502. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 300, page 628.

Represents the "S" entry of the timespan dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. This item must always be provided and must always take the value "S". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 289, page 502. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 300, page 628.

Represents the "V" entry of the timespan dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a double representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 289, page 502. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 300, page 628.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the artifact attributes. This is definitively detailed in: The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 385, page 787.

Create an empty ArtifactAttributesElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a ArtifactAttributesElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a ArtifactAttributesElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new ArtifactAttributesElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the artifact attributes object. It is an optional entry defined as part of the PDF 2.0 specification. It contains a string representing a PDF name object. This item may take one of the following valid values: ;PaginationLayoutPageInline For definitive details see: The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 385, page 787.

Represents the "BBox" entry of the artifact attributes object. It is an optional entry defined as part of the PDF 2.0 specification. It contains a RectangleElement. For definitive details see: The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 385, page 787.

Represents the "Subtype" entry of the artifact attributes object. It is an optional entry defined as part of the PDF 2.0 specification. It contains a string representing a PDF name object. If provided, this item must always take the value "Header". The specification defines this as exensible which means that it may contain entries in addition to those defined in the specification. In fact almost all objects are extensible but the fact that it is explicitly mentioned, implies that extra entries should be regarded as normal rather than exceptional. For further details see The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: Annex E, page 673.. For definitive details see: The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 385, page 787.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the attribute object dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 327, page 567. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 360, page 734.

Create an empty AttributesElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a AttributesElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a AttributesElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new AttributesElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

The StreamElement associated with this class.

Represents the "O" entry of the attribute object dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. This item may take one of the following valid values: LayoutListPrintFieldTableLink The specification defines this as exensible which means that it may contain entries in addition to those defined in the specification. In fact almost all objects are extensible but the fact that it is explicitly mentioned, implies that extra entries should be regarded as normal rather than exceptional. For further details see The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: Annex E, page 673.. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 327, page 567. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 360, page 734.

Represents the "NS" entry of the attribute object dictionary object. It is defined as part of the PDF 2.0 specification. It contains a NamespaceElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 327, page 567. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 360, page 734.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the box colour information dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 360, page 630. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 396, page 810.

Create an empty BoxColorInformationElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a BoxColorInformationElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a BoxColorInformationElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new BoxColorInformationElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "CropBox" entry of the box colour information dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a BoxStyleElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 360, page 630. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 396, page 810.

Represents the "BleedBox" entry of the box colour information dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a BoxStyleElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 360, page 630. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 396, page 810.

Represents the "TrimBox" entry of the box colour information dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a BoxStyleElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 360, page 631. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 396, page 810.

Represents the "ArtBox" entry of the box colour information dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a BoxStyleElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 360, page 631. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 396, page 811.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the box style dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 361, page 631. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 397, page 811.

Create an empty BoxStyleElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a BoxStyleElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a BoxStyleElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new BoxStyleElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "C" entry of the box style dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains doubles, representing PDF numeric objects. Items in this array should have a minimum value of 0 and a maximum of 1. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 361, page 631. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 397, page 811.

Represents the "W" entry of the box style dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a double representing a PDF numeric object. The PDF specification states that this item assumes a value of 1 if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 361, page 631. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 397, page 811.

Represents the "S" entry of the box style dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. The PDF specification states that this item assumes a value of "S" if no value has been provided. This item may take one of the following valid values: SD For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 361, page 631. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 397, page 811.

Represents the "D" entry of the box style dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains Elements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 361, page 631. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 397, page 811.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the document information dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 317, page 550. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 349, page 712. This class is always an indirect object because CrossReferenceStreamElement.EntryInfo and FileTrailerElement.EntryInfo require it to be so.

Create an empty DocumentInformationElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a DocumentInformationElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a DocumentInformationElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new DocumentInformationElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Title" entry of the document information dictionary object. It is an optional entry defined as part of the PDF 1.1 specification. It was deprecated in PDF 2.0. It contains a string representing a PDF string object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 317, page 550. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 349, page 712.

Represents the "Author" entry of the document information dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It was deprecated in PDF 2.0. It contains a string representing a PDF string object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 317, page 550. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 349, page 712.

Represents the "Subject" entry of the document information dictionary object. It is an optional entry defined as part of the PDF 1.1 specification. It was deprecated in PDF 2.0. It contains a string representing a PDF string object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 317, page 550. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 349, page 712.

Represents the "Keywords" entry of the document information dictionary object. It is an optional entry defined as part of the PDF 1.1 specification. It was deprecated in PDF 2.0. It contains a string representing a PDF string object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 317, page 550. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 349, page 712.

Represents the "Creator" entry of the document information dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It was deprecated in PDF 2.0. It contains a string representing a PDF string object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 317, page 550. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 349, page 712.

Represents the "Producer" entry of the document information dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It was deprecated in PDF 2.0. It contains a string representing a PDF string object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 317, page 550. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 349, page 712.

Represents the "CreationDate" entry of the document information dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. This is encoded as a date string. For details see the StringAtom.DateToString and StringAtom.StringToDate functions. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 317, page 550. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 349, page 712.

Represents the "ModDate" entry of the document information dictionary object. It is an optional entry defined as part of the PDF 1.1 specification. It contains a string representing a PDF string object. This is encoded as a date string. For details see the StringAtom.DateToString and StringAtom.StringToDate functions. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 317, page 550. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 349, page 713.

Represents the "Trapped" entry of the document information dictionary object. It is an optional entry defined as part of the PDF 1.3 specification. It was deprecated in PDF 2.0. It contains a string representing a PDF name object. The PDF specification states that this item assumes a value of "Unknown" if no value has been provided. This item may take one of the following valid values: TrueFalseUnknown For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 317, page 550. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 349, page 713.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the dpart dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 409, page 829. This class is always an indirect object because DocumentPartGoToActionElement.EntryDp, DpartElement.EntryDParts, DpartElement.EntryParent, DpartrootElement.EntryDPartRootNode and PageObjectElement.EntryDPart require it to be so.

Create an empty DocumentPartElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a DocumentPartElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a DocumentPartElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new DocumentPartElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the dpart dictionary object. It is an optional entry defined as part of the PDF 2.0 specification. It contains a string representing a PDF name object. If provided, this item must always take the value "DPart". For definitive details see: The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 409, page 829.

Represents the "Parent" entry of the dpart dictionary object. It is a required entry defined as part of the PDF 2.0 specification. It contains a DocumentPartElement. For definitive details see: The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 409, page 829.

Represents the "DParts" entry of the dpart dictionary object. It is defined as part of the PDF 2.0 specification. It contains an array which contains Elements. For definitive details see: The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 409, page 829.

Represents the "Start" entry of the dpart dictionary object. It is defined as part of the PDF 2.0 specification. It contains a PageObjectElement. For definitive details see: The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 409, page 830.

Represents the "End" entry of the dpart dictionary object. It is defined as part of the PDF 2.0 specification. It contains a PageObjectElement. For definitive details see: The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 409, page 830.

Represents the "DPM" entry of the dpart dictionary object. It is an optional entry defined as part of the PDF 2.0 specification. It contains an Element. For definitive details see: The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 409, page 830.

Represents the "AF" entry of the dpart dictionary object. It is an optional entry defined as part of the PDF 2.0 specification. It contains an array which contains FileSpecificationElements. For definitive details see: The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 409, page 830.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the dpartroot dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 408, page 829. This class is always an indirect object because DpartElement.EntryParent requires it to be so.

Create an empty DocumentPartRootElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a DocumentPartRootElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a DocumentPartRootElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new DocumentPartRootElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the dpartroot dictionary object. It is an optional entry defined as part of the PDF 2.0 specification. It contains a string representing a PDF name object. If provided, this item must always take the value "DPartRoot". For definitive details see: The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 408, page 829.

Represents the "DPartRootNode" entry of the dpartroot dictionary object. It is a required entry defined as part of the PDF 2.0 specification. It contains a DocumentPartElement. For definitive details see: The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 408, page 829.

Represents the "RecordLevel" entry of the dpartroot dictionary object. It is an optional entry defined as part of the PDF 2.0 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 408, page 829.

Represents the "NodeNameList" entry of the dpartroot dictionary object. It is an optional entry defined as part of the PDF 2.0 specification. It contains an array which contains strings, representing PDF name objects. For definitive details see: The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 408, page 829.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the linearization parameter dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: f.1, page 680. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: f.1, page 877.

Create an empty LinearizationParameterElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a LinearizationParameterElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a LinearizationParameterElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new LinearizationParameterElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Linearized" entry of the linearization parameter dictionary object. It is a required entry defined as part of the PDF 1.2 specification. It contains a double representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: f.1, page 680. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: f.1, page 877.

Represents the "L" entry of the linearization parameter dictionary object. It is a required entry defined as part of the PDF 1.2 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: f.1, page 680. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: f.1, page 877.

Represents the "H" entry of the linearization parameter dictionary object. It is a required entry defined as part of the PDF 1.2 specification. It contains an array which contains integers, representing PDF numeric objects. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: f.1, page 680. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: f.1, page 877.

Represents the "O" entry of the linearization parameter dictionary object. It is a required entry defined as part of the PDF 1.2 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: f.1, page 680. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: f.1, page 877.

Represents the "E" entry of the linearization parameter dictionary object. It is a required entry defined as part of the PDF 1.2 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: f.1, page 680. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: f.1, page 877.

Represents the "N" entry of the linearization parameter dictionary object. It is a required entry defined as part of the PDF 1.2 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: f.1, page 680. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: f.1, page 877.

Represents the "T" entry of the linearization parameter dictionary object. It is a required entry defined as part of the PDF 1.2 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: f.1, page 680. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: f.1, page 878.

Represents the "P" entry of the linearization parameter dictionary object. It is an optional entry defined as part of the PDF 1.2 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: f.1, page 680. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: f.1, page 878.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the marked-content reference dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 324, page 561. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 357, page 727.

Create an empty MarkedContentReferenceElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a MarkedContentReferenceElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a MarkedContentReferenceElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new MarkedContentReferenceElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the marked-content reference dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. This item must always be provided and must always take the value "MCR". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 324, page 561. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 357, page 727.

Represents the "Pg" entry of the marked-content reference dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a PageObjectElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 324, page 561. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 357, page 727.

Represents the "Stm" entry of the marked-content reference dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a FormXObjectElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 324, page 561. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 357, page 727.

Represents the "StmOwn" entry of the marked-content reference dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. The specification defines this property as being of any type. So any type of atom or data content is valid. It contains an Element. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 324, page 561. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 357, page 727.

Represents the "MCID" entry of the marked-content reference dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 324, page 561. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 357, page 727.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the mark information dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 321, page 556. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 353, page 719.

Create an empty MarkInformationElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a MarkInformationElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a MarkInformationElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new MarkInformationElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Marked" entry of the mark information dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a bool representing a PDF boolean object. The PDF specification states that this item assumes a value of false if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 321, page 556. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 353, page 719.

Represents the "UserProperties" entry of the mark information dictionary object. It is an optional entry defined as part of the PDF 1.6 specification. It contains a bool representing a PDF boolean object. The PDF specification states that this item assumes a value of false if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 321, page 556. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 353, page 719.

Represents the "Suspects" entry of the mark information dictionary object. It is an optional entry defined as part of the PDF 1.6 specification. It was deprecated in PDF 2.0. It contains a bool representing a PDF boolean object. The PDF specification states that this item assumes a value of false if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 321, page 556. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 353, page 719.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the metadata stream. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 315, page 549. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 347, page 711. This class is always an indirect object because it is also a StreamElement and these are always indirect objects.

Create an empty MetadataStreamElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a MetadataStreamElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a MetadataStreamElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new MetadataStreamElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

The StreamElement associated with this class.

Represents the "Type" entry of the metadata stream object. It is a required entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. This item must always be provided and must always take the value "Metadata". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 315, page 549. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 347, page 711.

Represents the "Subtype" entry of the metadata stream object. It is a required entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. This item must always be provided and must always take the value "XML". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 315, page 549. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 347, page 711.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the namespace dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 356, page 725. This class is always an indirect object because AttributeObjectElement.EntryNS, NamespaceElement.EntryRoleMapNS and StructureElementElement.EntryNS require it to be so.

Create an empty NamespaceElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a NamespaceElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a NamespaceElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new NamespaceElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the namespace dictionary object. It is an optional entry defined as part of the PDF 2.0 specification. It contains a string representing a PDF name object. If provided, this item must always take the value "Namespace". For definitive details see: The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 356, page 725.

Represents the "NS" entry of the namespace dictionary object. It is a required entry defined as part of the PDF 2.0 specification. It contains a string representing a PDF string object. For definitive details see: The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 356, page 725.

Represents the "Schema" entry of the namespace dictionary object. It is an optional entry defined as part of the PDF 2.0 specification. It contains a FileSpecificationElement. For definitive details see: The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 356, page 725.

Represents the "RoleMapNS" entry of the namespace dictionary object. It is an optional entry defined as part of the PDF 2.0 specification. It contains an Element. For definitive details see: The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 356, page 725.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the object reference dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 325, page 564. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 358, page 730.

Create an empty ObjectReferenceElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a ObjectReferenceElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a ObjectReferenceElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new ObjectReferenceElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the object reference dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. This item must always be provided and must always take the value "OBJR". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 325, page 564. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 358, page 730.

Represents the "Pg" entry of the object reference dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a PageObjectElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 325, page 564. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 358, page 730.

Represents the "Obj" entry of the object reference dictionary object. It is a required entry defined as part of the PDF 1.0 specification. The specification defines this property as being of any type. So any type of atom or data content is valid. It contains an Element. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 325, page 564. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 358, page 730.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the opi dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 369, page 639. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 370, page 641. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 406, page 823. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 407, page 825.

Create an empty OpiElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a OpiElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a OpiElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new OpiElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the opi dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. If provided, this item must always take the value "OPI". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 369, page 639. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 406, page 823. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 370, page 641. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 407, page 825.

Represents the "Version" entry of the opi dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a double representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 369, page 639. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 406, page 823. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 370, page 641. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 407, page 825.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the opi version dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 368, page 639. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 405, page 823.

Create an empty OpiVersionElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a OpiVersionElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a OpiVersionElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new OpiVersionElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "1.3" entry of the opi version dictionary object. It is an optional entry defined as part of the PDF 1.2 specification. It contains a Version13OpiElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 368, page 639. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 405, page 823.

Represents the "2.0" entry of the opi version dictionary object. It is an optional entry defined as part of the PDF 1.2 specification. It contains a Version20OpiElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 368, page 639. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 405, page 823.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the output intent dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 365, page 633. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 401, page 814.

Create an empty OutputIntentElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a OutputIntentElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a OutputIntentElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new OutputIntentElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the output intent dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. If provided, this item must always take the value "OutputIntent". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 365, page 633. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 401, page 814.

Represents the "S" entry of the output intent dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 365, page 633. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 401, page 814.

Represents the "OutputCondition" entry of the output intent dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 365, page 633. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 401, page 814.

Represents the "OutputConditionIdentifier" entry of the output intent dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 365, page 634. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 401, page 815.

Represents the "RegistryName" entry of the output intent dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 365, page 634. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 401, page 815.

Represents the "Info" entry of the output intent dictionary object. It is defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 365, page 634. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 401, page 815.

Represents the "DestOutputProfile" entry of the output intent dictionary object. It is defined as part of the PDF 1.0 specification. It contains an ICCProfileStreamElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 365, page 634. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 401, page 815.

Represents the "DestOutputProfileRef" entry of the output intent dictionary object. It is an optional entry defined as part of the PDF 2.0 specification. It contains an OutputProfilesElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 365, page 633. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 401, page 815.

Represents the "MixingHints" entry of the output intent dictionary object. It is defined as part of the PDF 1.0 specification. It contains a DeviceNMixingHintsElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 365, page 633. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 401, page 816.

Represents the "SpectralData" entry of the output intent dictionary object. It is defined as part of the PDF 1.0 specification. It contains an Element. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 365, page 633. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 401, page 816.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the destoutputprofileref dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 402, page 817.

Create an empty OutputProfilesElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a OutputProfilesElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a OutputProfilesElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new OutputProfilesElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "CheckSum" entry of the destoutputprofileref dictionary object. It is defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. For definitive details see: The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 402, page 817.

Represents the "ColorantTable" entry of the destoutputprofileref dictionary object. It is defined as part of the PDF 1.0 specification. It contains an array which contains strings, representing PDF name objects. For definitive details see: The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 402, page 817.

Represents the "ICCVersion" entry of the destoutputprofileref dictionary object. It is defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. For definitive details see: The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 402, page 817.

Represents the "ProfileCS" entry of the destoutputprofileref dictionary object. It is defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. For definitive details see: The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 402, page 817.

Represents the "ProfileName" entry of the destoutputprofileref dictionary object. It is defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. For definitive details see: The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 402, page 817.

Represents the "URLs" entry of the destoutputprofileref dictionary object. It is defined as part of the PDF 1.0 specification. It contains an array which contains FileSpecificationElements. For definitive details see: The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 402, page 817.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the page-piece data dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 319, page 552. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 351, page 715.

Create an empty PagePieceDataElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a PagePieceDataElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a PagePieceDataElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new PagePieceDataElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "LastModified" entry of the page-piece data dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. This is encoded as a date string. For details see the StringAtom.DateToString and StringAtom.StringToDate functions. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 319, page 552. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 351, page 715.

Represents the "Private" entry of the page-piece data dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. The specification defines this property as being of any type. So any type of atom or data content is valid. It contains an Element. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 319, page 552. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 351, page 715.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the printer's mark annotation. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 362, page 632. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 398, page 812. This class is always an indirect object because it inherits from AnnotationElement which is always an indirect object.

Create an empty PrintersMarkAnnotationElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a PrintersMarkAnnotationElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a PrintersMarkAnnotationElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new PrintersMarkAnnotationElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "MN" entry of the printer's mark annotation object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 362, page 632. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 398, page 812.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the separation dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 364, page 632. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 400, page 813.

Create an empty SeparationElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a SeparationElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a SeparationElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new SeparationElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Pages" entry of the separation dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains an array which contains PageObjectElements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 364, page 632. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 400, page 813.

Represents the "DeviceColorant" entry of the separation dictionary object. It is a required entry defined as part of the PDF 1.0 specification. This property may contain one of two different types: 1) A string representing a PDF name object. 2) A string representing a PDF string object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 364, page 632. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 400, page 813.

Represents the "ColorSpace" entry of the separation dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains ColorSpaceElements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 364, page 633. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 400, page 813.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the source information dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 355, page 623. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 391, page 803.

Create an empty SourceInformationElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a SourceInformationElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a SourceInformationElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new SourceInformationElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "AU" entry of the source information dictionary object. It is a required entry defined as part of the PDF 1.0 specification. This property may contain one of two different types: 1) A string representing a PDF string object. This is encoded as a string using single byte ASCII encoding. 2) An UrlAliasElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 355, page 623. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 391, page 803.

Represents the "TS" entry of the source information dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. This is encoded as a date string. For details see the StringAtom.DateToString and StringAtom.StringToDate functions. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 355, page 623. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 391, page 803.

Represents the "E" entry of the source information dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. This is encoded as a date string. For details see the StringAtom.DateToString and StringAtom.StringToDate functions. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 355, page 623. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 391, page 803.

Represents the "S" entry of the source information dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. The PDF specification states that this item assumes a value of 0 if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 355, page 623. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 391, page 803.

Represents the "C" entry of the source information dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a WebCaptureCommandElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 355, page 623. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 391, page 803.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the standard layout attributes. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 343, page 597. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 378, page 770. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 344, page 600. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 379, page 774. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 345, page 604. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 380, page 778. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 346, page 608. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 381, page 782.

Create an empty StandardLayoutAttributesElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a StandardLayoutAttributesElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a StandardLayoutAttributesElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new StandardLayoutAttributesElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Placement" entry of the standard layout attributes object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. The PDF specification states that this item assumes a value of "Inline" if no value has been provided. This item may take one of the following valid values: BlockInlineBeforeStartEnd For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 343, page 597. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 378, page 770. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 344, page 600. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 379, page 774. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 345, page 604. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 380, page 778. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 346, page 608. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 381, page 782.

Represents the "WritingMode" entry of the standard layout attributes object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. The PDF specification states that this item assumes a value of "LrTb" if no value has been provided. This item may take one of the following valid values: LrTbRlTbTbRl For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 343, page 598. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 378, page 771. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 344, page 600. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 379, page 774. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 345, page 604. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 380, page 778. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 346, page 608. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 381, page 782.

Represents the "BackgroundColor" entry of the standard layout attributes object. It is an optional entry defined as part of the PDF 1.5 specification. It contains an array which contains doubles, representing PDF numeric objects. Items in this array should have a minimum value of 0 and a maximum of 1. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 343, page 598. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 378, page 771. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 344, page 600. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 379, page 774. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 345, page 604. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 380, page 778. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 346, page 608. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 381, page 782.

Represents the "BorderColor" entry of the standard layout attributes object. It is an optional entry defined as part of the PDF 1.5 specification. It contains an array which contains doubles, representing PDF numeric objects. Items in this array should have a minimum value of 0 and a maximum of 1. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 343, page 598. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 378, page 772. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 344, page 600. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 379, page 774. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 345, page 604. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 380, page 778. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 346, page 608. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 381, page 782.

Represents the "BorderStyle" entry of the standard layout attributes object. It is an optional entry defined as part of the PDF 1.5 specification. It contains an array which contains strings, representing PDF name objects. The PDF specification states that items in this array assume a value of "None" if no value has been provided. Items in this array may take one of the following valid values: NoneHiddenDottedDashedSolidDoubleGrooveRidgeInsetOutset If you read the specification you will see that an array of one string may be represented as a single string rather than an array. However we always present this property as an array to simplify the interface. It is only if you add or remove items in the array, that the underlying representation will be changed. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 343, page 599. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 378, page 772. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 344, page 600. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 379, page 774. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 345, page 604. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 380, page 778. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 346, page 608. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 381, page 782.

Represents the "BorderThickness" entry of the standard layout attributes object. It is an optional entry defined as part of the PDF 1.5 specification. It contains an array which contains doubles, representing PDF numeric objects. Items in this array should have a minimum value of 0. If you read the specification you will see that an array of one double may be represented as a single double rather than an array. However we always present this property as an array to simplify the interface. It is only if you add or remove items in the array, that the underlying representation will be changed. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 343, page 599. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 378, page 773. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 344, page 600. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 379, page 774. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 345, page 604. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 380, page 778. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 346, page 608. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 381, page 782.

Represents the "Padding" entry of the standard layout attributes object. It is an optional entry defined as part of the PDF 1.5 specification. It contains an array which contains doubles, representing PDF numeric objects. The PDF specification states that items in this array assume a value of 0 if no value has been provided. If you read the specification you will see that an array of one double may be represented as a single double rather than an array. However we always present this property as an array to simplify the interface. It is only if you add or remove items in the array, that the underlying representation will be changed. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 343, page 600. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 378, page 773. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 344, page 600. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 379, page 774. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 345, page 604. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 380, page 778. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 346, page 608. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 381, page 782.

Represents the "Color" entry of the standard layout attributes object. It is an optional entry defined as part of the PDF 1.5 specification. It contains an array which contains doubles, representing PDF numeric objects. Items in this array should have a minimum value of 0 and a maximum of 1. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 343, page 600. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 378, page 773. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 344, page 600. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 379, page 774. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 345, page 604. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 380, page 778. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 346, page 608. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 381, page 782.

Represents the "SpaceBefore" entry of the standard layout attributes object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a double representing a PDF numeric object. The PDF specification states that this item assumes a value of 0 if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 343, page 597. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 378, page 770. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 344, page 600. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 379, page 774. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 345, page 604. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 380, page 778. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 346, page 608. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 381, page 782.

Represents the "SpaceAfter" entry of the standard layout attributes object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a double representing a PDF numeric object. The PDF specification states that this item assumes a value of 0 if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 343, page 597. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 378, page 770. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 344, page 600. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 379, page 774. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 345, page 604. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 380, page 778. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 346, page 608. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 381, page 782.

Represents the "StartIndent" entry of the standard layout attributes object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a double representing a PDF numeric object. The PDF specification states that this item assumes a value of 0 if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 343, page 597. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 378, page 770. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 344, page 600. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 379, page 774. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 345, page 604. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 380, page 778. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 346, page 608. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 381, page 782.

Represents the "EndIndent" entry of the standard layout attributes object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a double representing a PDF numeric object. The PDF specification states that this item assumes a value of 0 if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 343, page 597. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 378, page 770. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 344, page 600. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 379, page 774. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 345, page 604. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 380, page 778. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 346, page 608. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 381, page 782.

Represents the "TextIndent" entry of the standard layout attributes object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a double representing a PDF numeric object. The PDF specification states that this item assumes a value of 0 if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 343, page 597. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 378, page 770. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 344, page 600. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 379, page 774. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 345, page 604. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 380, page 778. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 346, page 608. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 381, page 782.

Represents the "TextAlign" entry of the standard layout attributes object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. The PDF specification states that this item assumes a value of "Start" if no value has been provided. This item may take one of the following valid values: StartCenterEndJustify For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 343, page 597. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 378, page 770. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 344, page 600. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 379, page 774. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 345, page 604. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 380, page 778. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 346, page 608. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 381, page 782.

Represents the "BBox" entry of the standard layout attributes object. It is defined as part of the PDF 1.0 specification. It contains a RectangleElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 343, page 597. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 378, page 770. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 344, page 600. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 379, page 774. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 345, page 604. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 380, page 778. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 346, page 608. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 381, page 782.

Represents the "Width" entry of the standard layout attributes object. It is an optional entry defined as part of the PDF 1.0 specification. This property may contain one of two different types: 1) A double representing a PDF numeric object. 2) A string representing a PDF name object. The PDF specification states that this item assumes a value of "Auto" if no value has been provided. If provided, this item must always take the value "Auto". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 343, page 597. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 378, page 770. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 344, page 600. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 379, page 774. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 345, page 604. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 380, page 778. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 346, page 608. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 381, page 782.

Represents the "Height" entry of the standard layout attributes object. It is an optional entry defined as part of the PDF 1.0 specification. This property may contain one of two different types: 1) A double representing a PDF numeric object. 2) A string representing a PDF name object. The PDF specification states that this item assumes a value of "Auto" if no value has been provided. If provided, this item must always take the value "Auto". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 343, page 597. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 378, page 770. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 344, page 600. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 379, page 774. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 345, page 604. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 380, page 778. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 346, page 608. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 381, page 782.

Represents the "BlockAlign" entry of the standard layout attributes object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. The PDF specification states that this item assumes a value of "Before" if no value has been provided. This item may take one of the following valid values: BeforeMiddleAfterJustify For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 343, page 597. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 378, page 770. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 344, page 600. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 379, page 774. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 345, page 604. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 380, page 778. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 346, page 608. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 381, page 782.

Represents the "InlineAlign" entry of the standard layout attributes object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. The PDF specification states that this item assumes a value of "Start" if no value has been provided. This item may take one of the following valid values: StartCenterEnd For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 343, page 597. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 378, page 770. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 344, page 600. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 379, page 774. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 345, page 604. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 380, page 778. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 346, page 608. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 381, page 782.

Represents the "TBorderStyle" entry of the standard layout attributes object. It is an optional entry defined as part of the PDF 1.5 specification. It contains an array which contains strings, representing PDF name objects. The PDF specification states that items in this array assume a value of "None" if no value has been provided. Items in this array may take one of the following valid values: NoneHiddenDottedDashedSolidDoubleGrooveRidgeInsetOutset If you read the specification you will see that an array of one string may be represented as a single string rather than an array. However we always present this property as an array to simplify the interface. It is only if you add or remove items in the array, that the underlying representation will be changed. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 343, page 597. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 378, page 770. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 344, page 600. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 379, page 774. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 345, page 604. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 380, page 778. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 346, page 608. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 381, page 782.

Represents the "TPadding" entry of the standard layout attributes object. It is an optional entry defined as part of the PDF 1.5 specification. It contains an array which contains integers, representing PDF numeric objects. Items in this array should have a minimum value of 1. The PDF specification states that items in this array assume a value of 0 if no value has been provided. If you read the specification you will see that an array of one integer may be represented as a single integer rather than an array. However we always present this property as an array to simplify the interface. It is only if you add or remove items in the array, that the underlying representation will be changed. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 343, page 597. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 378, page 770. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 344, page 600. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 379, page 774. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 345, page 604. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 380, page 778. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 346, page 608. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 381, page 782.

Represents the "BaselineShift" entry of the standard layout attributes object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a double representing a PDF numeric object. The PDF specification states that this item assumes a value of 0 if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 343, page 597. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 378, page 770. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 344, page 600. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 379, page 774. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 345, page 604. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 380, page 778. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 346, page 608. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 381, page 782.

Represents the "LineHeight" entry of the standard layout attributes object. It is an optional entry defined as part of the PDF 1.0 specification. This property may contain one of two different types: 1) A double representing a PDF numeric object. 2) A string representing a PDF name object. The PDF specification states that this item assumes a value of "Normal" if no value has been provided. This item may take one of the following valid values: NormalAuto For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 343, page 597. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 378, page 770. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 344, page 600. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 379, page 774. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 345, page 604. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 380, page 778. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 346, page 608. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 381, page 782.

Represents the "TextDecorationColor" entry of the standard layout attributes object. It is an optional entry defined as part of the PDF 1.5 specification. It contains an array which contains doubles, representing PDF numeric objects. Items in this array should have a minimum value of 0 and a maximum of 1. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 343, page 597. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 378, page 770. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 344, page 600. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 379, page 774. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 345, page 604. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 380, page 778. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 346, page 608. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 381, page 782.

Represents the "TextDecorationThickness" entry of the standard layout attributes object. It is an optional entry defined as part of the PDF 1.5 specification. It contains a double representing a PDF numeric object. It should have a minimum value of 0. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 343, page 597. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 378, page 770. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 344, page 600. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 379, page 774. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 345, page 604. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 380, page 778. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 346, page 608. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 381, page 782.

Represents the "TextDecorationType" entry of the standard layout attributes object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. The PDF specification states that this item assumes a value of "None" if no value has been provided. This item may take one of the following valid values: NoneUnderlineOverlineLineThrough For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 343, page 597. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 378, page 770. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 344, page 600. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 379, page 774. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 345, page 604. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 380, page 778. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 346, page 608. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 381, page 782.

Represents the "RubyAlign" entry of the standard layout attributes object. It is an optional entry defined as part of the PDF 1.5 specification. It contains a string representing a PDF name object. The PDF specification states that this item assumes a value of "Distribute" if no value has been provided. This item may take one of the following valid values: StartCenterEndJustifyDistribute For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 343, page 597. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 378, page 770. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 344, page 600. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 379, page 774. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 345, page 604. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 380, page 778. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 346, page 608. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 381, page 782.

Represents the "RubyPosition" entry of the standard layout attributes object. It is an optional entry defined as part of the PDF 1.5 specification. It contains a string representing a PDF name object. The PDF specification states that this item assumes a value of "Before" if no value has been provided. This item may take one of the following valid values: BeforeAfterWarichuInline For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 343, page 597. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 378, page 770. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 344, page 600. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 379, page 774. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 345, page 604. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 380, page 778. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 346, page 608. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 381, page 782.

Represents the "GlyphOrientationVertical" entry of the standard layout attributes object. It is an optional entry defined as part of the PDF 1.5 specification. It contains a string representing a PDF name object. The PDF specification states that this item assumes a value of "Auto" if no value has been provided. This item may take one of the following valid values: angleAutoor For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 343, page 597. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 378, page 770. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 344, page 600. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 379, page 774. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 345, page 604. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 380, page 778. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 346, page 608. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 381, page 782.

Represents the "TextPosition" entry of the standard layout attributes object. It is an optional entry defined as part of the PDF 2.0 specification. It contains a string representing a PDF name object. If provided, this item must always take the value ":". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 343, page 597. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 378, page 770. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 344, page 600. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 379, page 774. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 345, page 604. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 380, page 778. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 346, page 608. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 381, page 782.

Represents the "ColumnCount" entry of the standard layout attributes object. It is an optional entry defined as part of the PDF 1.6 specification. It contains an integer representing a PDF numeric object. The PDF specification states that this item assumes a value of 1 if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 343, page 597. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 378, page 770. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 344, page 600. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 379, page 774. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 345, page 604. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 380, page 778. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 346, page 608. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 381, page 782.

Represents the "ColumnGap" entry of the standard layout attributes object. It is an optional entry defined as part of the PDF 1.6 specification. It contains an array which contains doubles, representing PDF numeric objects. If you read the specification you will see that an array of one double may be represented as a single double rather than an array. However we always present this property as an array to simplify the interface. It is only if you add or remove items in the array, that the underlying representation will be changed. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 343, page 597. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 378, page 770. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 344, page 600. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 379, page 774. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 345, page 604. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 380, page 778. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 346, page 608. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 381, page 782.

Represents the "ColumnWidths" entry of the standard layout attributes object. It is an optional entry defined as part of the PDF 1.6 specification. It contains an array which contains doubles, representing PDF numeric objects. If you read the specification you will see that an array of one double may be represented as a single double rather than an array. However we always present this property as an array to simplify the interface. It is only if you add or remove items in the array, that the underlying representation will be changed. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 343, page 597. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 378, page 770. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 344, page 600. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 379, page 774. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 345, page 604. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 380, page 778. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 346, page 608. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 381, page 782.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the standard structure attributes. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; page 593. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 347, page 608. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 382, page 784. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 348, page 609. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 383, page 785. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 349, page 610. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 384, page 785.

Create an empty StandardStructureAttributesElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a StandardStructureAttributesElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a StandardStructureAttributesElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new StandardStructureAttributesElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "ListNumbering" entry of the standard structure attributes object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. The PDF specification states that this item assumes a value of "None" if no value has been provided. This item may take one of the following valid values: NoneDiscCircleSquareDecimalUpperRomanLowerRomanUpperAlphaLowerAlpha For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; page 593. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 347, page 608. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 382, page 784. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 348, page 609. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 383, page 785. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 349, page 610. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 384, page 785.

Represents the "ContinuedList" entry of the standard structure attributes object. It is an optional entry defined as part of the PDF 2.0 specification. It contains a bool representing a PDF boolean object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; page 593. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 347, page 608. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 382, page 784. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 348, page 609. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 383, page 785. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 349, page 610. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 384, page 785.

Represents the "ContinuedFrom" entry of the standard structure attributes object. It is an optional entry defined as part of the PDF 2.0 specification. It contains a string representing a PDF string object. This string contains raw byte data. So it looks like a string but really it is just a wrapper for data. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; page 593. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 347, page 608. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 382, page 784. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 348, page 609. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 383, page 785. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 349, page 610. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 384, page 785.

Represents the "Role" entry of the standard structure attributes object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. This item may take one of the following valid values: rbcbpbtv For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; page 593. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 347, page 608. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 382, page 784. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 348, page 609. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 383, page 785. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 349, page 610. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 384, page 785.

Represents the "checked" entry of the standard structure attributes object. It is an optional entry defined as part of the PDF 1.0 specification. It was deprecated in PDF 2.0. It contains a string representing a PDF name object. The PDF specification states that this item assumes a value of "off" if no value has been provided. This item may take one of the following valid values: onoffneutral For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; page 593. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 347, page 608. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 382, page 784. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 348, page 609. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 383, page 785. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 349, page 610. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 384, page 785.

Represents the "Checked" entry of the standard structure attributes object. It is an optional entry defined as part of the PDF 2.0 specification. It contains a string representing a PDF name object. The PDF specification states that this item assumes a value of "off" if no value has been provided. This item may take one of the following valid values: onoffneutral For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; page 593. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 347, page 608. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 382, page 784. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 348, page 609. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 383, page 785. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 349, page 610. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 384, page 785.

Represents the "Desc" entry of the standard structure attributes object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; page 593. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 347, page 608. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 382, page 784. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 348, page 609. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 383, page 785. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 349, page 610. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 384, page 785.

Represents the "RowSpan" entry of the standard structure attributes object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; page 593. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 347, page 608. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 382, page 784. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 348, page 609. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 383, page 785. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 349, page 610. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 384, page 785.

Represents the "ColSpan" entry of the standard structure attributes object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; page 593. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 347, page 608. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 382, page 784. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 348, page 609. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 383, page 785. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 349, page 610. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 384, page 785.

Represents the "Headers" entry of the standard structure attributes object. It is an optional entry defined as part of the PDF 1.5 specification. It contains an array which contains strings, representing PDF string objects. This string contains raw byte data. So it looks like a string but really it is just a wrapper for data. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; page 593. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 347, page 608. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 382, page 784. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 348, page 609. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 383, page 785. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 349, page 610. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 384, page 785.

Represents the "Scope" entry of the standard structure attributes object. It is an optional entry defined as part of the PDF 1.5 specification. It contains a string representing a PDF name object. This item may take one of the following valid values: RowColumnBoth For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; page 593. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 347, page 608. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 382, page 784. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 348, page 609. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 383, page 785. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 349, page 610. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 384, page 785.

Represents the "Summary" entry of the standard structure attributes object. It is an optional entry defined as part of the PDF 1.7 specification. It contains a string representing a PDF string object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; page 593. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 347, page 608. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 382, page 784. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 348, page 609. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 383, page 785. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 349, page 610. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 384, page 785.

Represents the "Short" entry of the standard structure attributes object. It is an optional entry defined as part of the PDF 2.0 specification. It contains a string representing a PDF string object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; page 593. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 347, page 608. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 382, page 784. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 348, page 609. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 383, page 785. The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 349, page 610. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 384, page 785.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the structure element dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 323, page 558. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 355, page 721. This class is always an indirect object because OutlineItemElement.EntrySE, StructureElementElement.EntryP and StructureElementElement.EntryRef require it to be so.

Create an empty StructureElementElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a StructureElementElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a StructureElementElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new StructureElementElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the structure element dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. If provided, this item must always take the value "StructElem". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 323, page 558. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 355, page 721.

Represents the "S" entry of the structure element dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. The specification defines this as exensible which means that it may contain entries in addition to those defined in the specification. In fact almost all objects are extensible but the fact that it is explicitly mentioned, implies that extra entries should be regarded as normal rather than exceptional. For further details see The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: Annex E, page 673.. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 323, page 558. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 355, page 721.

Represents the "P" entry of the structure element dictionary object. It is a required entry defined as part of the PDF 1.0 specification. This property may contain one of two different types: 1) A StructureElementElement. 2) A StructureTreeRootElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 323, page 558. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 355, page 721.

Represents the "ID" entry of the structure element dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. This string contains raw byte data. So it looks like a string but really it is just a wrapper for data. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 323, page 558. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 355, page 721.

Represents the "Pg" entry of the structure element dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a PageObjectElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 323, page 558. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 355, page 721.

Represents the "K" entry of the structure element dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains StructureElementElements. If you read the specification you will see that an array of one StructureElementElement may be represented as a single StructureElementElement rather than an array. However we always present this property as an array to simplify the interface. It is only if you add or remove items in the array, that the underlying representation will be changed. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 323, page 558. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 355, page 721.

Represents the "A" entry of the structure element dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains AttributesElements. If you read the specification you will see that an array of one AttributesElement may be represented as a single AttributesElement rather than an array. However we always present this property as an array to simplify the interface. It is only if you add or remove items in the array, that the underlying representation will be changed. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 323, page 558. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 355, page 722.

Represents the "C" entry of the structure element dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. This property may contain one of two different types: 1) A string representing a PDF name object. 2) An array which contains Elements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 323, page 558. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 355, page 722.

Represents the "R" entry of the structure element dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. It should have a minimum value of 0. The PDF specification states that this item assumes a value of 0 if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 323, page 558. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 355, page 722.

Represents the "T" entry of the structure element dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 323, page 559. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 355, page 722.

Represents the "Lang" entry of the structure element dictionary object. It is an optional entry defined as part of the PDF 1.4 specification. It contains a string representing a PDF string object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 323, page 559. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 355, page 722.

Represents the "Alt" entry of the structure element dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 323, page 559. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 355, page 722.

Represents the "E" entry of the structure element dictionary object. It is an optional entry defined as part of the PDF 1.5 specification. It contains a string representing a PDF string object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 323, page 559. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 355, page 722.

Represents the "ActualText" entry of the structure element dictionary object. It is an optional entry defined as part of the PDF 1.4 specification. It contains a string representing a PDF string object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 323, page 559. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 355, page 722.

Represents the "Ref" entry of the structure element dictionary object. It is an optional entry defined as part of the PDF 2.0 specification. It contains an array which contains StructureElementElements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 323, page 558. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 355, page 721.

Represents the "AF" entry of the structure element dictionary object. It is an optional entry defined as part of the PDF 2.0 specification. It contains an array which contains FileSpecificationElements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 323, page 558. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 355, page 722.

Represents the "NS" entry of the structure element dictionary object. It is an optional entry defined as part of the PDF 2.0 specification. It contains a NamespaceElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 323, page 558. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 355, page 722.

Represents the "PhoneticAlphabet" entry of the structure element dictionary object. It is an optional entry defined as part of the PDF 2.0 specification. It contains a string representing a PDF name object. The PDF specification states that this item assumes a value of "ipa" if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 323, page 558. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 355, page 723.

Represents the "Phoneme" entry of the structure element dictionary object. It is an optional entry defined as part of the PDF 2.0 specification. It contains a string representing a PDF string object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 323, page 558. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 355, page 723.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the structure tree root. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 322, page 557. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 354, page 719. This class is always an indirect object because OutlineItemElement.EntrySE and StructureElementElement.EntryP require it to be so.

Create an empty StructureTreeRootElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a StructureTreeRootElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a StructureTreeRootElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new StructureTreeRootElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the structure tree root object. It is a required entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. This item must always be provided and must always take the value "StructTreeRoot". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 322, page 557. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 354, page 719.

Represents the "K" entry of the structure tree root object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains StructureElementElements. If you read the specification you will see that an array of one StructureElementElement may be represented as a single StructureElementElement rather than an array. However we always present this property as an array to simplify the interface. It is only if you add or remove items in the array, that the underlying representation will be changed. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 322, page 557. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 354, page 719.

Represents the "IDTree" entry of the structure tree root object. It is defined as part of the PDF 1.0 specification. It contains a NameTreeNodeElement containing StructureElementElements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 322, page 557. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 354, page 719.

Represents the "ParentTree" entry of the structure tree root object. It is defined as part of the PDF 1.0 specification. It contains a NumberTreeNodeElement containing Elements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 322, page 557. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 354, page 720.

Represents the "ParentTreeNextKey" entry of the structure tree root object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 322, page 557. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 354, page 720.

Represents the "RoleMap" entry of the structure tree root object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an Element. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 322, page 557. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 354, page 720.

Represents the "ClassMap" entry of the structure tree root object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an Element. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 322, page 557. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 354, page 720.

Represents the "Namespaces" entry of the structure tree root object. It is defined as part of the PDF 2.0 specification. It contains an array which contains NamespaceElements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 322, page 557. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 354, page 720.

Represents the "PronunciationLexicon" entry of the structure tree root object. It is an optional entry defined as part of the PDF 2.0 specification. It contains an array which contains FileSpecificationElements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 322, page 557. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 354, page 720.

Represents the "AF" entry of the structure tree root object. It is an optional entry defined as part of the PDF 2.0 specification. It contains an array which contains FileSpecificationElements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 322, page 557. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 354, page 720.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the trap network annotation. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 366, page 637. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 403, page 820. This class is always an indirect object because it inherits from AnnotationElement which is always an indirect object.

Create an empty TrapNetworkAnnotationElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a TrapNetworkAnnotationElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a TrapNetworkAnnotationElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new TrapNetworkAnnotationElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "LastModified" entry of the trap network annotation object. It is defined as part of the PDF 1.4 specification. It contains a string representing a PDF string object. This is encoded as a date string. For details see the StringAtom.DateToString and StringAtom.StringToDate functions. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 366, page 637. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 403, page 820.

Represents the "Version" entry of the trap network annotation object. It is defined as part of the PDF 1.0 specification. It contains an array which contains Elements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 366, page 637. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 403, page 821.

Represents the "AnnotStates" entry of the trap network annotation object. It is defined as part of the PDF 1.0 specification. It contains an array which contains strings, representing PDF name objects. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 366, page 637. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 403, page 821.

Represents the "FontFauxing" entry of the trap network annotation object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains FontElements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 366, page 638. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 403, page 821.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the trap network appearance stream. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 367, page 638. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 404, page 821. This class is always an indirect object because it is also a StreamElement and these are always indirect objects.

Create an empty TrapNetworkAppearanceStreamElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a TrapNetworkAppearanceStreamElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a TrapNetworkAppearanceStreamElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new TrapNetworkAppearanceStreamElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "PCM" entry of the trap network appearance stream object. It is a required entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. This item may take one of the following valid values: DeviceGrayDeviceRGBDeviceCMYKDeviceCMYDeviceRGBKDeviceN For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 367, page 638. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 404, page 821.

Represents the "SeparationColorNames" entry of the trap network appearance stream object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains strings, representing PDF name objects. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 367, page 638. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 404, page 821.

Represents the "TrapRegions" entry of the trap network appearance stream object. It is an optional entry defined as part of the PDF 1.0 specification. It was deprecated in PDF 2.0. It contains an array which contains Elements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 367, page 638. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 404, page 822.

Represents the "TrapStyles" entry of the trap network appearance stream object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 367, page 638. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 404, page 822.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the url alias dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 356, page 624. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 392, page 804.

Create an empty UrlAliasElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a UrlAliasElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a UrlAliasElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new UrlAliasElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "U" entry of the url alias dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. This is encoded as a string using single byte ASCII encoding. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 356, page 624. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 392, page 804.

Represents the "C" entry of the url alias dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains Elements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 356, page 624. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 392, page 804.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the user properties attributes. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 328, page 569. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 361, page 736.

Create an empty UserPropertiesAttributesElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a UserPropertiesAttributesElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a UserPropertiesAttributesElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new UserPropertiesAttributesElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "P" entry of the user properties attributes object. It is a required entry defined as part of the PDF 1.0 specification. It contains an array which contains UserPropertyElements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 328, page 569. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 361, page 736.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the user property dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 329, page 569. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 362, page 736.

Create an empty UserPropertyElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a UserPropertyElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a UserPropertyElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new UserPropertyElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "N" entry of the user property dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 329, page 569. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 362, page 736.

Represents the "V" entry of the user property dictionary object. It is a required entry defined as part of the PDF 1.0 specification. The specification defines this property as being of any type. So any type of atom or data content is valid. It contains an Element. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 329, page 569. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 362, page 736.

Represents the "F" entry of the user property dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 329, page 569. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 362, page 737.

Represents the "H" entry of the user property dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a bool representing a PDF boolean object. The PDF specification states that this item assumes a value of false if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 329, page 569. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 362, page 737.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the version 1.3 opi dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 369, page 639. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 406, page 823.

Create an empty Version13OpiElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a Version13OpiElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a Version13OpiElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new Version13OpiElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "F" entry of the version 1.3 opi dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a FileSpecificationElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 369, page 639. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 406, page 823.

Represents the "ID" entry of the version 1.3 opi dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. This string contains raw byte data. So it looks like a string but really it is just a wrapper for data. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 369, page 640. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 406, page 823.

Represents the "Comments" entry of the version 1.3 opi dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 369, page 640. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 406, page 823.

Represents the "Size" entry of the version 1.3 opi dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains an array which contains integers, representing PDF numeric objects. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 369, page 640. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 406, page 824.

Represents the "CropRect" entry of the version 1.3 opi dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a RectangleElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 369, page 640. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 406, page 824.

Represents the "CropFixed" entry of the version 1.3 opi dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains doubles, representing PDF numeric objects. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 369, page 640. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 406, page 824.

Represents the "Position" entry of the version 1.3 opi dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains an array which contains doubles, representing PDF numeric objects. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 369, page 640. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 406, page 824.

Represents the "Resolution" entry of the version 1.3 opi dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains doubles, representing PDF numeric objects. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 369, page 640. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 406, page 824.

Represents the "ColorType" entry of the version 1.3 opi dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. The PDF specification states that this item assumes a value of "Spot" if no value has been provided. This item may take one of the following valid values: ProcessSpotSeparation For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 369, page 640. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 406, page 824.

Represents the "Color" entry of the version 1.3 opi dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains Elements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 369, page 641. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 406, page 824.

Represents the "Tint" entry of the version 1.3 opi dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a double representing a PDF numeric object. It should have a minimum value of 0 and a maximum of 1. The PDF specification states that this item assumes a value of 1 if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 369, page 641. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 406, page 825.

Represents the "Overprint" entry of the version 1.3 opi dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a bool representing a PDF boolean object. The PDF specification states that this item assumes a value of false if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 369, page 641. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 406, page 825.

Represents the "ImageType" entry of the version 1.3 opi dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains integers, representing PDF numeric objects. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 369, page 641. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 406, page 825.

Represents the "GrayMap" entry of the version 1.3 opi dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains integers, representing PDF numeric objects. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 369, page 641. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 406, page 825.

Represents the "Transparency" entry of the version 1.3 opi dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a bool representing a PDF boolean object. The PDF specification states that this item assumes a value of true if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 369, page 641. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 406, page 825.

Represents the "Tags" entry of the version 1.3 opi dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains Elements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 369, page 641. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 406, page 825.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the version 2.0 opi dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 370, page 641. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 407, page 825.

Create an empty Version20OpiElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a Version20OpiElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a Version20OpiElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new Version20OpiElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "F" entry of the version 2.0 opi dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a FileSpecificationElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 370, page 641. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 407, page 825.

Represents the "MainImage" entry of the version 2.0 opi dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. This string contains raw byte data. So it looks like a string but really it is just a wrapper for data. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 370, page 641. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 407, page 825.

Represents the "Tags" entry of the version 2.0 opi dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains Elements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 370, page 642. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 407, page 826.

Represents the "Size" entry of the version 2.0 opi dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains doubles, representing PDF numeric objects. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 370, page 642. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 407, page 826.

Represents the "CropRect" entry of the version 2.0 opi dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a RectangleElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 370, page 642. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 407, page 826.

Represents the "Overprint" entry of the version 2.0 opi dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a bool representing a PDF boolean object. The PDF specification states that this item assumes a value of false if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 370, page 642. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 407, page 826.

Represents the "Inks" entry of the version 2.0 opi dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. This property may contain one of two different types: 1) A string representing a PDF name object. 2) An array which contains Elements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 370, page 642. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 407, page 827.

Represents the "IncludedImageDimensions" entry of the version 2.0 opi dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains integers, representing PDF numeric objects. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 370, page 642. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 407, page 827.

Represents the "IncludedImageQuality" entry of the version 2.0 opi dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. It should have a minimum value of 1 and a maximum of 3. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 370, page 642. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 407, page 827.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the web capture command dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 357, page 624. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 393, page 804. This class is always an indirect object because SourceInformationElement.EntryC and WebCaptureInformationElement.EntryC require it to be so.

Create an empty WebCaptureCommandElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a WebCaptureCommandElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a WebCaptureCommandElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new WebCaptureCommandElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "URL" entry of the web capture command dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. This is encoded as a string using single byte ASCII encoding. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 357, page 624. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 393, page 804.

Represents the "L" entry of the web capture command dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. The PDF specification states that this item assumes a value of 1 if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 357, page 624. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 393, page 805.

Represents the "F" entry of the web capture command dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an integer representing a PDF numeric object. The PDF specification states that this item assumes a value of 0 if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 357, page 624. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 393, page 805.

Represents the "P" entry of the web capture command dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. This property may contain one of two different types: 1) A string representing a PDF string object. 2) A StreamElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 357, page 624. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 393, page 805.

Represents the "CT" entry of the web capture command dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. This is encoded as a string using single byte ASCII encoding. The PDF specification states that this item assumes a value of "application / x-www-form-urlencoded" if no value has been provided. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 357, page 624. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 393, page 805.

Represents the "H" entry of the web capture command dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 357, page 624. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 393, page 805.

Represents the "S" entry of the web capture command dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a WebCaptureCommandSettingsElement. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 357, page 625. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 393, page 805.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the web capture command settings dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 359, page 626. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 395, page 806.

Create an empty WebCaptureCommandSettingsElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a WebCaptureCommandSettingsElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a WebCaptureCommandSettingsElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new WebCaptureCommandSettingsElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "G" entry of the web capture command settings dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an Element. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 359, page 626. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 395, page 806.

Represents the "C" entry of the web capture command settings dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an Element. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 359, page 626. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 395, page 806.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the web capture content set. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 352, page 621. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 388, page 801.

Create an empty WebCaptureContentSetElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a WebCaptureContentSetElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a WebCaptureContentSetElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new WebCaptureContentSetElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "Type" entry of the web capture content set object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. If provided, this item must always take the value "SpiderContentSet". For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 352, page 621. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 388, page 801.

Represents the "S" entry of the web capture content set object. It is a required entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF name object. This item may take one of the following valid values: SPSSIS For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 352, page 621. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 388, page 801.

Represents the "ID" entry of the web capture content set object. It is a required entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. This string contains raw byte data. So it looks like a string but really it is just a wrapper for data. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 352, page 622. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 388, page 801.

Represents the "O" entry of the web capture content set object. It is a required entry defined as part of the PDF 1.0 specification. It contains an array which contains Elements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 352, page 622. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 388, page 801.

Represents the "SI" entry of the web capture content set object. It is a required entry defined as part of the PDF 1.0 specification. It contains an array which contains SourceInformationElements. If you read the specification you will see that an array of one SourceInformationElement may be represented as a single SourceInformationElement rather than an array. However we always present this property as an array to simplify the interface. It is only if you add or remove items in the array, that the underlying representation will be changed. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 352, page 622. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 388, page 801.

Represents the "CT" entry of the web capture content set object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. This is encoded as a string using single byte ASCII encoding. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 352, page 622. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 388, page 801.

Represents the "TS" entry of the web capture content set object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. This is encoded as a date string. For details see the StringAtom.DateToString and StringAtom.StringToDate functions. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 352, page 622. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 388, page 801.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the web capture image set. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 354, page 622. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 390, page 802.

Create an empty WebCaptureImageSetElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a WebCaptureImageSetElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a WebCaptureImageSetElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new WebCaptureImageSetElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "R" entry of the web capture image set object. It is a required entry defined as part of the PDF 1.0 specification. It contains an array which contains integers, representing PDF numeric objects. If you read the specification you will see that an array of one integer may be represented as a single integer rather than an array. However we always present this property as an array to simplify the interface. It is only if you add or remove items in the array, that the underlying representation will be changed. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 354, page 622. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 390, page 802.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the web capture information dictionary. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 350, page 617. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 386, page 796.

Create an empty WebCaptureInformationElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a WebCaptureInformationElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a WebCaptureInformationElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new WebCaptureInformationElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Assign an Atom to this Element. The process of assignment allows an existing Atom to be viewed through the lens of a particular type of Element. It is important to ensure that Atoms are assigned to appropriate types of Element. For example, while is is possible to assign a Page Atom to an Image Element, such an assignment is not going to produce any useful view of the data. In addition, some assignments cannot be made at all. This occurs if if the underlying atom types are inconsistent. For example a ColorSpaceElement is based around an ArrayAtom, so attempting to assign a DictAtom will result in failure. Classes that inherit from this one may wish to override this function to ensure that the Atom type that is provided is acceptable.

An IndirectObject closely associated with this Atom - ideally the one that contains it. The Atom to be assigned to this Element. Whether the assignment was made successfully. Thrown if the atom or host provided is null.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "V" entry of the web capture information dictionary object. It is a required entry defined as part of the PDF 1.0 specification. It contains a double representing a PDF numeric object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 350, page 617. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 386, page 796.

Represents the "C" entry of the web capture information dictionary object. It is an optional entry defined as part of the PDF 1.0 specification. It contains an array which contains WebCaptureCommandElements. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 350, page 617. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 386, page 796.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

This class represents the web capture page set. This is definitively detailed in: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 353, page 622. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 389, page 802.

Create an empty WebCapturePageSetElement. The Element created by this default constructor is empty - it has no Atom within it. Before use an atom must be Assigned or Created. In practice it is easiest to do this using one of the other constructors.

Create a WebCapturePageSetElement wrapping an Atom. This constructor creates an Element and then Assigns the Atom to it. The result is a specialized Element which can be used to examine or modify the contents of the Atom.

The Atom to be assigned to this Element. An IndirectObject. This can be any IndirectObject from the Soup but ideally should be one closely associated with the Atom.

Create a WebCapturePageSetElement wrapping an IndirectObject. This constructor creates an Element and then Assigns the IndirectObject to it. The result is a specialized Element which can be used to examine or modify the contents of the IndirectObject.

The IndirectObject to be assigned to this Element.

Create a new WebCapturePageSetElement for use in the same soup as the relation. This constructor creates an Element and then Assigns a new Atom or IndirectObject to it. The result is a new, blank specialized Element which can be used to examine or modify the contents of the new Atom. Some Elements always need to be IndirectObjects, others can be simply Atoms. So if an IndirectObject is not required then a plain Atom will be used. However if the Element is of a type which requires it to be an IndirectObject, or if the options indicate it, then an IndirectObject containing an Atom will be used.

An Element. This can be any Element in the Soup but ideally should be one closely associated with this Element. Options related to creation. For example this allows you to determine whether the Element should be created using an IndirectObject rather than just an Atom. If not provided a default set of options is used.

Creates a deep copy of the current Element.

The newly created copy.

Get the minimum PDF version required for the use of a particular named entry. This function should be overridden by classes which inherit from this. They should provide return values for the entries specific to the new class.

The name of the entry. The PDF version.

Validate this object and report any inconsistencies. The validation of one object involves validating the properties of the object. Since the properties are often objects themselves, the process can be quite involved.

The Validation object which will receive validation results and progress.

Represents the "T" entry of the web capture page set object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 353, page 622. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 389, page 802.

Represents the "TID" entry of the web capture page set object. It is an optional entry defined as part of the PDF 1.0 specification. It contains a string representing a PDF string object. This string contains raw byte data. So it looks like a string but really it is just a wrapper for data. For definitive details see: The ISO PDF Specification, ISO 32000-1:2008 PDF 1.7; Table: 353, page 622. The ISO PDF Specification, ISO 32000-2:2017 PDF 2.0; Table: 389, page 802.

Clears any cached Element items. Elements in properties are cached so that the Element you assign to a property is the same as the one you retrieve when you later get that property. However it is possible that sometimes this behavior is not what you want. For example suppose you assign a DeviceColorSpaceElement to a property and then later change the underlying Atom so that it is really a CalRGBColorSpace. In this situation the retrieved ColorSpaceElement will continue to be interpreted as a DeviceColorSpaceElement and an invalid one at that. What you really want to do here is to clear the cached Element thus allowing the property to be regenerated as a CalRGBColorSpace. This function clears the cached Elements to allow this to happen.

Represents an Image object and allows accessing the underlying raw image data

The color space of the image. This may be used to examine the original color space or to convert the image to a new one.

Get the filters. If there are no filters then this property will hold an empty array.

The color palette for the image.

Get the raw pixel data as an array of bytes.

Call to disable scan masking. Some types of images may be masked. By default they will be provided to you with the masked areas removed. If you wish to have access to the raw scans before this operation, call this method first.

The color space type.

Access the scan info

Whether alpha information is embedded in the image.

Any constant alpha value

The ID of the softmask. If none then -1.

Whether this image is a mask.

Any stencil fill information.

Whether a stencil fill needs to be applied.

Any stencil fill pattern that needs to be applied. If the StencilFill property is true and this property is null, a solid brush should be used.

Any stencil blend information.

Object representing a pattern bitmap.

The left coordinate at which the pattern should first be placed.

The top coordinate at which the pattern should first be placed.

Access view X correction

Access view Y correction

Access view width correction

Access view height correction

Base class representing basic image data.

A name for the image. The name for the image will be unique within the current document. This name can be used to detect and avoid the duplication of data.

The width of the image in pixels.

The height of the image in pixels.

The color space type.

The color palette for the image.

The pixel data for the image.

The transform which should be used to display this image. The display location is unrelated to the pixel dimensions of the image. By default all images are displayed mapped to a one unit square box at the origin. The transform provides with you the indended location, size, rotation and skew for the image.

Add this instance for layout analysis. This function is currently ignored.

The unique string that should be used to identify this object. Whether the item was added.

Provides access to the raw image data.

The raw data buffer

The raw data buffer flipped vertically.

Whether to flip the image data vertically.

The stride of the data. The stride of an image is the number of bytes that makes up a horizontal line. This may include padding bytes at the end.

Whether the image data contains an alpha channel.

Represents information about the brush. The color of a solid brush is determined by the active color (which gets set in IExporter.SetCurrentColor). The Pattern is only set if the brush of of type BrushType.Pattern.

Brush type

Solid brush (single color).

Pattern brush (based on an image).

The type of the brush - solid or pattern.

The pattern used - only set if BrushType is Pattern.

Represents a clipping region and bounding box. A clipping region consists of a set of different types of points. These may encompass moves, lines or curves. The path that these points combine to make, represents the visible area of the clipping region.

PointType enumeration.

This is the starting point of a collection of lines - equivalent to a 'move to' operation.

This is a connected point - equivalent to a 'line to' operation.

This is one of the points describing a cubic Bezier curve - equivalent to a 'bezier to' operation. Note that a cubic Bezier operation requires a start point, an end point and two tangential points, so there will always be 3 points to describe the end and tangential points.

This indicates that the current sub-path should be closed.

Whether to use the Even-Odd or Non-Zero fill rule.

The type for each of the Points.

The points that make up the path. The path that these points combine to make, represents the visible area of the clipping region.

The smallest rectangle that encompasses all the points.

Blend mode.

Select source color only.

Multiply source and backdrop.

Multiply complement of backdrop and source colors, and complements result.

Depending on the backdrop value multiplies or screens the colors.

Select the darker of source and backdrop colors.

Select the lighter of source and backdrop colors.

Brighten backdrop to reflect the source color.

Darken backdrop color to reflect source color.

Depending on source color multiplies or screens the colors.

Depending on source color darkens or lightens the colors.

Subtract the darker of the two colors from the lighter one.

Similar to that of the Difference, but less contrast.

Hu.e

Saturation.

Color.

Luminosity.

Counter representing number of available blend modes.

Color purpose

Color is used for a fill operation.

Color is used for a stroke operation.

Color is used for a backdrop operation.

A palette of different colors to be accessed by index.

Return the color entry at the specified index.

Index of the color.

Get the number of entries in the palette.

Helper class describing an individual color.

Red component.

Green component.

Blue comnponent.

Alpha component.

Helper class to hold ICC color profile info.

The stream from which to read the profile info.

Name of the object.

Implement IDisposable.

Describes a color space.

Convert to ColorSpaceType.

Convert from ColorSpaceType.

Convert byte to ColorSpaceType.

The type of color space. To convert to RGB simply set this property to ColorSpaceType.DeviceRGB.

The stream containing the ICC color profile data. This property will be null if there is no color profile. The ColorSpace owns the stream so, after making use of it, you may wish call Dispose on it.

A unique name for the ICC color profile. This unique name can be used to match color profiles against each other to avoid duplication. This property will be null if there is no color profile.

Color information for stroke or fill operations.

The components of the color. Color components typically ranges from zero to one. However some color spaces, such as Lab, allow values outside this range.

The transparency information associated with this color.

What this color should be used for.

The ColorSpace of this color.

Transparency information.

The blending mode to use.

The alpha value to use.

The shape value to use.

The opacity value to use.

Flags for how to process objects during export

Whether to transfer page data across pages.

Whether to provide a layout analysis of the page contents at the end of a page.

Whether to allow vertical text runs.

Whether to use text ascent/descent settings for text calculations.

Pattern alpha is ignored by the device or client

Exporter interface for ABCpdf

Return the user's requested options for rendering text, see TextRenderFlags. Will be called after StartDoc(), so it can be set in the constructor or in StartDoc.

Called at the beginning, allows to initialize and set up the exporter.

The original doc which is to be converted/exported. The output stream to which the resulting document should be written.

Called when starting a new page.

Information about the page to be rendered, see PageInfo.

Called when the current page is finished. Note that the PageLayout will only contain layout information if in TextRenderingOptions the flag RequiresPageLayout was specified, AND if the content has been added to the layout through a call to ILayoutContent.AddToLayout() for text, path or image content.

Information about the page layout like margins and columns.

Called when all pages are finished. This call allows you to finalize and clean up.

Called when a new Text object is to be added to the current page.

Called when a new path object is to be added to the current page. If the provided RenderPath is supposed to be rendered, this function needs to call back RenderPath.GenerateGeometry to create renderable geometry.

Called when a new image object is to be added to the current page.

Called when a new clipping region is to be added to the current page.

Called when the current state should be saved. Graphics states should be kept on a stack. So this operation represents pushing a copy of the current graphics state onto the top of the stack.

Called when the last saved graphics state should be restored. Graphics states should be kept on a stack. So this operation represents popping the current graphics state off the top of the stack.

Called when the current font needs to be changed. In order to receive calls to AddText, the current font needs to be set/substituted with a call to Font.SetOrSubstitute(). If you do not call Font.SetOrSubstitute(), each glyph will be converted into a path and passed back to you as vectors via AddPath.

Called when an area should be filled with a pattern. This is used for drawing shading patterns.

Called when the current color should be updated. The color can either be used for stroke or fill, see Color for more detail.

Called when a new transparency group should be pushed on the transparency stack.

Called when the current transparency group should be popped from the transparency stack.

Exporter interface for ABCpdf

Called at the beginning, allows to initialize and set up the exporter.

The original doc which is to be converted/exported. The output stream to which the resulting document should be written.

Called when starting a new page.

Information about the page to be rendered, see PageInfo.

Called when the current page is finished. Note that the PageLayout will only contain layout information if in TextRenderingOptions the flag RequiresPageLayout was specified, AND if the content has been added to the layout through a call to ILayoutContent.AddToLayout() for text, path or image content.

Called when all pages are finished. This call allows you to finalize and clean up.

Called when the current state should be saved. Graphics states should be kept on a stack. So this operation represents pushing a copy of the current graphics state onto the top of the stack.

Called when the last saved graphics state should be restored. Graphics states should be kept on a stack. So this operation represents popping the current graphics state off the top of the stack.

Called when a new transparency group should be pushed on the transparency stack.

The transparency grou.

Called when the current transparency group should be popped from the transparency stack. The blend information that is supplied should be applied to the current state after the group has been popped.

The blending information to apply.

Called when the current color should be updated. The purpose of the color - typically stroke or fill - can be determined using the Color.Purpose property.

The color which should be set.

Called when the current font needs to be changed. In order to receive calls to AddText, the current font needs to be set/substituted with a call to Font.SetOrSubstitute(). If you do not call Font.SetOrSubstitute() and return true, text will be vectorized and returned to you via AddPath.

The font which should be set. Whether the font was set successfully.

Called when a new Text object is to be added to the current page. Return true if the text was handled. If you return false the text will be vectorized and returned to you via AddPath.

The text which should be displayed. Whether the text was displayed successfully.

Called when a new path object is to be added to the current page.

The path which should be stroked, filled or both.

Called when a new image object is to be added to the current page.

The image bitmap that should be drawn.

Called when an area should be filled with a pattern. This is most typically used for drawing shading patterns.

The pattern that should be drawn.

Called when a new clipping region is to be added to the current page. The current region should become the intersection of itself and the provided region.

The provided region.

Describes a font to be used for rendering text

Font type enum.

Undefined.

Type 0 font.

Typoe 1 font.

MM type font.

True type font.

Type 3 font.

Open type font.

Implement IDisposable

Convert the font to OpenType. Calling this method will attempt to convert this font to the OpenType format. If successful, the font data will be available via the Stream property.

Whether the conversion was successful or not.

Substitute an alternative font. If you do not want to use the existing font then you can ask for a substitution. The fonts on the local machine will be searched for a suitably similar match.

If the font was substituted successfully.

Subset the font. Subsetting reduces the size of a font by removing unused characters and metrics. Because the characters that are used are not known until the pages have been exported, you should only call this method at the end of the export process.

Whether the font was successfully subset.

Load font metrics from the current font. This function populates the DefaultGlyphWidth, MissingGlyphWidth, SpaceWidth, LineGap, BaselineDistance, Ascender, Descender, Ascent and Descent properties. These properties are dependent on the current font. So if you call Substitute you may wish to call this function again to load up the new metrics.

True if successful.

The type of font.

The identity of this font. This property holds a pointer to the underlying representation of this font. This can be used for identifying and avoiding duplication of font data.

Full name of font.

Common name of font.

Font family name.

Substitution font file name. This will only be set if the Subsitute method has been called.

Stream containing font data.

Whether font is bold or not.

Whether font is italic or not.

If font flags indicate that font can be embedded.

If font is a subset.

If font was substituted.

If font was converted to OpenType. Conversion to OpenType can be performed using using the Convert function.

The TrueType default glyph width metric.

The TrueType missing glyph width metric.

The TrueType space width metric.

The TrueType Ascender metric.

The TrueType Descender metric.

The TrueType Ascent metric.

The TrueType Descent metric.

The TrueType LineGap metric.

The TrueType BaselineDistance metric.

The base line descent - Descender plus LineGap.

If the font has been substituted, glyph widths from that font. The character widths for a font are embedded in the PDF document. So when text is drawn the widths for the individual characters will be provided to you. However, when substituting a font, the widths in the PDF may not entirely agree with the widths in the font. The font substitution algorithm will try to make sure that the character widths are broadly similar. However although the average may be comparable, individual glyphs may be quite different. If you need to reconcile the two when adding text, you can obtain the substitution widths via this property. Each width is provided as 1000ths of the font size and they are indexed by glyph ID. If the font has not been subsituted this property will be null.

Interface for content which can be added to PageLayout.

Add this object to the PageLayout of the current page.

The unique ID that should be used to identify the object. Whether the item was added.

Object representing page layout info, where all the content that has been added with AddToLayout will be contained.

Return true if it has a layout. This will be true only if the IExporter.TextRenderingOptions has the flag RequiresPageLayout set and the content has been added with AddToLayout().

Get top margin

Get bottom margin

Get left margin

Get right margin

Get all paragraphs

Get all columns

Returns the current columns and then releases all columns

Object representing a paragraph

Alignment type enum

No alignment

Left aligned

Right aligned

Justified alignment

Centered alignment

Direction type enum

Horizontal direction

Vertical direction

Access all text lines

Get the alignment type

Get the direction

Return true if fixed

Access column

Object representing a line

Access the text runs

Access the drawings

Representing a text object (text that as added through IExporter.AddText)

Write mode enum

Horizontal write mode

Vertical write mode

Access the write mode

Access the character sizes

Access the layout ID

Represents a graphical object (which can be an image or a path object)

Access the transform

Access the rectangle

Access the layout ID

Represents a general simple Page object with a content box, margins and a transform, and allows accessing the underlying Doc Page object)

Implement IDisposable

Call Update with new values for the matrix, box or margin values

Call Update if you change the matrix, box or margin values.

Access the transformation matrix. If you change the matrix you should call Update to notify the rendering process that this has occurred.

Access the box which represents the area in which content can be placed. If you change the box you should call Update to notify the rendering process that this has occurred.

Access the margins of the page.

Access the underlying Page. The Page is owned by the PageInfo class and will be disposed of when the PageInfo class is disposed of. For this reason, if you wish to keep a copy of the Page you should call the DetachPage method.

Detach the Page from this PageInfo class. Detaching the page will release ownership so the PageInfo class will not dispose of it.

Contains all the necessary info to paint a stroke

The matrix to apply to the stroke object

The line width

Miter Limit (ratio of miter length to line width, as in (miterLength / lineWidth = (1 / (sin(pi/2))))

The type of line cap, see PdfLineCap

The type of line join, see PdfLineJoin

The array describing the lengths of dashes

What "phase" the first dash starts in (based on the dash array)

The flatness factor for bezier curves (describing a deviation from a theoretical smooth curve)

Smoothness factor

An object representing a path, contains the description of the path attributes.

The type of line cap to use (according to pdf spec)

Butt line cap

Round line cap

Square line cap

The type of line join to use (according to pdf spec)

Miter join

Round join

Bevel join

Whether the path is a fill or a stroke path (determines the output geometry)

No operation specified (invalid)

Fill operation

Stroke operation

The tessellation flags determining how geometry is produced.

No flags specified

Whether to generate triangles or keep it as lines (thick lines will be outlined then)

Whether to resolve strokes (ie lines with thickness become rectangles) or just keep them as the original lines

Whether to resolve beziers in the tesselator

If set, uses vertex lists and flags (as in regions and paths), otherwise vertices and indices (as in typical geometry)

Set all available flags

Add this instance for layout analysis. This function is currently ignored.

The unique string that should be used to identify this object. Whether the item was added.

The type of geometry

None (invalid)

A set of points

A set of lines (wireframe)

A set of triangles (mesh)

Generate tessellation using the provided geometry and tessellation settings. The number of segments determines the number of straight lines that a bezier curve will be broken into. If you prefer to use the default flatness parameter to determine this, leave the segments at a zero default.

The type of geometry to use for the tessellation. The type of tessellation options to use. The number of segments for each curve. The tessellated path.

Generate geometry using the provided tessellation settings

Return true if the path is meant for filling

Return true if the path is meant for stroking

Access the brush for filling

Access the brush for stroking

Any fill pattern that needs to be applied. If the IsFill property is true and this property is null, a solid brush should be used.

Any stroke pattern that needs to be applied. If the IsStroke property is true and this property is null, a solid brush should be used.

Access the blend info

Access the alpha value

Access the soft mask ID

Access the extra stroke info

The matrix to apply to the stroke object.

The line width for stroking.

The Miter Limit. If lines meet at a sharp angle and the LineJoin is set to Miter, the miter may extend a long way relative to the thickness of the line. This property restricts the amount of extension that may be applied. Beyond this amount a beveled join should be applied. The miter is the distance between the inside and outside corners of the join, expressed as a fraction of the line width.

The type of line cap to be applied at the end of stroked lines.

The type of line join to apply where stroked lines join.

Stroked paths may be dashed. This array describes the lengths of the dashes. The aray is cyclical, so after the end is reached, the dashes start back at the beginning.

Stroked paths may be dashed. This array describes the phase of the dashes. The phase describes the length into the dash array at which the dashes should start.

The current flatness factor to be used for bezier curves. Bezier curves need to be deconstructed into multiple straight line segments. This flatness describes the deviation from a theoretical perfectly smooth curve.

The current smoothness factor to be used for gradient fills.

The tessellation settings which are used to create the actual geometry

Construct am instance

The type of geometry to produce, see GeometryInfo.GeometryType The flags to use for geometry creation, see TessSettingFlags The number of segments to use for bezier curves (to produce a fixed number of segments)

The type of geometry to produce, see GeometryInfo.GeometryType

>The flags to use for geometry creation, see TessSettingFlags

The number of segments to use for bezier curves (to produce a fixed number of segments, 0 = use flatness parameter)

A geometry object, which can be represented as points, lines or triangles (depending on the GeometryType)

Implement IDisposable

Access the geometry type

The array of vertices

The array of indices (multiples of 2 for lines, multiples of 3 for triangles)

The bounding box of an object (2D)

Whether the even-odd rule should be used for determining fills (2D objects)

The array of flags (alternative to indices)

Represents a text object (which should use the currently set font from the graphics stack)

Access the rendering mode for the text.

No operation - text is invisible.

Whether to fill text.

Whether to stroke - outline - text.

Whether to add text to the clipping path.

Add this instance for layout analysis. This function is currently ignored.

The unique string that should be used to identify this object. Whether the item was added.

ICloneable interface

Access the text

Access the transform

Access the array of widths

Access the array of advances

Access the array of indices

Access the array of clusters

Access the alpha value

Access the soft mask ID

Access the character spacing

Access the word spacing

Access the horizontal scaling

Access the text rise

Access the RenderingModeInfo

Return true if it is a fill

Return true if it is an outline

Return true if it is invisible

Access the font size

Access the text leading value

Return true if it is vertical

Represents a transparency group, as specified in the PDF spec

Gets the soft mask ID

Returns whether this object is isolated

Returns whether knockout is true

Gets the softmask luminosity value

Gets the softmask alpha value

Gets the backgrop colour

Represents blending info (how overlapping components affect the final color)

Gets the opacity value

Gets the shape value

Gets the alpha value

Gets the blend mode

Gets the soft mask ID. The soft mask ID is a unique number you can use to associate a soft mask with any mask images you may create.

ConfigSect Class.

An Atom containing an array of other Atoms.

Create an ArrayAtom from a XRect representation.

The XRect representing the value of the object. The resulting ArrayAtom.

Create an ArrayAtom from a XTransform representation.

The XTransform representing the value of the object. The resulting ArrayAtom.

Create an array of Atoms from a string containing a sequence of PDF objects.

The string holding the sequence of atoms. The resulting ArrayAtom.

Create an array of Atoms from a byte array containing a sequence of PDF objects.

The byte array holding the sequence of atoms. The resulting ArrayAtom.

Create an array of NameAtoms from a list of strings. If the provided list is null then the return value will be null.

The list of strings. The resulting ArrayAtom.

Create an array of StringAtoms from a list of strings. If the provided list is null then the return value will be null.

The list of strings. The resulting ArrayAtom.

Create an array of NumAtoms from aa list of integers. If the provided list is null then the return value will be null.

The list of integers. The resulting ArrayAtom.

Create an array of NumAtoms from a list of doubles. If the provided list is null then the return value will be null.

The list of doubles. The resulting ArrayAtom.

ArrayAtom constructor.

The number of Atoms in the array.

Copies the Atoms into an array.

The array that is the destination for the elements. The zero-based index in array at which copying begins.

Gets or sets the Atom at the specified index.

Gets or sets the integer at the specified index.

Gets or sets the double at the specified index.

Gets or sets the string at the specified index.

Add an Atom to the end of the array.

The Atom to be added. The position in which the new element was inserted.

Add an integer to the end of the array.

The integer to be added. The position in which the new element was inserted.

Add a double to the end of the array.

The floating point value to be added. The position in which the new element was inserted.

Add a string to the end of the array.

The string to be added. The position in which the new element was inserted.

Removes all Atoms from the array.

Determines whether the array contains a specific Atom.

The object to locate. True if the object is found, otherwise false.

Determines the index of a specific Atom.

The object to locate in the Collection. If found, the index of value, otherwise -1.

Inserts an Atom into the array at the specified position.

The zero-based index at which value should be inserted. The Atom to insert into the array.

Removes an Atom from the array.

The Atom to be removed. True if the Atom is removed, otherwise false.

Removes an Atom at a specified position from the array.

The zero-based index of the item to remove.

Gets an enumerator for the Collection.

The enumerator for the collection.

Test whether the two ArrayAtoms are the same.

The ArrayAtom to test against. Whether the ArrayAtoms are equal.

Compares this instance of an ArrayAtom to another and returns an indication of their relative values.

An ArrayAtom to compare against. A signed number indicating the relative value of this instance.

Inserts the elements in the supplied array into this array at the specified index. If the index is equal to the then the elements are added to the end of the array. If the supplied array is null or the index is invalid then an exception will be raised.

The zero-based index at which the new elements should be inserted. The array whose elements should be inserted.

Adds the elements in the supplied array at the end of this array. If the supplied array is null then an exception will be raised.

The array whose elements should be added.

Creates a shallow copy of a range of elements in the source array. If the index or count is invalid then an exception will be raised.

The zero-based index specifying the first element. The number of elements to be selected.

Removes a range of elements from the source array. If the index or count is invalid then an exception will be raised.

The zero-based index specifying the first element. The number of elements to be selected.

ComparisonType Enumeration.

Nothing.

Consider ID.

Consider Atom.

A PDF atomic object comprising a basic chunk of PDF data.

Atom destructor.

Create an appropriate type of Atom from a raw PDF string representation.

The string representing the value of the object. The resulting Atom.

Gets the Name value from the Atom if it is a NameAtom.

The Atom to get the name from. The returned name.

Gets the String value from the Atom if it is a StringAtom.

The Atom to get the text from. The returned text.

Gets the Boolean value from the Atom if it is a BoolAtom.

The Atom to get the Boolean from. The returned Boolean.

Gets the Integer value from the Atom if it is a NumAtom.

The Atom to get the integer from. The returned integer.

Gets the Double value from the Atom if it is a NumAtom.

The Atom to get the double from. The returned double.

Gets the Object ID value from the Atom if it is a RefAtom.

The Atom to get the Object ID from. The returned Object ID.

Gets the named entry from the Atom if it is a DictAtom.

The Atom to get the item from. The name of the item to be retrieved. The returned Atom.

Gets the indexed entry from the Atom if it is a DictAtom or ArrayAtom.

The Atom to get the item from. The index of the item to be retrieved. The returned Atom.

Removes the named entry from the Atom if it is a DictAtom.

The Atom from which the item should be removed. The name of the item to be removed.

Adds the named entry to the Atom if it is a DictAtom.

The Atom to which the item should be added. The name of the item to be added. The item to be added. The returned Atom.

Add the indexed entry to the Atom if it is an ArrayAtom.

The Atom to which the item should be added. The index at which the item should be added. The item to be added. The returned Atom.

Test whether the two Atoms are the same.

The Atom to test against. Whether the Atoms are equal.

Test whether the two Atoms are the same.

The object to test against. Whether the objects are equal.

Test whether the data in two Atoms is the same. The comparison type specifies the type of data to compare. Only if all the comparisons are true are the objects said to be equal.

The Atoms to test against. Whether the Atoms are equal.

A hash code for the Atom.

The returned hash code.

A hash code derived from this Atom. The hash code can be made up of a variety of parts of the indirect object combined together. The ID and the Atom hash codes are derived from the value of the ID and Atom respectively.

The returned hash code.

Compares this instance of an Atom to another and returns an indication of their relative values.

A System.Object that evaluates to an Atom. A signed number indicating the relative value of this instance.

Creates a deep copy of the current Atom.

The newly created copy.

The string representation of the Atom as it would appear in a PDF.

The string representation of the object.

The byte array representation of the Atom as it would appear in a PDF.

The byte array representation of the object.

Dispose of the Atom.

Dispose of the Atom.

An Atom containing a boolean value.

Construct a BoolAtom.

Construct a BoolAtom from a boolean value.

The initial value that the Atom should adopt.

Whether the boolean is true or false.

Test whether the two BoolAtoms are the same.

The BoolAtom to test against. Whether the BoolAtoms are equal.

Compares this instance of a BoolAtom to another and returns an indication of their relative values.

A System.Object that evaluates to a BoolAtom. A signed number indicating the relative value of this instance.

An Atom containing a dictionary of other Atoms indexed by name.

The collection of names in a DictAtom.

Initializes a new instance that reflects the keys in the specified DictAtom.

The DictAtom.

Gets the number of elements contained.

Copies the DictAtom.KeyCollection elements to an existing one-dimensional Array, starting at the specified array index.

The array that is the destination for the elements. The zero-based index in array at which copying begins.

Returns an enumerator that iterates through the DictAtom.KeyCollection.

The enumerator for the key collection.

Enumerates the elements of a DictAtom.KeyCollection.

Releases all resources used by the DictAtom.KeyCollection.Enumerator.

Gets the element at the current position of the enumerator.

Advances the enumerator to the next element of the DictAtom.KeyCollection.

Whether the enumerator was successfully advanced to the next element.

The collection of Atoms in a DictAtom.

Initializes a new instance that reflects the values in the specified DictAtom.

Gets the number of elements contained.

Copies the DictAtom.ValueCollection elements to an existing one-dimensional Array, starting at the specified array index.

Returns an enumerator that iterates through the DictAtom.ValueCollection.

Enumerates the elements of a DictAtom.ValueCollection.

Releases all resources used by the DictAtom.ValueCollection.Enumerator.

Gets the element at the current position of the enumerator.

Advances the enumerator to the next element of the DictAtom.ValueCollection.

DictAtom constructor.

Gets the number of elements in the dictionary.

Copies the Atoms into an array.

The array that is the destination for the elements. The zero-based index in array at which copying begins.

Copies the names and Atoms into an array.

The array that is the destination for the elements. The zero-based index in array at which copying begins.

Gets or set the Atom with the specified key.

Gets or set the integer with the specified key.

Gets or set the double with the specified key.

Gets or set the string with the specified key.

Add an Atom to the dictionary.

The string to use as the key of the element to add. The Atom to be added.

Add an integer to the dictionary.

The string to use as the key of the element to add. The integer to be added.

Add a double to the dictionary.

The string to use as the key of the element to add. The floating point value to be added.

Add a string to the dictionary.

The string to use as the key of the element to add. The string to be added.

Removes all elements from the dictionary.

Determines whether the dictionary contains an element with a specific name.

Remove an element from the dictionary.

The name of the element to be removed.

Get an array of all the names in the dictionary.

An array of all the names in the dictionary.

Get an array of all the Atoms in the dictionary.

An array of all the Atoms in the dictionary.

Get the collection of the keys in the dictionary.

Get the collection of the Atoms in the dictionary.

Gets an enumerator for the Dictionary.

The enumerator for the dictionary.

Test whether the two DictAtoms are the same.

The DictAtom to test against. Whether the DictAtoms are equal.

Compares this instance of a DictAtom to another and returns an indication of their relative values.

A System.Object that evaluates to a DictAtom. A signed number indicating the relative value of this instance.

Enumerates the elements of a DictAtom.

Releases all resources used by the DictAtom.Enumerator.

Gets the element at the current position of the enumerator.

Advances the enumerator to the next element of the DictAtom.

true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection.

An atom representing a name.

Create a name atom.

Create a name atom from a string.

The initial value that the Atom should adopt.

The text of the name.

Test whether the two NameAtoms are the same.

The NameAtom to test against. Whether the NameAtoms are equal.

Compares this instance of a NameAtom to another and returns an indication of their relative values.

A System.Object that evaluates to a NameAtom. A signed number indicating the relative value of this instance.

A null atom.

Create a null atom.

Test whether the two NullAtoms are the same.

The NullAtom to test against. Whether the NullAtom are equal.

Compares this instance of a NullAtom to another and returns an indication of their relative values.

A System.Object that evaluates to a NullAtom. A signed number indicating the relative value of this instance.

An atom representing a numeric value.

Create a number atom.

Create a number atom from an integer.

The initial integer value that the Atom should adopt.

Create a number atom from a floating point value.

The initial floating point value that the Atom should adopt.

The integer value of the number.

The integer value of the number.

The floating point value of the number.

Test whether the two NumAtoms are the same.

The NumAtoms to test against. Whether the NumAtoms are equal.

Compares this instance of a NumAtom to another and returns an indication of their relative values.

A System.Object that evaluates to a NumAtom. A signed number indicating the relative value of this instance.

Encode a number into a PDF string. This format may be needed for direct insertion into a content stream.

The number to convert. The string representation.

An atom which represents a content stream operator.

Create an operator atom.

Create an operator atom for a string.

The operator text.

The text of the operator.

Test whether the two OpAtoms are the same.

The OpAtom to test against. Whether the OpAtoms are equal.

Compares this instance of a OpAtom to another and returns an indication of their relative values.

A System.Object that evaluates to a OpAtom. A signed number indicating the relative value of this instance.

Finds all the OpAtom entries in an array.

The ArrayAtom to be searched. The names and indexes of the OpAtoms that were found.

Finds specified types of OpAtom entries in an array.

The ArrayAtom to be searched. The types of OpAtoms that should be returned. The names and indexes of the OpAtoms that were found.

Gets the parameter associated with the OpAtom at the specified index and validates that the atom is of the correct type. Only the top level atoms are checked. So for example, the TJ operator takes an ArrayAtom consisting of NumAtoms and StringAtoms. This function will ensure that there is one ArrayAtom available as a parameter. However it will not ensure that all items inside the array are NumAtoms or StringAtoms. If the atom is not of the correct type, is not available in the array (eg because the array is too small) or the operator is unrecognized then the return value will be null. If the operator does not take any parameters the return will be null. The Atom is the actual object in the supplied array so changing the value of the Atom will change the value in the array. If the index does not point to an OpAtom or is not inside the array bounds then an exception will be thrown. This function supports all the standard PDF operator types as defined in the PDF Specification apart from BI, ID and EI which are used for inline images. The reason these are not supported is because this sequence is read as a DictAtom with embedded data so you should never encounter it.

The array in which the OpAtom is found. The index to the OpAtom. The parameter for the operator.

Gets the parameters associated with the OpAtom at the specified index and validates that the atoms are of the correct type. Because the arguments are validated and the types are checked so you can rely on the fact that the returned array contains a valid number of Atoms of the correct types. Only the top level atoms are checked. So for example, the TJ operator takes an ArrayAtom consisting of NumAtoms and StringAtoms. This function will ensure that there is one ArrayAtom available as a parameter. However it will not ensure that all items inside the array are NumAtoms or StringAtoms. Also resource lookups are not done so, for example, it is not checked that a font name actualy exists in the font resource dictionay. If the operator takes no parameters a zero length array will be returned. If the operator parameters are incorrect or if the operator is not recognized then the return value will be null. In this unusual situation you may wish to set the to whitespace to remove the invalid operator from the content stream. While this does not fix the underlying problem, it will at least prevent applications like Acrobat from reporting an error.

The array in which the OpAtom is found. The index to the OpAtom. The parameters for the operator.

An atom which references an IndirectObject.

Create a reference atom.

Create a reference atom pointing to a IndirectObject.

The initial IndirectObject that the Atom should point to.

The ID of the referenced IndirectObject.

The generation of the referenced IndirectObject.

Set the IndirectObject that the reference should point to.

The IndirectObject that the RefAtom should point to.

Get the IndirectObject that the reference is pointing to.

The collection of objects to be searched. The matching IndirectObject.

Test whether the two RefAtoms are the same.

The RefAtom to test against. Whether the RefAtoms are equal.

Compares this instance of a RefAtom to another and returns an indication of their relative values.

A System.Object that evaluates to a RefAtom. A signed number indicating the relative value of this instance.

An atom representing a textual value.

Create a string atom.

Create a string atom from a string.

The initial value that the Atom should adopt.

Create a string atom from an array of bytes.

The initial value that the Atom should adopt.

The text of the string.

Test whether the two StringAtoms are the same.

The StringAtom to test against. Whether the StringAtoms are equal.

Compares this instance of a StringAtom to another and returns an indication of their relative values.

A System.Object that evaluates to a StringAtom. A signed number indicating the relative value of this instance.

Encode a string into a PDF string format for use in a content stream using a normal or simple font. Typically you will obtain an appropriate encoding from a FontObject.

The text to be encoded. The encoding to use - typically obtained from the FontObject.GetEncoding method. If null an identify encoding will be used. The StringBuilder to which the encoded representation should be appended. If null then one will be created. The updated StringBuilder.

Encode a string into a PDF string format for use in a content stream using a Composite font with a double byte CMap.

The text to be encoded. The encoding to use - typically obtained from the FontObject.GetEncoding method. If null an identify encoding will be used. The StringBuilder to which the encoded representation should be appended. If null then one will be created. The updated StringBuilder.

Decode a PDF encoded string into a plain string format.

The text to be decoded. The StringBuilder to which the encoded representation should be appended. If null then one will be created. The updated StringBuilder.

Decode a double byte PDF encoded string into a plain string format. This may be necessary if you are looking at a content stream using a Composite font with a double byte CMap.

The text to be decoded. The StringBuilder to which the encoded representation should be appended. If null then one will be created. The updated StringBuilder.

Convert a DateTime into a standard PDF date string.

The PDF date string covers date, time and time zone. The format is broadly similar to ASN.1 as detailed in ISO/IEC 8824. For example, February 3, 2017, at 9:14 PM Pacific Standard Time would be represented as "D:201702032114-08'00". The DateTime to be converted. The standard PDF date string.

Convert a standard PDF date string into a DateTime.

The PDF date string covers date, time and time zone. The format is broadly similar to ASN.1 as detailed in ISO/IEC 8824. For example, February 3, 2017, at 9:14 PM Pacific Standard Time would be represented as "D:201702032114-08'00". The standard PDF date string to be converted. The DateTime.

UnitType Enumeration.

PostScript Points - 1/72 of an Inch.

Twentieths of a Point - 1/20 of a PostScript Point.

Didot Points - 1/72 of a French Royal Inch.

ATA Points - 1/72.272 of an Inch.

TeX Points - 1/72.27 of an Inch.

L'Imprimerie Nationale Points - 0.4 mm.

Picas - 12 PostScript Points.

Ciceros - 12 Didot Points.

ATA Ciceros - 12 ATA Points.

TeX Ciceros - 12 TeX Points.

Microns - millionths of a metre.

Milimeters - thousandths of a metre.

Centimeters - hundredths of a metre.

Meters.

Inches.

Feet.

LanguageType Enumeration.

Latin - the default and most efficient encoding for Western languages.

Unicode - the setting you will most often want to use when embedding foreign character sets.

Korean.

Japanese.

Simplified Chinese.

Traditional Chinese.

CharUsageType Enumeration.

Uses the default characters.

Uses symbol character codes between 0xf000 and 0xf0ff in addition to those between 0 and 255.

LineEndingType Enumeration.

No symbol.

A square block.

A filled circle.

A filled diamond.

Two lines forming an arrow.

A triangular arrow.

A perpendicular line.

A longer perpendicular line.

The same as OpenArrow, but pointing backwards rather than forwards.

The same as ClosedArrow, but pointing backwards rather than forwards.

A 30 degree line.

A barbed arrowhead.

The delegate called during HTML rendering.

The delegate called when embedding an object during HTML rendering.

The source type of operations.

No information was set.

A document.

A document page.

A page content.

A standard image (single-frame).

An image used as a mask.

A multi-frame image.

A frame in a multi-frame image.

A stream in a PDF document.

A path element in a PDF stream.

A text element in a PDF stream.

A form XObject in a PDF stream.

A shading operator in a PDF stream.

A font in a PDF.

Provides generic information related to the ProcessingObject event.

ProcessingInfo constructor.

The event type.

The current document being processed, null if not applicable.

The total number of documents, null if not applicable.

The current page being processed, null if not applicable.

The total number of pages, null if not applicable.

The current frame being processed, null if not applicable.

The total number of frames, null if not applicable.

The number of frames per second, null if not applicable.

The object's horizontal location, null if not applicable.

The object's vertical location, null if not applicable.

The object's width, null if not applicable.

The object's height, null if not applicable.

The object's background color, null if not applicable.

Indicates whether the source has been handled by the event handler.

The stream position, null if not applicable.

The stream length, null if not applicable.

The object text, null if not applicable.

Provides data related to an Operation about to be performed on an IndirectObject.

ProcessingObjectEventArgs constructor.

The IndirectObject to be processed.

ProcessingObjectEventArgs constructor.

The IndirectObject to be processed. The ProcessingInfo containing related information.

Gets the IndirectObject to be processed.

Gets or sets an object which can be used to save data about the event.

Gets related information.

Provides data related to an Operation which has just been performed on an IndirectObject.

ProcessedObjectEventArgs constructor.

The IndirectObject processed. A value indicating whether the processing was successful.

Gets the IndirectObject which has just been processed.

Gets or sets an object which can be used to save data about the event.

Gets a value indicating whether the processing was successful.

Represents the method that handles the event of performing an Operation on an IndirectObject.

The source of the event. A ProcessingObjectEventArgs that contains the event data.

Represents the method that handles the event of performing an Operation on an IndirectObject.

The source of the event. A ProcessedObjectEventArgs that contains the event data.

An Operation to be performed on an IndirectObject.

Occurs before an IndirectObject is operated on. The EventArgs Tag property is passed to the ObjectProcessed event.

Occurs after an IndirectObject is operated on. The EventArgs Tag property is passed from the ObjectProcessing event.

Dispose of the Operation.

Dispose of the Operation.

Operation to recolor pages in a document.

RecolorOperation constructor.

Gets or sets a value indicating whether annotations are to be recolored.

Gets or sets the number of type0 function samples to generate (between 64 and 1000)

Gets or sets the destination ColorSpace.

Gets or sets the default rendering intent.

Gets or sets a value which determines if content in the PDF is allowed to override the default rendering intent.

Recolors a document.

The Doc to be recolored.

Recolors a page.

The Page to be recolored.

Recolors the pages referenced by a Pages IndirectObject.

The Pages IndirectObject to be recolored

Replace transparent overlaps with opaque results of transparent object interactions.

FlattenTransOperation constructor.

Gets or sets a value indicating whether annotations are to be flattened.

The rasterized resolution in dots per inch.

Whether to anti-alias flattened rasterized text.

Whether to anti-alias flattened rasterized polygons.

Compositing ColorSpace (Gray (Grey), RGB, CMYK)

Log message with details on the previous Flattening operation

The alpha of the backdrop, range 0..1 (default 1)

The path to the default Gray ICC color profile.

The path to the default RGB ICC color profile.

The path to the default CMYK ICC color profile.

Flatten the transparency in a document.

The Doc to be flattened.

Flatten the transparency in a page.

The Page to be flattened.

Flattens the transparency in the pages referenced by a Pages IndirectObject.

The Pages IndirectObject to be flattened

The Application for XpsImportOperation.ImportAny.

The application determined by the file association in the Shell (Windows Explorer).

Microsoft Word.

Microsoft Excel.

Microsoft PowerPoint.

Microsoft InfoPath.

Microsoft OneNote.

Microsoft Publisher.

Microsoft Project.

Microsoft Visio.

Microsoft Outlook.

Operation to import pages in an XPS document.

The types of annotations.

No annotation.

Link annotation that points to a page in the same document.

Link annotation that links to an external resource (e.g. URL).

XpsImportOperation constructor.

The types of annotations to be added.

The password needed to read the source.

The application that prints the document to XPS when ImportAny is called.

The folder of the application for printing documents to XPS when using ImportAny.

Whether to enable macros when opening MS Office documents. This property is supported only for Word, Excel and Powerpoint.

The document number for ImportAny, e.g. the Excel Worksheet number.

XpsImportOperation destructor.

Dispose of the Operation.

Enable an application process to be reused so that it is terminated only manually or when this operation is disposed of.

The import application. Whether the application process is to be reused. Whether the reuse status of the application has been changed.

Whether an application is to be kept running and reused.

The import application. Whether the application process is to be kept running and reused.

Whether an application is running.

The import application. Whether the application is running.

Terminate a running application.

The import application. Whether the application has been running and killed.

Import an XPS document.

Import a document by converting it to XPS using the Microsoft XPS print driver.

The target PDF document. The file path to the source document.

Import a document by converting it to XPS using the Microsoft XPS print driver.

The target PDF document. The file path to the source document. The timeout in milliseconds for the XPS printer driver.

The application installation folder.

The import application. The installation folder of the application.

SWF action data type code.

The undefined type.

The null type.

SWF action value.

The undefined value.

The null value.

The type code.

Parameters for initializing the SWF machine.

The stage width in twips when the scale mode is NoScale.

The stage height in twips when the scale mode is NoScale.

The stage alignment.

The stage scale mode.

The Flash variables.

Operation to import frames in a Flash movie.

SwfImportOperation constructor.

Dispose of the Operation.

The target PDF Document.

The time-out for script execution.

The background region.

The clip region.

Whether to reset regions to frame bounds before importing a frame.

The content alignment.

The content scale mode.

The parameters for initializing the SWF machine.

Import frames in a Flash movie.

Import frames in a Flash movie.

Operation to render pages in a document.

RenderOperation constructor.

RenderOperation destructor.

Dispose of the Operation.

Renders the current page in the document.

The destination file path.

Renders the current page in the document.

A dummy file name used to determine the type of image. The destination stream.

Renders the current page in the document.

A dummy file name used to determine the type of image. The data containing the rendered page.

Renders the current page in the document.

The bitmap containing the rendered page.

Operation to draw pages from one document onto another. This operation is in many ways similar to the Doc.AddImageDoc function. However the AddImageDoc function is not aware of state and thus it has to take each call afresh. In contrast the DrawPagesOperation is aware of state which means that, for a process drawing many pages between two documents, it can operate much more quickly.

DrawPagesOperation constructor.

The document from which pages will be taken. The document onto which pages will be drawn.

DrawPagesOperation destructor.

Dispose of the DrawPagesOperation.

The source document from which to take pages.

The destination document onto which pages will be drawn.

Whether to copy fields and annotations. Default false.

Whether to draw only the portion of the page specified by the Souce.Rect. If this value is false then the entire visible page will be drawn. Default false.

The level of alpha to apply to the drawn page from transparent through to fully opaque (0 to 255). If this value is null then no alpha will be applied. Default null.

Draw the current page from the source PDF document onto the current page of the destination document, returning the ID of the newly added object. The page is scaled to fill the current Rect. It is transformed using the current Transform. Many field and annotation types can only exist as a simple rectangle with sides parallel to the page borders. For this reason you should be cautious about the transforms you use when specifying that annotations should be copied. A transform which involves scale and translation will be fine but one involving rotation and skew factors may result in unusual output if the field or annotation does not support this combination. Pages may be rotated. As such, when drawing one page onto another, you may wish to copy the Page.Rotation from the source page to the destination page. More complex example code to de-rotate a page may be found under the documentation for the Page.Rotation.

The ID of the newly added object.

Operation to apply a visual effect.

Names of all the installed effects.

Effect constructor.

The name of the effect that is required. If the name is not one of the valid names then an exception will be thrown.

Effect destructor.

Dispose of the Operation.

The name of the Effect.

A description of what the effect does.

Whether to automatically restore the image color space and apply compression after the effect is applied.

The quality of compression to use when automatically compressing after the effect is applied.

The parameters associated with the effect.

Apply effect to image.

The PixMap to which the image should be applied. The effect will be applied to the PixMap. Effects normally involve wholescale changes and so it may well be necessary to change the color space and depth in order to apply the effect. If the AutoRestore property is set then the PixMap will be restored to a similar color space after processing and it will be recompressed at an appropriate quality. This default is generally what is required. However if the AutoRestore property is not set then final output may well have different characteristics such as color space and depth. In general the final image will be uncompressed eight bit RGB no matter what was supplied. If you are relying on particular characteristics present in the original PixMap then you should convert or recolor it after the effect has been applied. Since the final image will be left uncompressed you will likely want to recompress it using an apppopriate schema.

A parameter that controls the operation of the effect.

The name of the parameter.

A description of what the parameter does.

The minimum recomended value (if applicable).

The maximum recomended value (if applicable).

The value of the parameter, or the first value if there are multiple.

The values of the parameter. Most parameters have one value only.

The PDF conformance.

PDF conformance.

PDF/A Part 1 Level B conformance.

PDF/A Part 1 Level A conformance.

PDF/A Part 2 Level B conformance.

PDF/A Part 2 Level U conformance.

PDF/A Part 2 Level A conformance.

The PDF conformity.

No conformity.

Removes JavaScript actions.

The PDF conformity options.

No option.

Keeps the document's modification date unchanged.

The PDF conformance identification.

Conformance version identifier.

Conformance amendment identifier.

Conformance corrigendum identifier.

Conformance level.

The effective PdfConformance value.

Gets the conformance identification from a document.

Operation to validate PDF files.

Dispose of the Operation.

The target PDF Document.

The PDF conformance.

The validation errors.

The validation warnings.

Read and validate an existing document from file.

Read and validate an existing document from data.

Read and validate an existing document from stream.

Operation to produce conforming PDF files.

Dispose of the Operation.

The PDF conformance.

Options related to the changes that may be made to enable PDF conformance.

Options related to the way that the PDF may be changed as part of the operation.

The features within the document which could not be made conformant.

The changes made to make the document conformant.

Write the conforming document to a file.

The document. The destination file path.

Write the conforming document to a stream.

The document. The destination stream.

Get the conforming document as raw data.

The document. The PDF document as an array of bytes.

Get the conforming document as raw data stream.

The document. The PDF document as a stream.

Operation to reduce the size of a document.

ReduceSizeOperation constructor.

The PDF Document.

The pages to be operated upon.

Whether to unembed simple Latin based fonts where possible.

Whether to unembed complex Unicode based fonts where possible.

Whether to unembed embedded fonts that do not have an obvious substitute on the local machine.

Whether to unembed embedded fonts that appear to be corrupt or non-standard.

Whether to refactor and remove duplicate images where possible.

Whether to resize and recompress images where possible.

Whether to compress uncompressed streams where possible.

The target resolution for the resampling of color images.

The target compression type for the re-encoding of color images.

The target compression quality for the re-encoding of color images.

The target resolution for the resampling of grayscale images.

The target compression type for the re-encoding of grayscale images.

The target compression quality for the re-encoding of grayscale images.

The target resolution for the resampling of monochrome images.

The target compression type for the re-encoding of monochrome images.

The target compression quality for the re-encoding of monochrome images.

The amount of divergence from the target palette which will be allowed.

Compact and compress the document.

Whether to compact the entire document or only selected pages.

Operation to tag a document and make it accessible.

The method used to order paragraphs which appear on a page.

Use the order of layout that already exists on the page.

Recursively group by rows and columns.

Order primarily top to bottom, secondarily left to right.

Default constructor.

The document.

The pages to be operated upon.

Whether to attempt to fix font settings that may be required for accessibility.

Whether to attempt to fix or add metadata that may be required for accessibility.

Whether to detect and fix invalid operators in content stream.

Whether to detect and insert table structures.

Whether to detect and insert ordered and unordered list structures.

Whether to detect and remove page headers.

Whether to detect and remove page footers.

Whether to detect and insert structure outline.

The method that should be used for determining paragraph order.

Tags the document for accessibility.

Operation to analyse the semantic structure of a document. In terms of visualization the GetHtml method is terribly useful to be able to see what kind of results have been obtained and how they are structured.

Default constructor.

The document.

Whether to detect and insert table structures.

Whether to detect and insert table structures.

Whether to detect and insert page headers.

Whether to detect and insert page footers.

Whether to detect and insert structure outline.

The method that should be used for determining paragraph order.

The pages to be operated upon.

The text operation which will be used for page analysis.

The image operation which will be used for page analysis.

The paragraphs in reading order rather than layout order.

The header level for each paragraph in reading order.

A line of text in a paragraph.

A collection of text lines forming a paragraph.

A block of text that can contain other blocks of text in either a columnar or blockular layout.

A class for representing a 'Do' draw image operation

A class for representing an Annotation without any stream operator

A class for gathering up TextFragments that are actually all part of one DrawTextOperator. For example a DrawTextOperator might consist of the following: [(Yea) 10 (r) -9000 (Description) -9000 (Total)] TJ Because the three chunks of text are widely spaced the TextFragments associated with each one might not actually fall into the same line. Instead they might be grouped into columns. So column one might contain the two fragments making up "Year" and the other two text chunks might fall into separator lines. This class allows you to group these partial bits of a DrawTextOperator for later use. They fall into a kind of span so that consecutive operators can be held.

Base class for implementing a class that takes a content stream and processes it line by line. This is typically used for rewriting a content stream eg to prettify the format or to add comments.

A class for rewriting a content stream adding tags as you go along.

General purpose utilities for tagging.

An analog of XRect but done as a struct. Not only is this easier to use in terms of assignment but also it's faster (I estimate about three to five times). Perhaps some optimizations to XRect would be good for places where XRects are used standalone and we don't need to go back to unmanaged code.

Set the sides of the rectangle.

The new left position. The new bottom position. The new right position. The new top position.

Determine if this rectangle intersects with another.

Union the rectangle with another rectangle. This rectangle becomes the smallest rectangle that encloses both rectangles. Rectangles with no area are ignored.

The rectangle to add to this one. The supplied rectangle is left unchanged by this function.

Union the rectangle with another rectangle. This rectangle becomes the smallest rectangle that encloses both rectangles.

The rectangle to add to this one. The supplied rectangle is left unchanged by this function. Whether rectangles with no area should be ignored.

Intersect the rectangle with another rectangle. This rectangle becomes the largest rectangle that both rectangles enclose.

The rectangle to intersect to this one. The supplied rectangle is left unchanged by this function. Whether rectangles with no area should be ignored.

Determine if the rectangle encloses any area.

Determine the area of the rectangle.

Object to extract content stream arrays from one or more pages and related objects.

Contents constructor.

The document.

Whether to externalize inline images before processing content streams.

Whether to preflight the document to ensure that any dynamic content has been frozen in place. If you have not added any content to this document - if you have just read it from file - you can set this property to false.

Whether to include annotation and field appearances in the output.

Whether to attempt to update annotation appearance streams if they are missing.

Whether to include Form XObjects in the output.

Whether to include Patterns in the output.

The content streams for the items that have been found.

A log of any errors or inconsistencies found during processing.

Add and scan all the pages in the document.

Add and scan one particular page in the document.

The number of the page to be processed. This is a one based index.

Add and scan a range of pages in the document.

The number of the first page to be processed. This is a one based index. The number of the last page to be processed. This is a one based index.

Object to hold the extracted content of a document.

PageContents constructor.

The document.

Whether to include annotation and field text in the output.

Whether to include color information in the output.

Whether to attempt to regenerate missing Unicode tables from embedded fonts.

Add a particular set of Layer objects from a particular Page. This is an alternative to the AddPages overloads.

The Page on which the provided layers are located. The layers to be added.

Add and process all the pages in the document.

Add and process one particular page in the document.

The number of the page to be processed. This is a one based index.

Add and process a range of pages in the document.

The number of the first page to be processed. This is a one based index. The number of the last page to be processed. This is a one based index.

Operation to analyse and extract the text in a document.

TextOperation constructor.

The document.

The pages to be operated upon.

The minimum distance at which two text fragments will be assumed to be part of one undivided word. This value is specified in terms of a fraction of the font size.

The minimum distance at which two text fragments will be assumed to be part of separate tab groups. This value is specified in terms of a fraction of the font size.

The character used to separate out tab groups when GetText is called.

Whether to de-hyphenate words that appear to be split across two lines.

Whether to show text which is invisible because it is affected by a clip path.

How much overlap to require clipped text to have before it is defined as visible.

Whether to show text content that is marked as an artifact.

Whether to show overlapping repeated text content. This is most typically used for a synthetic bold effect.

Whether to get information on the BT and ET text object markers used to contain and group text operators.

Whether to provide native colors such as CMYK, separations and spot colors, or whether to convert all colors to RGB.

A set of character to string substitutions used for translating typographic characters like ligatures into more normal text.

Get all the text in the page contents.

The text from the specified pages.

Get all the text in the page contents.

The area of interest from which text should be returned. The page from which text should be returned. This is a one based index. The text from the specified pages within the specified area of interest.

Get all the text in the page contents.

The areas of interest from which text should be returned. The pages from which text should be returned. These are one based indexes. The text from the specified pages within the specified areas of interest.

Select a range of text in the document.

The start index for the selection as related to the string returned by the GetText method. The length for the selection as related to the string returned by the GetText method. Returns a list of find matches encompassing the selected text.

Group a range of text fragments into a set of lines.

The fragments to be grouped. Returns a list of groups defining the lines.

If this state can be represented by a simple rect, this is it. For non-trivial states this cannot be done so this will be null.

If this path can be represented by a simple rect, this is it. For non-trivial paths this cannot be done so this will be null.

A fragment of text as it appears in a document.

The ID of the Page on which this text fragment is located.

The Stream ID of the content stream in which this text fragment is located.

The offset within the content stream to the start of the drawing operation that contains this fragment.

The length within the content stream of the drawing operation that contains this fragment.

The zero based index of the drawing operator text array item that contains this fragment. For non text array operators this value is zero.

The character offset within the RawText to the the Text of this fragment.

The text of the fragment. A fragment may span only a portion of the complete text drawing operator.

The text specified in the drawing operator or the text array item of the drawing operator.

The rectangle that contains the text of the fragment.

Prepare document for drawing at the fragment location. After calling this function you can add content overlaying the fragment. For example you might call Doc.FillRect to overlay it. The Doc.Page, Doc.Rect and Doc.Transform may all be changed as a result of calling this method. Text is drawn at a height of one point, using a transformation matrix to scale it up. So, in general, after calling this method, the Doc.Rect.Height will be 1.0.

The angle of rotation of the fragment in degrees.

The font object used for drawing this text fragment.

The effective font size used for drawing this text fragment.

The color used for drawing this text fragment.

The font ColorSpace used for drawing this text fragment.

The skew angle of the font as used for oblique styles to simulate italic.

A group of text fragments that belong together.

The ID of the Page on which this group is located.

The rectangle that contains the group.

The text of the group.

The text fragments in the group.

Operation to analyse the placement of raster images (bitmaps) in a document.

ImageOperation constructor.

The document.

Whether to include all images in the analysis to allow the detection of orphans.

The pages to be operated upon.

Get the image information for all the raster images.

A collection of all the image properties.

A class that represents one raster image (bitmap) in a document.

The PixMap object associated with the image.

The set of renditions of the image at different locations within the document.

The resolution of the image in dots per inch.

The horizontal resolution of the image in dots per inch.

The vertical resolution of the image in dots per inch.

A class that represents one image placement in a document.

The ID of the Page on which the image is placed.

The ID of the Stream in which the image draw operation is contained.

The StreamObject in which the image draw operation is contained.

The offset within the uncompressed StreamObject to the start of the drawing operation that contains this image draw operation.

The length within the uncompressed StreamObject of the drawing operation that contains this image draw operation.

The transformation matrix for the placement of the image.

The bounding rectangle for the placement of the image. Note that images may be rotated or otherwise transformed. For this reason consider whether the Matrix property or the Focus method might be more appropriately used in place of the BoundingBox property.

The resolution of the image in dots per inch.

The horizontal resolution of the image in dots per inch.

The vertical resolution of the image in dots per inch.

Focus the document on the location of the image placement.

ColorOperatorType Enumeration.

Unknown or undefined.

Device dependent Gray.

Device dependent RGB.

Device dependent CMYK.

Calibrated Gray.

EncryptionMethodType Enumeration.

(Not supported.)

No encryption.

Uses the RC4 algorithm.

Uses the AES algorithm with 128-bit encryption keys.

Uses the AES algorithm with 256-bit encryption keys.

XFont Class.

FontWeight Enumeration.

Don't care.

Thin weight.

Extra-light weight.

Light weight.

Normal weight.

Medium weight.

Semi-bold weight.

Bold weight.

Extra-bold weight.

Heavy weight.

Find all the fonts currently installed on the system.

The set of matching fonts.

Find all fonts belonging to a particular family.

The name of the font family. The set of matching fonts.

Find the names of all font families.

The set of family names.

Find all fonts with a given name.

The name of the font. The set of matching fonts.

Find a font in a list, with a given style.

The list of fonts. The weight of the required font. (The midpoint of the weight range.) The maximum difference of the weight of the required font. (The radius of the weight range.) Whether an italic font is required. A matching font. Null if no matching font could be found.

Find a font from a specific family, with a given style.

The name of the font family. The weight of the required font. Whether an italic font is required. A matching font. Null if no matching font could be found.

Find a font from a specific family, with a given style.

The name of the font family. The weight of the required font. Whether an italic font is required. A matching font. Null if no matching font could be found.

Return text width in thousandths of a unit.

The text. The width of the text in 1000ths.

The complete set of names by which this font is known.

The weight of the font (which can be compared against the FontWeight enumeration).

Whether the font is in an italic style.

Whether the font is in a fixed pitch (rather than proportional) style.

Whether the font is in a script style.

Whether the font is in a serif style.

Whether the font contains symbolic rather than Unicode glyphs.

The complete, hopefully unique, human readable name of the font.

The name of the family to which the font belongs.

The name the font will be known by on a PostScript printer.

The baseline of the font in thousandths of a unit.

Whether the licensing rights in the font indicate that it may be embedded. TrueType and OpenType fonts contain licensing rights flags. If this property is true it indicates that either the editable embedding or bitmap embedding flags are true.

The paths to the files that contain the font definition. Most fonts are contained in only one font file, however PostScript fonts can consist of both a PFM and PFB file. If there is no font file this property may be null.

The character widths in thousandths of a unit for all the characters in the font.

Unloads a font so that it is no longer available.

A helper filter to give only the HtmlOptions supported by the ABCChrome engine.

The minimum width to be used for auto-sized pages.

The width of the virtual browser in pixels.

Ignore certificate-related errors. Default is true.

The CSS media to use.

Whether to enable JavaScript and VBScript.

Whether form fields should be live.

Whether the location of certain tags should be noted.

Whether to hide background graphics on a page.

The maximum amount of time allowed for obtaining a page (ms).

The number of times a page should be retried if unavailable or invalid.

The maximum interval to wait.for paint prior to assuming page is rendered (ms).

The maximum amount of time to wait for repaints when using RepaintDelay (ms).

A script to be run after the page is loaded.

Convert external links to internal links wherever possible.

Gets an array of the HTML IDs of tagged visible items.

The Object ID of the object. The IDs of tagged visible HTML objects.

Gets an array of the locations of tagged visible items.

The Object ID of the object. The location of tagged visible HTML objects.

Gets an array of the locations of tagged visible items before Doc.Transform is applied.

The Object ID of the object. The location (before Doc.Transform is applied) of tagged visible HTML objects.

Retrieves the HTTP status code.

The Object ID of the web page to be accessed. The HTTP status code or zero if not available.

Retrieves the client side onload script return value.

The Object ID of the web page to be accessed. The return value.

The options for new worker processes.

Ends any HTML Engine worker threads or processes.

The way in which to select threads or processes that should be ended. The number of selected threads or processes.

The FireShield settings that dynamically determine the file access that should be allowed for HTML conversion.

The condition of the state of thread or process.

No thread or process.

Idle threads or processes.

Threads or processes that are idle or when they become idle.

All threads or processes.

The content type of the embedded file.

No content.

SWF file.

The CSS media type to use.

Print media

Screen media

The conversion used for the values of HTML parameters.

No conversion.

Sets the value to the text content of the file pointed to by the value as a URL.

The method for loading URI/HTML.

Uses the default method.

Uses Moniker and treats input as HTML.

Uses the Navigate method of WebBrowser.

The module for obtaining URI/HTML data.

Uses the default module.

Uses the engine's module.

Uses System.Net.WebRequest.

Uses System.Net.WebRequest when access by the engine's module has been denied.

The request method for URL.

The GET request method.

The POST request method.

The engine to use for HTML parsing and layout.

Rendering engine used in Microsoft Internet Explorer.

Rendering engine used in Mozilla Firefox.

Rendering engine used in Google Chrome.

The HTML rendering conditions.

Never performs the action.

Always performs the action.

Performs the action when the default conditions are met.

Performs the action when some filter is disabled.

Performs the action when only partial content is available.

Performs the action when vector-output coercion has failed.

The page break logic for HTML.

Uses the cumulative cohesion of all objects occupying each horizontal line.

Uses the maximum cohesion among objects occupying each horizontal line.

Optimizes the break position globally around a candidate position.

Optimizes the break position locally around a candidate position.

No optimization.

The FireShield settings that dynamically determine the file access that should be allowed for HTML conversion. FireShield lets you dynamically assign file permissions at runtime, to ensure that your HTML engine only accesses the locations you want. You can provide rules so that each request can be assigned custom rights and permissions, dependent on the type of conversion.

The enforcement policy for the file access rules.

No enforcement of the access rules.

Prohibit access if the rules do not specify that access should be allowed. Always report an error if this happens.

Prohibit access if the rules do not specify that access should be allowed. Attempt to continue the operation without error.

If the rules do not specify that access should be allowed, allow it but also log the file path.

File access enforcement for the worker process. This property allows you to specify the type of action that should be taken if the HTML engine attempts to access a resource to which it is not allowed. You can choose from the following options: None - No enforcement of the access rules.Deny - Prohibit access if the rules do not specify that access should be allowed. Always report an error if this happens.Mask - Prohibit access if the rules do not specify that access should be allowed. Attempt to continue the operation without error.Log - If the rules do not specify that access should be allowed, allow it, but also log the file path via the Log property.

File access rules for the worker process. To determine whether access is allowed to a specific path, the rules are evaluated in sequence. A path may match with multiple rules and it is the final evaluated access type at the end of the sequence, which determines the access level. Rules are case insensitive. At the start of processing the evaluated access type is Deny. This means that, by default, all file access is denied. For each rule, if the file path starts with the rule path and the file name matches the pattern, then the rule access type is assigned to the evaluated access type. In this way you can set up a rule sequence which matches on a general level but then denies on a specific level. For example you might allow access to all files in a folder but then deny access to .aspx files within that folder.

File access log for the worker process. In the event that the Policy is set to Log, files to which access should be denied, are reported via this property.

The options for new worker processes.

The type of access to allow to the resource.

Allow full access to the resource.

Do not allow any access to the resource.

Access rule constructor.

Access rule constructor.

The path to the resource which should be controlled.

A selected file type within the path, that that should be the target of control. Such file types are described using standard DOS format. For example to match on DLLs you might specify "*.dll".

The type of control to exercise over the resource. You can choose from the following options: Allow - Allow full access to the resource.Deny - Do not allow any access to the resource.

The type of control to exercise over the resource.

The options for new worker processes.

The maximum number of processes for the HTML Engine.

Whether the process pool for the HTML Engine has started.

The number of existing processes for the HTML Engine.

The user name.

The domain or server containing the user.

The password for the user.

Whether to load the user profile.

The maximum time for which a process can be idle before being terminated (ms).

The number of times a page should be retried if there is a problem with the process.

Skip the check of engine-dependent options that are set since last HTML import.

Start the process pool for the HTML Engine.

Whether the process pool is started anew.

The HTML parameter with conversion.

HtmlParameter constructor.

The source.

The parameter value.

The conversion for the value.

The information for an object embedded in HTML.

The URL of the embedded object.

The base URL for resolving relative URLs.

The content type of the embedded object.

Indicates whether parameter names are case-sensitive.

The parameters for the embedded object.

The collection of HTML parameter names and values.

The collection of parameter names in a HtmlParameterDictionary.

Initializes a new instance that reflects the keys in the specified HtmlParameterDictionary.

The HtmlParameterDictionary whose keys are reflected.

Gets the number of elements contained.

Copies the HtmlParameterDictionary.KeyCollection elements to an existing one-dimensional Array, starting at the specified array index.

The one-dimensional Array that is the destination of the elements copied. The zero-based index in array at which copying begins.

Enumerates the elements of a HtmlParameterDictionary.KeyCollection.

Releases all resources used by the HtmlParameterDictionary.KeyCollection.Enumerator.

Gets the element at the current position of the enumerator.

Advances the enumerator to the next element of the HtmlParameterDictionary.KeyCollection.

true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection.

Returns an enumerator that iterates through the HtmlParameterDictionary.KeyCollection.

A HtmlParameterDictionary.KeyCollection.Enumerator.

The collection of parameter values in a HtmlParameterDictionary.

Initializes a new instance that reflects the values in the specified HtmlParameterDictionary.

The HtmlParameterDictionary whose values are reflected.

Gets the number of elements contained.

Copies the HtmlParameterDictionary.ValueCollection elements to an existing one-dimensional Array, starting at the specified array index.

The one-dimensional Array that is the destination of the elements copied. The zero-based index in array at which copying begins.

Enumerates the elements of a HtmlParameterDictionary.ValueCollection.

Releases all resources used by the HtmlParameterDictionary.ValueCollection.Enumerator.

Gets the element at the current position of the enumerator.

Advances the enumerator to the next element of the HtmlParameterDictionary.ValueCollection.

true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection.

Returns an enumerator that iterates through the HtmlParameterDictionary.ValueCollection.

A HtmlParameterDictionary.ValueCollection.Enumerator.

Initializes a new empty instance that has the default initial capacity, and uses the default equality comparer for the key type.

Initializes a new empty instance that has the specified initial capacity, and uses the default equality comparer for the key type.

The initial number of elements that the HtmlParameterDictionary can contain.

Initializes a new empty instance that has the default initial capacity, and uses the specified IEqualityComparer.

The IEqualityComparer implementation to use when comparing keys, or null to use the default EqualityComparer for the type of the key.

Initializes a new empty instance that has the specified initial capacity, and uses the specified IEqualityComparer.

The initial number of elements that the HtmlParameterDictionary can contain. The IEqualityComparer implementation to use when comparing keys, or null to use the default EqualityComparer for the type of the key.

Initializes a new instance that contains elements copied from the specified IDictionary and uses the default equality comparer for the key type.

The IDictionary whose elements are copied.

Initializes a new instance that contains elements copied from the specified IDictionary and uses the specified IEqualityComparer.

The IDictionary whose elements are copied. The IEqualityComparer implementation to use when comparing keys, or null to use the default EqualityComparer for the type of the key.

Gets the IEqualityComparer that is used to determine equality of keys for the dictionary.

Gets a collection containing the keys.

Gets a collection containing the values.

Determines whether the HtmlParameterDictionary contains a specific value.

The value to locate. true if the HtmlParameterDictionary contains an element with the specified value; otherwise, false.

Gets or sets the value associated with the specified key.

The key of the value to get or set. The value associated with the specified key. If the specified key is not found, a get operation throws a KeyNotFoundException, and a set operation creates a new element with the specified key.

Determines whether the HtmlParameterDictionary contains the specified key.

The key to locate. true if the HtmlParameterDictionary contains an element with the specified key; otherwise, false.

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 value parameter. true if the HtmlParameterDictionary contains an element with the specified key; otherwise, false.

Adds the specified key and value to the dictionary.

The key of the element to add. The value of the element to add.

Removes the value with the specified key.

The key of the element to remove. true if the element is successfully found and removed; otherwise, false. This method returns false if key is not found.

Gets the number of key/value pairs contained.

Removes all keys and values.

Enumerates the elements of a HtmlParameterDictionary.

Releases all resources used by the HtmlParameterDictionary.Enumerator.

Gets the element at the current position of the enumerator.

Advances the enumerator to the next element of the HtmlParameterDictionary.

true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection.

Returns an enumerator that iterates through the HtmlParameterDictionary.

A HtmlParameterDictionary.Enumerator structure.

A helper filter to give only the HtmlOptions supported by Gecko HTML engine.

Gets the version of the Gecko engine.

The version of the Gecko engine.

The width of the virtual browser in pixels.

A user name to be used for authentication.

A password to be used for authentication.

Whether hyperlinks should be live.

Whether form fields should be live.

Whether movies and other active content should be live.

Whether the location of certain tags should be noted.

Whether the values of form elements, except radio buttons, with the same name are distinct.

Whether font substitution should be used to reduce file size.

Whether fonts should be embedded rather than referenced.

Whether embedded fonts should be subset.

Whether fonts with restricted licensing should be protected from embedding.

The quality of compression acceptable for continuous tone images such as JPEGs.

The maximum amount of time allowed for obtaining a page (ms).

The minimum number of content items required for a page to be valid.

The number of times a page should be retried if unavailable or invalid.

Whether to hide the background color of a page.

A script to be run after the page is loaded.

The request method for URL.

The CSS media to use.

Whether to enable JavaScript and VBScript.

Whether any proxy servers should re-request items of content.

Whether to improve the support for page-break-inside of avoid.

Whether to improve the support for page break in table to prevent missing rows.

Whether to disable the default background color.

Whether to disable the snap rounding of coordinates and lengths.

The minimum width to be used for auto-sized pages.

The options for new worker processes.

Convert external links to internal links wherever possible.

Convert external links to internal links.

Specifies both linkIDs and destIDs. The number of links converted.

Convert external links to internal links.

The list of IDs of view objects containing links (anchor tags with href attributes). The list of IDs of view objects containing destinations (anchor tags with name attributes). Whether links pointing to the URLs of HTML pages (URLs without fragments) are converted to internal links. The default value is false. The number of links converted.

Gets an array of the HTML IDs of tagged visible items.

The Object ID of the object. The IDs of tagged visible HTML objects.

Gets an array of the locations of tagged visible items.

The Object ID of the object. The location of tagged visible HTML objects.

Gets an array of the locations of tagged visible items before Doc.Transform is applied.

The Object ID of the object. The location (before Doc.Transform is applied) of tagged visible HTML objects.

Retrieves the HTTP status code.

The Object ID of the web page to be accessed. The HTTP status code or zero if not available.

Retrieves the client side onload script return value.

The Object ID of the web page to be accessed. The return value.

Ends any HTML Engine worker threads or processes.

The way in which to select threads or processes that should be ended. The number of selected threads or processes.

A helper filter to give only the HtmlOptions supported by Internet Explorer HTML engine.

The width of the virtual browser in pixels.

A user name to be used for authentication.

A password to be used for authentication.

Whether hyperlinks should be live.

Whether form fields should be live.

Whether movies and other active content should be live.

Whether the location of certain tags should be noted.

Whether hyperlinks with targets should be allowed to open in a new browser window.

Whether the values of form elements, except radio buttons, with the same name are distinct.

Whether font substitution should be used to reduce file size.

Whether fonts should be embedded rather than referenced.

Whether embedded fonts should be subset.

Whether fonts with restricted licensing should be protected from embedding.

The quality of compression acceptable for continuous tone images such as JPEGs.

The maximum amount of time allowed for obtaining a page (ms).

The minimum number of content items required for a page to be valid.

The number of times a page should be retried if unavailable or invalid.

Whether content should be rendered in multipaged format.

Whether to hide the background color of a page.

Additional HTTP headers to send in the request.

The user-agent string.

A script to be run after the page is loaded.

The request method for URL.

Whether to disable automatic cookies.

Whether to reload page.

The conditions under which to coerce a vector output.

The conditions under which to disable vector-output coercion.

Whether to host a WebBrowser control.

Whether to deactivate the WebBrowser.

The method for loading URI/HTML.

The module for obtaining URI/HTML data.

Whether to enable JavaScript and VBScript.

Whether to enable ActiveX.

Whether to enable Java.

Whether to enable Video.

Whether to resynchronize page.

Whether any proxy servers should re-request items of content.

Whether to use theme.

Whether not to use theme.

Whether the page cache should be searched first.

The length of time that pages can be held in the cache (ms).

The number of pages that can be held in the cache.

The maximum size at which an image may be regarded as atomic.

Whether HTML pages are marked up before conversion to PDF.

Whether HTML layout is checked and adjusted for optimal output to PDF.

Whether to automatically clip redundant content at the end of the page.

The minimum width to be used for auto-sized pages.

The percentage of the current drawing area in which HTML breaks can occur.

The page break logic for HTML.

The options for new worker processes.

The delegate called during HTML rendering.

The delegate called when embedding an object during HTML rendering.

Sets whether to use theme or not.

Whether to use theme or not.

Sets whether to use theme or not.

Whether to use theme. Whether not to use theme.

Clear all items from the page cache.

Clear all expired items from the page cache.

Convert external links to internal links wherever possible.

Convert external links to internal links.

Specifies both linkIDs and destIDs. The number of links converted.

Convert external links to internal links.

The list of IDs of view objects containing links (anchor tags with href attributes). The list of IDs of view objects containing destinations (anchor tags with name attributes). Whether links pointing to the URLs of HTML pages (URLs without fragments) are converted to internal links. The default value is false. The number of links converted.

Gets an array of the HTML IDs of tagged visible items.

The Object ID of the object. The IDs of tagged visible HTML objects.

Gets an array of the locations of tagged visible items.

The Object ID of the object. The location of tagged visible HTML objects.

Gets an array of the locations of tagged visible items before Doc.Transform is applied.

The Object ID of the object. The location (before Doc.Transform is applied) of tagged visible HTML objects.

Retrieves the HTTP status code.

The Object ID of the web page to be accessed. The HTTP status code or zero if not available.

Retrieves the client side onload script return value.

The Object ID of the web page to be accessed. The return value.

A palette of different colors that may be used. This class allows you to specify how to select colors when image colors are reduced, for example when exporting as an indexed color image.

The type of palette.

An optimized Octree algorithm for fast, high quality color reduction.

A fixed number of colors compatible with Web colors.

A fixed number of colors compatible with Windows colors.

A fixed number of colors compatible with Macintosh colors.

A set of colors uniformly distributed throughout the color space.

Use only grayscale colors.

Only two colors: black and white.

Same as Adaptive but optimized to ensure an exact color match wherever possible.

XPalette constructor. Create a default Adaptive palette with 256 colors.

The type of palette. This property reflects the set of colors that may be used. For example you may wish to select uniformly from the RGB color space or perhaps only from shades of gray.

PaletteType.Adaptive

The palette data If you want to use a raw palette derived from some source other than file then provide the raw data using this property. You may obtain such information by reading an .act file into memory. Raw palettes consist of an array of 768 bytes holding 256 RGB triplets.

The palette fixed colors. Add fixed colors to the palette when you want certain colors to be present in the palette.

Whether to dither colors when exporting. When images are exported at a reduced color depth, they can be dithered. Dithering uses a scattering of pixels of different colors to approximate colors that are not available. In general it is a good idea to dither images like photographs which contain smooth gradations of colors. It is best not to dither 'Posterized' images containing blocks of colors.

The target number of colors in the palette.

The module used for read operations.

A default set of modules.

The SWF vector module.

The XPS module.

The XPS module with the XPS printer driver.

The OpenOffice.org PDF conversion.

The PDF read module.

The SVG vector import module.

The EPS vector import module.

The base raster image import module.

The tiff import module.

The Photoshop import module.

Microsoft Office import module.

WordGlue import module.

Rich Text Format (RTF) import module.

JPEG 2000 (JP2 / JPX) import module.

EMF and WMF vector import module.

Bookmark creation strategy.

Use module-specific default settings.

Do not import any bookmarks from source documents.

Use document headings as bookmarks.

Content items to process.

Use module-specific default settings.

Import only main content.

Import main content and mark-up.

The error-handling option for read operations.

Produces output until an error is encountered.

No output is produced when an error is encountered.

Settings for read operations.

XReadOptions constructor.

Dispose of the XReadOptions.

The module to use.

Bookmark creation strategy.

Content items to process.

The error-handling option.

The password needed to read the source.

The file extension when the source is specified not with a path or a file name.

The import warning and information log.

Indicates whether the transparency of raster images should be preserved.

The timeout for external components.

Whether to enable macros when opening MS Office documents. This property is supported only for Word, Excel and Powerpoint.

Whether the values of form elements with the same name are distinct.

The Operation to use.

The frame to be read from a multiple frame image such as a movie.

Whether form fields should be live.

Whether links should be live.

OpenOffice.org PDF conversion control parameters.

The default document size for documents that do not specify a size.

Whether to try and determine the document size based on the size of the content. Some formats such as SVG contain a viewport wrapper and then a viewbox containing content. The size of the viewport can be specified - much the same as specifying the size of paper something should be printed on. However similarly you can specify the size of the content without specifying the size of the viewport - much the same as saying that the drawing is a certain size without dictating the size of the paper. This is quite a common situation for web output where you want the content to be drawn in a browser window and you do not know what size the user will select for that window. If this property is set to true, the page size will be set to be the same as the content viewbox. This effectively shinks the page to fit the content avoiding excessive white space or clipping. If this property is set to false then the document size is taken from the DefaultRect property and the content is centered on this page. The viewbox size is inserted as the page ArtBox for possible use at a later stage.

The font to use for text that does not specify a font.

Perform extra checks when reading, for importing non-compliant PDF documents.

As far as possible, silently repair corrupt PDF documents during the read process.

Skip back a number of revisions when reading an incrementally saved PDF document.

Whether to automatically open the default document inside a PDF portfolio rather than the portfolio itself. If you wish to see the document the way a user would see it when it opens, them this parameter should be set to true. If you wish to operate upon the set of files embedded in the portfolio then it should be set to false.

The default resolution to use for the import.

Clear cached data and terminate worker threads and worker processes for a read module.

Whether it has taken an action.

Test whether two XReadOptions are the same.

The XReadOption to test against. Whether the two XReadOption are equal.

Test whether the two read options are the same.

The object to test against. Whether the objects are equal.

A hash code for the XReadOption.

The returned hash code.

Creates a deep copy of the current XReadOptions.

Content alignment.

Center.

Left.

Right.

Top.

Bottom.

Content scale mode.

Make the content the biggest and completely within the area while keeping the aspect ratio.

Make the content the smallest and covering the entire area while keeping the aspect ratio.

Scale the content possibly with distortion to fit the entire area.

No scaling.

Raster Smoothing.

Specifies the default algorithm.

Specifies no anti-aliasing.

Specifies anti-aliasing.

LicenseType Enumeration.

Unknown or undefined.

Trial license with professional feature set.

Standard feature set.

Professional feature set.

XSettings Class.

The current license for the software.

The current feature level for the software.

The current license for the software.

The current licensee for the software.

Whether to log errors in the Application Event Log.

The current assembly.

The software version.

Register and install trial license.

A trial license key used for remote deployment.

Install a license. Return true if license is valid.

The license to install. True if a license is installed, otherwise false.

Install a redistribution license. Return true if license is valid.

The license to install. True if a license is installed, otherwise false.

Install a trial license.

The license to install. True if a license is installed, otherwise false.

Install a system license. Return true if license is installed.

The license to install. True if a license is installed, otherwise false.

Set the application configuration section.

The ABCpdf configuration section.

Whether the current license is valid in this particular process.

Load color books for use when rendering spot color images.

The file to load or directory to scan.

An object encapsulating a PDF document.

Document constructor.

Doc destructor.

The ID of the current page.

The ID of the current font.

The current text size (points).

The current line width (points).

The horizontal positioning factor (0 to 1).

The vertical positioning factor (0 to 1).

The current drawing color.

The current drawing position.

The current drawing rectangle.

The page size.

The current text style.

The current default transformation.

The current license details.

The ID of the root catalog.

The content insertion position (one is top).

The number of layers in the current page.

Add a page - return the page ID.

Add a page at a specified location - return the page ID.

Add a font resource - return the font ID.

Add a block of text - return the text ID.

Add a line - return the line ID.

Add an image - return the image ID.

Add an image - return the image ID.

Add an image - return the image ID.

Add an image - return the image ID.

Add an image - return the image ID.

Get a particular type of information about an object.

Get numeric information about an object.

Add a framed rectangle - return the rectangle ID.

Add a filled rectangle - return the rectangle ID.

Delete a specified object.

Save the PDF as a file.

Write the PDF to a stream.

Get the PDF as raw data.

Read an existing PDF from data.

Read an existing PDF from file.

Read an existing PDF from stream.

Embed a font resource - return the font ID.

Alters an aspect of an existing object.

Adds a bookmark for the current page.

Adds a native PDF object to the document.

Flattens and compresses the current page.

Clears the document freeing up resources.

XColor Class.

XColor constructor.

XColor destructor.

A string representation of the color.

A string representation of the color.

The red intensity of the color (0 to 255).

The green intensity of the color (0 to 255).

The blue intensity of the color (0 to 255).

The color as a System.Drawing.Color.

Image class.

Image constructor.

XPoint destructor.

Load an image from a file.

Load an image from data.

Load an image from a stream.

The type of image.

The number of frames in the image.

The currently selected frame.

The width of the current frame (pixels).

The height of the current frame (pixels).

The horizontal resolution of the current frame (DPI).

The vertical resolution of the current frame (DPI).

The current selection rectangle.

Clears the image freeing up resources.

XPoint class.

XPoint constructor.

XPoint destructor.

A string representation of the point.

A string representation of the point.

The horizontal offset of the point from the bottom left.

The vertical offset of the point from the bottom left.

The point as a System.Drawing Point.

XRect class.

XRect constructor.

XRect destructor.

A string representation of the rectangle.

A string representation of the rectangle.

The offset of the top edge from the bottom left.

The offset of the left edge from the bottom left.

The offset of the bottom edge from the bottom left.

The offset of the right edge from the bottom left.

The width of the rectangle.

The height of the rectangle.

Translate the rectangle up and right.

Scale the rectangle, pinning the bottom left corner.

Move the bottom left corner to a position, preserving width and height.

Inset the rectangle horizontally and vertically.

The rectangle as a System.Drawing Rectangle.

XSettings Class.

The current license for the software.

Whether to log errors in the Application Event Log.

XTextStyle class.

XTextStyle constructor.

XTextStyle destructor.

A string representation of the style.

A string representation of the style.

The text size (points).

The first line of paragraph indent (points).

The inter-character spacing (points).

The inter-word spacing (points).

The inter-line spacing (points).

The inter-paragraph spacing (points).

The horizontal justification factor (0 to 1).

Whether to apply an underline.

Whether to apply a strikethrough.

Whether to apply a double strikethrough.

The width of outline to use.

XTransform class.

XTransform constructor.

XTransform destructor.

A string representation of the transform.

A string representation of the transform.

Reset to the identity.

Invert the transform.

Translate horizontally and vertically.

Rotate about a locked anchor point (angle in degrees).

Scale about a locked anchor point.

Skew horizontally and vertically about a locked anchor point.

The transform as a System.Drawing Matrix.

An Atom containing an array of other Atoms.

Create an ArrayAtom from a XRect representation.

The XRect representing the value of the object. The resulting ArrayAtom.

Create an ArrayAtom from a XTransform representation.

The XTransform representing the value of the object. The resulting ArrayAtom.

Create an array of Atoms from a string containing a sequence of PDF objects.

The string holding the sequence of atoms. The resulting ArrayAtom.

Create an array of Atoms from a byte array containing a sequence of PDF objects.

The byte array holding the sequence of atoms. The resulting ArrayAtom.

Create an array of NameAtoms from a list of strings. If the provided list is null then the return value will be null.

The list of strings. The resulting ArrayAtom.

Create an array of StringAtoms from a list of strings. If the provided list is null then the return value will be null.

The list of strings. The resulting ArrayAtom.

Create an array of NumAtoms from aa list of integers. If the provided list is null then the return value will be null.

The list of integers. The resulting ArrayAtom.

Create an array of NumAtoms from a list of doubles. If the provided list is null then the return value will be null.

The list of doubles. The resulting ArrayAtom.

ArrayAtom constructor.

The number of Atoms in the array.

Copies the Atoms into an array.

The array that is the destination for the elements. The zero-based index in array at which copying begins.

Gets or sets the Atom at the specified index.

Gets or sets the integer at the specified index.

Gets or sets the double at the specified index.

Gets or sets the string at the specified index.

Add an Atom to the end of the array.

The Atom to be added. The position in which the new element was inserted.

Add an integer to the end of the array.

The integer to be added. The position in which the new element was inserted.

Add a double to the end of the array.

The floating point value to be added. The position in which the new element was inserted.

Add a string to the end of the array.

The string to be added. The position in which the new element was inserted.

Removes all Atoms from the array.

Determines whether the array contains a specific Atom.

The object to locate. True if the object is found, otherwise false.

Determines the index of a specific Atom.

The object to locate in the Collection. If found, the index of value, otherwise -1.

Inserts an Atom into the array at the specified position.

The zero-based index at which value should be inserted. The Atom to insert into the array.

Removes an Atom from the array.

The Atom to be removed. True if the Atom is removed, otherwise false.

Removes an Atom at a specified position from the array.

The zero-based index of the item to remove.

Gets an enumerator for the Collection.

The enumerator for the collection.

Test whether the two ArrayAtoms are the same.

The ArrayAtom to test against. Whether the ArrayAtoms are equal.

Compares this instance of an ArrayAtom to another and returns an indication of their relative values.

An ArrayAtom to compare against. A signed number indicating the relative value of this instance.

Inserts the elements in the supplied array into this array at the specified index. If the index is equal to the then the elements are added to the end of the array. If the supplied array is null or the index is invalid then an exception will be raised.

The zero-based index at which the new elements should be inserted. The array whose elements should be inserted.

Adds the elements in the supplied array at the end of this array. If the supplied array is null then an exception will be raised.

The array whose elements should be added.

Creates a shallow copy of a range of elements in the source array. If the index or count is invalid then an exception will be raised.

The zero-based index specifying the first element. The number of elements to be selected.

Removes a range of elements from the source array. If the index or count is invalid then an exception will be raised.

The zero-based index specifying the first element. The number of elements to be selected.

Nothing.

Consider ID.

Consider Atom.

A PDF atomic object comprising a basic chunk of PDF data.

Atom destructor.

Create an appropriate type of Atom from a raw PDF string representation.

The string representing the value of the object. The resulting Atom.

Gets the Name value from the Atom if it is a NameAtom.

The Atom to get the name from. The returned name.

Gets the String value from the Atom if it is a StringAtom.

The Atom to get the text from. The returned text.

Gets the Boolean value from the Atom if it is a BoolAtom.

The Atom to get the Boolean from. The returned Boolean.

Gets the Integer value from the Atom if it is a NumAtom.

The Atom to get the integer from. The returned integer.

Gets the Double value from the Atom if it is a NumAtom.

The Atom to get the double from. The returned double.

Gets the Object ID value from the Atom if it is a RefAtom.

The Atom to get the Object ID from. The returned Object ID.

Gets the named entry from the Atom if it is a DictAtom.

The Atom to get the item from. The name of the item to be retrieved. The returned Atom.

Gets the indexed entry from the Atom if it is a DictAtom or ArrayAtom.

The Atom to get the item from. The index of the item to be retrieved. The returned Atom.

Removes the named entry from the Atom if it is a DictAtom.

The Atom from which the item should be removed. The name of the item to be removed.

Adds the named entry to the Atom if it is a DictAtom.

The Atom to which the item should be added. The name of the item to be added. The item to be added. The returned Atom.

Add the indexed entry to the Atom if it is an ArrayAtom.

The Atom to which the item should be added. The index at which the item should be added. The item to be added. The returned Atom.

Test whether the two Atoms are the same.

The Atom to test against. Whether the Atoms are equal.

Test whether the two Atoms are the same.

The object to test against. Whether the objects are equal.

A hash code for the Atom.

The returned hash code.

Compares this instance of an Atom to another and returns an indication of their relative values.

A System.Object that evaluates to an Atom. A signed number indicating the relative value of this instance.

Creates a deep copy of the current Atom.

The newly created copy.

The string representation of the Atom as it would appear in a PDF.

The string representation of the object.

The byte array representation of the Atom as it would appear in a PDF.

The byte array representation of the object.

Dispose of the Atom.

Dispose of the Atom.

An Atom containing a boolean value.

Construct a BoolAtom.

Construct a BoolAtom from a boolean value.

The initial value that the Atom should adopt.

Whether the boolean is true or false.

Test whether the two BoolAtoms are the same.

The BoolAtom to test against. Whether the BoolAtoms are equal.

Compares this instance of a BoolAtom to another and returns an indication of their relative values.

A System.Object that evaluates to a BoolAtom. A signed number indicating the relative value of this instance.

An Atom containing a dictionary of other Atoms indexed by name.

The collection of names in a DictAtom.

Initializes a new instance that reflects the keys in the specified DictAtom.

The DictAtom.

Gets the number of elements contained.

Copies the DictAtom.KeyCollection elements to an existing one-dimensional Array, starting at the specified array index.

The array that is the destination for the elements. The zero-based index in array at which copying begins.

Returns an enumerator that iterates through the DictAtom.KeyCollection.

The enumerator for the key collection.

Enumerates the elements of a DictAtom.KeyCollection.

Releases all resources used by the DictAtom.KeyCollection.Enumerator.

Gets the element at the current position of the enumerator.

Advances the enumerator to the next element of the DictAtom.KeyCollection.

Whether the enumerator was successfully advanced to the next element.

The collection of Atoms in a DictAtom.

Initializes a new instance that reflects the values in the specified DictAtom.

Gets the number of elements contained.

Copies the DictAtom.ValueCollection elements to an existing one-dimensional Array, starting at the specified array index.

Returns an enumerator that iterates through the DictAtom.ValueCollection.

Enumerates the elements of a DictAtom.ValueCollection.

Releases all resources used by the DictAtom.ValueCollection.Enumerator.

Gets the element at the current position of the enumerator.

Advances the enumerator to the next element of the DictAtom.ValueCollection.

DictAtom constructor.

Gets the number of elements in the dictionary.

Copies the Atoms into an array.

The array that is the destination for the elements. The zero-based index in array at which copying begins.

Copies the names and Atoms into an array.

The array that is the destination for the elements. The zero-based index in array at which copying begins.

Gets or set the Atom with the specified key.

Gets or set the integer with the specified key.

Gets or set the double with the specified key.

Gets or set the string with the specified key.

Add an Atom to the dictionary.

The string to use as the key of the element to add. The Atom to be added.

Add an integer to the dictionary.

The string to use as the key of the element to add. The integer to be added.

Add a double to the dictionary.

The string to use as the key of the element to add. The floating point value to be added.

Add a string to the dictionary.

The string to use as the key of the element to add. The string to be added.

Removes all elements from the dictionary.

Determines whether the dictionary contains an element with a specific name.

Remove an element from the dictionary.

The name of the element to be removed.

Get an array of all the names in the dictionary.

An array of all the names in the dictionary.

Get an array of all the Atoms in the dictionary.

An array of all the Atoms in the dictionary.

Get the collection of the keys in the dictionary.

Get the collection of the Atoms in the dictionary.

Gets an enumerator for the Dictionary.

The enumerator for the dictionary.

Test whether the two DictAtoms are the same.

The DictAtom to test against. Whether the DictAtoms are equal.

Compares this instance of a DictAtom to another and returns an indication of their relative values.

A System.Object that evaluates to a DictAtom. A signed number indicating the relative value of this instance.

Enumerates the elements of a DictAtom.

Releases all resources used by the DictAtom.Enumerator.

Gets the element at the current position of the enumerator.

Advances the enumerator to the next element of the DictAtom.

true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection.

An atom representing a name.

Create a name atom.

Create a name atom from a string.

The initial value that the Atom should adopt.

The text of the name.

Test whether the two NameAtoms are the same.

The NameAtom to test against. Whether the NameAtoms are equal.

Compares this instance of a NameAtom to another and returns an indication of their relative values.

A System.Object that evaluates to a NameAtom. A signed number indicating the relative value of this instance.

A null atom.

Create a null atom.

Test whether the two NullAtoms are the same.

The NullAtom to test against. Whether the NullAtom are equal.

Compares this instance of a NullAtom to another and returns an indication of their relative values.

A System.Object that evaluates to a NullAtom. A signed number indicating the relative value of this instance.

An atom representing a numeric value.

Create a number atom.

Create a number atom from an integer.

The initial integer value that the Atom should adopt.

Create a number atom from a floating point value.

The initial floating point value that the Atom should adopt.

The integer value of the number.

The integer value of the number.

The floating point value of the number.

Test whether the two NumAtoms are the same.

The NumAtoms to test against. Whether the NumAtoms are equal.

Compares this instance of a NumAtom to another and returns an indication of their relative values.

A System.Object that evaluates to a NumAtom. A signed number indicating the relative value of this instance.

Encode a number into a PDF string. This format may be needed for direct insertion into a content stream.

The number to convert. The string representation.

An atom which represents a content stream operator.

Create an operator atom.

Create an operator atom for a string.

The operator text.

The text of the operator.

Test whether the two OpAtoms are the same.

The OpAtom to test against. Whether the OpAtoms are equal.

Compares this instance of a OpAtom to another and returns an indication of their relative values.

A System.Object that evaluates to a OpAtom. A signed number indicating the relative value of this instance.

Finds all the OpAtom entries in an array.

The ArrayAtom to be searched. The names and indexes of the OpAtoms that were found.

Finds specified types of OpAtom entries in an array.

The ArrayAtom to be searched. The types of OpAtoms that should be returned. The names and indexes of the OpAtoms that were found.

Gets the parameter associated with the OpAtom at the specified index and validates that the atom is of the correct type. Only the top level atoms are checked. So for example, the TJ operator takes an ArrayAtom consisting of NumAtoms and StringAtoms. This function will ensure that there is one ArrayAtom available as a parameter. However it will not ensure that all items inside the array are NumAtoms or StringAtoms. If the atom is not of the correct type, is not available in the array (eg because the array is too small) or the operator is unrecognized then the return value will be null. If the operator does not take any parameters the return will be null. The Atom is the actual object in the supplied array so changing the value of the Atom will change the value in the array. If the index does not point to an OpAtom or is not inside the array bounds then an exception will be thrown. This function supports all the standard PDF operator types as defined in the PDF Specification apart from BI, ID and EI which are used for inline images. The reason these are not supported is because this sequence is read as a DictAtom with embedded data so you should never encounter it.

The array in which the OpAtom is found. The index to the OpAtom. The parameter for the operator.

Gets the parameters associated with the OpAtom at the specified index and validates that the atoms are of the correct type. Because the arguments are validated and the types are checked so you can rely on the fact that the returned array contains a valid number of Atoms of the correct types. Only the top level atoms are checked. So for example, the TJ operator takes an ArrayAtom consisting of NumAtoms and StringAtoms. This function will ensure that there is one ArrayAtom available as a parameter. However it will not ensure that all items inside the array are NumAtoms or StringAtoms. Also resource lookups are not done so, for example, it is not checked that a font name actualy exists in the font resource dictionay. If the operator takes no parameters a zero length array will be returned. If the operator parameters are incorrect or if the operator is not recognized then the return value will be null. In this unusual situation you may wish to set the to whitespace to remove the invalid operator from the content stream. While this does not fix the underlying problem, it will at least prevent applications like Acrobat from reporting an error.

The array in which the OpAtom is found. The index to the OpAtom. The parameters for the operator.

An atom which references an IndirectObject.

Create a reference atom.

Create a reference atom pointing to a IndirectObject.

The initial IndirectObject that the Atom should point to.

The ID of the referenced IndirectObject.

The generation of the referenced IndirectObject.

Set the IndirectObject that the reference should point to.

The IndirectObject that the RefAtom should point to.

Get the IndirectObject that the reference is pointing to.

The collection of objects to be searched. The matching IndirectObject.

Test whether the two RefAtoms are the same.

The RefAtom to test against. Whether the RefAtoms are equal.

Compares this instance of a RefAtom to another and returns an indication of their relative values.

A System.Object that evaluates to a RefAtom. A signed number indicating the relative value of this instance.

An atom representing a textual value.

Create a string atom.

Create a string atom from a string.

The initial value that the Atom should adopt.

Create a string atom from an array of bytes.

The initial value that the Atom should adopt.

The text of the string.

Test whether the two StringAtoms are the same.

The StringAtom to test against. Whether the StringAtoms are equal.

Compares this instance of a StringAtom to another and returns an indication of their relative values.

A System.Object that evaluates to a StringAtom. A signed number indicating the relative value of this instance.

Encode a string into a PDF string format for use in a content stream using a normal or simple font. Typically you will obtain an appropriate encoding from a FontObject.

The text to be encoded. The encoding to use - typically obtained from the FontObject.GetEncoding method. If null an identify encoding will be used. The StringBuilder to which the encoded representation should be appended. If null then one will be created. The updated StringBuilder.

Encode a string into a PDF string format for use in a content stream using a Composite font with a double byte CMap.

The text to be encoded. The encoding to use - typically obtained from the FontObject.GetEncoding method. If null an identify encoding will be used. The StringBuilder to which the encoded representation should be appended. If null then one will be created. The updated StringBuilder.

Decode a PDF encoded string into a plain string format.

The text to be decoded. The StringBuilder to which the encoded representation should be appended. If null then one will be created. The updated StringBuilder.

Decode a double byte PDF encoded string into a plain string format. This may be necessary if you are looking at a content stream using a Composite font with a double byte CMap.

The text to be decoded. The StringBuilder to which the encoded representation should be appended. If null then one will be created. The updated StringBuilder.

Convert a DateTime into a standard PDF date string.

The PDF date string covers date, time and time zone. The format is broadly similar to ASN.1 as detailed in ISO/IEC 8824. For example, February 3, 2017, at 9:14 PM Pacific Standard Time would be represented as "D:201702032114-08'00". The DateTime to be converted. The standard PDF date string.

Convert a standard PDF date string into a DateTime.

The PDF date string covers date, time and time zone. The format is broadly similar to ASN.1 as detailed in ISO/IEC 8824. For example, February 3, 2017, at 9:14 PM Pacific Standard Time would be represented as "D:201702032114-08'00". The standard PDF date string to be converted. The DateTime.

UnitType Enumeration.

PostScript Points - 1/72 of an Inch.

Twentieths of a Point - 1/20 of a PostScript Point.

Didot Points - 1/72 of a French Royal Inch.

ATA Points - 1/72.272 of an Inch.

TeX Points - 1/72.27 of an Inch.

L'Imprimerie Nationale Points - 0.4 mm.

Picas - 12 PostScript Points.

Ciceros - 12 Didot Points.

ATA Ciceros - 12 ATA Points.

TeX Ciceros - 12 TeX Points.

Microns - millionths of a metre.

Milimeters - thousandths of a metre.

Centimeters - hundredths of a metre.

Meters.

Inches.

Feet.

LanguageType Enumeration.

Latin - the default and most efficient encoding for Western languages.

Unicode - the setting you will most often want to use when embedding foreign character sets.

Korean.

Japanese.

Simplified Chinese.

Traditional Chinese.

CharUsageType Enumeration.

Uses the default characters.

Uses symbol character codes between 0xf000 and 0xf0ff in addition to those between 0 and 255.

The delegate called during HTML rendering.

The delegate called when embedding an object during HTML rendering.

An object encapsulating a PDF document.

Document constructor.

Doc destructor.

Dispose of the Doc.

Dispose of the Doc.

A string representation of the graphic style of the document.

The string representation of the object.

A string representation of the graphic style of the document. This covers the Transform, ColorSpace, Color, Font, TextStyle, Width and Options properties. However it does not cover the Page, Layer, Rect or Pos properties.

The ID of the current page.

The ID of the current font.

The current text size (points).

The current line width (points).

The horizontal positioning factor (0 to 1).

The vertical positioning factor (0 to 1).

The current drawing color.

The current drawing position.

The current drawing rectangle.

The page size.

The visible page size.

The current text style.

The current default transformation.

The current encryption settings.

The current license details.

The ID of the root catalog.

The content insertion position (one is top).

The number of layers in the current page.

Add a page - return the page ID.

The Object ID of the newly added Page Object.

Add a page at a specified location - return the page ID.

The page insertion location. The Object ID of the newly added Page Object.

Add a font resource - return the font ID.

The name of the font typeface. The Object ID of the newly added Font Object.

Add a font resource - return the font ID.

The name of the font typeface. The language type to use. The Object ID of the newly added Font Object.

Add a font resource - return the font ID.

The name of the font typeface The language type to use. Whether the text direction should be vertical. The Object ID of the newly added Font Object.

Add a font resource - return the font ID.

The name of the font typeface. LanguageType enumeration value. The Object ID of the newly added Font Object.

Add a font resource - return the font ID.

The name of the font typeface. LanguageType enumeration value. Whether the text direction should be vertical. The Object ID of the newly added Font Object.

Add a block of text - return the text ID.

The text to be added to the page. The Object ID of the newly added Text Object.

Fit a block of text into the current rectangle - return the text ID.

The text to be added to the page. The Object ID of the newly added Text Object.

Add a block of HTML styled text - return the text ID.

The HTML to be added to the page. The Object ID of the newly added Text Object.

Chain a block of HTML styled text - return the text ID.

A dummy parameter. The contents are not used. The Object ID of a previously added text block. The Object ID of the newly added Text Object.

Fit a block of HTML styled text into the current rectangle - return the text ID.

The HTML to be added to the page. The Object ID of the newly added Text Object.

Measure a block of text - return the length in the current measurement units (typically points).

The text to be measured. The length of the text in the current measurement units (typically points).

Measure a block of text - return the length. This method is unit agnostic so you can use whatever units you like and the result will be returned in terms of those units. However typically you would provide point based measurements.

The text to be measured. The size of the font. The spacing to be applied between each character. The spacing to be applied between each word. Whether a synthetic italic style is to be applied. Whether a synthetic bold style is to be applied. The size of any outline to be applied to the font. The length of the text.

Measure a block of text - return the length. This method is unit agnostic so you can use whatever units you like and the result will be returned in terms of those units. However typically you would provide point based measurements.

The text to be measured. The size of the font. The spacing to be applied between each character. The spacing to be applied between each word. Whether a synthetic italic style is to be applied. Whether a synthetic bold style is to be applied. The size of any outline to be applied to the font. The default width for missing characters in 1000ths of an M. The length of the text.

Add a Form or Image XObject into the current rectangle - return the layer ID.

The image to be added to the page. The Object ID of the newly added Layer Object.

Add a Form or Image XObject into the current rectangle - return the layer ID.

The image to be added to the page. The Object ID of the newly added Layer Object.

Add a line - return the line ID.

The horizontal offset of the start point. The horizontal offset of the end point. The vertical offset of the start point. The vertical offset of the end point. The Object ID of the newly added Graphic Object.

Add an image - return the image ID.

An XImage containing the image to be added to the page. The ID of the newly added Image Object.

Add an image - return the image ID.

An existing image object ID to be copied to the page again. The ID of the newly added Image Object.

Add an image - return the image ID.

The raw JPEG data to be added to the page. The ID of the newly added Image Object.

Add an image - return the image ID.

The raw JPEG data to be added to the page. The page of the document to be added. The ID of the newly added Image Object.

Add an image - return the image ID.

A file path, URL or html string to be added to the page. The ID of the newly added Image Object.

Add an image - return the image ID.

A file path, URL or html string to be added to the page. The page of the document to be added. The ID of the newly added Image Object.

Add an image - return the image ID.

A .NET Bitmap to be added to the page. The ID of the newly added Image Object.

Add an image - return the image ID.

A PDF document page to be added to the page. The page of the document to be added. The source area of the document page to be added. The ID of the newly added Image Object.

Add an image - return the image ID.

A PDF document page to be added to the page. The page of the document to be added. The ID of the newly added Image Object.

Add a Bitmap to the current page - return the image ID.

A .NET Bitmap to be added to the page. Whether transparency information should be preserved. The ID of the newly added Image Object.

Add a copy of an existing image to the current page - return the image ID.

An existing image object ID to be copied to the page again. The ID of the newly added Image Object.

Extract the first image from a chunk of data and add it to the current page - return the image ID.

The data containing the image in a format such as JPEG or TIFF. The ID of the newly added Image Object.

Extract an image from a chunk of data and add it to the current page - return the image ID.

The data containing the image in a format such as JPEG or TIFF. Some image types support multiple frames or pages. This is the one based index specifying the required frame (default one). The ID of the newly added Image Object.

Draw a page from one PDF document onto the current page of this document - return the image ID.

The document to be used as the source. The page you want drawn. Use one to indicate the first page. The portion of the page you want drawn. Pass null to specify the entire page. The ID of the newly added Image Object.

Draw a page from one PDF document onto the current page of this document - return the image ID. Optionally copy annotations and fields where possible.

The document to be used as the source. The page you want drawn. Use one to indicate the first page. The portion of the page you want drawn. Pass null to specify the entire page. Whether to copy fields and annotations. The ID of the newly added Image Object.

Draw a page from one PDF document onto the current page of this document - return the image ID. Optionally copy annotations and fields where possible.

The document to be used as the source. The page you want drawn. Use one to indicate the first page. The portion of the page you want drawn. Pass null to specify the entire page. Whether to copy fields and annotations. The level of alpha to apply to the drawn page from transparent through to fully opaque (0 to 255). The ID of the newly added Image Object.

Extract the first image from a file and add it to the current page - return the image ID.

A file path, URL or html string to be added to the page. The Object ID of the newly added Image Object.

Extract an image from a file and add it to the current page - return the image ID.

A file path, URL or html string to be added to the page. Some image types support multiple frames or pages. This is the one based index specifying the required frame (default one). The Object ID of the newly added Image Object.

Adds an image to the current page - return the image ID.

An XImage containing the image to be added to the page. The ID of the newly added Image.

Adds an image to the current page - return the image ID.

An XImage containing the image to be added to the page. Whether transparency information should be preserved. The ID of the newly added Image.

Add a new page from a paged HTML or PostScript render - return the image ID.

The ID of the previous object in the chain. The ID of the newly added object.

Renders a web page specified by URL - return the image ID.

The HTML to be rendered. The ID of the newly added object.

Renders a web page specified as HTML - return the image ID.

The HTML to be rendered. Allows you to override the default XHtmlOptions.Paged property. Allows you to override the default XHtmlOptions.BrowserWidth property. Allows you to override and disable the page cache. The ID of the newly added object.

Renders a web page specified by URL - return the image ID.

The URL for the page to be rendered. The ID of the newly added object.

Renders a web page specified by URL - return the image ID.

The URL for the page to be rendered. Allows you to override the default XHtmlOptions.Paged property. Allows you to override the default XHtmlOptions.BrowserWidth property. Allows you to override and disable the page cache. The ID of the newly added object.

Get a particular type of information about an object.

The Object ID of the object to be queried. The type of information to be retrieved. The returned information.

Get numeric information about an object.

The Object ID of the object to be queried. The type of information to be retrieved. The returned integer.

Get numeric information about an object.

The Object ID of the object to be queried. The type of information to be retrieved. The returned integer.

Get numeric information about an object.

The Object ID of the object to be queried. The type of information to be retrieved. The returned value.

Get date and time information about an object.

The Object ID of the object to be queried. The type of information to be retrieved. The returned value.

Get date and time information about an object.

The Object ID of the object to be queried. The type of information to be retrieved. The returned value will be in local time if the date includes time zone information, otherwise it will be in UTC. The returned value.

Add a framed rectangle - return the line ID.

The Object ID of the newly added Graphic Object.

Add a framed rounded rectangle - return the line ID.

The horizontal radius to use for rounded corners. The vertical radius to use for rounded corners. The Object ID of the newly added Graphic Object.

Add a framed rounded rectangle - return the line ID.

The horizontal radius to use for rounded corners. The vertical radius to use for rounded corners. Whether to draw the frame inside the rectangle. The Object ID of the newly added Graphic Object.

Add a framed rounded rectangle - return the line ID.

Whether to draw the frame inside the rectangle. The Object ID of the newly added Graphic Object.

Add a filled rectangle - return the line ID.

The Object ID of the newly added Graphic Object.

Add a filled rounded rectangle - return the line ID.

The horizontal radius to use for rounded corners. The vertical radius to use for rounded corners. The Object ID of the newly added Graphic Object.

Delete a specified object.

The Object ID of the object to be deleted.

Save the PDF as a file.

The destination file path.

Write the PDF to a stream.

The destination stream.

Get the PDF as raw data.

The PDF document as an array of bytes.

Get the PDF as raw data stream.

The PDF document as a stream.

Read an existing document from file.

The file path to the PDF, OpenOffice.org, SVG, or XPS document.

Read an existing document from file.

The file path to the PDF, OpenOffice.org, SVG, or XPS document. Any password needed to open the document.

Read an existing document from file.

The file path to the PDF, OpenOffice.org, SVG, or XPS document. The settings for the read.

Read an existing PDF from data.

The source PDF data.

Read an existing PDF from data.

The source PDF data. Any password needed to open the document.

Read an existing PDF from data.

The source PDF data. The settings for the read.

Read an existing PDF from stream.

The source PDF or document stream.

Read an existing PDF from stream.

The source PDF or document stream. Any password needed to open the document.

Read an existing PDF from stream.

The source PDF or document stream. The settings for the read.

Embed a font resource - return the font ID.

The name of the font typeface. The Object ID of the newly embedded Font Object.

Embed a font resource - return the font ID.

The name of the font typeface. The language type to use. The Object ID of the newly embedded Font Object.

Embed a font resource - return the font ID.

The name of the font typeface. The language type to use. Whether the text direction should be vertical. The Object ID of the newly embedded Font Object.

Embed a font resource - return the font ID.

The name of the font typeface. The language type to use. Whether the text direction should be vertical. Whether to subset the font. The Object ID of the newly embedded Font Object.

Embed a font resource - return the font ID.

The name of the font typeface. The language type to use. Whether the text direction should be vertical. Whether to subset the font. Whether to override permissions on the font. The Object ID of the newly embedded Font Object.

Embed a font resource - return the font ID.

The name of the font typeface. LanguageType enumeration value. The Object ID of the newly embedded Font Object.

Embed a font resource - return the font ID.

The name of the font typeface. LanguageType enumeration value. Whether the text direction should be vertical. The Object ID of the newly embedded Font Object.

Embed a font resource - return the font ID.

The name of the font typeface. LanguageType enumeration value. Whether the text direction should be vertical. Whether to subset the font. The Object ID of the newly embedded Font Object.

Embed a font resource - return the font ID.

The name of the font typeface. LanguageType enumeration value. Whether the text direction should be vertical. Whether to subset the font. Whether to override permissions on the font. The Object ID of the newly embedded Font Object.

Alters an aspect of an existing object.

The Object ID of the object to be modified. The type of value to insert. The string value to insert.

Alters an aspect of an existing object.

The Object ID of the object to be modified. The type of value to insert. The integer value to insert.

Alters an aspect of an existing object.

The Object ID of the object to be modified. The type of value to insert. The long value to insert.

Alters an aspect of an existing object.

The Object ID of the object to be modified. The type of value to insert. The double value to insert.

Alters an aspect of an existing object.

The Object ID of the object to be modified. The type of value to insert. The DateTime value to insert.

Alters an aspect of an existing object.

The Object ID of the object to be modified. The type of value to insert. The boolean value to insert.

Adds a bookmark for the current page.

The path to the bookmark. Whether the bookmark should be displayed open (expanded) or closed (collapsed). The Object ID of the newly added Bookmark Object.

Adds a native PDF object to the document.

The raw native object to be added. The Object ID of the newly added Object.

Flattens and compresses the current page.

n/a.

Clears the document freeing up resources.

Clears the cached, decompressed data for stream objects.

Clears the cached, decompressed data for stream objects.

The types of stream objects whose cached, decompressed data are discarded. The default value is All.

Adds an alignment grid to help position objects.

The Object ID of the newly added Grid Object.

The page number (one is the first page).

The number of pages in the document.

Appends a PDF document to the end of the current document.

The document to add to the end of this one.

Add an arc - return the line ID.

The start angle of the arc in degrees. The end angle of the arc in degrees. The horizontal center of the arc. The vertical center of the arc. The horizontal radius of the arc. The vertical radius of the arc. The Object ID of the newly added Graphic Object

Add an arc - return the arc ID.

The start angle of the arc in degrees. The end angle of the arc in degrees. The horizontal center of the arc. The vertical center of the arc. The horizontal radius of the arc. The vertical radius of the arc. Whether to fill the arc rather than simply drawing it. The Object ID of the newly added Graphic Object

The current line options.

The current measurement units.

Whether to measure from the top of the page.

The ID of the current color space.

Add an ICC based color space - return the ID.

The path to the ICC color space file. The Object ID of the newly added ColorSpace Object.

Add a separation color space - return the ID.

The name of the color. The display representation of the color. This should be supplied in the same format as the XColor.String uses. The Object ID of the newly added ColorSpace Object.

Add an oval - return the line ID.

Whether to fill the oval rather than simply outline it. The Object ID of the newly added Graphic Object.

Add a pie slice - return the line ID.

The start angle of the pie slice in degrees. The end angle of the pie slice in degrees. Whether to fill the pie slice rather than simply outline it. The Object ID of the newly added Graphic Object.

Add a polygon - return the line ID.

The coordinates of the vertices of the polygon. Whether to fill the polygon rather than simply outline it. The Object ID of the newly added Graphic Object.

Add a polygon - return the line ID.

The coordinates of the vertices of the polygon. Whether to fill the polygon rather than simply outline it. The Object ID of the newly added Graphic Object.

Add a polygon - return the line ID.

The coordinates of the vertices of the polygon. The index of the first coordinate into the array points. The number of coordinates in the array points to use. Whether to fill the polygon rather than simply outline it. The Object ID of the newly added Graphic Object.

Add a rectangle - return the line ID. Note that this is subtly different from the way that FrameRect works. When a rectangle is framed the line goes around the ouside of the rectangle. When a rectangle is added the line is centered on the rectangle - so half is inside and half is outside.

Whether to fill the rectangle rather than simply outline it. The Object ID of the newly added Graphic Object.

Determine if an object is chainable.

The Object ID of the object to be tested. Whether the object is chainable or not.

Extract content from the current page in a specified format. Prefer the overload accepting a Page.TextType enumeration.

Extract content from the current page in a specified format.

The format in which to return the content. The returned content.

Remap pages for reordering, copying and deletion.

The list of page numbers.

Remap pages for reordering, copying and deletion.

The list of page numbers.

Remap pages for reordering, copying and deletion.

The list of page numbers. The index of the first page number into the array pages. The number of page numbers in the array pages to use.

The PDF Indirect Object Collection.

The HTML and URL rendering options and control.

The save options and control.

The PDF rendering options and control.

The document form and fields.

The top level bookmark for the document.

An Annotation such as a text note or hyperlink.

AnnotationFlags Enumeration.

Do not display the annotation if it does not belong to one of the standard types and no special handler is available.

Do not display or print the annotation or allow it to interact with the user, regardless of its type or whether an annotation handler is available.

Print the annotation when the page is printed. Typically used to hide pushbuttons when a page is printed.

Do not scale the annotation as the zoom level of the page is changed. The top left of the annotation on the page remains fixed regardless of the page zoom level.

Do not rotate the annotation as the page is rotated. The top left of the annotation on the page remains fixed regardless of the page rotation.

Do not show the annotation on the screen or allow it to interact with the user. The annotation may be printed if the Print flag is set.

Do not allow the annotation to interact with the user.

Do not allow the annotation to be moved, deleted or otherwiser modified. However the content may be changed even if this property is set.

Invert the interpretation of the NoView flag for certain events.

Do not allow the contents of the annotation to be modified. Other annotation properties such as size and location may be modified.

Test whether the two Annotations are the same.

The Annotation to test against. Whether the Annotations are equal.

The sub-type of Annotation.

The visible text of the annotation.

The full name of any form field associated with this annotation.

The field type of any form field associated with this annotation.

The value of any form field associated with this annotation.

The rotation of the annotation in degrees counterclockwise to the page - a multiple of 90. This property is only valid if this annotation is associated with a form field. After changing this property you will need to call to realize the change.

The background color of the field. This color must be grayscale, RGB or CMYK. If it is null then the background is transparent. This property is only valid if this annotation is associated with a form field. When you set this property a clone of the XColor you assign is created to avoid one XColor being shared by multiple annotations. After changing this property you will need to call to realize the change.

The border color of the field. This color must be grayscale, RGB or CMYK. If it is null then the border is transparent. This property is only valid if this annotation is associated with a form field. When you set this property a clone of the XColor you assign is created to avoid one XColor being shared by multiple annotations. After changing this property you will need to call to realize the change.

The border appearance. This property is a three or four element array. The first three elements describe the horizontal corner radius, the vertical corner radius and the border width. If the corners are zero then the border has rectangular rather than rounded corners. If the border width is zero then there is no border. The last optional element is a dash array to be used in drawing dashed borders. This conforms to the standard dash array format which indicates alternatingly the length of lines and gaps. So [2 1] would indicate two on, one off, two on, one off... Longer arrays can be used for more complex dash patterns. If this property is null then a solid rectangular border of width one will be drawn. This is equivalent to the following code: annot.Border = (ArrayAtom)Atom.FromString("[0 0 1"); // C# annot.Border = DirectCast(Atom.FromString("[0 0 1]"), ArrayAtom) ' VB.NET After changing this property you will need to call to realize the change.

The possible values for any form field associated with this annotation.

The Page on which this annotation is located.

The rectangle which defines the position and area of the annotation on the page.

The default text direction.

Update the Appearance Stream for this Annotation.

Stamp this Annotation into the page.

Prepare document for drawing at the Annotation location.

True if the focus operation was successful.

The Annotation Flags entry.

Dispose of the Annotation.

A bookmark or outline item.

Test whether the two Bookmarks are the same.

The Bookmark to test against. Whether the Bookmarks are equal.

Whether the bookmark appears open or closed.

The parent of this bookmark.

The destination Page associated with this bookmark.

The destination Page ID associated with this bookmark.

The bookmark title to be displayed on screen.

Refresh and reload the document bookmarks.

Adopt a specified bookmark.

The bookmark to be adopted.

The number of Bookmarks in the collection.

Copies the Bookmarks into an array.

The array that is the destination for the elements. The zero-based index in array at which copying begins.

Gets or sets the Bookmark at the specified index.

Add a Bookmark to the end of the list.

The bookmark to be added. The position in which the new element was inserted.

Add a Bookmark to the end of the list.

The title for the bookmark to be added. The position in which the new element was inserted.

Removes all child Bookmarks.

Determines whether the array contains a specific Bookmark.

The object to locate. True if the object is found, otherwise false.

Determines the index of a specific Bookmark.

The object or the title of the object to locate in the Collection. If found, the index of value, otherwise -1.

Determines the index of a specific Bookmark.

The object or the title of the object to locate in the Collection. If found, the index of value, otherwise -1.

Inserts a Bookmark into the list at the specified position.

The zero-based index at which value should be inserted. The bookmark to be added.

Inserts a Bookmark into the list at the specified position.

The zero-based index at which value should be inserted. The title for the bookmark to be added.

Removes a Bookmark.

The Bookmark to be removed. True if the Bookmark is removed, otherwise false.

Removes a Bookmark at a specified position.

The zero based index specifying the Bookmark to be removed.

Gets an enumerator for the Collection.

The enumerator for the collection.

The Catalog for the document.

Test whether the two Catalogs are the same.

The Catalog to test against. Whether the Catalogs are equal.

The root Pages Object.

The root Outlines Object.

The names of all the eForm fields in the document.

The names of all the eForm fields in the document.

Get all the eForm fields in the document.

The names of all the eForm fields in the document.

Perform whole document analysis of page contents.

Gets all the fonts in this document.

All the fonts in the document.

Gets all the embedded files in this document. PDF documents can contain a set of named files. These files can then be referenced by name elsewhere in the document. The most common case in which named files are used is in the case of PDF portfolios. Adobe now uses the name Portfolio for this type of document but in the PDF specification they are known as Portable Collections. While the names may vary two are the same. PDF Portfolios appear as one PDF document but actually contain many. Typically the first document represents the visible face of the collection when opened. After the collection is open you can switch between the embedded PDFs. PDF portfolios can be used to represent a folder of PDFs. For example you might find a portable collection being used to display multiple emails within a single PDF Portfolio.

All the files embedded in the document.

ColorSpaceType Enumeration.

Unknown or undefined.

Device dependent Gray.

Device dependent RGB.

Device dependent CMYK.

Calibrated Gray.

Calibrated RGB.

ICC Color Profile Based.

Lab.

Indexed Color.

Pattern.

Separation.

DeviceN.

A color space.

ColorSpace constructor.

The ObjectSoup to contain the newly created StreamObject.

ColorSpace constructor.

The ObjectSoup to contain the newly created StreamObject. The type of color space required.

Test whether the two ColorSpaces are the same.

The ColorSpace to test against. Whether the ColorSpaces are equal.

The type of color space.

Any name associated with the color space.

The number of color components in the color space.

The type of color space.

The base type of color space. For non-indexed color spaces this will always be the same as the ColorSpaceType.

The white point for the color space specified in CIE 1931 XYZ space. X and Y must be positive and Z must be one. The default for this peroperty is 0 0 0. When you set this property a clone of the XColor you assign is created to avoid one XColor being shared by multiple fields.

The black point for the color space specified in CIE 1931 XYZ space. All components for this valud must be non-negative. The default for this peroperty is 0 0 0. When you set this property a clone of the XColor you assign is created to avoid one XColor being shared by multiple fields.

The gamma correction for the color space. Gamma is defined for each component of a calibrated color space. So for a CalGray color space it has one entry and for a CalRGB color space it has three. This means that for a CalGray color space this property will be a NumAtom and for a CalRGB color space it will be an ArrayAtom with three entries. Gamma is not valid for other color spaces. Each gamma entry must be positive and is generally greater than or equal to one.

Any ICC Color Profile associated with this color space.

An EmbeddedFile represents a file stream embedded inside a PDF document. It includees a small amount of metadata such as, optionally, the file creation and modification date. However it is primarily related to file data.

EmbeddedFile constructor.

The ObjectSoup to contain the newly created EmbeddedFile.

EmbeddedFile constructor. This constructor takes a path to a file. The file data will be inserted into the this object, appropriate metadata will be added using the function and the data will be compressed using the function.

The ObjectSoup to contain the newly created StreamObject. A path to a file containing data which should be placed in the EmbeddedFile.

EmbeddedFile constructor. This constructor takes a byte array. The data will be inserted into the this object, and the data will be compressed using the function.

The ObjectSoup to contain the newly created StreamObject. An array of bytes which should be placed in the EmbeddedFile.

Test whether the two EmbeddedFiles are the same.

The EmbeddedFile to test against. Whether the EmbeddedFiles are equal.

Update properties like the ModificationDate, CreationDate and Size to reflect the file values. The EmbeddedFile must be part of an ObjectSoup or an exception will be thrown.

A path to a file containing data. If null is passed the data will be cleared.

The subtype of the embedded file. This property is represented via a and hence it cannot take an empty string. Setting this property to an empty string will set it to null.

The size of the embedded file.

The creation date of the embedded file.

The modification date of the embedded file.

The 16 byte checksum for the embedded file.

The Macintosh file type - a four char code represented as an integer.

The Macintosh file creator - a four char code represented as an integer.

The Macintosh resource forks stream for this file.

FieldType Enumeration.

Pushbutton Type.

Checkbox Type.

Radio Type.

Text Type.

List Type.

Combo Type.

Signature Type.

Unknown Type.

A field in a PDF form.

Field Flags Enumeration.

Do not let the user change the value of the field.

Require that the field has a value at the time it is exported by a form submission action.

Do not export the value of the field as part of a form submission action.

This is used for radio buttons and specifies that exactly one button shall be selected at all times.

Indicates whether the field is a radio button or a checkbox. This field is ignored if the Pushbutton flag is set.

Whether this field is a pushbutton that stores no permanent value.

Allow radio buttons with the same 'on' value to turn on and off together.

Allow a text field to contain multiple lines of text.

Display text field as a password box in which the text contents are obscured.

Display a text field that allows a file to be selected. When the form is submitted the contents of the file will be used as the value of the field.

Text in this text or choice field shall not be spell checked.

Text in this text field shall not scroll. Once text has been entered which fills the field it shall accept no further characters.

Use the MaxLen property to equally space out text field characters into a comb-like slot position.

The value of this text field shall be a rich text string.

Whether this field is a combo or list field.

Whether field shall present an editable text box in addition to a list.

Whether entries in the list shall be put into alphabetical order.

Whether more than one entry in the list can be selected at the same time.

A change to the value of this field will be committed as soon as it is made.

Test whether the two Fields are the same.

The Field to test against. Whether the Fields are equal.

The value of the field.

The type of the field.

The possible values for this field.

The fully qualified field name.

The Page on which this field is located.

The ID of the Page on which this field is located.

The Parent of this field.

The rectangle which defines the position and area of the annotation on the page.

All the immediate children of this field.

Prepare document for drawing at the field location.

True if the focus operation was successful.

Stamp this field into the document.

Gets all the Annotations referenced by this field or its children.

Gets all the Fields that are descendents of this one.

The maximum depth to search. One for immediate children. Two for children and grandchildren. etc

The partial field name.

The format for this field.

Whether the field supports multiple selections.

The Field Flags (Ff) entry.

QuaddingType Enumeration.

Left aligned text.

Center aligned text.

Right aligned text.

The alignment for the text. Getting this property gets the effective value which may be inherited. Setting this property sets the alignment on this item itself. This feature is referred to as quadding within the Adobe PDF Specification. We call it alignment because quadding is not normal terminology. The appearance of the field is not updated until you change the or call .

The default appearance (DA) used for the text. This property controls the base set of drawing instructions used for controlling the appearance of variable text in a field. Getting this property gets the effective value which may be inherited. Setting this property sets the value on this item itself. Similarly setting this property to null will remove the property on the item itself but the value may continue to be inherited. The appearance of the field is not updated until you change the or call .

The font used for the text. This is derived from the for the field. Getting this property gets the effective value which may be inherited from a parent field or from document defaults. To change this property use the function.

The font size used for the text. This is derived from the for the field. Getting this property gets the effective value which may be inherited from a parent field or from document defaults. To change this property use the function.

Sets the font and font size to be used for text. Callng this function works by changing the for the field. Properties such ase the and gets the effective value which may be inherited. Calling this funtion sets the value on this item itself which will override any inherited value. Passing a font value of null will remove both the font and size from the item itself though a value may be still be present if it is inherited from a parent field or from document defaults. A zero size font indicates that the font should scale so that it fits the size of the field. Negative font heights appear the same as positive ones but are best avoided as they are likely to cause confusion. The appearance of the field is not updated until you change the or call .

The color used for the text. This is derived from the for the field. Getting this property gets the effective value which may be inherited. Setting this property sets the value on this item itself. When you set this property a clone of the XColor you assign is created to avoid one XColor being shared by multiple fields. The appearance of the field is not updated until you change the or call .

Update the Appearance Stream for all the Annotations associated with this field.

The export values for this field. Choice fields such as Combo boxes and Lists have a value selected from one of their Options. However it is possible to specify an export value which is different from the value of field. The export value will be used if the form data is exported or submitted in some way so it is purely for external use. This function allows you to get the export values from the field. Please note that export values are only meaningful for fields of FieldType FieldType.Combo or FieldType.List and they are only relevant for form export.

An array of strings - one for each option. The size of the array is always equal to the number of options.

Dispose of the Field.

A collection of Fields.

The number of Fields in the collection.

Copies the Fields into an array.

The array that is the destination for the elements. The zero-based index in array at which copying begins.

Gets or sets the Field at the specified index.

Gets or sets the Field of the specified name.

Add a Field to the end of the list.

The item to be added. The position in which the new element was inserted.

Removes all child Fields.

Determines whether the list contains a specific Field.

The object to locate. True if the object is found, otherwise false.

Determines the index of a specific Field.

The object to locate in the collection. If found, the index of value, otherwise -1.

Inserts a Field into the list at the specified position.

The zero-based index at which value should be inserted. The item to insert into the array.

Removes a Field.

The name of the element to be removed. True if the Field is removed, otherwise false.

Removes a Field at a specified position.

The zero-based index of the item to remove.

Gets an enumerator for the Collection.

The enumerator for the collection.

A file specification represents the name and location of a file and optionally may also include references to embedded data.

FileSpecification constructor.

The ObjectSoup to contain the newly created FileSpecification.

FileSpecification constructor. This constructor takes a path to a file. The file data will be inserted into the this object, appropriate metadata will be added using the function and the data will be compressed using the CompressFlate function.

The ObjectSoup to contain the newly created FileSpecification. This should not be null. A file to embed within the file specification. Thrown if the soup is null.

Test whether the two FileSpecifications are the same.

The FileSpecification to test against. Whether the FileSpecifications are equal.

A description of the file for use in a user interface.

The default platform being used for the file specification. For historic reasons PDF has supported multiple different files for multiple different platforms. This was appropriate when files were often non-interoperable and would not port easily between machines. Fortunately this state of affairs is now unusual and only the default "UF" platform is commonly used. Adobe do not specify what the initials stand for, but it is likely to be Unicode File, though it could be Universal File or URL File. While you are unlikely to wish to create documents which use these obsolescent platforms, you may find old documents that use them. This method allows you to access information specified by platform. Appropriate selectors are "UF", "F", "DOS", "Mac" or "Unix" as per the descriptions in the Adobe PDF Specification. You can use the Platforms property to deterine which are being used. The defaut of "UF" provides access via the standard settings as specified in the PDF 1.7 specification.

The URI to the file. For the default plaform, attempting to set this property to a value which is nov a valid URI will result in an exception being thrown. To convert a standard Windows path to a URI use (new System.Uri(path).AbsouteUri. For some values of the Platform property (eg Mac, DOS, Unix) raw file paths can be used. However these are obsolete and while you may see PDFs which contain them, you would be inadvised to generate new documents containing these structures.

The embedded file if one has been embedded in the PDF. If a file has not been embedded then the URL needs to be intepreted in the context of the current PDF to locate the external file. Setting this property will clear the EmbeddedFiles property if one is present. This property references another in the Doc. So if this object is not part of a Doc then this property will always be null.

The set of embedded files if a set has been embedded in the PDF. Normally a file specification will refer to one file. However in some situations it may be necessary to allow it to refer to multiple. For example if a CMYK image is available as four color separations then it may be useful to be able to embed four different files to make up the whole data set. Each file will need a name so this property reflects both the name and the content of each file. If the EmbeddedFiles property has a value, then the first file in the array should always be the same as the EmbeddedFile property. For this reason setting this property will also set the EmbeddedFile property to be equal to the first file in the array. If there are no items in the array then the EmbeddedFile property will be cleared.

This property references other objects in the Doc. So if this object is not part of a Doc then this property will always be null.

Whether the file changes frequently and needs to be reloaded each time it is used, or if it is not and may be cached.

Removes any obsolescent and redundant entries and converts this object to the PDF 1.7 standard.

Get the path to the file for the specified platform. If there is no matching path then null will be returned.

Set the path to the file for the specified platform. Setting to null will remove the path.

A specific font as used in the document.

The font writing mode type.

Horizontal writing mode.

Vertical writing mode.

The support for encoding text.

Encode all text.

Encode nothing if any character is not included in the font.

Encode up to and excluding the first character not included in the font.

Font Descriptor Flags Enumeration.

All glyphs have the same width; as opposed to proportional or variable-pitch fonts, which have different widths.

Glyphs have serifs - short strokes drawn at an angle on the top and bottom of glyph stems. Sans serif fonts do not have serifs.

Font contains glyphs outside the Adobe standard Latin character set. This flag and the Nonsymbolic flag are mutually exclusive.

Glyphs look like cursive handwriting.

Font uses the Adobe standard Latin character set or a subset of it.

Glyphs have slanted dominant vertical strokes.

Font contains no lowercase letters.

Lower case letters in this font look like smaller versions of their upper case equivalents.

Whether bold glyphs shall be painted with extra pixels even at very small text sizes.

Test whether the two FontObjects are the same.

The FontObject to test against. Whether the FontObjects are equal.

The font writing mode.

Encode text for use with PDF text operators.

The text to be encoded. The way in which characters not included in the font are to be encoded. The PDF string containing the encoded text.

Encode text for use with PDF text operators.

The text to be encoded. The way in which characters not included in the font are to be encoded. The number of characters in (parameter) text that are encoded in the return value. The PDF string containing the encoded text.

Subset a previously embedded font.

Whether subsetting was performed succesfully.

Subset a previously embedded font to include only those characters in the provided string.

Attempt to regenerate a ToUnicode map.

Whether a new ToUnicode map was generated.

Whether the font contains an embedded subset.

The PostScript name of the font.

Whether to exclude invalid glyphs from our lookup tables. When fonts are subsetted the glyphs in the tables may be rendered invalid because they are not used. By default we attempt to detect such glyphs and exclude them from any operations or font properties.

The unicode to glyph mapping table for all the characters in the font.

The glyph to unicode mapping table for all the characters in the font.

The glyph to unicode string mapping table for all the characters in the font that contain one. This should be viewed as a supplement and an override for the GlyphToUnicode and UnicodeToGlyph mappings.

The character widths in thousandths of a unit for all the characters in the font.

The bounding box for the glyphs in this font. This corresponds to the xMin, xMax, yMin and yMax entries in the 'head' TrueType table. The PDF format only supports a limited range of metrics so FontObjects read from PDF may contain some approximations compared with 'live' FontObjects which have been added using the Doc.AddFont or Doc.EmbedFont methods.

The line spacing for the glyphs in this font. This broadly reflects the distance in 1000ths between the bottom of the lowest descender and the top of the highest ascender on two subsequent lines. We follow Microsoft best practice on this metric and vary the calculations depending on whether bit 7 of the fsSelection entry in the 'OS/2' TrueType table is set or not. However it is worth noting that many items of software including Microsoft flagship products do not. The PDF format only supports a limited range of metrics so FontObjects read from PDF may contain some approximations compared with 'live' FontObjects which have been added using the Doc.AddFont or Doc.EmbedFont methods.

The line gap for the glyphs in this font. This corresponds to the sTypoLineGap entry in the 'OS/2' TrueType table.

The PDF format only supports a limited range of metrics so FontObjects read from PDF may contain some approximations compared with 'live' FontObjects which have been added using the Doc.AddFont or Doc.EmbedFont methods.

The ascent for the glyphs in this font. This corresponds to the usWinAscent entry in the 'OS/2' TrueType table.

The PDF format only supports a limited range of metrics so FontObjects read from PDF may contain some approximations compared with 'live' FontObjects which have been added using the Doc.AddFont or Doc.EmbedFont methods.

The descent for the glyphs in this font. This corresponds to the usWinDescent entry in the 'OS/2' TrueType table.

The PDF format only supports a limited range of metrics so FontObjects read from PDF may contain some approximations compared with 'live' FontObjects which have been added using the Doc.AddFont or Doc.EmbedFont methods.

The ascender for the glyphs in this font. This corresponds to the sTypoAscender entry in the 'OS/2' TrueType table.

The PDF format only supports a limited range of metrics so FontObjects read from PDF may contain some approximations compared with 'live' FontObjects which have been added using the Doc.AddFont or Doc.EmbedFont methods.

The descender for the glyphs in this font. This corresponds to the sTypoDescender entry in the 'OS/2' TrueType table.

The PDF format only supports a limited range of metrics so FontObjects read from PDF may contain some approximations compared with 'live' FontObjects which have been added using the Doc.AddFont or Doc.EmbedFont methods.

Whether the font is a complex composite font.

Whether the font is a descendent of a complex composite font.

Whether the font is a composite glyph encoded identity font.

The Font Descriptor Flags entry.

Whether the font is for vertical writing.

Search for and automatically embed a font file into this font object. If an existing font file is already embedded it will be replaced. If you wish to subset the font you will need to call the Subset method after Embedding the font. Calling this function on Identity encoded fonts should be done with great caution as thse types of fonts rely on glyph IDs and are thus specific to a particular font file.

Whether a font file was embedded as a result of this operation.

The embedded font file.

Unembed the font if this is a simple operation. Latin based fonts can often be unembedded as a simple and fast operation. However Unicode and symbolic fonts are more complex to unembed and cannot be simply removed from the document.

The number of bytes of font data that were removed as a result of this call. Note that if multiple font objects reference the same embedded font then the same number may be returned multiple times.

Obtain a standard encoding dictionary for use with PDF text operators.

The language type for the desired encoding. Whether the writing direction should be horizontal or vertical. A dictionary mapping Unicode values to native character IDs.

A Form XObject is a self contained stream of graphics operations which can be referenced as a group.

FormXObject constructor.

The ObjectSoup to contain the newly created FormXObject.

Test whether the two FormXObjects are the same.

The FormXObject to test against. Whether the FormXObjects are equal.

The rect defining the bounding box of the graphic. Content will be clipped to this area.

The transformation matrix used for mapping the Form XObject space into user space. This entry may be null which signifies the identity matrix.

Get a dictionary mapping the names of a particular type of resource to Atoms.

The type of resource to be indexed. A dictionary mapping resource names to Atoms.

Get a dictionary mapping the names of a particular type of resource to Atoms.

The type of resource to be indexed. Whether to include resources from other Form XObjects referenced from this one. Whether to include resources from Patterns referenced from this Form XObject. A set of IDs indicating IndirectObjects that should be skipped. This value may be null if you do not want to skip any items. A set of IDs of all the resources that have been encountered. The set of resources is generally the same as the set of items in the returned dictionary, but may not be if resource names have clashed. This value may be null if you are not interested in the set. A dictionary mapping resource names to Atoms.

Add a particular type of resource.

The resource to be added. The type of resource. The format of the name that should be used. The actual name that was used.

A specific GraphicLayer as used in the document.

Test whether the two GraphicLayers are the same.

The GraphicLayer to test against. Whether the GraphicLayers are equal.

A pre-specified graphics state.

Test whether the two GraphicsStates are the same.

The GraphicsState to test against. Whether the GraphicsStates are equal.

An ICC Color Profile.

IccProfile constructor.

The ObjectSoup to contain the newly created IccProfile. A path to an ICC file.

IccProfile constructor.

The ObjectSoup to contain the newly created IccProfile. An ICC profile stored in an array of bytes.

Test whether the two IccProfiles are the same.

The IccProfile to test against. Whether the IccProfiles are equal.

Set the raw binary content of the stream.

The raw binary content of the stream.

Updates this object to reflect the values contained within the embedded ICC color profile data.

The alternate color space for this ICC color profile. This represents the base non-ICC color space.

A rendition of a image on a page.

Test whether the two ImageLayers are the same.

The ImageLayer to test against. Whether the ImageLayers are equal.

The PixMap containing the image data.

The name used to identify the PixMap in the Page resources.

The clipping path to be applied to the image.

ComparisonType Enumeration.

Nothing.

Consider ID.

Consider ID.

Consider Atom.

Consider Data.

A PDF Indirect Object.

Construct an appropriate type of IndirectObject given a string value.

The string representing the value of the object. The resulting IndirectObject.

IndirectObject constructor.

IndirectObject destructor.

Whether the two IndirectObjects are the same.

The object to test against. Whether the objects are equal.

Test whether the two IndirectObjects are the same.

The IndirectObject to test against. Whether the IndirectObjects are equal.

Test whether the data in two IndirectObjects is the same. The comparison type specifies the type of data to compare. Only if all the comparisons are true are the objects said to be equal.

The IndirectObject to test against. Whether the IndirectObjects are equal.

Creates a deep copy of the current IndirectObject.

The newly created copy.

Transcodes and reloads the IndirectObject. Normally transcoding takes place automatically as objects are added. However sometimes changes occur after the even which may result in core aspects of the object changing. These changes may require caches to be regenerated or even an entirely new object to be created - one which better represents the new underlying structure of the PDF data. This is particualy the caes for the FontObject class which implements a lot of caching and is often dependent on other objcts in the soup. If transcoding results in a new object being created it will displace the current object from the soup. As such you will noremlly discard the old reference if a new IndirectObject is returned.

An appropriate subclass of IndirectObject.

A hash code for the IndirectObject.

The returned hash code.

A hash code derived from this IndirectObject. The hash code can be made up of a variety of parts of the indirect object combined together. The ID and the Atom hash codes are derived from the value of the ID and Atom respectively. The Data hash code is made from a sample of the compressed data contained in the stream. For this reason two StreamObjects, compressed differently, will return different hash codes even if the uncompressed data is identical. The data sample is kept small - in the order of a few hundred bytes - to ensure a fast response even for very large streams.

The returned hash code.

The string representation of the IndirectObject.

The string representation of the object.

Dispose of the IndirectObject.

Dispose of the IndirectObject.

The ID of the PDF object.

The Generation of the PDF object.

The revision of the document in which this object is stored. One is the oldest update and larger values are more recent. A value of zero indicates that the object was not read from stream.

The minimum version of the PDF specification required to support this object.

The minimum extension level of Adobe Supplement to the PDF specification required to support this object.

Whether the IndirectObject is currently alive.

The atom contained by the IndirectObject.

Resolves any indirect references and returns the Atom.

The Atom to resolve. The final Atom or null if no Atom could be found.

Resolves any indirect references and returns the final RefAtom.

The Atom to resolve. The final RefAtom or null if no valid RefAtom could be found.

Resolves any indirect references and returns the final IndirectObject.

The Atom to resolve. The final IndirectObject or null if no valid object could be found.

The Doc containing this IndirectObject.

The ObjectSoup containing this IndirectObject.

A layer of visible content.

Test whether the two Layers are the same.

The Layer to test against. Whether the Layers are equal.

The Page on which the Layer is located. While Layers are normally only referenced from one page, it is possible to reference them from multiple. This property reflects the orginal Page for which this layer was created.

The transform which has been applied to the visible content.

The transformed rect defining the bounds of the visible content on the page.

The untransformed rect defining the bounds of the visible content on the page.

The collection of IndirectObjects for a PDF.

ObjectSoup destructor.

Dispose of the Collection.

Gets the number of items in the Collection.

Gets the number of incremental updates. No object in the collection will have a Revision higher than this.

Copies the objects in the Collection to an Array.

The array that is the destination for the elements. The zero-based index in array at which copying begins.

Gets or sets the object at the specified index.

Adds an object to the Collection.

The IndirectObject to be added. The position in which the new element was inserted.

Removes all objects from the Collection.

Determines whether the Collection contains a specific object.

The object to locate. True if the object is found, otherwise false.

Determines the index of a specific object.

The object to locate in the Soup. If found, the index of value, otherwise -1.

Inserts an object into the Collection at the specified position.

The zero-based index at which value should be inserted. The Object to insert into the Soup.

Removes an object from the Collection.

The IndirectObject to be removed. True if the IndirectObject is removed, otherwise false.

Removes an object at a specified position from the Collection.

The zero-based index of the item to remove.

Gets an enumerator for the Collection.

The enumerator for the collection.

The Catalog for the document.

The Trailer or XRef for the document.

A set of IndirectObjects from an ObjectSoup. This may be used for selecting related objects and copying them to a new soup while maintaining the relationships between the items in the selection.

ObjectSet constructor.

The soup from which objects will be selected.

Gets a dictionary used to redirect all objects of a specific type to a specific object ID.

Gets the dictionary used to map object IDs from the source soup to new object IDs in the final soup. Some mappings may be populated via the RemapTypes as IndirectObjects are added. Most will be populated at the point that the CopyTo method is called.

Gets the collection of IndirectObjects currently contained in the subset.

Add a parent object along with all objects it refers to.

The IndirectObject to be added. The number of objects that were added.

Add all the objects this dictionary refers to.

A dictionary atom to be added. The number of objects that were added.

Add just this object ignoring any objects it may refer to.

The IndirectObject to be added. True if the item was added.

Copy the objects in this subset to a new soup while preserving the relationships between the items in the selection.

The destination soup.

The top level outline item.

Test whether the two Outlines are the same.

The Outline to test against. Whether the Outlines are equal.

A visible page within the document.

TextType Enumeration.

Unicode Text.

Unicode Text without features like inferred spaces and de-hyphenation.

Scalable Vector Graphics (SVG).

Scalable Vector Graphics (SVG). Extra attributes related to PDF drawing operators.

Scalable Vector Graphics (SVG). Extra attributes related to PDF drawing operators. Form XObject content included.

Test whether the two Pages are the same.

The Page to test against. Whether the Pages are equal.

The parent of this page.

The number of degrees to rotate the page before display. Should be a multiple of 90.

The page number (one is the first page).

Detaches a content stream from the page.

The stream to detach from the page.

Gets all the named separations referenced by the page.

An array of the names of the separations.

Gets all the content Layers for the page.

An array of all the content Layers on the page.

Gets all the Annotations on the page.

An array of all the Annotations on the page.

Converts the page from one color space to another.

The destination color space. Whether to convert the color space of annotation appearance streams.

Converts the page from one color space to another.

The destination color space. Whether to convert the color space of annotation appearance streams. All the PixMaps which were recolored as a result of the call.

Makes any inline images into external images.

Makes any inline images into external images. Return the extracted images.

Replaces the content stream of a page containing text to one containing glyph outlines.

Extract content from the current page in a specified format.

Extract content from the current page in a specified format.

Extract content from selected layers of the current page in a specified format.

Flatten and compress the page content stream.

Whether to force the flattening even if the streams contain extra information which might be lost. Whether the page is flat.

Flatten the page content stream.

Whether to force the flattening even if the streams contain extra information which might be lost. Whether to compress the resulting stream or whether to leave it as undetermined compression. Whether the page is flat.

Get all the resources of a named type, optionally including any used by referenced objects.

The type of resource to be found. Whether to include resources in annotations. Whether to include resources in referenced Form XObjects. Whether to include resources in pattern dictionaries. Whether to include resources in parent objects. A set of IndirectObject IDs that should be skipped when performing the scan. May be null. A set of matching resource Atoms.

Get a dictionary mapping the names of a particular type of resource to Atoms.

The ID of the resource containing object. This is typically the Page ID but you may also use a Form XObject ID. The type of resource to be indexed. A dictionary mapping resource names to Atoms.

Get a dictionary mapping the names of a particular type of resource to Atoms.

The ID of the resource containing object. This is typically the Page ID but you may also use a Form XObject ID. The type of resource to be indexed. Whether to include resources from Annotations on the page (assuming the containing object is a page). Whether to include resources from Form XObjects referenced from this containing object. Whether to include resources from Patterns referenced from this containing object. Whether to include resources from parents of this page (assuming the containing object is a page). A set of IDs indicating IndirectObjects that should be skipped. This value may be null if you do not want to skip any items. A set of IDs of all the resources that have been encountered. The set of resources is generally the same as the set of items in the returned dictionary, but may not be if resource names have clashed. This value may be null if you are not interested in the set. A dictionary mapping resource names to Atoms.

Makes a FormXObject out of the page.

Removes all FormXObjects from the page by embedding them into the content. Most Form XObjects can be embedded in the page with no difference in page appearance. However Form XObjects such as transparency groups contain structures which cannot be represented any other way. These structures are uncommon in most documents but they do occur. In this situation you need to decide whether a change in page appearance is acceptable and that the objects should be forcably embedded. The alternative is to skip these objects and embed only those that will not affect the page appearance.

Whether to stamp FormXObjects that may cause a change in the page appearance. The number of FormXObjects removed from the page.

Add a particular type of resource to the page.

The resource to be added. The type of resource. The format of the name that should be used. The actual name that was used.

Add a content layer to the top of the page.

The layer to be added.

Render one or more layers on the current page.

This function renders a set of layers and returns the result as a System.Drawing.Bitmap. The Bitmap covers the smallest possible area which encompasses all the layers provided. If this Page is not in a Doc then an exception will be raised. The function will return null if the layers argument is null or empty or the output Bitmap would be smaller than one pixel in area. Rendering options such as resolution in DPI,are taken directly from the current XRendering settings for the doc. However automatic page rotation (XRendering.AutoRotate) is disabled so that a Layer can be rendered and then re-inserted into the page as a raster copy of itself. Note that a layer can exist on multiple pages and indeed can be rendered in the context of a page that does not contain it. However layers typically contain references to named resources which are only available in the context of a specific page. So rendering a layer in the context of a page which does not normally contain it is prone to error unless the page and layer have been specifically consructed to allow this. The layers to be rendered.

The MediaBox for the page.

The MediaBox defines the boundaries of the physical medium on which the page may be displayed or printed. This may include bleed areas or printing marks and also parts of the medium on which printing cannot take place because of physicsal limitations of the output technology. Any PDF drawing outside the MediaBox can be safely ignored. These boundaries may be defined directly on the Page object or they may be inherited from a parent Pages object. A MediaBox is mandatory for all pages so this property should never be null. Assigning a new value to this property will change the property for the current Page rather than any Pages object from which the value may have been inherited. In this way the property exhibits a copy-on-write behavior. Attempting to assign a null value to this property will result in a NullReferenceException being thrown.

The CropBox for the page. The CropBox defines the visible part of the physical medium on which the page may be displayed or printed. This is what you see as the boundary of the page when you view a document using Acrobat Reader. These boundaries may be defined directly on the Page object or they may be inherited from a parent Pages object. The CropBox is optional and if this property is null it is implicitly assumed to be the same as the MediaBox. Assigning a new value to this property will change the property for the current Page rather than any Pages object from which the value may have been inherited. In this way the property exhibits a copy-on-write behavior. Attempting to assign a null value to this property will result in a NullReferenceException being thrown. If you want to assign an effective value of null to this property you should assign it the value of the MediaBox.

The TrimBox for the page.

The TrimBox defines the intended boundaries of the page after trimming. These boundaries are always defined directly on the Page object. If no property has been defined then this property will be null and the effective value is assumed to be that of the CropBox.

The ArtBox for the page.

The ArtBox defines the extent of meaningful content on this page. These boundaries are always defined directly on the Page object. If no property has been defined then this property will be null and the effective value is assumed to be that of the CropBox.

The BleedBox for the page.

The BleedBox defines the region to which the contents of the page shall be clipped when rendered in a production environment. These boundaries are always defined directly on the Page object. If no property has been defined then this property will be null and the effective value is assumed to be that of the CropBox.

The Thumbnail for the page.

Dispose of the Page.

A Pages node within the document.

Test whether the two Pages are the same.

The Pages to test against. Whether the Pages are equal.

The parent of this node.

The number of visible pages under this node.

Performs a fast lookup to identify a particular Page from this node tree.

The page number - a one based index. The specified Page object or null if one could not be found.

Gets all the Page objects under this node. Only immediate children are returned. Any Pages objects are returned as null Page objects.

An array of all the Page objects under this node. Only immediate children are returned. Any Pages objects are returned as null Page objects.

Gets all the Page objects under this node and descendents of this node.

Gets all the Page objects under this node and descendents of this node.

Converts all the visible Page objects from one color space to another.

The destination color space. Whether to convert the color space of annotation appearance streams.

Converts all the visible Page objects from one color space to another.

The destination color space. Whether to convert the color space of annotation appearance streams. All the PixMaps which were recolored as a result of the call.

Interpolation Enumeration.

Automatically decide a good method.

Nearest neighbor interpolation.

Linear interpolation.

Cubic interpolation.

Supersampling interpolation (cannot be used for enlarging).

Interpolation using 3-lobed Lanczos window function.

Rendering Intent Enumeration.

Use a perceptual model for handling out of gamut colors (good for photographs).

Keep color values the same but allow the brightness to vary.

Use a saturation model for handling out of gamut colors (good for diagrams).

Use the closest color at the gamut boundary.

A bitmap based image.

PixMap constructor.

The ObjectSoup to contain the newly created StreamObject.

PixMap static constructor.

The ObjectSoup to contain the newly created PixMap. The XImage from which the PixMap should be created.

PixMap static constructor.

The ObjectSoup to contain the newly created PixMap. The XImage from which the PixMap should be created.

Test whether the two PixMaps are the same.

The PixMap to test against. Whether the PixMaps are equal.

The width of the image in pixels.

In general you will want to call Resize rather than change the value of this property. This is because the width, height, bits per component and number of components need to match up with the image data. Changing this property does not change the underlying data and unless you ensure the data matches up, you will end up with an invalid PixMap that does not display correctly when saved into PDF.

The height of the image in pixels.

In general you will want to call Resize rather than change the value of this property. This is because the width, height, bits per component and number of components need to match up with the image data. Changing this property does not change the underlying data and unless you ensure the data matches up, you will end up with an invalid PixMap that does not display correctly when saved into PDF.

The number of color components for each pixel.

The number of bits per color component.

In general you will want to call Resample rather than change the value of this property. This is because the width, height, bits per component and number of components need to match up with the image data. Changing this property does not change the underlying data and unless you ensure the data matches up, you will end up with an invalid PixMap that does not display correctly when saved into PDF.

The type of color space for this image.

In general you will want to call Recolor rather than change the value of this property. This is because the width, height, bits per component and number of components need to match up with the image data. Changing this property does not change the underlying data and unless you ensure the data matches up, you will end up with an invalid PixMap that does not display correctly when saved into PDF.

The ColorSpace for this image.

Whether corrupt data should automatically be fixed.

Whether this image is a one bit image mask.

Any one bit image mask associated with this image.

Any soft image mask associated with this image.

Any matte associated with this soft mask.

Sets a constant alpha value (0-255) for this image.

A constant alpha value to assign to this image.

Sets a chromakey transparent color for this image.

A chromakey string to assign to this image.

Converts the image to grayscale.

Decompress the data in the stream using on-the-fly resizing. This type of scaling is fast but may change the depth of the image. Only some compression types support on-the-fly resizing.

Converts the image from indexed color to component color.

Converts the image from one color space to another.

The destination color space.

Converts the image from one color space to another.

The destination color space. The rendering intent enumeration.

Gets the content of the object as a Bitmap.

The Bitmap containing the image.

Set the content of the object as a Bitmap.

The Bitmap containing the image. Whether any transparency information should be preserved. If transparency is required the PixMap must be contained within an ObjectSoup. After the Bitmap has been set the PixMap will be uncompressed so you may wish to compress it using a call like CompressJpeg or CompressFlate.

Changes the number of bits per color component.

The number of bits per color component.

Resizes the image.

The destination width for the image. The destination height for the image.

Resizes the image.

The destination width for the image. The destination height for the image. The type of interpolation to be used when resizing the image.

JPEG compresses the image.

The quality of compression to use (0 to 100).

CCITT compresses the image.

JPEG 2000 compresses the image.

The quality of compression to use (0 to 100).

JBIG2 compresses the image.

Rotate the image clockwise.

The number of degrees clockwise that the image should be rotated. This must be a multiple of 90. This function rotates the PixMap image clockwise. The rotation angle must be a multiple of 90. If an invalid number of degrees is specified then an ArgumentOutOfRangeException will be thrown. An image may have an associated bit mask or soft (alpha) mask. If this is the case the associated mask will be transformed as well. When a PixMap is drawn on a page it is scaled to fit into a particular location. The scaling is separate from the PixMap itself. Rotating by 90 or 270 degrees will swap the width and height of the PixMap. Because the scaling of drawn copies is separate from the PixMap itself, any previously drawn instances of the PixMap may appear to have an incorrect aspect ratio. After this method has been called the PixMap will no longer be compressed. You may wish to compress it using the StreamObject.Compress method or similar.

Flip the image horizontally or vertically.

Whether to flip the image horizontally. Whether to flip the image vertically. This function flips the image horizontally or vertically or both. Flipping both horizontally and vertically is equivalent to a 180 degree rotation. An image may have an associated bit mask or soft (alpha) mask. If this is the case the associated mask will be transformed as well. Flipping horizontally will mean that pixels that were on the far right of the image will be moved to the far left and pixels on the left will be moved to the right. Flipping horizontally will mean that pixels that were on the top of the image will be moved to the bottom and pixels that were on the bottom will be moved to the top. After this method has been called the PixMap will no longer be compressed. You may wish to compress it using the StreamObject.Compress method or similar.

Saves the PixMap as a file attempting to preserve resolution, color space and depth as far as the output format allows.

The destination file path.

Saves the PixMap to stream attempting to preserve resolution, color space and depth as far as the output format allows.

The destination output stream. A dummy file name used to determine the type of image required.

A digital Signature Field.

The validation policy type for certificates.

Perform an X.509 certificate path validation using the Windows Trusted Root CA store. Additional certificates passed in through Validate() will also be added as trust anchors.

Just verify that the certificate(s) in the document has or have been signed with one of the certificates specified as a parameter in Validate().

Test whether the two Signatures are the same.

The Signature to test against. Whether the Signatures are equal.

The validation policy for certificates.

Return binary X509 certificate(s) data.

The encoded X.509 data for the certificate(s).

Return binary X509 certificate(s) data.

The number of certificates. The encoded X.509 data for the certificate(s).

Sign a signature using a private key and password.

The path to the PFX/PKCS #12 (.pfx or .p12) file used for signing. The password used to authorize use of the private key.

Sign a signature using a private key and password.

The data for the PFX/PKCS #12 (.pfx or .p12) file used for signing. The password used to authorize use of the private key.

Sign a signature using a private key and password.

The stream for the PFX/PKCS #12 (.pfx or .p12) file used for signing. The password used to authorize use of the private key.

Sign a signature using a private key and password.

The stream for the PFX/PKCS #12 (.pfx or .p12) file used for signing. The password used to authorize use of the private key. The OID of the hash algorithm that should be used.

Sign a signature using a private key.

The System.Security.Cryptography.X509Certificates.X509Certificate2 object for the PFX/PKCS #12 (.pfx or .p12) certificate used for signing. Whether to suppress prompting the user to use the private key.

Sign a signature using a private key.

The System.Security.Cryptography.X509Certificates.X509Certificate2 object for the PFX/PKCS #12 (.pfx or .p12) certificate used for signing. Whether to suppress prompting the user to use the private key. The OID of the hash algorithm that should be used. The parts of the signing certificate chain which should be included in the signature.

Commit a previously signed signature to the document.

The location of the signing.

The reason for signing.

The name of the person signing.

The URL to a timestamping service.

The time of signing in UTC format.

True if the PDF was modified after signing.

True if the signature's certificate is trusted according to ValidationPolicy.

True if the signature's certificate was time-valid when the document was signed.

True if the signature and document look well formed and well applied.

The type of hash algorithm used in the signature.

Check and validate the status of this signature.

True if the certificate is valid.

Check and validate the status of this signature.

Check and validate the status of this signature.

An array of paths to X.509 certificate (.cer) files. True if the certificate is valid.

CompressionType Enumeration.

Not compressed.

Compressed in an undefined or complex way.

Flate compressed.

LZW compressed.

CCITT compressed.

JPEG compressed.

JPEG 2000 compressed.

ASCII Hex encoded.

ASCII 85 encoded.

Run length compressed.

JBIG2 compressed.

Security handler encrypted.

StreamObjectTypes Enumeration.

No stream object.

All stream objects.

Other stream objects.

PixMap.

Form XObject.

Tiling pattern objects.

Shading objects that are streams.

Function objects that are streams.

A PDF data stream.

StreamObject constructor.

The ObjectSoup to contain the newly created StreamObject.

StreamObject constructor.

The ObjectSoup to contain the newly created StreamObject. A path to a file containing data which should be placed in the StreamObject.

StreamObject constructor.

The ObjectSoup to contain the newly created StreamObject. An array of bytes which should be placed in the StreamObject.

Test whether the two StreamObjects are the same.

The StreamObject to test against. Whether the StreamObjects are equal.

The number of bytes of encoded stream data.

Whether the stream data is compressed or otherwise encoded.

The primary compression type.

All compression types, ordered in terms of the complete decompression sequence required for the stream.

Get the raw binary content of the stream.

The raw binary content of the stream.

Set the raw binary content of the stream from data held in another StreamObject.

The raw binary content of the stream from data held in another StreamObject.

Set the raw binary content of the stream.

The raw binary content of the stream.

Set the raw binary content of the stream.

Set the raw binary content of the stream from data embedded in a file.

A path to a file containing data which should be placed in the StreamObject.

Get the content of the stream as a string.

The content of the stream as a string.

Set the content of the stream as a string.

The content of the stream as a string.

Compress the data in the stream.

Compress the data in the stream using Flate compression.

Whether the compression was applied.

Compress the data in the stream using Flate compression.

Whether to force the stream to be compressed in this way. Whether the compression was applied.

Compress the data in the stream using ASCII Hex compression.

Whether the compression was applied.

Compress the data in the stream using ASCII Hex compression.

Whether to force the stream to be compressed in this way. Whether the compression was applied.

Compress the data in the stream using ASCII85 (Base85) compression.

Whether the compression was applied.

Compress the data in the stream using ASCII85 (Base85) compression.

Whether to force the stream to be compressed in this way. Whether the compression was applied.

Compress the data in the stream using run length compression.

Whether the compression was applied.

Compress the data in the stream using run length compression.

Whether to force the stream to be compressed in this way. Whether the compression was applied.

Decompress the data in the stream.

Whether the data in the stream is uncompressed.

Clear the data and compression settings for the stream.

Clear the cached, decompressed data for the stream.

A multistyled text object appearing on a page.

Test whether the two TextLayers are the same.

The TextLayer to test against. Whether the TextLayers are equal.

The number of characters appearing on the page.

The number of lines appearing on the page.

Whether the text had to be truncated.

The previous text object in the text chain.

The point defining the end position of the text.

The full text provided in the initial call to AddHtml or AddText. This text is shared between all the items in a chain.

The offset to the first character (in the full text) to be drawn onto this layer.

The offset to the last character (in the full text) to be drawn onto this layer.

The offset to the character (in the full text) which will be drawn at the start of the next item in the chain.

A TextOperation describing the precise layout of this text layer.

The TextFragments describing the precise layout of this text layer.

Removes any cached TextOperation and TextFragments associated with this fragment. This can reduce memory use or it can be used to allow text information to be regenerated after the TextLayer contents have been updated..

A view onto a larger underlying graphic.

Test whether the two ViewLayers are the same.

The ViewLayer to test against. Whether the ViewLayers are equal.

The content width of the image.

The content height of the image.

The scroll width of the image.

The scroll height of the image.

The offset to the top of the current page.

The width of the content on the current page.

The height of the content on the current page.

Whether the image is truncated.

The source type of operations.

No information was set.

A document.

A document page.

A page content.

A standard image (single-frame).

An image used as a mask.

A multi-frame image.

A frame in a multi-frame image.

A stream in a PDF document.

A path element in a PDF stream.

A text element in a PDF stream.

A form XObject in a PDF stream.

A shading operator in a PDF stream.

A font in a PDF.

Provides generic information related to the ProcessingObject event.

ProcessingInfo constructor.

The event type.

The current document being processed, null if not applicable.

The total number of documents, null if not applicable.

The current page being processed, null if not applicable.

The total number of pages, null if not applicable.

The current frame being processed, null if not applicable.

The total number of frames, null if not applicable.

The number of frames per second, null if not applicable.

The object's horizontal location, null if not applicable.

The object's vertical location, null if not applicable.

The object's width, null if not applicable.

The object's height, null if not applicable.

The object's background color, null if not applicable.

Indicates whether the source has been handled by the event handler.

The stream position, null if not applicable.

The stream length, null if not applicable.

The object text, null if not applicable.

Provides data related to an Operation about to be performed on an IndirectObject.

ProcessingObjectEventArgs constructor.

The IndirectObject to be processed.

ProcessingObjectEventArgs constructor.

The IndirectObject to be processed. The ProcessingInfo containing related information.

Gets the IndirectObject to be processed.

Gets or sets an object which can be used to save data about the event.

Gets related information.

Provides data related to an Operation which has just been performed on an IndirectObject.

ProcessedObjectEventArgs constructor.

The IndirectObject processed. A value indicating whether the processing was successful.

Gets the IndirectObject which has just been processed.

Gets or sets an object which can be used to save data about the event.

Gets a value indicating whether the processing was successful.

Represents the method that handles the event of performing an Operation on an IndirectObject.

The source of the event. A ProcessingObjectEventArgs that contains the event data.

Represents the method that handles the event of performing an Operation on an IndirectObject.

The source of the event. A ProcessedObjectEventArgs that contains the event data.

An Operation to be performed on an IndirectObject.

Occurs before an IndirectObject is operated on. The EventArgs Tag property is passed to the ObjectProcessed event.

Occurs after an IndirectObject is operated on. The EventArgs Tag property is passed from the ObjectProcessing event.

Dispose of the Operation.

Dispose of the Operation.

Operation to recolor pages in a document.

RecolorOperation constructor.

Gets or sets a value indicating whether annotations are to be recolored.

Gets or sets the number of type0 function samples to generate (between 64 and 1000)

Gets or sets the destination ColorSpace.

Gets or sets the default rendering intent.

Gets or sets a value which determines if content in the PDF is allowed to override the default rendering intent.

Recolors a document.

The Doc to be recolored.

Recolors a page.

The Page to be recolored.

Recolors the pages referenced by a Pages IndirectObject.

The Pages IndirectObject to be recolored

Replace transparent overlaps with opaque results of transparent object interactions.

FlattenTransOperation constructor.

Gets or sets a value indicating whether annotations are to be flattened.

The rasterized resolution in dots per inch.

Whether to anti-alias flattened rasterized text.

Whether to anti-alias flattened rasterized polygons.

Compositing ColorSpace (Gray (Grey), RGB, CMYK)

Log message with details on the previous Flattening operation

The alpha of the backdrop, range 0..1 (default 1)

The path to the default Gray ICC color profile.

The path to the default RGB ICC color profile.

The path to the default CMYK ICC color profile.

Flatten the transparency in a document.

The Doc to be flattened.

Flatten the transparency in a page.

The Page to be flattened.

Flattens the transparency in the pages referenced by a Pages IndirectObject.

The Pages IndirectObject to be flattened

The Application for XpsImportOperation.ImportAny.

The application determined by the file association in the Shell (Windows Explorer).

Microsoft Word.

Microsoft Excel.

Microsoft PowerPoint.

Microsoft InfoPath.

Microsoft OneNote.

Microsoft Publisher.

Microsoft Project.

Microsoft Visio.

Microsoft Outlook.

Operation to import pages in an XPS document.

The types of annotations.

No annotation.

Link annotation that points to a page in the same document.

Link annotation that links to an external resource (e.g. URL).

XpsImportOperation constructor.

The types of annotations to be added.

The password needed to read the source.

The application that prints the document to XPS when ImportAny is called.

The folder of the application for printing documents to XPS when using ImportAny.

Whether to enable macros when opening MS Office documents. This property is supported only for Word, Excel and Powerpoint.

The document number for ImportAny, e.g. the Excel Worksheet number.

XpsImportOperation destructor.

Dispose of the Operation.

Enable an application process to be reused so that it is terminated only manually or when this operation is disposed of.

The import application. Whether the application process is to be reused. Whether the reuse status of the application has been changed.

Whether an application is to be kept running and reused.

The import application. Whether the application process is to be kept running and reused.

Whether an application is running.

The import application. Whether the application is running.

Terminate a running application.

The import application. Whether the application has been running and killed.

Import an XPS document.

Import a document by converting it to XPS using the Microsoft XPS print driver.

The target PDF document. The file path to the source document.

Import a document by converting it to XPS using the Microsoft XPS print driver.

The target PDF document. The file path to the source document. The timeout in milliseconds for the XPS printer driver.

The application installation folder.

The import application. The installation folder of the application.

SWF action data type code.

The undefined type.

The null type.

SWF action value.

The undefined value.

The null value.

The type code.

Parameters for initializing the SWF machine.

The stage width in twips when the scale mode is NoScale.

The stage height in twips when the scale mode is NoScale.

The stage alignment.

The stage scale mode.

The Flash variables.

Operation to import frames in a Flash movie.

SwfImportOperation constructor.

Dispose of the Operation.

The target PDF Document.

The time-out for script execution.

The background region.

The clip region.

Whether to reset regions to frame bounds before importing a frame.

The content alignment.

The content scale mode.

The parameters for initializing the SWF machine.

Import frames in a Flash movie.

Import frames in a Flash movie.

Operation to render pages in a document.

RenderOperation constructor.

RenderOperation destructor.

Dispose of the Operation.

Renders the current page in the document.

The destination file path.

Renders the current page in the document.

A dummy file name used to determine the type of image. The destination stream.

Renders the current page in the document.

A dummy file name used to determine the type of image. The data containing the rendered page.

Renders the current page in the document.

The bitmap containing the rendered page.

CopyPagesOperation constructor.

The document from which pages will be taken. The document onto which pages will be drawn.

The source document from which to take pages.

The destination document onto which pages will be drawn.

Whether to copy fields and annotations. Default false.

Whether to draw only the portion of the page specified by the Souce.Rect. If this value is false then the entire visible page will be drawn. Default false.

The level of alpha to apply to the drawn page from transparent through to fully opaque (0 to 255). If this value is null then no alpha will be applied. Default null.

Draw the current page from the source PDF document onto the current page of the destination document, returning the ID of the newly added object. The page is scaled to fill the current Rect. It is transformed using the current Transform. Many field and annotation types can only exist as a simple rectangle with sides parallel to the page borders. For this reason you should be cautious about the transforms you use when specifying that annotations should be copied. A transform which involves scale and translation will be fine but one involving rotation and skew factors may result in unusual output if the field or annotation does not support this combination. Pages may be rotated. As such, when drawing one page onto another, you may wish to copy the Page.Rotation from the source page to the destination page. More complex example code to de-rotate a page may be found under the documentation for the Page.Rotation.

The ID of the newly added object.

Operation to apply a visual effect.

Names of all the installed effects.

Effect constructor.

The name of the effect that is required. If the name is not one of the valid names then an exception will be thrown.

Effect destructor.

Dispose of the Operation.

The name of the Effect.

A description of what the effect does.

Whether to automatically restore the image color space and apply compression after the effect is applied.

The quality of compression to use when automatically compressing after the effect is applied.

The parameters associated with the effect.

Apply effect to image.

The PixMap to which the image should be applied. The effect will be applied to the PixMap. Effects normally involve wholescale changes and so it may well be necessary to change the color space and depth in order to apply the effect. If the AutoRestore property is set then the PixMap will be restored to a similar color space after processing and it will be recompressed at an appropriate quality. This default is generally what is required. However if the AutoRestore property is not set then final output may well have different characteristics such as color space and depth. In general the final image will be uncompressed eight bit RGB no matter what was supplied. If you are relying on particular characteristics present in the original PixMap then you should convert or recolor it after the effect has been applied. Since the final image will be left uncompressed you will likely want to recompress it using an apppopriate schema.

A parameter that controls the operation of the effect.

The name of the parameter.

A description of what the parameter does.

The minimum recomended value (if applicable).

The maximum recomended value (if applicable).

The value of the parameter, or the first value if there are multiple.

The values of the parameter. Most parameters have one value only.

The PDF conformance.

PDF conformance.

PDF/A Part 1 Level B conformance.

PDF/A Part 1 Level A conformance.

The PDF conformity.

No conformity.

Removes JavaScript actions.

The PDF conformity options.

No option.

Keeps the document's modification date unchanged.

The PDF conformance identification.

Conformance version identifier.

Conformance amendment identifier.

Conformance level.

The effective PdfConformance value.

Gets the conformance identification from a document.

Operation to validate PDF files.

Dispose of the Operation.

The target PDF Document.

The PDF conformance.

The validation errors.

The validation warnings.

Read and validate an existing document from file.

Read and validate an existing document from data.

Read and validate an existing document from stream.

Operation to produce conforming PDF files.

Dispose of the Operation.

The PDF conformance.

Options related to the changes that may be made to enable PDF conformance.

Options related to the way that the PDF may be changed as part of the operation.

The features within the document which could not be made conformant.

The changes made to make the document conformant.

Write the conforming document to a file.

The document. The destination file path.

Write the conforming document to a stream.

The document. The destination stream.

Get the conforming document as raw data.

The document. The PDF document as an array of bytes.

Get the conforming document as raw data stream.

The document. The PDF document as a stream.

Operation to reduce the size of a document.

ReduceSizeOperation constructor.

The PDF Document.

The pages to be operated upon.

Whether to unembed simple Latin based fonts where possible.

Whether to unembed complex Unicode based fonts where possible.

Whether to unembed embedded fonts that do not have an obvious substitute on the local machine.

Whether to unembed embedded fonts that appear to be corrupt or non-standard.

Whether to refactor and remove duplicate images where possible.

Whether to resize and recompress images where possible.

Whether to compress uncompressed streams where possible.

The target resolution for the resampling of color images.

The target compression type for the re-encoding of color images.

The target compression quality for the re-encoding of color images.

The target resolution for the resampling of grayscale images.

The target compression type for the re-encoding of grayscale images.

The target compression quality for the re-encoding of grayscale images.

The target resolution for the resampling of monochrome images.

The target compression type for the re-encoding of monochrome images.

The target compression quality for the re-encoding of monochrome images.

The amount of divergence from the target palette which will be allowed.

Compact and compress the document.

Whether to compact the entire document or only selected pages.

Operation to tag a document and make it accessible.

Default constructor.

The document.

The pages to be operated upon.

Whether to attempt to fix font settings that may be required for accessibility.

Whether to attempt to fix or add metadata that may be required for accessibility.

Whether to detect and fix invalid operators in content stream.

Whether to detect and insert table structures.

Whether to detect and insert ordered and unordered list structures.

Whether to detect and remove page headers.

Whether to detect and remove page footers.

Whether to detect and insert structure outline.

Tags the document for accessibility.

Operation to analyse the semantic structure of a document. In terms of visualization the GetHtml method is terribly useful to be able to see what kind of results have been obtained and how they are structured.

Default constructor.

The document.

Whether to detect and insert table structures.

Whether to detect and insert table structures.

Whether to detect and insert page headers.

Whether to detect and insert page footers.

Whether to detect and insert structure outline.

The pages to be operated upon.

The text operation which will be used for page analysis.

The image operation which will be used for page analysis.

The paragraphs in reading order rather than layout order.

The header level for each paragraph in reading order.

A line of text in a paragraph.

A collection of text lines forming a paragraph.

A block of text that can contain other blocks of text in either a columnar or blockular layout.

A class for representing a 'Do' draw image operation

A class for representing an Annotation without any stream operator

A class for gathering up TextFragments that are actually all part of one DrawTextOperator. For example a DrawTextOperator might consist of the following: [(Yea) 10 (r) -9000 (Description) -9000 (Total)] TJ Because the three chunks of text are widely spaced the TextFragments associated with each one might not actually fall into the same line. Instead they might be grouped into columns. So column one might contain the two fragments making up "Year" and the other two text chunks might fall into separator lines. This class allows you to group these partial bits of a DrawTextOperator for later use. They fall into a kind of span so that consecutive operators can be held.

Base class for implementing a class that takes a content stream and processes it line by line. This is typically used for rewriting a content stream eg to prettify the format or to add comments.

A class for rewriting a content stream adding tags as you go along.

General purpose utilities for tagging.

An analog of XRect but done as a struct. Not only is this easier to use in terms of assignment but also it's faster (I estimate about three to five times). Perhaps some optimizations to XRect would be good for places where XRects are used standalone and we don't need to go back to unmanaged code.

Set the sides of the rectangle.

The new left position. The new bottom position. The new right position. The new top position.

Determine if this rectangle intersects with another.

Union the rectangle with another rectangle. This rectangle becomes the smallest rectangle that encloses both rectangles. Rectangles with no area are ignored.

The rectangle to add to this one. The supplied rectangle is left unchanged by this function.

Union the rectangle with another rectangle. This rectangle becomes the smallest rectangle that encloses both rectangles.

The rectangle to add to this one. The supplied rectangle is left unchanged by this function. Whether rectangles with no area should be ignored.

Intersect the rectangle with another rectangle. This rectangle becomes the largest rectangle that both rectangles enclose.

The rectangle to intersect to this one. The supplied rectangle is left unchanged by this function. Whether rectangles with no area should be ignored.

Determine if the rectangle encloses any area.

Determine the area of the rectangle.

Object to hold the extracted content of a document.

PageContents constructor.

The document.

Whether to include annotation and field text in the output.

Whether to include color information in the output.

Whether to attempt to regenerate missing Unicode tables from embedded fonts.

Add a particular set of Layer objects from a particular Page. This is an alternative to the AddPages overloads.

The Page on which the provided layers are located. The layers to be added.

Add and process all the pages in the document.

Add and process one particular page in the document.

The number of the page to be processed. This is a one based index.

Add and process a range of pages in the document.

The number of the first page to be processed. This is a one based index. The number of the last page to be processed. This is a one based index.

Operation to analyse and extract the text in a document.

TextOperation constructor.

The document.

The pages to be operated upon.

The minimum distance at which two text fragments will be assumed to be part of one undivided word. This value is specified in terms of a fraction of the font size.

The minimum distance at which two text fragments will be assumed to be part of separate tab groups. This value is specified in terms of a fraction of the font size.

The character used to separate out tab groups when GetText is called.

Whether to de-hyphenate words that appear to be split across two lines.

Whether to show text which is invisible because it is affected by a clip path.

How much overlap to require clipped text to have before it is defined as visible.

Whether to show text content that is marked as an artifact.

Whether to show overlapping repeated text content. This is most typically used for a synthetic bold effect.

Whether to get information on the BT and ET text object markers used to contain and group text operators.

Whether to provide native colors such as CMYK, separations and spot colors, or whether to convert all colors to RGB.

A set of character to string substitutions used for translating typographic characters like ligatures into more normal text.

Get all the text in the page contents.

The text from the specified pages.

Get all the text in the page contents.

The area of interest from which text should be returned. The page from which text should be returned. This is a one based index. The text from the specified pages within the specified area of interest.

Get all the text in the page contents.

The areas of interest from which text should be returned. The pages from which text should be returned. These are one based indexes. The text from the specified pages within the specified areas of interest.

Select a range of text in the document.

The start index for the selection as related to the string returned by the GetText method. The length for the selection as related to the string returned by the GetText method. Returns a list of find matches encompassing the selected text.

Group a range of text fragments into a set of lines.

The fragments to be grouped. Returns a list of groups defining the lines.

A fragment of text as it appears in a document.

The ID of the Page on which this text fragment is located.

The Stream ID of the content stream in which this text fragment is located.

The offset within the content stream to the start of the drawing operation that contains this fragment.

The length within the content stream of the drawing operation that contains this fragment.

The zero based index of the drawing operator text array item that contains this fragment. For non text array operators this value is zero.

The character offset within the RawText to the the Text of this fragment.

The text of the fragment. A fragment may span only a portion of the complete text drawing operator.

The text specified in the drawing operator or the text array item of the drawing operator.

The rectangle that contains the text of the fragment.

The angle of rotation of the fragment in degrees.

The font object used for drawing this text fragment.

The effective font size used for drawing this text fragment.

The color used for drawing this text fragment.

The font ColorSpace used for drawing this text fragment.

The skew angle of the font as used for oblique styles to simulate italic.

A group of text fragments that belong together.

The ID of the Page on which this group is located.

The rectangle that contains the group.

The text of the group.

The text fragments in the group.

Operation to analyse the placement of raster images (bitmaps) in a document.

ImageOperation constructor.

The document.

Whether to include all images in the analysis to allow the detection of orphans.

The pages to be operated upon.

Get the image information for all the raster images.

A collection of all the image properties.

A class that represents one raster image (bitmap) in a document.

The PixMap object associated with the image.

The set of renditions of the image at different locations within the document.

The resolution of the image in dots per inch.

The horizontal resolution of the image in dots per inch.

The vertical resolution of the image in dots per inch.

A class that represents one image placement in a document.

The ID of the Page on which the image is placed.

The ID of the Stream in which the image draw operation is contained.

The StreamObject in which the image draw operation is contained.

The offset within the uncompressed StreamObject to the start of the drawing operation that contains this image draw operation.

The length within the uncompressed StreamObject of the drawing operation that contains this image draw operation.

The transformation matrix for the placement of the image.

The bounding rectangle for the placement of the image. Note that images may be rotated or otherwise transformed. For this reason consider whether the Matrix property or the Focus method might be more appropriately used in place of the BoundingBox property.

The resolution of the image in dots per inch.

The horizontal resolution of the image in dots per inch.

The vertical resolution of the image in dots per inch.

Focus the document on the location of the image placement.

ColorOperatorType Enumeration.

Unknown or undefined.

Device dependent Gray.

Device dependent RGB.

Device dependent CMYK.

Calibrated Gray.

XColor Class.

Create an XColor from an array of NumAtoms containing PDF color values. PDF color values typically range between 0 and 1, representing zero and 100% intensity respectively. If the array indexes selected are invalid or do not contain NumAtoms then an exception will be raised.

The toms containing the parameters for the color operator. The PDF color operator. The newly created XColor object.

Create an XColor from an ArrayAtom of NumAtoms containing PDF color values. PDF color values typically range between 0 and 1, representing zero and 100% intensity respectively. If the array is null or the array indexes selected are invalid or do not contain NumAtoms then an exception will be raised.

The ArrayAtom containing the components of the color. The newly created XColor object.

Create an XColor from a grayscale value.

The amount of black (0 to 255) The newly created XColor object.

Create an XColor from a set of RGB component values.

The amount of red (0 to 255) The amount of green (0 to 255) The amount of blue (0 to 255) The newly created XColor object.

Create an XColor from a set of CMYK component values.

Set the color to an opaque CMYK value.

The amount of cyan (0 to 100) The amount of magenta (0 to 100) The amount of yellow (0 to 100) The amount of black (0 to 100) The newly created XColor object.

Create an XColor from a set of ColorSpace PDF components.

The intensity of the first component (typically 0 to 1)

Create an XColor from a set of ColorSpace PDF components.

The intensity of the first component (typically 0 to 1) The intensity of the second component (typically 0 to 1)

Create an XColor from a set of ColorSpace PDF components.

The intensity of the first component (typically 0 to 1) The intensity of the second component (typically 0 to 1) The intensity of the third component (typically 0 to 1)

Create an XColor from a set of ColorSpace PDF components.

The intensity of the first component (typically 0 to 1) The intensity of the second component (typically 0 to 1) The intensity of the third component (typically 0 to 1) The intensity of the fourth component (typically 0 to 1)

XColor constructor.

Creates a deep copy of the current XColor.

XColor destructor.

Dispose of the XColor.

Dispose of the XColor.

A string representation of the color.

The string representation of the object.

An ArrayAtom representation of the components of the color.

An ArrayAtom containing the components of the color.

A string representation of the color.

The red intensity of the color (0 to 255).

The green intensity of the color (0 to 255).

The blue intensity of the color (0 to 255).

The gray intensity of the color (0 to 255).

The cyan intensity of the color (0 to 100).

The magenta intensity of the color (0 to 100).

The yellow intensity of the color (0 to 100).

The black intensity of the color (0 to 100).

The alpha opacity of the color (0 to 255).

The components of the color in native PDF format.

The native color space for the set color operator.

Any name that may be associated with this color. Most commonly this is used for pattern names.

The color as a System.Drawing.Color.

Set the color.

The source color.

Set the color to an opaque grayscale value.

The amount of black (0 to 255)

Set the color to a transparent grayscale value.

The amount of black (0 to 255) The level of opacity from transparent through to fully opaque (0 to 255)

Set the color to an opaque RGB value.

The amount of red (0 to 255) The amount of green (0 to 255) The amount of blue (0 to 255)

Set the color to a transparent RGB value.

The amount of red (0 to 255) The amount of green (0 to 255) The amount of blue (0 to 255) The level of opacity from transparent through to fully opaque (0 to 255)

Set the color to an opaque CMYK value.

The amount of cyan (0 to 100) The amount of magenta (0 to 100) The amount of yellow (0 to 100) The amount of black (0 to 100)

Set the color to a transparent CMYK value.

The amount of cyan (0 to 100) The amount of magenta (0 to 100) The amount of yellow (0 to 100) The amount of black (0 to 100) The level of opacity from transparent through to fully opaque (0 to 255)

Set the color to a set of ColorSpace PDF components.

The intensity of the first component (typically 0 to 1)

Set the color to a set of ColorSpace PDF components.

The intensity of the first component (typically 0 to 1) The intensity of the second component (typically 0 to 1)

Set the color to a set of ColorSpace PDF components.

The intensity of the first component (typically 0 to 1) The intensity of the second component (typically 0 to 1) The intensity of the third component (typically 0 to 1)

Set the color to a set of ColorSpace PDF components.

The intensity of the first component (typically 0 to 1) The intensity of the second component (typically 0 to 1) The intensity of the third component (typically 0 to 1) The intensity of the fourth component (typically 0 to 1)

Set the color to a random opaque value in the current color space.

Test whether the two colors are the same.

The XColor to test against. Whether the XColors are equal.

Test whether the two colors are the same.

The object to test against. Whether the objects are equal.

A hash code for the XColor.

The returned hash code.

Compares this instance of an XColor to another and returns an indication of their relative values.

A System.Object that evaluates to an XColor. A signed number indicating the relative value of this instance.

EncryptionMethodType Enumeration.

(Not supported.)

No encryption.

Uses the RC4 algorithm.

Uses the AES algorithm with 128-bit encryption keys.

Uses the AES algorithm with 256-bit encryption keys.

XEncryption class.

XEncryption destructor.

Dispose of the XEncryption.

Dispose of the XEncryption.

The level of encryption to use.

The crypt method for strings.

The crypt method for streams.

Sets the crypt methods.

The crypt method for strings and streams.

Sets the crypt methods.

The crypt method for strings. The crypt method for streams.

The user password.

The owner password.

Whether to encrypt the document metadata.

Whether a user can print the document.

Whether a user can modify the document.

Whether a user can copy from the document.

Whether a user can edit the document.

Whether a user can fill forms in the document.

Whether a user can extract detail from the document.

Whether a user can assemble the document.

Whether a user can print a high resolution copy of the document.

A string representation of the encryption state.

The string representation of the object.

A string representation of the encryption state. This covers all the properties of this object.

XFont Class.

FontWeight Enumeration.

Don't care.

Thin weight.

Extra-light weight.

Light weight.

Normal weight.

Medium weight.

Semi-bold weight.

Bold weight.

Extra-bold weight.

Heavy weight.

Find all the fonts currently installed on the system.

The set of matching fonts.

Find all fonts belonging to a particular family.

The name of the font family. The set of matching fonts.

Find the names of all font families.

The set of family names.

Find all fonts with a given name.

The name of the font. The set of matching fonts.

Find a font in a list, with a given style.

The list of fonts. The weight of the required font. (The midpoint of the weight range.) The maximum difference of the weight of the required font. (The radius of the weight range.) Whether an italic font is required. A matching font. Null if no matching font could be found.

Find a font from a specific family, with a given style.

The name of the font family. The weight of the required font. Whether an italic font is required. A matching font. Null if no matching font could be found.

Find a font from a specific family, with a given style.

The name of the font family. The weight of the required font. Whether an italic font is required. A matching font. Null if no matching font could be found.

Return text width in thousandths of a unit.

The text. The width of the text in 1000ths.

The complete set of names by which this font is known.

The weight of the font (which can be compared against the FontWeight enumeration).

Whether the font is in an italic style.

Whether the font is in a fixed pitch (rather than proportional) style.

Whether the font is in a script style.

Whether the font is in a serif style.

The complete, hopefully unique, human readable name of the font.

The name of the family to which the font belongs.

The name the font will be known by on a PostScript printer.

The baseline of the font in thousandths of a unit.

The character widths in thousandths of a unit for all the characters in the font.

Unloads a font so that it is no longer available.

XForm Class.

All top level fields in the form.

Whether values should be formatted before insertion into fields.

The format provider for formatting dates and times.

Whether field appearances should be pre-generated.

Whether the viewer should automatically regenerate field appearances.

The full names of all the fields in the document.

The names of all the eForm fields in the document.

Returns a particular field referenced by full name.

Stamp all fields into the document.

Refresh and reload the document fields.

Make fields unique across pages, duplicating fields if necessary.

Make fields unique across pages, duplicating fields if necessary.

The token to append to existing field names.

Add a particular type of resource to the form.

The resource to be added. The type of resource. The format of the name that should be used. The actual name that was used.

The condition of the state of thread or process.

No thread or process.

Idle threads or processes.

Threads or processes that are idle or when they become idle.

All threads or processes.

The content type of the embedded file.

No content.

SWF file.

The CSS media type to use.

Print media

Screen media

The conversion used for the values of HTML parameters.

No conversion.

Sets the value to the text content of the file pointed to by the value as a URL.

The method for loading URI/HTML.

Uses the default method.

Uses Moniker and treats input as HTML.

Uses the Navigate method of WebBrowser.

The module for obtaining URI/HTML data.

Uses the default module.

Uses the engine's module.

Uses System.Net.WebRequest.

Uses System.Net.WebRequest when access by the engine's module has been denied.

The request method for URL.

The GET request method.

The POST request method.

The engine to use for HTML parsing and layout.

Rendering engine used in Microsoft Internet Explorer.

Rendering engine used in Mozilla Firefox.

The HTML rendering conditions.

Never performs the action.

Always performs the action.

Performs the action when the default conditions are met.

Performs the action when some filter is disabled.

Performs the action when only partial content is available.

Performs the action when vector-output coercion has failed.

The page break logic for HTML.

Uses the cumulative cohesion of all objects occupying each horizontal line.

Uses the maximum cohesion among objects occupying each horizontal line.

Optimizes the break position globally around a candidate position.

Optimizes the break position locally around a candidate position.

No optimization.

The options for new worker processes.

Whether the process pool for the HTML Engine has started.

The number of existing processes for the HTML Engine.

The user name.

The domain or server containing the user.

The password for the user.

Whether to load the user profile.

The maximum time for which a process can be idle before being terminated (ms).

The number of times a page should be retried if there is a problem with the process.

Start the process pool for the HTML Engine.

Whether the process pool is started anew.

The HTML parameter with conversion.

HtmlParameter constructor.

The source.

The parameter value.

The conversion for the value.

The information for an object embedded in HTML.

The URL of the embedded object.

The base URL for resolving relative URLs.

The content type of the embedded object.

Indicates whether parameter names are case-sensitive.

The parameters for the embedded object.

XHtmlOptions Class.

An object that provides access to only the HTML options supported by the MSHTML engine.

An object that provides access to only the HTML options supported by the Gecko HTML engine.

A helper filter to give only the HtmlOptions supported by the MSHTML engine.

A helper filter to give only the HtmlOptions supported by the Gecko engine.

The width of the virtual browser in pixels.

A user name to be used for authentication.

A password to be used for authentication.

Whether hyperlinks should be live.

Whether form fields should be live.

Whether movies and other active content should be live.

Whether the location of certain tags should be noted.

Whether hyperlinks with targets should be allowed to open in a new browser window.

Whether the values of form elements, except radio buttons, with the same name are distinct.

Whether font substitution should be used to reduce file size.

Whether fonts should be embedded rather than referenced.

Whether embedded fonts should be subset.

Whether fonts with restricted licensing should be protected from embedding.

The quality of compression acceptable for continuous tone images such as JPEGs.

The maximum amount of time allowed for obtaining a page (ms).

The minimum number of content items required for a page to be valid.

The number of times a page should be retried if unavailable or invalid.

Whether content should be rendered in multipaged format.

Whether to hide the background color of a page.

Additional HTTP headers to send in the request.

The user-agent string.

A script to be run after the page is loaded.

The request method for URL.

Whether to disable automatic cookies.

Whether to reload page.

The rendering engine to use for HTML conversion.

The CSS media to use.

The conditions under which to coerce a vector output.

The conditions under which to disable vector-output coercion.

Whether to host a WebBrowser control.

Whether to deactivate the WebBrowser.

The method for loading URI/HTML.

The module for obtaining URI/HTML data.

Whether to enable JavaScript and VBScript.

Whether to enable ActiveX.

Whether to enable Java.

Whether to enable Video.

Whether to resynchronize page.

Whether any proxy servers should re-request items of content.

Whether to use theme.

Whether not to use theme.

Whether the page cache should be searched first.

The length of time that pages can be held in the cache (ms).

The number of pages that can be held in the cache.

The maximum size at which an image may be regarded as atomic.

Whether HTML pages are marked up before conversion to PDF.

Whether HTML layout is checked and adjusted for optimal output to PDF.

Whether to automatically clip redundant content at the end of the page.

Whether to improve the support for page-break-inside of avoid.

Whether to improve the support for page break in table to prevent missing rows.

Whether to disable the default background color.

Whether to disable the snap rounding of coordinates and lengths.

The minimum width to be used for auto-sized pages.

The percentage of the current drawing area in which HTML breaks can occur.

The page break logic for HTML.

The options for new worker processes.

The delegate called during HTML rendering.

The delegate called when embedding an object during HTML rendering.

Sets whether to use theme or not.

Whether to use theme or not.

Sets whether to use theme or not.

Whether to use theme. Whether not to use theme.

Clear all items from the page cache.

Clear all expired items from the page cache.

Convert external links to internal links wherever possible.

Convert external links to internal links.

Specifies both linkIDs and destIDs. The number of links converted.

Convert external links to internal links.

The list of IDs of view objects containing links (anchor tags with href attributes). The list of IDs of view objects containing destinations (anchor tags with name attributes). Whether links pointing to the URLs of HTML pages (URLs without fragments) are converted to internal links. The number of links converted.

Gets an array of the HTML IDs of tagged visible items.

The Object ID of the object. The IDs of tagged visible HTML objects.

Gets an array of the locations of tagged visible items.

The Object ID of the object. The location of tagged visible HTML objects.

Gets an array of the locations of tagged visible items before Doc.Transform is applied.

The Object ID of the object. The location (before Doc.Transform is applied) of tagged visible HTML objects.

Retrieves the HTTP status code.

The Object ID of the web page to be accessed. The HTTP status code or zero if not available.

Retrieves the client side onload script return value.

The Object ID of the web page to be accessed. The return value.

Ends any HTML Engine worker threads or processes.

The way in which to select threads or processes that should be ended. The number of selected threads or processes.

A helper filter to give only the HtmlOptions supported by Gecko HTML engine.

Whether hyperlinks should be live.

Whether movies and other active content should be live.

Whether form fields should be live.

Whether the location of certain tags should be noted.

Whether the values of form elements, except radio buttons, with the same name are distinct.

Whether font substitution should be used to reduce file size.

Whether fonts should be embedded rather than referenced.

Whether embedded fonts should be subset.

Whether fonts with restricted licensing should be protected from embedding.

The quality of compression acceptable for continuous tone images such as JPEGs.

The maximum amount of time allowed for obtaining a page (ms).

A user name to be used for authentication.

A password to be used for authentication.

The minimum width to be used for auto-sized pages.

The number of times a page should be retried if unavailable or invalid.

A script to be run after the page is loaded.

The request method for URL.

Whether to enable JavaScript and VBScript.

The CSS media to use.

Gets an array of the HTML IDs of tagged visible items.

The Object ID of the object. The IDs of tagged visible HTML objects.

Gets an array of the locations of tagged visible items.

The Object ID of the object. The location of tagged visible HTML objects.

A helper filter to give only the HtmlOptions supported by Internet Explorer HTML engine.

The width of the virtual browser in pixels.

A user name to be used for authentication.

A password to be used for authentication.

Whether hyperlinks should be live.

Whether form fields should be live.

Whether movies and other active content should be live.

Whether the location of certain tags should be noted.

Whether hyperlinks with targets should be allowed to open in a new browser window.

Whether the values of form elements, except radio buttons, with the same name are distinct.

Whether font substitution should be used to reduce file size.

Whether fonts should be embedded rather than referenced.

Whether embedded fonts should be subset.

Whether fonts with restricted licensing should be protected from embedding.

The quality of compression acceptable for continuous tone images such as JPEGs.

The maximum amount of time allowed for obtaining a page (ms).

The minimum number of content items required for a page to be valid.

The number of times a page should be retried if unavailable or invalid.

Whether content should be rendered in multipaged format.

Whether to hide the background color of a page.

Additional HTTP headers to send in the request.

A script to be run after the page is loaded.

The request method for URL.

Whether to disable automatic cookies.

The conditions under which to coerce a vector output.

The conditions under which to disable vector-output coercion.

Whether to host a WebBrowser control.

Whether to deactivate the WebBrowser.

Whether to enable JavaScript and VBScript.

Whether to enable ActiveX.

Whether to enable Java.

Whether to enable Video.

Whether to resynchronize page.

Whether any proxy servers should re-request items of content.

Whether the page cache should be searched first.

The length of time that pages can be held in the cache (ms).

The number of pages that can be held in the cache.

The maximum size at which an image may be regarded as atomic.

Whether HTML pages are marked up before conversion to PDF.

Whether to automatically clip redundant content at the end of the page.

The minimum width to be used for auto-sized pages.

The percentage of the current drawing area in which HTML breaks can occur.

The page break logic for HTML.

The delegate called during HTML rendering.

The delegate called when embedding an object during HTML rendering.

Clear all items from the page cache.

Clear all expired items from the page cache.

Convert external links to internal links wherever possible.

Convert external links to internal links.

Specifies both linkIDs and destIDs. The number of links converted.

Convert external links to internal links.

The list of IDs of view objects containing links (anchor tags with href attributes). The list of IDs of view objects containing destinations (anchor tags with name attributes). Whether links pointing to the URLs of HTML pages (URLs without fragments) are converted to internal links. The default value is false. The number of links converted.

Gets an array of the HTML IDs of tagged visible items.

The Object ID of the object. The IDs of tagged visible HTML objects.

Gets an array of the locations of tagged visible items.

The Object ID of the object. The location of tagged visible HTML objects.

Gets an array of the locations of tagged visible items before Doc.Transform is applied.

The Object ID of the object. The location (before Doc.Transform is applied) of tagged visible HTML objects.

Retrieves the HTTP status code.

The Object ID of the web page to be accessed. The HTTP status code or zero if not available.

Retrieves the client side onload script return value.

The Object ID of the web page to be accessed. The return value.

The collection of HTML parameter names and values.

The collection of parameter names in a HtmlParameterDictionary.

Initializes a new instance that reflects the keys in the specified HtmlParameterDictionary.

The HtmlParameterDictionary whose keys are reflected.

Gets the number of elements contained.

Copies the HtmlParameterDictionary.KeyCollection elements to an existing one-dimensional Array, starting at the specified array index.

The one-dimensional Array that is the destination of the elements copied. The zero-based index in array at which copying begins.

Enumerates the elements of a HtmlParameterDictionary.KeyCollection.

Releases all resources used by the HtmlParameterDictionary.KeyCollection.Enumerator.

Gets the element at the current position of the enumerator.

Advances the enumerator to the next element of the HtmlParameterDictionary.KeyCollection.

true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection.

Returns an enumerator that iterates through the HtmlParameterDictionary.KeyCollection.

A HtmlParameterDictionary.KeyCollection.Enumerator.

The collection of parameter values in a HtmlParameterDictionary.

Initializes a new instance that reflects the values in the specified HtmlParameterDictionary.

The HtmlParameterDictionary whose values are reflected.

Gets the number of elements contained.

Copies the HtmlParameterDictionary.ValueCollection elements to an existing one-dimensional Array, starting at the specified array index.

The one-dimensional Array that is the destination of the elements copied. The zero-based index in array at which copying begins.

Enumerates the elements of a HtmlParameterDictionary.ValueCollection.

Releases all resources used by the HtmlParameterDictionary.ValueCollection.Enumerator.

Gets the element at the current position of the enumerator.

Advances the enumerator to the next element of the HtmlParameterDictionary.ValueCollection.

true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection.

Returns an enumerator that iterates through the HtmlParameterDictionary.ValueCollection.

A HtmlParameterDictionary.ValueCollection.Enumerator.

Initializes a new empty instance that has the default initial capacity, and uses the default equality comparer for the key type.

Initializes a new empty instance that has the specified initial capacity, and uses the default equality comparer for the key type.

The initial number of elements that the HtmlParameterDictionary can contain.

Initializes a new empty instance that has the default initial capacity, and uses the specified IEqualityComparer.

The IEqualityComparer implementation to use when comparing keys, or null to use the default EqualityComparer for the type of the key.

Initializes a new empty instance that has the specified initial capacity, and uses the specified IEqualityComparer.

The initial number of elements that the HtmlParameterDictionary can contain. The IEqualityComparer implementation to use when comparing keys, or null to use the default EqualityComparer for the type of the key.

Initializes a new instance that contains elements copied from the specified IDictionary and uses the default equality comparer for the key type.

The IDictionary whose elements are copied.

Initializes a new instance that contains elements copied from the specified IDictionary and uses the specified IEqualityComparer.

The IDictionary whose elements are copied. The IEqualityComparer implementation to use when comparing keys, or null to use the default EqualityComparer for the type of the key.

Gets the IEqualityComparer that is used to determine equality of keys for the dictionary.

Gets a collection containing the keys.

Gets a collection containing the values.

Determines whether the HtmlParameterDictionary contains a specific value.

The value to locate. true if the HtmlParameterDictionary contains an element with the specified value; otherwise, false.

Gets or sets the value associated with the specified key.

The key of the value to get or set. The value associated with the specified key. If the specified key is not found, a get operation throws a KeyNotFoundException, and a set operation creates a new element with the specified key.

Determines whether the HtmlParameterDictionary contains the specified key.

The key to locate. true if the HtmlParameterDictionary contains an element with the specified key; otherwise, false.

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 value parameter. true if the HtmlParameterDictionary contains an element with the specified key; otherwise, false.

Adds the specified key and value to the dictionary.

The key of the element to add. The value of the element to add.

Removes the value with the specified key.

The key of the element to remove. true if the element is successfully found and removed; otherwise, false. This method returns false if key is not found.

Gets the number of key/value pairs contained.

Removes all keys and values.

Enumerates the elements of a HtmlParameterDictionary.

Releases all resources used by the HtmlParameterDictionary.Enumerator.

Gets the element at the current position of the enumerator.

Advances the enumerator to the next element of the HtmlParameterDictionary.

true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection.

Returns an enumerator that iterates through the HtmlParameterDictionary.

A HtmlParameterDictionary.Enumerator structure.

A helper filter to give only the HtmlOptions supported by Gecko HTML engine.

Gets the version of the Gecko engine.

The version of the Gecko engine.

The width of the virtual browser in pixels.

A user name to be used for authentication.

A password to be used for authentication.

Whether hyperlinks should be live.

Whether form fields should be live.

Whether movies and other active content should be live.

Whether the location of certain tags should be noted.

Whether the values of form elements, except radio buttons, with the same name are distinct.

Whether font substitution should be used to reduce file size.

Whether fonts should be embedded rather than referenced.

Whether embedded fonts should be subset.

Whether fonts with restricted licensing should be protected from embedding.

The quality of compression acceptable for continuous tone images such as JPEGs.

The maximum amount of time allowed for obtaining a page (ms).

The minimum number of content items required for a page to be valid.

The number of times a page should be retried if unavailable or invalid.

Whether to hide the background color of a page.

A script to be run after the page is loaded.

The request method for URL.

The CSS media to use.

Whether to enable JavaScript and VBScript.

Whether any proxy servers should re-request items of content.

Whether to improve the support for page-break-inside of avoid.

Whether to improve the support for page break in table to prevent missing rows.

Whether to disable the default background color.

Whether to disable the snap rounding of coordinates and lengths.

The minimum width to be used for auto-sized pages.

The options for new worker processes.

Convert external links to internal links wherever possible.

Convert external links to internal links.

Specifies both linkIDs and destIDs. The number of links converted.

Convert external links to internal links.

The list of IDs of view objects containing links (anchor tags with href attributes). The list of IDs of view objects containing destinations (anchor tags with name attributes). Whether links pointing to the URLs of HTML pages (URLs without fragments) are converted to internal links. The default value is false. The number of links converted.

Gets an array of the HTML IDs of tagged visible items.

The Object ID of the object. The IDs of tagged visible HTML objects.

Gets an array of the locations of tagged visible items.

The Object ID of the object. The location of tagged visible HTML objects.

Gets an array of the locations of tagged visible items before Doc.Transform is applied.

The Object ID of the object. The location (before Doc.Transform is applied) of tagged visible HTML objects.

Retrieves the HTTP status code.

The Object ID of the web page to be accessed. The HTTP status code or zero if not available.

Retrieves the client side onload script return value.

The Object ID of the web page to be accessed. The return value.

Ends any HTML Engine worker threads or processes.

The way in which to select threads or processes that should be ended. The number of selected threads or processes.

A helper filter to give only the HtmlOptions supported by Internet Explorer HTML engine.

The width of the virtual browser in pixels.

A user name to be used for authentication.

A password to be used for authentication.

Whether hyperlinks should be live.

Whether form fields should be live.

Whether movies and other active content should be live.

Whether the location of certain tags should be noted.

Whether hyperlinks with targets should be allowed to open in a new browser window.

Whether the values of form elements, except radio buttons, with the same name are distinct.

Whether font substitution should be used to reduce file size.

Whether fonts should be embedded rather than referenced.

Whether embedded fonts should be subset.

Whether fonts with restricted licensing should be protected from embedding.

The quality of compression acceptable for continuous tone images such as JPEGs.

The maximum amount of time allowed for obtaining a page (ms).

The minimum number of content items required for a page to be valid.

The number of times a page should be retried if unavailable or invalid.

Whether content should be rendered in multipaged format.

Whether to hide the background color of a page.

Additional HTTP headers to send in the request.

The user-agent string.

A script to be run after the page is loaded.

The request method for URL.

Whether to disable automatic cookies.

Whether to reload page.

The conditions under which to coerce a vector output.

The conditions under which to disable vector-output coercion.

Whether to host a WebBrowser control.

Whether to deactivate the WebBrowser.

The method for loading URI/HTML.

The module for obtaining URI/HTML data.

Whether to enable JavaScript and VBScript.

Whether to enable ActiveX.

Whether to enable Java.

Whether to enable Video.

Whether to resynchronize page.

Whether any proxy servers should re-request items of content.

Whether to use theme.

Whether not to use theme.

Whether the page cache should be searched first.

The length of time that pages can be held in the cache (ms).

The number of pages that can be held in the cache.

The maximum size at which an image may be regarded as atomic.

Whether HTML pages are marked up before conversion to PDF.

Whether HTML layout is checked and adjusted for optimal output to PDF.

Whether to automatically clip redundant content at the end of the page.

The minimum width to be used for auto-sized pages.

The percentage of the current drawing area in which HTML breaks can occur.

The page break logic for HTML.

The options for new worker processes.

The delegate called during HTML rendering.

The delegate called when embedding an object during HTML rendering.

Sets whether to use theme or not.

Whether to use theme or not.

Sets whether to use theme or not.

Whether to use theme. Whether not to use theme.

Clear all items from the page cache.

Clear all expired items from the page cache.

Convert external links to internal links wherever possible.

Convert external links to internal links.

Specifies both linkIDs and destIDs. The number of links converted.

Convert external links to internal links.

The list of IDs of view objects containing links (anchor tags with href attributes). The list of IDs of view objects containing destinations (anchor tags with name attributes). Whether links pointing to the URLs of HTML pages (URLs without fragments) are converted to internal links. The default value is false. The number of links converted.

Gets an array of the HTML IDs of tagged visible items.

The Object ID of the object. The IDs of tagged visible HTML objects.

Gets an array of the locations of tagged visible items.

The Object ID of the object. The location of tagged visible HTML objects.

Gets an array of the locations of tagged visible items before Doc.Transform is applied.

The Object ID of the object. The location (before Doc.Transform is applied) of tagged visible HTML objects.

Retrieves the HTTP status code.

The Object ID of the web page to be accessed. The HTTP status code or zero if not available.

Retrieves the client side onload script return value.

The Object ID of the web page to be accessed. The return value.

Image class.

Image constructor.

XPoint destructor.

Dispose of the XImage.

Dispose of the XImage.

The XReadOptions used to create the object. The Stream used to create the object if NeedsStream is true.

Dispose of the XImage.

Load an image from a file.

The path to the graphic file. The settings for the read. The resulting IndirectObject.

Load an image from data.

The data containing the graphic. The settings for the read. The resulting IndirectObject.

Load an image from a stream.

The stream containing the graphic. The settings for the read. The resulting IndirectObject.

Load an image from a file.

The path to the graphic file.

Load an image from data.

The data containing the graphic.

Load an image from a stream.

The stream containing the graphic.

Assign a soft mask to the image.

The image containing the soft mask. Whether to invert the mask.

The type of image.

The number of frames in the image.

The default frame rate for a moving image.

The currently selected frame.

The width of the current frame (pixels).

The height of the current frame (pixels).

Whether the image specifies the resolution.

The horizontal resolution of the current frame (DPI).

The vertical resolution of the current frame (DPI).

The orientation of the current frame.

The applied orientation of the current frame.

The current selection rectangle.

The physical bounds of the image in points.

Whether the image can be added indirect.

Whether the file needs to exist.

Whether the stream needs be kept open.

Clears the image freeing up resources.

Clears the image freeing up resources.

The XReadOptions used to create the object. The Stream used to create the object if NeedsStream is true.

XPoint class.

XPoint constructor.

XPoint constructor.

A string defining the initial point in the format "x y".

XPoint constructor.

Creates a deep copy of the current XPoint.

XPoint destructor.

Dispose of the XPoint.

Dispose of the XPoint.

A string representation of the point.

The string representation of the object.

A string representation of the point.

The horizontal offset of the point from the bottom left.

The vertical offset of the point from the bottom left.

The point as a System.Drawing Point.

Set the point.

The source point.

Test whether two points are the same.

The XPoint to test against. Whether the two XPoints are equal.

Test whether the two points are the same.

The object to test against. Whether the objects are equal.

Determines if two points are effectively the same.

The point to be compared against this one. The largest difference in coordinates which will still be defined as equal.

A hash code for the XPoint.

The returned hash code.

Compares this instance of an XPoint to another and returns an indication of their relative values.

A System.Object that evaluates to an XPoint. A signed number indicating the relative value of this instance.

Copies a series of X and Y coordinates from an array of XPoints to an array of doubles. The array of doubles is represented as a series of pairs of X and Y coordinates. So the double array should be twice the length of the XPoint array.

An array of XPoints to be copied from. An array of doubles to be copied to. The number of points in the source array to copy.

Copies a series of X and Y coordinates from an array of XPoints to an array of doubles. The array of doubles is represented as a series of pairs of X and Y coordinates. So the double array should be twice the length of the XPoint array. Any null XPoint entries in the array will be assumed to be 0,0.

An array of XPoints to be copied from. The index in the source array at which copying begins. An array of doubles to be copied to. The index in the destination array at which copying begins. The number of points in the source array to copy.

Copies a series of X and Y coordinates from an array of doubles to an array of XPoints. The array of doubles is represented as a series of pairs of X and Y coordinates. So the double array should be twice the length of the XPoint array.

An array of doubles to be copied from. An array of XPoints to be copied to. The number of points (ie pairs of doubles) in the source array to copy.

Copies a series of X and Y coordinates from an array of doubles to an array of XPoints. The array of doubles is represented as a series of pairs of X and Y coordinates. So the double array should be twice the length of the XPoint array. Each XPoint in the destination array will be newly created from the source array values.

An array of doubles to be copied from. The index in the source array at which copying begins. An array of XPoints to be copied to. The index in the destination array at which copying begins. The number of points (ie pairs of doubles) in the source array to copy.

The module used for read operations.

A default set of modules.

The SWF vector module.

The XPS module.

The XPS module with the XPS printer driver.

The OpenOffice.org PDF conversion.

The PDF read module.

The SVG vector import module.

The EPS vector import module.

The base raster image import module.

The tiff import module.

The Photoshop import module.

Microsoft Office import module.

WordGlue import module.

Rich Text Format (RTF) import module.

Bookmark creation strategy.

Use module-specific default settings.

Do not import any bookmarks from source documents.

Use document headings as bookmarks.

Content items to process.

Use module-specific default settings.

Import only main content.

Import main content and mark-up.

The error-handling option for read operations.

Produces output until an error is encountered.

No output is produced when an error is encountered.

Settings for read operations.

XReadOptions constructor.

Dispose of the XReadOptions.

The module to use.

Bookmark creation strategy.

Content items to process.

The error-handling option.

The password needed to read the source.

The file extension when the source is specified not with a path or a file name.

The import warning and information log.

Indicates whether the transparency of raster images should be preserved.

The timeout for external components.

Whether to enable macros when opening MS Office documents. This property is supported only for Word, Excel and Powerpoint.

Whether the values of form elements with the same name are distinct.

The Operation to use.

The frame to be read from a multiple frame image such as a movie.

Whether form fields should be live.

Whether links should be live.

OpenOffice.org PDF conversion control parameters.

The default document size for documents that do not specify a size.

The font to use for text that does not specify a font.

Perform extra checks when reading, for importing non-compliant PDF documents.

Skip back a number of revisions when reading an incrementally saved PDF document.

Whether to automatically open the default document inside a PDF portfolio rather than the portfolio itself. If you wish to see the document the way a user would see it when it opens, them this parameter should be set to true. If you wish to operate upon the set of files embedded in the portfolio then it should be set to false.

The default resolution to use for the import.

Clear cached data and terminate worker threads and worker processes for a read module.

Whether it has taken an action.

Test whether two XReadOptions are the same.

The XReadOption to test against. Whether the two XReadOption are equal.

Test whether the two read options are the same.

The object to test against. Whether the objects are equal.

A hash code for the XReadOption.

The returned hash code.

Creates a deep copy of the current XReadOptions.

XRect class.

Corner Enumeration.

Bottom Left Corner.

Top Left Corner.

Bottom Right Corner.

Top Right Corner.

Create an XRect from the coordinates of two diagonally opposite corners.

The minimum x coordinate. The minimum y coordinate. The maximum x coordinate. The maximum y coordinate. The newly created XRect object.

Create an XRect from a bottom left corner, a width and a height.

The left coordinate. The bottom coordinate. The width of the rectangle. The height of the rectangle. The newly created XRect object.

Create an XRect from a top left corner, a width and a height.

The left coordinate. The top coordinate. The width of the rectangle. The height of the rectangle. The newly created XRect object.

Create the smallest XRect that encloses all the XPoints supplied. If no points or null is supplied then the return value is null.

An array containing points. The newly created XRect object.

Create an XRect from a standard PDF Rectangle ArrayAtom. Such arrays typically contain four numbers - lower left x and y coordinates followed by upper right x and y. However this is a convention and any two diagonally opposite points are acceptable. If the array is null or the entries do not resolve to four NumAtoms then the return value will be null.

An ArrayAtom containing four NumAtoms. Any IndirectObject from the document. The newly created XRect object.

Create an XRect from a list of four doubles. Such arrays typically contain lower left x and y coordinates followed by upper right x and y. However this is a convention and any two diagonally opposite points are acceptable. If the array is null or does not contain four items then the return will be null.

An IList containing four doubles. The newly created XRect object.

Create an XRect from an array of four doubles. Such arrays typically contain lower left x and y coordinates followed by upper right x and y. However this is a convention and any two diagonally opposite points are acceptable. If the array is null or does not contain four items then the return will be null.

An array containing four doubles. The newly created XRect object.

XRect constructor. To construct an XRect with initial values use one of the static constructors such as XRect.FromSides, XRect.FromLbwh or XRect.FromPoints.

XRect constructor using a string initializer.

A string defining the initial rectangle in the format "left bottom right top".

Creates a deep copy of the current XRect.

XRect destructor.

Dispose of the XPoint.

Dispose of the XPoint.

A string representation of the rectangle.

The string representation of the object.

A string representation of the rectangle.

The offset of the top edge from the bottom left.

The offset of the left edge from the bottom left.

The offset of the bottom edge from the bottom left.

The offset of the right edge from the bottom left.

The width of the rectangle.

The height of the rectangle.

Translate the rectangle up and right.

The horizontal distance to move the rectangle. The vertical distance to move the rectangle.

Scale the rectangle, pinning the bottom left corner.

The horizontal scale factor. The vertical scale factor.

Move the rectangle, preserving width and height.

The new left position. The new bottom position.

Move the specified corner of the rectangle to a position, preserving width and height.

The new left position. The new bottom position. The corner to position.

Inset the rectangle horizontally and vertically.

The amount to inset the left and right edges. The amount to inset the top and bottom edges.

Get the four corners of the rectangle from the bottom left going clockwise.

The rectangle as a System.Drawing Rectangle.

The corner of the rectangle to pin.

Resize the rectangle preserving position.

The new width. The new height.

Resize the rectangle preserving the position of the specified corner.

The new width. The new height. The corner to pin.

Set the position and size of the rectangle.

The new left position. The new bottom position. The new width. The new height.

Set the position and size of the rectangle.

The source rectangle.

Set the sides of the rectangle.

The new left position. The new bottom position. The new right position. The new top position.

Intersect this rectangle with another rectangle.

The other rectangle to intersect with.

Determine if this rectangle intersects with another.

Union the rectangle with another rectangle. This rectangle becomes the smallest rectangle that encloses both rectangles. Rectangles with no area are ignored.

The rectangle to add to this one. The supplied rectangle is left unchanged by this function.

Union the rectangle with another rectangle. This rectangle becomes the smallest rectangle that encloses both rectangles.

The rectangle to add to this one. The supplied rectangle is left unchanged by this function. Whether rectangles with no area should be ignored.

Determine if the rectangle encloses any area.

Determine if the rectangle contains a point.

Determine if the rectangle contains a point.

Determine if the rectangle contains a point.

Determine if the rectangle contains a point.

Determine if the rectangle contains a point.

Determine if this rectangle fully contains another rectangle.

Test whether two rects are the same.

The XRect to test against. Whether the two XRects are equal.

Test whether the two rects are the same.

The object to test against. Whether the objects are equal.

Determines if two rects are effectively the same.

The rect to be compared against this one. The largest difference in coordinates which will still be defined as equal.

A hash code for the XRect.

The returned hash code.

Compares this instance of an XRect to another and returns an indication of their relative values.

A System.Object that evaluates to an XRect. A signed number indicating the relative value of this instance.

Fit the rectangle as content inside another rectangle.

Content alignment.

Center.

Left.

Right.

Top.

Bottom.

Content scale mode.

Make the content the biggest and completely within the area while keeping the aspect ratio.

Make the content the smallest and covering the entire area while keeping the aspect ratio.

Scale the content possibly with distortion to fit the entire area.

No scaling.

XRendering Class.

Rendering Compression Enumeration.

Uncompressed

G3 Black and White Fax Compression

G4 Black and White Fax Compression

LZW Compression

JPEG Compression

Adobe Flate Compression

Flate Compression

Macintosh PackBits

Rendering Colorspace Enumeration.

Red, green and blue

Grayscale

Cyan, magenta, yellow and black

Lab - a device independent color space

Indexed RGB - see the PaletteSize property

The output resolution in dots per inch.

The horizontal output resolution in dots per inch.

The vertical output resolution in dots per inch.

The output colorspace.

The output bits per color channel.

The number of colors in the palette for indexed color output.

Whether to anti-alias text.

Whether to anti-alias polygons.

Whether to anti-alias images.

Whether to apply entire scene anti-aliasing.

Whether to save the alpha channel.

Whether to resize images for vector (emf, ps, etc.) output.

The output file quality factor for lossy compression (0 to 100).

The type of compression to prefer when saving.

The minimum stroked line width for output.

The minimum stroked line width for output.

Whether to append to (rather than overwrite) existing image files.

The path to the default Gray ICC color profile.

The path to the default RGB ICC color profile.

The path to the default CMYK ICC color profile.

The path to the default CMYK ICC color profile.

Whether to apply overprint.

Whether to render fields and annotations.

The named separation.

Halftone type and options.

Whether to use embedded halftones.

Whether pages should be automatically rotated.

Number of strips to generate when writing a tiff file.

The log for the last render.

A collection of TIFF tags that should be written to the output file.

Renders and saves the current area of the current page as data.

A dummy file name used to determine the type of image required. The image as an array of bytes.

Renders and saves the current area of the current page to a Bitmap.

The Bitmap containing the image.

Renders and saves the current area of the current page as a file.

The destination file path.

Renders and saves the current area of the current page to a stream.

A dummy file name used to determine the type of image required. The destination stream.

XSaveOptions Class.

Whether to reduce size by remapping objects.

Whether to linearize the output for fast web viewing.

Whether to use incremental update to preserve the validity of signature fields.

Whether to use object stream compression to reduce the size of documents.

Whether to update the file version identifier.

Whether to assign a constant file version identifier.

Whether to assign non-ASCII file identifiers.

The file extension when the target is specified not with a path or a file name.

The path to the template file.

The template data.

The folder where to save additional files (images, fonts, etc).

The XPS output quality for lossy compression (0 to 100).

Specify the type of graphic paths.

Use a sensible default type for the exporter.

Do not embed graphics in the final output.

Render graphics using images, valid for MS Word and HTML exporters.

Render graphics via VML, valid for MS Word exporter.

Render graphics via HTML 5 Canvas, valid for HTML exporter.

How to implement paths, valid values depend on exporter format.

//@HTML and MS Word Exporters only, throw on invalid format

The font substitution type.

Use a sensible default font substituion type.

Always substitute fonts with those installed on the machine.

Only substitute fonts which are missing or could not be converted to open type.

The font substitution type.

//@HTML and MS Word Exporters only

The delegate called to write the page separator for export.

The arguments passed to WritePageSeparator.

The writer. It is an XmlWriter for HTML export.

Writes the default page separator.

The page number, which starts at 1.

The delegate called to write the page separator for export.

//@HTML Exporter only

Raster Smoothing.

Specifies the default algorithm.

Specifies no anti-aliasing.

Specifies anti-aliasing.

XSaveTemplateData Class.

The template that specifies one page per frame.

XSaveTemplateData constructor.

The horizontal measurement resolution.

The vertical measurement resolution.

The smoothing for displaying images.

The JPEG quality level.

Whether JPEG images are re-encoded in JPEG.

Sets the measurement resolutions.

The new measurement resolution in DPI.

Sets the measurement resolutions.

The new horizontal measurement resolution in DPI. The new vertical measurement resolution in DPI.

LicenseType Enumeration.

Unknown or undefined.

Trial license with professional feature set.

Standard feature set.

Professional feature set.

XSettings Class.

The current license for the software.

The current feature level for the software.

The current license for the software.

The current licensee for the software.

Whether to log errors in the Application Event Log.

The current assembly.

The software version.

Register and install trial license.

A trial license key used for remote deployment.

Install a license. Return true if license is valid.

The license to install. True if a license is installed, otherwise false.

Install a redistribution license. Return true if license is valid.

The license to install. True if a license is installed, otherwise false.

Install a trial license.

The license to install. True if a license is installed, otherwise false.

Install a system license. Return true if license is installed.

The license to install. True if a license is installed, otherwise false.

Set the application configuration section.

The ABCpdf configuration section.

Whether the current license is valid in this particular process.

Load color books for use when rendering spot color images.

The file to load or directory to scan.

XTextStyle class.

KerningType Enumeration.

No kerning.

Uses the default kerning.

DirectionType Enumeration.

No preferred reading direction.

Prefer left to right reading direction (eg English).

Prefer right to left reading directiong (eg Hebrew).

XTextStyle constructor.

XTextStyle destructor.

Dispose of the XTextStyle.

Dispose of the XTextStyle.

A string representation of the style.

The string representation of the object.

A string representation of the style.

The text size (points).

The first line of paragraph indent (points).

The inter-character spacing (points).

The inter-word spacing (points).

The inter-line spacing (points).

The inter-paragraph spacing (points).

The distance between the line spacing below the top of the text frame and the first baseline (1000ths of em).

The horizontal justification factor (0 to 1).

Whether to apply an underline.

Whether to apply a strikethrough.

Whether to apply a double strikethrough.

The width of outline to use.

Whether to synthesize and apply an italic style.

Whether to synthesize and apply a bold style.

Whether to preserve white space characters for plain text.

The kerning of type.

The default kerning is based on the glyph indexes and the kerning table which applies to them. This is sometimes known as format zero. There are other other types of kerning based on classes of glyphs and the relationship between ther classes. This is sometimes known as format two. In theory the two formats will produce the same result. However this depends on the accuracy with which the fonts are constructed. There are no formats one or three. As well as the standard kerning there are other forms which allow shifts perpendicular to the text flow. However this is unusual and little used and is not currently supported.

The usage of characters.

The paragraph indent (points).

The default text direction.

Most Western languages have a default reading direction of left-to-right. However some other languages, notably Hebrew and Arabic, read right-to left. To further complicate matters it is quite common for languages like Hebrew to read bi-directionally - to have sections which are read left-to-right against the normal flow of text. The most common case in which this occurs is the use of numbers in text. Numbers are always read left-to-right. However it is also quite common to quote English names and again these are read in the standard English direction. This property allows you to set the default or predominant direction to be assumed for text.

The ID of the current font.

The horizontal positioning factor (0 to 1).

The vertical positioning factor (0 to 1).

XTransform class.

AngleUnitType Enumeration.

Degrees.

Radians.

XTransform constructor.

Matrix entry 1,1. Matrix entry 1,2. Matrix entry 2,1. Matrix entry 2,2. The x translation to be applied. The y translation to be applied.

XTransform constructor.

An array of doubles specifying the values for the matrix. These are in the order m11, m12, m21, m22, tx and ty.

XTransform constructor.

A string defining the initial transform in the format returned by the String property.

XTransform constructor.

XTransform constructor.

XTransform constructor.

Creates a deep copy of the current XTransform.

XTransform destructor.

Dispose of the XTransform.

Dispose of the XTransform.

A string representation of the transform.

The string representation of the object.

A string representation of the transform.

The x translation.

The y translation.

Reset to the identity.

Invert the transform.

Translate horizontally and vertically.

The distance to translate to the right. The distance to translate upwards.

Rotate about a locked anchor point (angle according to AngleUnit property).

The angle to rotate in degrees. The horizontal coordinate about which the rotation should be applied. The vertical coordinate about which the rotation should be applied.

Scale about a locked anchor point.

The amount of horizontal scaling to apply. The amount of vertical scaling to apply. The horizontal coordinate about which the stretch should be applied. The vertical coordinate about which the stretch should be applied.

Skew horizontally and vertically about a locked anchor point.

The amount of horizontal skewing to apply. The amount of vertical skewing to apply. The horizontal coordinate about which the stretch should be applied. The vertical coordinate about which the stretch should be applied.

Set the transform.

The new horizontal scale. The new vertical skew. The new horizontal skew. The new vertical scale. The new horizontal translation. The new vertical translation.

Set the transform.

The source transform.

Pre-multiplies this tranformation matrix by the supplied transform, by prepending the specified transform matrix.

The transform to be prepended.

Multiplies this tranformation matrix by the supplied transform, by appending the specified transform matrix.

The transform to be appended.

Determines if two transforms are effectively the same.

The transform to be compared against this one. The largest difference in values which will still be defined as equal.

Applies this transform to a specified array of points.

The array of points to be transformed.

Applies this transform to a specified array of points.

The array of points to be transformed.

Applies this transform to a specified array of points.

The array of points to be transformed.

Applies this transform to a specified point.

The point to be transformed.

Applies this transform to a specified point.

The point to be transformed.

Applies this transform to a specified point.

The point to be transformed.

Applies this transform to a specified point.

The point to be transformed.

The transform as an array of floating-point values.

The transform as a System.Drawing Matrix.

The transform as a System.Windows.Media Matrix.

The angle units, degrees or radians.

Test whether two transforms are the same.

The XTransform to test against. Whether the two XTransform are equal.

Test whether the two transforms are the same.

The object to test against. Whether the objects are equal.

A hash code for the XTransform.

The returned hash code.

Compares this instance of an XTransform to another and returns an indication of their relative values.

A System.Object that evaluates to an XTransform. A signed number indicating the relative value of this instance.

An object encapsulating a PDF document.

Document constructor.

Doc destructor.

The ID of the current page.

The ID of the current font.

The current text size (points).

The current line width (points).

The horizontal positioning factor (0 to 1).

The vertical positioning factor (0 to 1).

The current drawing color.

The current drawing position.

The current drawing rectangle.

The page size.

The current text style.

The current default transformation.

The current encryption settings.

The current license details.

The ID of the root catalog.

The content insertion position (one is top).

The number of layers in the current page.

Add a page - return the page ID.

Add a page at a specified location - return the page ID.

Add a font resource - return the font ID.

Add a font resource - return the font ID.

Add a font resource - return the font ID.

Add a block of text - return the text ID.

Add a block of HTML styled text - return the text ID.

Chain a block of HTML styled text - return the text ID.

Add a line - return the line ID.

Add an image - return the image ID.

Add an image - return the image ID.

Add an image - return the image ID.

Add an image - return the image ID.

Add an image - return the image ID.

Add an image - return the image ID.

Add an image - return the image ID.

Add an image - return the image ID.

Add an image - return the image ID.

Get a particular type of information about an object.

Get numeric information about an object.

Add a framed rectangle - return the line ID.

Add a framed rounded rectangle - return the line ID.

Add a filled rectangle - return the line ID.

Add a filled rounded rectangle - return the line ID.

Delete a specified object.

Save the PDF as a file.

Write the PDF to a stream.

Get the PDF as raw data.

Read an existing PDF from data.

Read an existing PDF from data.

Read an existing PDF from file.

Read an existing PDF from file.

Read an existing PDF from stream.

Embed a font resource - return the font ID.

Embed a font resource - return the font ID.

Embed a font resource - return the font ID.

Embed a font resource - return the font ID.

Alters an aspect of an existing object.

Adds a bookmark for the current page.

Adds a native PDF object to the document.

Flattens and compresses the current page.

Clears the document freeing up resources.

Adds an alignment grid to help position objects.

The page number (one is the first page).

The number of pages in the document.

Appends a PDF document to the end of the current document.

Add an arc - return the line ID.

The current line options.

XColor Class.

XColor constructor.

XColor destructor.

A string representation of the color.

A string representation of the color.

The red intensity of the color (0 to 255).

The green intensity of the color (0 to 255).

The blue intensity of the color (0 to 255).

The gray intensity of the color (0 to 255).

The cyan intensity of the color (0 to 100).

The magenta intensity of the color (0 to 100).

The yellow intensity of the color (0 to 100).

The black intensity of the color (0 to 100).

The native color space for the color.

The color as a System.Drawing.Color.

XEncryption class.

XEncryption destructor.

The level of encryption to use.

The user password.

The owner password.

Whether a user can print the document.

Whether a user can modify the document.

Whether a user can copy from the document.

Whether a user can edit the document.

Whether a user can fill forms in the document.

Whether a user can extract detail from the document.

Whether a user can assemble the document.

Whether a user can print a high resolution copy of the document.

Image class.

Image constructor.

XPoint destructor.

Load an image from a file.

Load an image from data.

Load an image from a stream.

The type of image.

The number of frames in the image.

The currently selected frame.

The width of the current frame (pixels).

The height of the current frame (pixels).

The horizontal resolution of the current frame (DPI).

The vertical resolution of the current frame (DPI).

The current selection rectangle.

Clears the image freeing up resources.

XPoint class.

XPoint constructor.

XPoint destructor.

A string representation of the point.

A string representation of the point.

The horizontal offset of the point from the bottom left.

The vertical offset of the point from the bottom left.

The point as a System.Drawing Point.

XRect class.

XRect constructor.

XRect destructor.

A string representation of the rectangle.

A string representation of the rectangle.

The offset of the top edge from the bottom left.

The offset of the left edge from the bottom left.

The offset of the bottom edge from the bottom left.

The offset of the right edge from the bottom left.

The width of the rectangle.

The height of the rectangle.

Translate the rectangle up and right.

Scale the rectangle, pinning the bottom left corner.

Move the bottom left corner to a position, preserving width and height.

Inset the rectangle horizontally and vertically.

The rectangle as a System.Drawing Rectangle.

The corner of the rectangle to pin.

XSettings Class.

The current license for the software.

Whether to log errors in the Application Event Log.

The software version.

Register and install trial license.

XTextStyle class.

XTextStyle constructor.

XTextStyle destructor.

A string representation of the style.

A string representation of the style.

The text size (points).

The first line of paragraph indent (points).

The inter-character spacing (points).

The inter-word spacing (points).

The inter-line spacing (points).

The inter-paragraph spacing (points).

The horizontal justification factor (0 to 1).

Whether to apply an underline.

Whether to apply a strikethrough.

Whether to apply a double strikethrough.

The width of outline to use.

Whether to synthesize and apply an italic style.

Whether to synthesize and apply a bold style.

The paragraph indent (points).

XTransform class.

XTransform constructor.

XTransform destructor.

A string representation of the transform.

A string representation of the transform.

Reset to the identity.

Invert the transform.

Translate horizontally and vertically.

Rotate about a locked anchor point (angle in degrees).

Scale about a locked anchor point.

Skew horizontally and vertically about a locked anchor point.

The transform as a System.Drawing Matrix.

An Atom containing an array of other Atoms.

ArrayAtom constructor.

The number of Atoms in the array.

Copies the Atoms into an array.

Gets or sets the Atom at the specified index.

Gets or sets the integer at the specified index.

Gets or sets the double at the specified index.

Gets or sets the string at the specified index.

Add an Atom to the end of the array.

Add an integer to the end of the array.

Add a double to the end of the array.

Add a string to the end of the array.

Removes all Atoms from the array.

Determines whether the array contains a specific Atom.

Determines the index of a specific Atom.

Inserts an Atom into the array at the specified position.

Removes an Atom from the array.

Removes an Atom at a specified position from the array.

Gets an enumerator for the Collection.

A PDF atomic object comprising a basic chunk of PDF data.

Atom destructor.

Create an appropriate type of Atom from a raw PDF string representation.

Test whether the two Atoms are the same.

Creates a deep copy of the current Atom.

A hash code for the Atom.

The string representation of the Atom as it would appear in a PDF.

Dispose of the Atom.

Dispose of the Atom.

An Atom containing a boolean value.

Construct a BoolAtom.

Construct a BoolAtom from a boolean value.

Whether the boolean is true or false.

An Atom containing a dictionary of other Atoms indexed by name.

DictAtom constructor.

Gets the number of elements in the dictionary.

Copies the Atoms into an array.

Gets or set the Atom with the specified key.

Gets or set the integer with the specified key.

Gets or set the double with the specified key.

Gets or set the string with the specified key.

Add an Atom to the dictionary.

Add an integer to the dictionary.

Add a double to the dictionary.

Add a string to the dictionary.

Removes all elements from the dictionary.

Determines whether the dictionary contains an element with a specific name.

Remove an element from the dictionary.

Get an array of all the names in the dictionary.

Get an array of all the Atoms in the dictionary.

The keys in the dictionary.

The Atoms in the dictionary.

Gets an enumerator for the Dictionary.

An atom representing a name.

Create a name atom.

Create a name atom from a string.

The text of the name.

A null atom.

Create a null atom.

An atom representing a numeric value.

Create a number atom.

Create a number atom from an integer.

Create a number atom from a floating point value.

The integer value of the number.

The floating point value of the number.

An atom which references an IndirectObject.

Create a reference atom.

Create a reference atom pointing to a IndirectObject.

The ID of the referenced IndirectObject.

The generation of the referenced IndirectObject.

Set the IndirectObject that the reference should point to.

Get the IndirectObject that the reference is pointing to.

An atom representing a textual value.

Create a string atom.

Create a string atom from a string.

The text of the string.

An object encapsulating a PDF document.

Document constructor.

Doc destructor.

Dispose of the Doc.

Dispose of the Doc.

The ID of the current page.

The ID of the current font.

The current text size (points).

The current line width (points).

The horizontal positioning factor (0 to 1).

The vertical positioning factor (0 to 1).

The current drawing color.

The current drawing position.

The current drawing rectangle.

The page size.

The current text style.

The current default transformation.

The current encryption settings.

The current license details.

The ID of the root catalog.

The content insertion position (one is top).

The number of layers in the current page.

Add a page - return the page ID.

Add a page at a specified location - return the page ID.

Add a font resource - return the font ID.

Add a font resource - return the font ID.

Add a font resource - return the font ID.

Add a block of text - return the text ID.

Add a block of HTML styled text - return the text ID.

Chain a block of HTML styled text - return the text ID.

Add a line - return the line ID.

Add an image - return the image ID.

Add an image - return the image ID.

Add an image - return the image ID.

Add an image - return the image ID.

Add an image - return the image ID.

Add an image - return the image ID.

Add an image - return the image ID.

Add an image - return the image ID.

Add an image - return the image ID.

Add a Bitmap to the current page - return the image ID.

Add a copy of an existing image to the current page - return the image ID.

Extract an image from a chunk of data and add it to the current page - return the image ID.

Draw a page from one PDF document onto the current page of this document - return the image ID.

Extract an image from a file and add it to the current page - return the image ID.

Adds an image to the current page - return the image ID.

Add a new page from a paged HTML render - return the image ID.

Renders a web page specified as HTML - return the image ID.

Renders a web page specified by URL - return the image ID.

Get a particular type of information about an object.

Get numeric information about an object.

Add a framed rectangle - return the line ID.

Add a framed rounded rectangle - return the line ID.

Add a filled rectangle - return the line ID.

Add a filled rounded rectangle - return the line ID.

Delete a specified object.

Save the PDF as a file.

Write the PDF to a stream.

Get the PDF as raw data.

Read an existing PDF from data.

Read an existing PDF from data.

Read an existing PDF from file.

Read an existing PDF from file.

Read an existing PDF from stream.

Embed a font resource - return the font ID.

Embed a font resource - return the font ID.

Embed a font resource - return the font ID.

Embed a font resource - return the font ID.

Alters an aspect of an existing object.

Adds a bookmark for the current page.

Adds a native PDF object to the document.

Flattens and compresses the current page.

Clears the document freeing up resources.

Adds an alignment grid to help position objects.

The page number (one is the first page).

The number of pages in the document.

Appends a PDF document to the end of the current document.

Add an arc - return the line ID.

The current line options.

The current measurement units.

Whether to measure from the top of the page.

The ID of the current color space.

Add an ICC based color space - return the ID.

Add a separation color space - return the ID.

The PDF Indirect Object Collection.

An Annotation such as a text note or hyperlink.

The sub-type of Annotation.

The visible text of the annotation.

The full name of any form field associated with this annotation.

The field type of any form field associated with this annotation.

The value of any form field associated with this annotation.

The possible values for any form field associated with this annotation.

The Page on which this annotation is located.

The rectangle which defines the position and area of the annotation on the page.

A bookmark or outline item.

The Catalog for the document.

The root Pages Object.

The root Outlines Object.

The names of all the eForm fields in the document.

Get all the eForm fields in the document.

A color space.

The type of color space.

Any name associated with the color space.

Any ICC Color Profile associated with this color space.

A specific font as used in the document.

A specific GraphicLayer as used in the document.

A pre-specified graphics state.

An ICC Color Profile.

A rendition of a image on a page.

The PixMap containing the image data.

A PDF Indirect Object.

Construct an appropriate type of IndirectObject given a string value.

IndirectObject constructor.

IndirectObject destructor.

Whether the two IndirectObjects are the same.

Creates a deep copy of the current IndirectObject.

A hash code for the IndirectObject.

The string representation of the IndirectObject.

Dispose of the IndirectObject.

Dispose of the IndirectObject.

The ID of the PDF object.

The Generation of the PDF object.

The minimum version of the PDF specification required to support this object.

Whether the IndirectObject is currently alive.

The atom contained by the IndirectObject.

A layer of visible content.

The rect defining the bounds of the visible content.

The collection of IndirectObjects for a PDF.

ObjectSoup destructor.

Dispose of the Collection.

Gets the number of items in the Collection.

Copies the objects in the Collection to an Array.

Gets or sets the object at the specified index.

Adds an object to the Collection.

Removes all objects from the Collection.

Determines whether the Collection contains a specific object.

Determines the index of a specific object.

Inserts an object into the Collection at the specified position.

Removes an object from the Collection.

Removes an object at a specified position from the Collection.

Gets an enumerator for the Collection.

The Catalog for the document.

The Trailer or XRef for the document.

The top level outline item.

A visible page within the document.

The parent of this page.

Gets all the content Layers for the page.

Gets all the Annotations on the page.

A Pages node within the document.

The parent of this node.

The number of visible pages under this node.

Gets all the visible Page objects under this node.

A bitmap based image.

The width of the image in pixels.

The height of the image in pixels.

The number of color components for each pixel.

The ColorSpace for this image.

Sets a constant alpha value (0-255) for this image.

Sets a chromakey transparent color for this image.

Converts the image to grayscale.

A PDF data stream.

The number of bytes of encoded stream data.

Whether the stream data is compressed or otherwise encoded.

Get the raw binary content of the stream.

Set the raw binary content of the stream.

Get the content of the stream as a string.

Set the content of the stream as a string.

Compress the data in the stream.

Decompress the data in the stream.

Clear the data and compression settings for the stream.

A multistyled text object appearing on a page.

The number of characters appearing on the page.

The number of lines appearing on the page.

Whether the text had to be truncated.

The previous text object in the text chain.

The point defining the end position of the text.

A view onto a larger underlying graphic.

The entire visible width of the image.

The entire visible height of the image.

The offset to the top of the current page.

The height of content on the current page.

Whether the image is truncated.

XColor Class.

XColor constructor.

XColor destructor.

Dispose of the XColor.

Dispose of the XColor.

A string representation of the color.

A string representation of the color.

The red intensity of the color (0 to 255).

The green intensity of the color (0 to 255).

The blue intensity of the color (0 to 255).

The gray intensity of the color (0 to 255).

The cyan intensity of the color (0 to 100).

The magenta intensity of the color (0 to 100).

The yellow intensity of the color (0 to 100).

The black intensity of the color (0 to 100).

The alpha opacity of the color (0 to 255).

The native color space for the color.

The color as a System.Drawing.Color.

XEncryption class.

XEncryption destructor.

Dispose of the XEncryption.

Dispose of the XEncryption.

The level of encryption to use.

The user password.

The owner password.

Whether a user can print the document.

Whether a user can modify the document.

Whether a user can copy from the document.

Whether a user can edit the document.

Whether a user can fill forms in the document.

Whether a user can extract detail from the document.

Whether a user can assemble the document.

Whether a user can print a high resolution copy of the document.

Image class.

Image constructor.

XPoint destructor.

Dispose of the XImage.

Dispose of the XImage.

Load an image from a file.

Load an image from data.

Load an image from a stream.

Assign a soft mask to the image.

The type of image.

The number of frames in the image.

The currently selected frame.

The width of the current frame (pixels).

The height of the current frame (pixels).

The horizontal resolution of the current frame (DPI).

The vertical resolution of the current frame (DPI).

The current selection rectangle.

Clears the image freeing up resources.

XPoint class.

XPoint constructor.

XPoint constructor.

XPoint destructor.

Dispose of the XPoint.

Dispose of the XPoint.

A string representation of the point.

A string representation of the point.

The horizontal offset of the point from the bottom left.

The vertical offset of the point from the bottom left.

The point as a System.Drawing Point.

XRect class.

Corner Enumeration.

Bottom Left Corner.

Top Left Corner.

Bottom Right Corner.

Top Right Corner.

XRect constructor.

XRect constructor.

XRect destructor.

Dispose of the XPoint.

Dispose of the XPoint.

A string representation of the rectangle.

A string representation of the rectangle.

The offset of the top edge from the bottom left.

The offset of the left edge from the bottom left.

The offset of the bottom edge from the bottom left.

The offset of the right edge from the bottom left.

The width of the rectangle.

The height of the rectangle.

Translate the rectangle up and right.

Scale the rectangle, pinning the bottom left corner.

Move the bottom left corner to a position, preserving width and height.

Inset the rectangle horizontally and vertically.

The rectangle as a System.Drawing Rectangle.

The corner of the rectangle to pin.

Resize the rectangle preserving position.

Set the position and size of the rectangle.

XSettings Class.

The current license for the software.

Whether to log errors in the Application Event Log.

The software version.

Register and install trial license.

A trial license key used for remote deployment.

XTextStyle class.

XTextStyle constructor.

XTextStyle destructor.

Dispose of the XTextStyle.

Dispose of the XTextStyle.

A string representation of the style.

A string representation of the style.

The text size (points).

The first line of paragraph indent (points).

The inter-character spacing (points).

The inter-word spacing (points).

The inter-line spacing (points).

The inter-paragraph spacing (points).

The horizontal justification factor (0 to 1).

Whether to apply an underline.

Whether to apply a strikethrough.

Whether to apply a double strikethrough.

The width of outline to use.

Whether to synthesize and apply an italic style.

Whether to synthesize and apply a bold style.

The paragraph indent (points).

XTransform class.

XTransform constructor.

XTransform destructor.

Dispose of the XTransform.

Dispose of the XTransform.

A string representation of the transform.

A string representation of the transform.

Reset to the identity.

Invert the transform.

Translate horizontally and vertically.

Rotate about a locked anchor point (angle in degrees).

Scale about a locked anchor point.

Skew horizontally and vertically about a locked anchor point.

The transform as a System.Drawing Matrix.

An Atom containing an array of other Atoms.

ArrayAtom constructor.

The number of Atoms in the array.

Copies the Atoms into an array.

Gets or sets the Atom at the specified index.

Gets or sets the integer at the specified index.

Gets or sets the double at the specified index.

Gets or sets the string at the specified index.

Add an Atom to the end of the array.

Add an integer to the end of the array.

Add a double to the end of the array.

Add a string to the end of the array.

Removes all Atoms from the array.

Determines whether the array contains a specific Atom.

Determines the index of a specific Atom.

Inserts an Atom into the array at the specified position.

Removes an Atom from the array.

Removes an Atom at a specified position from the array.

Gets an enumerator for the Collection.

A PDF atomic object comprising a basic chunk of PDF data.

Atom destructor.

Create an appropriate type of Atom from a raw PDF string representation.

Test whether the two Atoms are the same.

Creates a deep copy of the current Atom.

A hash code for the Atom.

The string representation of the Atom as it would appear in a PDF.

Dispose of the Atom.

Dispose of the Atom.

An Atom containing a boolean value.

Construct a BoolAtom.

Construct a BoolAtom from a boolean value.

Whether the boolean is true or false.

An Atom containing a dictionary of other Atoms indexed by name.

DictAtom constructor.

Gets the number of elements in the dictionary.

Copies the Atoms into an array.

Gets or set the Atom with the specified key.

Gets or set the integer with the specified key.

Gets or set the double with the specified key.

Gets or set the string with the specified key.

Add an Atom to the dictionary.

Add an integer to the dictionary.

Add a double to the dictionary.

Add a string to the dictionary.

Removes all elements from the dictionary.

Determines whether the dictionary contains an element with a specific name.

Remove an element from the dictionary.

Get an array of all the names in the dictionary.

Get an array of all the Atoms in the dictionary.

The keys in the dictionary.

The Atoms in the dictionary.

Gets an enumerator for the Dictionary.

An atom representing a name.

Create a name atom.

Create a name atom from a string.

The text of the name.

A null atom.

Create a null atom.

An atom representing a numeric value.

Create a number atom.

Create a number atom from an integer.

Create a number atom from a floating point value.

The integer value of the number.

The floating point value of the number.

An atom which references an IndirectObject.

Create a reference atom.

Create a reference atom pointing to a IndirectObject.

The ID of the referenced IndirectObject.

The generation of the referenced IndirectObject.

Set the IndirectObject that the reference should point to.

Get the IndirectObject that the reference is pointing to.

An atom representing a textual value.

Create a string atom.

Create a string atom from a string.

The text of the string.

The delegate called during HTML rendering.

An object encapsulating a PDF document.

Document constructor.

Doc destructor.

Dispose of the Doc.

Dispose of the Doc.

The ID of the current page.

The ID of the current font.

The current text size (points).

The current line width (points).

The horizontal positioning factor (0 to 1).

The vertical positioning factor (0 to 1).

The current drawing color.

The current drawing position.

The current drawing rectangle.

The page size.

The visible page size.

The current text style.

The current default transformation.

The current encryption settings.

The current license details.

The ID of the root catalog.

The content insertion position (one is top).

The number of layers in the current page.

Add a page - return the page ID.

Add a page at a specified location - return the page ID.

Add a font resource - return the font ID.

Add a font resource - return the font ID.

Add a font resource - return the font ID.

Add a block of text - return the text ID.

Add a block of HTML styled text - return the text ID.

Chain a block of HTML styled text - return the text ID.

Add a line - return the line ID.

Add an image - return the image ID.

Add an image - return the image ID.

Add an image - return the image ID.

Add an image - return the image ID.

Add an image - return the image ID.

Add an image - return the image ID.

Add an image - return the image ID.

Add an image - return the image ID.

Add an image - return the image ID.

Add a Bitmap to the current page - return the image ID.

Add a copy of an existing image to the current page - return the image ID.

Extract an image from a chunk of data and add it to the current page - return the image ID.

Draw a page from one PDF document onto the current page of this document - return the image ID.

Extract an image from a file and add it to the current page - return the image ID.

Adds an image to the current page - return the image ID.

Add a new page from a paged HTML render - return the image ID.

Renders a web page specified by URL - return the image ID.

Renders a web page specified as HTML - return the image ID.

Renders a web page specified by URL - return the image ID.

Renders a web page specified by URL - return the image ID.

Get a particular type of information about an object.

Get numeric information about an object.

Get numeric information about an object.

Add a framed rectangle - return the line ID.

Add a framed rounded rectangle - return the line ID.

Add a framed rounded rectangle - return the line ID.

Add a framed rounded rectangle - return the line ID.

Add a filled rectangle - return the line ID.

Add a filled rounded rectangle - return the line ID.

Delete a specified object.

Save the PDF as a file.

Write the PDF to a stream.

Get the PDF as raw data.

Read an existing PDF from data.

Read an existing PDF from data.

Read an existing PDF from file.

Read an existing PDF from file.

Read an existing PDF from stream.

Embed a font resource - return the font ID.

Embed a font resource - return the font ID.

Embed a font resource - return the font ID.

Embed a font resource - return the font ID.

Embed a font resource - return the font ID.

Alters an aspect of an existing object.

Adds a bookmark for the current page.

Adds a native PDF object to the document.

Flattens and compresses the current page.

Clears the document freeing up resources.

Adds an alignment grid to help position objects.

The page number (one is the first page).

The number of pages in the document.

Appends a PDF document to the end of the current document.

Add an arc - return the line ID.

Add an arc - return the arc ID.

The current line options.

The current measurement units.

Whether to measure from the top of the page.

The ID of the current color space.

Add an ICC based color space - return the ID.

Add a separation color space - return the ID.

Add an oval - return the line ID.

Add a pie slice - return the line ID.

Add a polygon - return the line ID.

Determine if an object is chainable.

Extract content from the current page in a specified format.

Remap pages for reordering, copying and deletion.

The PDF Indirect Object Collection.

The HTML and URL rendering options and control.

The save options and control.

The PDF rendering options and control.

The document form and fields.

The top level bookmark for the document.

An Annotation such as a text note or hyperlink.

The sub-type of Annotation.

The visible text of the annotation.

The full name of any form field associated with this annotation.

The field type of any form field associated with this annotation.

The value of any form field associated with this annotation.

The possible values for any form field associated with this annotation.

The Page on which this annotation is located.

The rectangle which defines the position and area of the annotation on the page.

A bookmark or outline item.

Whether the bookmark appears open or closed.

The parent of this bookmark.

The destination Page associated with this bookmark.

The destination Page ID associated with this bookmark.

The bookmark title to be displayed on screen.

Refresh and reload the document bookmarks.

Adopt a specified bookmark.

The number of Bookmarks in the collection.

Copies the Bookmarks into an array.

Gets or sets the Bookmark at the specified index.

Add a Bookmark to the end of the list.

Add a Bookmark to the end of the list.

Removes all child Bookmarks.

Determines whether the array contains a specific Bookmark.

Determines the index of a specific Bookmark.

Inserts a Bookmark into the list at the specified position.

Inserts a Bookmark into the list at the specified position.

Removes a Bookmark.

Removes a Bookmark at a specified position.

Gets an enumerator for the Collection.

The Catalog for the document.

The root Pages Object.

The root Outlines Object.

The names of all the eForm fields in the document.

Get all the eForm fields in the document.

A color space.

The type of color space.

Any name associated with the color space.

Any ICC Color Profile associated with this color space.

FieldType Enumeration.

Pushbutton Type.

Checkbox Type.

Radio Type.

Text Type.

List Type.

Combo Type.

Signature Type.

Unknown Type.

A field in a PDF form.

The value of the field.

The type of the field.

The possible values for this field.

The fully qualified field name.

The Page on which this field is located.

The rectangle which defines the position and area of the annotation on the page.

All the children of this field.

Prepare document for drawing at the field location.

Stamp this field into the document.

The partial field name.

The format for this field.

Whether the field supports multiple selections.

A collection of Fields.

The number of Fields in the collection.

Copies the Fields into an array.

Gets or sets the Field at the specified index.

Gets or sets the Field of the specified name.

Add a Field to the end of the list.

Removes all child Fields.

Determines whether the list contains a specific Field.

Determines the index of a specific Field.

Inserts a Field into the list at the specified position.

Removes a Field.

Removes a Field at a specified position.

Gets an enumerator for the Collection.

A specific font as used in the document.

A specific GraphicLayer as used in the document.

A pre-specified graphics state.

An ICC Color Profile.

A rendition of a image on a page.

The PixMap containing the image data.

A PDF Indirect Object.

Construct an appropriate type of IndirectObject given a string value.

IndirectObject constructor.

IndirectObject destructor.

Whether the two IndirectObjects are the same.

Creates a deep copy of the current IndirectObject.

A hash code for the IndirectObject.

The string representation of the IndirectObject.

Dispose of the IndirectObject.

Dispose of the IndirectObject.

The ID of the PDF object.

The Generation of the PDF object.

The minimum version of the PDF specification required to support this object.

Whether the IndirectObject is currently alive.

The atom contained by the IndirectObject.

A layer of visible content.

The rect defining the bounds of the visible content.

The collection of IndirectObjects for a PDF.

ObjectSoup destructor.

Dispose of the Collection.

Gets the number of items in the Collection.

Copies the objects in the Collection to an Array.

Gets or sets the object at the specified index.

Adds an object to the Collection.

Removes all objects from the Collection.

Determines whether the Collection contains a specific object.

Determines the index of a specific object.

Inserts an object into the Collection at the specified position.

Removes an object from the Collection.

Removes an object at a specified position from the Collection.

Gets an enumerator for the Collection.

The Catalog for the document.

The Trailer or XRef for the document.

The top level outline item.

A visible page within the document.

The parent of this page.

Gets all the content Layers for the page.

Gets all the Annotations on the page.

Detaches a content stream from the page.

A Pages node within the document.

The parent of this node.

The number of visible pages under this node.

Gets all the visible Page objects under this node.

A bitmap based image.

The width of the image in pixels.

The height of the image in pixels.

The number of color components for each pixel.

The ColorSpace for this image.

Sets a constant alpha value (0-255) for this image.

Sets a chromakey transparent color for this image.

Converts the image to grayscale.

A PDF data stream.

The number of bytes of encoded stream data.

Whether the stream data is compressed or otherwise encoded.

Get the raw binary content of the stream.

Set the raw binary content of the stream.

Get the content of the stream as a string.

Set the content of the stream as a string.

Compress the data in the stream.

Decompress the data in the stream.

Clear the data and compression settings for the stream.

A multistyled text object appearing on a page.

The number of characters appearing on the page.

The number of lines appearing on the page.

Whether the text had to be truncated.

The previous text object in the text chain.

The point defining the end position of the text.

A view onto a larger underlying graphic.

The entire visible width of the image.

The entire visible height of the image.

The offset to the top of the current page.

The height of content on the current page.

Whether the image is truncated.

XColor Class.

XColor constructor.

XColor destructor.

Dispose of the XColor.

Dispose of the XColor.

A string representation of the color.

A string representation of the color.

The red intensity of the color (0 to 255).

The green intensity of the color (0 to 255).

The blue intensity of the color (0 to 255).

The gray intensity of the color (0 to 255).

The cyan intensity of the color (0 to 100).

The magenta intensity of the color (0 to 100).

The yellow intensity of the color (0 to 100).

The black intensity of the color (0 to 100).

The alpha opacity of the color (0 to 255).

The native color space for the color.

The color as a System.Drawing.Color.

XEncryption class.

XEncryption destructor.

Dispose of the XEncryption.

Dispose of the XEncryption.

The level of encryption to use.

The user password.

The owner password.

Whether a user can print the document.

Whether a user can modify the document.

Whether a user can copy from the document.

Whether a user can edit the document.

Whether a user can fill forms in the document.

Whether a user can extract detail from the document.

Whether a user can assemble the document.

Whether a user can print a high resolution copy of the document.

XForm Class.

All top level fields in the form.

Whether values should be formatted before insertion into fields.

Whether field appearances should be pre-generated.

Whether the viewer should automatically regenerate field appearances.

Returns a particular field referenced by full name.

Stamp all fields into the document.

Refresh and reload the document fields.

XHtmlOptions Class.

The width of the virtual browser in pixels.

A user name to be used for authentication.

A password to be used for authentication.

Whether hyperlinks should be live.

Whether form fields should be live.

Whether movies and other active content should be live.

Whether the location of certain tags should be noted.

Whether font substitution should be used to reduce file size.

Whether fonts should be embedded rather than referenced.

Whether fonts with restricted licensing should be protected from embedding.

The quality of compression acceptable for continuous tone images such as JPEGs.

The maximum amount of time allowed for obtaining a page (ms).

The minimum number of content items required for a page to be valid.

The number of times a page should be retried if unavailable or invalid.

Whether content should be rendered in multipaged format.

Whether to hide the background color of a page.

A script to be run after the page is loaded.

Whether to enable JavaScript and VBScript.

Whether to enable ActiveX.

Whether to enable Java.

Whether to enable Video.

Whether to resynchronize page.

Whether any proxy servers should re-request items of content.

Whether the page cache should be searched first.

The length of time that pages can be held in the cache (ms).

The number of pages that can be held in the cache.

The delegate called during HTML rendering.

Clear all items from the page cache.

Clear all expired items from the page cache.

Convert external links to internal links wherever possible.

Gets an array of the HTML IDs of tagged visible items.

Gets an array of the locations of tagged visible items.

Retrieves the client side onload script return value.

Image class.

Image constructor.

XPoint destructor.

Dispose of the XImage.

Dispose of the XImage.

Load an image from a file.

Load an image from data.

Load an image from a stream.

Assign a soft mask to the image.

The type of image.

The number of frames in the image.

The currently selected frame.

The width of the current frame (pixels).

The height of the current frame (pixels).

The horizontal resolution of the current frame (DPI).

The vertical resolution of the current frame (DPI).

The current selection rectangle.

Clears the image freeing up resources.

XPoint class.

XPoint constructor.

XPoint constructor.

XPoint destructor.

Dispose of the XPoint.

Dispose of the XPoint.

A string representation of the point.

A string representation of the point.

The horizontal offset of the point from the bottom left.

The vertical offset of the point from the bottom left.

The point as a System.Drawing Point.

XRect class.

Corner Enumeration.

Bottom Left Corner.

Top Left Corner.

Bottom Right Corner.

Top Right Corner.

XRect constructor.

XRect constructor.

XRect destructor.

Dispose of the XPoint.

Dispose of the XPoint.

A string representation of the rectangle.

A string representation of the rectangle.

The offset of the top edge from the bottom left.

The offset of the left edge from the bottom left.

The offset of the bottom edge from the bottom left.

The offset of the right edge from the bottom left.

The width of the rectangle.

The height of the rectangle.

Translate the rectangle up and right.

Scale the rectangle, pinning the bottom left corner.

Move the bottom left corner to a position, preserving width and height.

Inset the rectangle horizontally and vertically.

The rectangle as a System.Drawing Rectangle.

The corner of the rectangle to pin.

Resize the rectangle preserving position.

Set the position and size of the rectangle.

XRendering Class.

The output resolution in dots per inch.

The horizontal output resolution in dots per inch.

The vertical output resolution in dots per inch.

A string representation of the output colorspace.

The output bits per color channel.

Whether to anti-alias text.

Whether to anti-alias polygons.

Whether to anti-alias images.

Whether to apply entire scene anti-aliasing.

The output file quality factor for lossy compression (0 to 100).

The path to the default Gray ICC color profile.

The path to the default RGB ICC color profile.

The path to the default CMYK ICC color profile.

The path to the default CMYK ICC color profile.

Whether to apply overprint.

Whether to render fields and annotations.

The named separation.

Halftone type and options.

Whether to use embedded halftones.

The log for the last render.

Renders and saves the current area of the current page as data.

Renders and saves the current area of the current page to a Bitmap.

Renders and saves the current area of the current page as a file.

Renders and saves the current area of the current page to a stream.

XSaveOptions Class.

Whether to reduce size by remapping objects.

Whether to linearize the output for fast web viewing.

Whether to update the file version identifier.

Whether to assign a constant file version identifier.

XSettings Class.

The current license for the software.

Whether to log errors in the Application Event Log.

The software version.

Register and install trial license.

A trial license key used for remote deployment.

XTextStyle class.

XTextStyle constructor.

XTextStyle destructor.

Dispose of the XTextStyle.

Dispose of the XTextStyle.

A string representation of the style.

A string representation of the style.

The text size (points).

The first line of paragraph indent (points).

The inter-character spacing (points).

The inter-word spacing (points).

The inter-line spacing (points).

The inter-paragraph spacing (points).

The horizontal justification factor (0 to 1).

Whether to apply an underline.

Whether to apply a strikethrough.

Whether to apply a double strikethrough.

The width of outline to use.

Whether to synthesize and apply an italic style.

Whether to synthesize and apply a bold style.

The paragraph indent (points).

XTransform class.

XTransform constructor.

XTransform destructor.

Dispose of the XTransform.

Dispose of the XTransform.

A string representation of the transform.

A string representation of the transform.

Reset to the identity.

Invert the transform.

Translate horizontally and vertically.

Rotate about a locked anchor point (angle in degrees).

Scale about a locked anchor point.

Skew horizontally and vertically about a locked anchor point.

The transform as a System.Drawing Matrix.

An Atom containing an array of other Atoms.

ArrayAtom constructor.

The number of Atoms in the array.

Copies the Atoms into an array.

Gets or sets the Atom at the specified index.

Gets or sets the integer at the specified index.

Gets or sets the double at the specified index.

Gets or sets the string at the specified index.

Add an Atom to the end of the array.

Add an integer to the end of the array.

Add a double to the end of the array.

Add a string to the end of the array.

Removes all Atoms from the array.

Determines whether the array contains a specific Atom.

Determines the index of a specific Atom.

Inserts an Atom into the array at the specified position.

Removes an Atom from the array.

Removes an Atom at a specified position from the array.

Gets an enumerator for the Collection.

A PDF atomic object comprising a basic chunk of PDF data.

Atom destructor.

Create an appropriate type of Atom from a raw PDF string representation.

Gets the Name value from the Atom if it is a NameAtom.

Gets the String value from the Atom if it is a StringAtom.

Gets the Boolean value from the Atom if it is a BoolAtom.

Gets the Integer value from the Atom if it is a NumAtom.

Gets the Double value from the Atom if it is a NumAtom.

Gets the Object ID value from the Atom if it is a RefAtom.

Gets the named entry from the Atom if it is a DictAtom.

Gets the indexed entry from the Atom if it is a DictAtom or ArrayAtom.

Removes the named entry from the Atom if it is a DictAtom.

Adds the named entry to the Atom if it is a DictAtom.

Add the indexed entry to the Atom if it is an ArrayAtom.

Test whether the two Atoms are the same.

Creates a deep copy of the current Atom.

A hash code for the Atom.

The string representation of the Atom as it would appear in a PDF.

Dispose of the Atom.

Dispose of the Atom.

An Atom containing a boolean value.

Construct a BoolAtom.

Construct a BoolAtom from a boolean value.

Whether the boolean is true or false.

An Atom containing a dictionary of other Atoms indexed by name.

DictAtom constructor.

Gets the number of elements in the dictionary.

Copies the Atoms into an array.

Gets or set the Atom with the specified key.

Gets or set the integer with the specified key.

Gets or set the double with the specified key.

Gets or set the string with the specified key.

Add an Atom to the dictionary.

Add an integer to the dictionary.

Add a double to the dictionary.

Add a string to the dictionary.

Removes all elements from the dictionary.

Determines whether the dictionary contains an element with a specific name.

Remove an element from the dictionary.

Get an array of all the names in the dictionary.

Get an array of all the Atoms in the dictionary.

The keys in the dictionary.

The Atoms in the dictionary.

Gets an enumerator for the Dictionary.

An atom representing a name.

Create a name atom.

Create a name atom from a string.

The text of the name.

A null atom.

Create a null atom.

An atom representing a numeric value.

Create a number atom.

Create a number atom from an integer.

Create a number atom from a floating point value.

The integer value of the number.

The floating point value of the number.

An atom which references an IndirectObject.

Create a reference atom.

Create a reference atom pointing to a IndirectObject.

The ID of the referenced IndirectObject.

The generation of the referenced IndirectObject.

Set the IndirectObject that the reference should point to.

Get the IndirectObject that the reference is pointing to.

An atom representing a textual value.

Create a string atom.

Create a string atom from a string.

The text of the string.

The delegate called during HTML rendering.

An object encapsulating a PDF document.

Document constructor.

Doc destructor.

Dispose of the Doc.

Dispose of the Doc.

The ID of the current page.

The ID of the current font.

The current text size (points).

The current line width (points).

The horizontal positioning factor (0 to 1).

The vertical positioning factor (0 to 1).

The current drawing color.

The current drawing position.

The current drawing rectangle.

The page size.

The visible page size.

The current text style.

The current default transformation.

The current encryption settings.

The current license details.

The ID of the root catalog.

The content insertion position (one is top).

The number of layers in the current page.

Add a page - return the page ID.

Add a page at a specified location - return the page ID.

Add a font resource - return the font ID.

Add a font resource - return the font ID.

Add a font resource - return the font ID.

Add a block of text - return the text ID.

Add a block of HTML styled text - return the text ID.

Chain a block of HTML styled text - return the text ID.

Add a line - return the line ID.

Add an image - return the image ID.

Add an image - return the image ID.

Add an image - return the image ID.

Add an image - return the image ID.

Add an image - return the image ID.

Add an image - return the image ID.

Add an image - return the image ID.

Add an image - return the image ID.

Add an image - return the image ID.

Add a Bitmap to the current page - return the image ID.

Add a copy of an existing image to the current page - return the image ID.

Extract the first image from a chunk of data and add it to the current page - return the image ID.

Extract an image from a chunk of data and add it to the current page - return the image ID.

Draw a page from one PDF document onto the current page of this document - return the image ID.

Extract the first image from a file and add it to the current page - return the image ID.

Extract an image from a file and add it to the current page - return the image ID.

Adds an image to the current page - return the image ID.

Adds an image to the current page - return the image ID.

Add a new page from a paged HTML or PostScript render - return the image ID.

Renders a web page specified by URL - return the image ID.

Renders a web page specified as HTML - return the image ID.

Renders a web page specified by URL - return the image ID.

Renders a web page specified by URL - return the image ID.

Get a particular type of information about an object.

Get numeric information about an object.

Get numeric information about an object.

Add a framed rectangle - return the line ID.

Add a framed rounded rectangle - return the line ID.

Add a framed rounded rectangle - return the line ID.

Add a framed rounded rectangle - return the line ID.

Add a filled rectangle - return the line ID.

Add a filled rounded rectangle - return the line ID.

Delete a specified object.

Save the PDF as a file.

Write the PDF to a stream.

Get the PDF as raw data.

Read an existing document from file.

Read an existing document from file.

Read an existing PDF from data.

Read an existing PDF from data.

Read an existing PDF from stream.

Embed a font resource - return the font ID.

Embed a font resource - return the font ID.

Embed a font resource - return the font ID.

Embed a font resource - return the font ID.

Embed a font resource - return the font ID.

Alters an aspect of an existing object.

Adds a bookmark for the current page.

Adds a native PDF object to the document.

Flattens and compresses the current page.

Clears the document freeing up resources.

Adds an alignment grid to help position objects.

The page number (one is the first page).

The number of pages in the document.

Appends a PDF document to the end of the current document.

Add an arc - return the line ID.

Add an arc - return the arc ID.

The current line options.

The current measurement units.

Whether to measure from the top of the page.

The ID of the current color space.

Add an ICC based color space - return the ID.

Add a separation color space - return the ID.

Add an oval - return the line ID.

Add a pie slice - return the line ID.

Add a polygon - return the line ID.

Determine if an object is chainable.

Extract content from the current page in a specified format.

Remap pages for reordering, copying and deletion.

The PDF Indirect Object Collection.

The HTML and URL rendering options and control.

The save options and control.

The PDF rendering options and control.

The document form and fields.

The top level bookmark for the document.

An Annotation such as a text note or hyperlink.

The sub-type of Annotation.

The visible text of the annotation.

The full name of any form field associated with this annotation.

The field type of any form field associated with this annotation.

The value of any form field associated with this annotation.

The possible values for any form field associated with this annotation.

The Page on which this annotation is located.

The rectangle which defines the position and area of the annotation on the page.

Update the Appearance Stream for this Annotation.

A bookmark or outline item.

Whether the bookmark appears open or closed.

The parent of this bookmark.

The destination Page associated with this bookmark.

The destination Page ID associated with this bookmark.

The bookmark title to be displayed on screen.

Refresh and reload the document bookmarks.

Adopt a specified bookmark.

The number of Bookmarks in the collection.

Copies the Bookmarks into an array.

Gets or sets the Bookmark at the specified index.

Add a Bookmark to the end of the list.

Add a Bookmark to the end of the list.

Removes all child Bookmarks.

Determines whether the array contains a specific Bookmark.

Determines the index of a specific Bookmark.

Inserts a Bookmark into the list at the specified position.

Inserts a Bookmark into the list at the specified position.

Removes a Bookmark.

Removes a Bookmark at a specified position.

Gets an enumerator for the Collection.

The Catalog for the document.

The root Pages Object.

The root Outlines Object.

The names of all the eForm fields in the document.

Get all the eForm fields in the document.

ColorSpaceType Enumeration.

Unknown or undefined.

Device dependent Gray.

Device dependent RGB.

Device dependent CMYK.

Calibrated Gray.

Calibrated RGB.

ICC Color Profile Based.

Lab.

Indexed Color.

Pattern.

Separation.

DeviceN.

A color space.

ColorSpace constructor.

ColorSpace constructor.

The type of color space.

Any name associated with the color space.

The number of color components in the color space.

The type of color space.

Any ICC Color Profile associated with this color space.

FieldType Enumeration.

Pushbutton Type.

Checkbox Type.

Radio Type.

Text Type.

List Type.

Combo Type.

Signature Type.

Unknown Type.

A field in a PDF form.

The value of the field.

The type of the field.

The possible values for this field.

The fully qualified field name.

The Page on which this field is located.

The rectangle which defines the position and area of the annotation on the page.

All the children of this field.

Prepare document for drawing at the field location.

Stamp this field into the document.

The partial field name.

The format for this field.

Whether the field supports multiple selections.

A collection of Fields.

The number of Fields in the collection.

Copies the Fields into an array.

Gets or sets the Field at the specified index.

Gets or sets the Field of the specified name.

Add a Field to the end of the list.

Removes all child Fields.

Determines whether the list contains a specific Field.

Determines the index of a specific Field.

Inserts a Field into the list at the specified position.

Removes a Field.

Removes a Field at a specified position.

Gets an enumerator for the Collection.

A specific font as used in the document.

A specific GraphicLayer as used in the document.

A pre-specified graphics state.

An ICC Color Profile.

IccProfile constructor.

IccProfile constructor.

Set the raw binary content of the stream.

A rendition of a image on a page.

The PixMap containing the image data.

A PDF Indirect Object.

Construct an appropriate type of IndirectObject given a string value.

IndirectObject constructor.

IndirectObject destructor.

Whether the two IndirectObjects are the same.

Creates a deep copy of the current IndirectObject.

A hash code for the IndirectObject.

The string representation of the IndirectObject.

Dispose of the IndirectObject.

Dispose of the IndirectObject.

The ID of the PDF object.

The Generation of the PDF object.

The minimum version of the PDF specification required to support this object.

Whether the IndirectObject is currently alive.

The atom contained by the IndirectObject.

Resolves any indirect references and returns the Atom.

Resolves any indirect references and returns the final RefAtom.

The Doc containing this IndirectObject.

A layer of visible content.

The rect defining the bounds of the visible content.

The collection of IndirectObjects for a PDF.

ObjectSoup destructor.

Dispose of the Collection.

Gets the number of items in the Collection.

Copies the objects in the Collection to an Array.

Gets or sets the object at the specified index.

Adds an object to the Collection.

Removes all objects from the Collection.

Determines whether the Collection contains a specific object.

Determines the index of a specific object.

Inserts an object into the Collection at the specified position.

Removes an object from the Collection.

Removes an object at a specified position from the Collection.

Gets an enumerator for the Collection.

The Catalog for the document.

The Trailer or XRef for the document.

The top level outline item.

A visible page within the document.

The parent of this page.

The number of degrees to rotate the page before display. Should be a multiple of 90.

Gets all the named separations referenced by the page.

Gets all the content Layers for the page.

Gets all the Annotations on the page.

Converts the page from one color space to another.

Converts the page from one color space to another.

A Pages node within the document.

The parent of this node.

The number of visible pages under this node.

Gets all the visible Page objects under this node.

Converts all the visible Page objects from one color space to another.

Converts all the visible Page objects from one color space to another.

Interpolation Enumeration.

Automatically decide a good method.

Nearest neighbor interpolation.

Linear interpolation.

Cubic interpolation.

Supersampling interpolation (cannot be used for enlarging).

Interpolation using 3-lobed Lanczos window function.

Rendering Intent Enumeration.

Use a perceptual model for handling out of gamut colors (good for photographs).

Keep color values the same but allow the brightness to vary.

Use a saturation model for handling out of gamut colors (good for diagrams).

Use the closest color at the gamut boundary.

A bitmap based image.

The width of the image in pixels.

The height of the image in pixels.

The number of color components for each pixel.

The number of bits per color component.

The type of color space for this image.

The ColorSpace for this image.

Whether this image is a one bit image mask.

Sets a constant alpha value (0-255) for this image.

Sets a chromakey transparent color for this image.

Converts the image to grayscale.

Converts the image from indexed color to component color.

Converts the image from one color space to another.

Converts the image from one color space to another.

Vectorizes the image.

Changes the number of bits per color component.

Resizes the image.

Resizes the image.

JPEG compresses the image.

CCITT compresses the image.

JPEG 2000 compresses the image.

A digital Signature Field.

Sign a signature using a private key and password.

Sign a signature using a private key and password.

Sign a signature using a private key and password.

The location of the signing.

The reason for signing.

The name of the person signing.

The time of signing in UTC format.

True if the PDF was modified after signing.

Check and validate the status of this signature.

CompressionType Enumeration.

Not compressed.

Compressed in an undefined or complex way.

Flate compressed.

LZW compressed.

CCITT compressed.

JPEG compressed.

JPEG 2000 compressed.

ASCII Hex encoded.

ASCII 85 encoded.

Run length compressed.

JBIG2 compressed.

Security handler encrypted.

A PDF data stream.

StreamObject constructor.

StreamObject constructor.

StreamObject constructor.

The number of bytes of encoded stream data.

Whether the stream data is compressed or otherwise encoded.

The primary compression type.

Get the raw binary content of the stream.

Set the raw binary content of the stream.

Set the raw binary content of the stream from data embedded in a file.

Get the content of the stream as a string.

Set the content of the stream as a string.

Compress the data in the stream.

Decompress the data in the stream.

Clear the data and compression settings for the stream.

A multistyled text object appearing on a page.

The number of characters appearing on the page.

The number of lines appearing on the page.

Whether the text had to be truncated.

The previous text object in the text chain.

The point defining the end position of the text.

A view onto a larger underlying graphic.

The entire visible width of the image.

The entire visible height of the image.

The offset to the top of the current page.

The height of content on the current page.

Whether the image is truncated.

Provides data related to an Operation about to be performed on an IndirectObject.

ProcessingObjectEventArgs constructor.

The IndirectObject to be processed.

Gets the IndirectObject to be processed.

Gets or sets an object which can be used to save data about the event.

Provides data related to an Operation which has just been performed on an IndirectObject.

ProcessedObjectEventArgs constructor.

The IndirectObject processed. A value indicating whether the processing was successful.

Gets the IndirectObject which has just been processed.

Gets or sets an object which can be used to save data about the event.

Gets a value indicating whether the processing was successful.

Represents the method that handles the event of performing an Operation on an IndirectObject.

The source of the event. A ProcessingObjectEventArgs that contains the event data.

Represents the method that handles the event of performing an Operation on an IndirectObject.

The source of the event. A ProcessedObjectEventArgs that contains the event data.

An Operation to be performed on an IndirectObject.

Occurs before an IndirectObject is operated on. The EventArgs Tag property is passed to the ObjectProcessed event.

Occurs after an IndirectObject is operated on. The EventArgs Tag property is passed from the ObjectProcessing event.

Dispose of the Operation.

Dispose of the Operation.

Operation to recolor pages in a document.

RecolorOperation constructor.

Gets or sets a value indicating whether annotations are to be recolored.

Gets or sets the destination ColorSpace.

Recolors a document.

The Doc to be recolored.

Recolors a page.

The Page to be recolored.

Recolors the pages referenced by a Pages IndirectObject.

The Pages IndirectObject to be recolored

XColor Class.

XColor constructor.

XColor destructor.

Dispose of the XColor.

Dispose of the XColor.

A string representation of the color.

A string representation of the color.

The red intensity of the color (0 to 255).

The green intensity of the color (0 to 255).

The blue intensity of the color (0 to 255).

The gray intensity of the color (0 to 255).

The cyan intensity of the color (0 to 100).

The magenta intensity of the color (0 to 100).

The yellow intensity of the color (0 to 100).

The black intensity of the color (0 to 100).

The alpha opacity of the color (0 to 255).

The native color space for the color.

The color as a System.Drawing.Color.

XEncryption class.

XEncryption destructor.

Dispose of the XEncryption.

Dispose of the XEncryption.

The level of encryption to use.

The user password.

The owner password.

Whether a user can print the document.

Whether a user can modify the document.

Whether a user can copy from the document.

Whether a user can edit the document.

Whether a user can fill forms in the document.

Whether a user can extract detail from the document.

Whether a user can assemble the document.

Whether a user can print a high resolution copy of the document.

XFont Class.

FontWeight Enumeration.

Don't care.

Thin weight.

Extra-light weight.

Light weight.

Normal weight.

Medium weight.

Semi-bold weight.

Bold weight.

Extra-bold weight.

Heavy weight.

Find all the fonts currently installed on the system.

Find all fonts belonging to a particular family.

The complete set of names by which this font is known.

The weight of the font (which can be compared against the FontWeight enumeration).

Whether the font is in an italic style.

Whether the font is in a fixed pitch (rather than proportional) style.

Whether the font is in a script style.

Whether the font is in a serif style.

The complete, hopefully unique, human readable name of the font.

The name of the family to which the font belongs.

The name the font will be known by on a PostScript printer.

XForm Class.

All top level fields in the form.

Whether values should be formatted before insertion into fields.

Whether field appearances should be pre-generated.

Whether the viewer should automatically regenerate field appearances.

The full names of all the fields in the document.

Returns a particular field referenced by full name.

Stamp all fields into the document.

Refresh and reload the document fields.

XHtmlOptions Class.

The width of the virtual browser in pixels.

A user name to be used for authentication.

A password to be used for authentication.

Whether hyperlinks should be live.

Whether form fields should be live.

Whether movies and other active content should be live.

Whether the location of certain tags should be noted.

Whether hyperlinks with targets should be allowed to open in a new browser window.

Whether the values of form elements, except radio buttons, with the same name are distinct.

Whether font substitution should be used to reduce file size.

Whether fonts should be embedded rather than referenced.

Whether fonts with restricted licensing should be protected from embedding.

The quality of compression acceptable for continuous tone images such as JPEGs.

The maximum amount of time allowed for obtaining a page (ms).

The minimum number of content items required for a page to be valid.

The number of times a page should be retried if unavailable or invalid.

Whether content should be rendered in multipaged format.

Whether to hide the background color of a page.

A script to be run after the page is loaded.

Whether to enable JavaScript and VBScript.

Whether to enable ActiveX.

Whether to enable Java.

Whether to enable Video.

Whether to resynchronize page.

Whether any proxy servers should re-request items of content.

Whether the page cache should be searched first.

The length of time that pages can be held in the cache (ms).

The number of pages that can be held in the cache.

The maximum size at which an image may be regarded as atomic.

Whether HTML pages are marked up before conversion to PDF.

Whether to automatically clip redundant content at the end of the page.

The delegate called during HTML rendering.

Clear all items from the page cache.

Clear all expired items from the page cache.

Convert external links to internal links wherever possible.

Gets an array of the HTML IDs of tagged visible items.

Gets an array of the locations of tagged visible items.

Retrieves the client side onload script return value.

Image class.

Image constructor.

XPoint destructor.

Dispose of the XImage.

Dispose of the XImage.

Load an image from a file.

Load an image from data.

Load an image from a stream.

Assign a soft mask to the image.

The type of image.

The number of frames in the image.

The currently selected frame.

The width of the current frame (pixels).

The height of the current frame (pixels).

The horizontal resolution of the current frame (DPI).

The vertical resolution of the current frame (DPI).

The current selection rectangle.

The physical bounds of the image in points.

Whether the image can be added indirect.

Clears the image freeing up resources.

XPoint class.

XPoint constructor.

XPoint constructor.

XPoint destructor.

Dispose of the XPoint.

Dispose of the XPoint.

A string representation of the point.

A string representation of the point.

The horizontal offset of the point from the bottom left.

The vertical offset of the point from the bottom left.

The point as a System.Drawing Point.

XRect class.

Corner Enumeration.

Bottom Left Corner.

Top Left Corner.

Bottom Right Corner.

Top Right Corner.

XRect constructor.

XRect constructor.

XRect destructor.

Dispose of the XPoint.

Dispose of the XPoint.

A string representation of the rectangle.

A string representation of the rectangle.

The offset of the top edge from the bottom left.

The offset of the left edge from the bottom left.

The offset of the bottom edge from the bottom left.

The offset of the right edge from the bottom left.

The width of the rectangle.

The height of the rectangle.

Translate the rectangle up and right.

Scale the rectangle, pinning the bottom left corner.

Move the bottom left corner to a position, preserving width and height.

Inset the rectangle horizontally and vertically.

The rectangle as a System.Drawing Rectangle.

The corner of the rectangle to pin.

Resize the rectangle preserving position.

Set the position and size of the rectangle.

XRendering Class.

Compression Enumeration.

Uncompressed

G3 Black and White Fax Compression

G4 Black and White Fax Compression

LZW Compression

Adobe Flate Compression

Flate Compression

Macintosh PackBits

The output resolution in dots per inch.

The horizontal output resolution in dots per inch.

The vertical output resolution in dots per inch.

A string representation of the output colorspace.

The output bits per color channel.

Whether to anti-alias text.

Whether to anti-alias polygons.

Whether to anti-alias images.

Whether to apply entire scene anti-aliasing.

Whether to save the alpha channel.

The output file quality factor for lossy compression (0 to 100).

The type of compression to prefer when saving.

Whether to append to (rather than overwrite) existing image files.

The path to the default Gray ICC color profile.

The path to the default RGB ICC color profile.

The path to the default CMYK ICC color profile.

The path to the default CMYK ICC color profile.

Whether to apply overprint.

Whether to render fields and annotations.

The named separation.

Halftone type and options.

Whether to use embedded halftones.

Whether pages should be automatically rotated.

The log for the last render.

Renders and saves the current area of the current page as data.

Renders and saves the current area of the current page to a Bitmap.

Renders and saves the current area of the current page as a file.

Renders and saves the current area of the current page to a stream.

XSaveOptions Class.

Whether to reduce size by remapping objects.

Whether to linearize the output for fast web viewing.

Whether to update the file version identifier.

Whether to assign a constant file version identifier.

Whether to assign non-ASCII file identifiers.

XSettings Class.

The current license for the software.

Whether to log errors in the Application Event Log.

The software version.

Register and install trial license.

A trial license key used for remote deployment.

XTextStyle class.

XTextStyle constructor.

XTextStyle destructor.

Dispose of the XTextStyle.

Dispose of the XTextStyle.

A string representation of the style.

A string representation of the style.

The text size (points).

The first line of paragraph indent (points).

The inter-character spacing (points).

The inter-word spacing (points).

The inter-line spacing (points).

The inter-paragraph spacing (points).

The horizontal justification factor (0 to 1).

Whether to apply an underline.

Whether to apply a strikethrough.

Whether to apply a double strikethrough.

The width of outline to use.

Whether to synthesize and apply an italic style.

Whether to synthesize and apply a bold style.

The paragraph indent (points).

XTransform class.

XTransform constructor.

XTransform destructor.

Dispose of the XTransform.

Dispose of the XTransform.

A string representation of the transform.

A string representation of the transform.

Reset to the identity.

Invert the transform.

Translate horizontally and vertically.

Rotate about a locked anchor point (angle in degrees).

Scale about a locked anchor point.

Skew horizontally and vertically about a locked anchor point.

The transform as a System.Drawing Matrix.

An Atom containing an array of other Atoms.

ArrayAtom constructor.

The number of Atoms in the array.

Copies the Atoms into an array.

Gets or sets the Atom at the specified index.

Gets or sets the integer at the specified index.

Gets or sets the double at the specified index.

Gets or sets the string at the specified index.

Add an Atom to the end of the array.

Add an integer to the end of the array.

Add a double to the end of the array.

Add a string to the end of the array.

Removes all Atoms from the array.

Determines whether the array contains a specific Atom.

Determines the index of a specific Atom.

Inserts an Atom into the array at the specified position.

Removes an Atom from the array.

Removes an Atom at a specified position from the array.

Gets an enumerator for the Collection.

A PDF atomic object comprising a basic chunk of PDF data.

Atom destructor.

Create an appropriate type of Atom from a raw PDF string representation.

Gets the Name value from the Atom if it is a NameAtom.

Gets the String value from the Atom if it is a StringAtom.

Gets the Boolean value from the Atom if it is a BoolAtom.

Gets the Integer value from the Atom if it is a NumAtom.

Gets the Double value from the Atom if it is a NumAtom.

Gets the Object ID value from the Atom if it is a RefAtom.

Gets the named entry from the Atom if it is a DictAtom.

Gets the indexed entry from the Atom if it is a DictAtom or ArrayAtom.

Removes the named entry from the Atom if it is a DictAtom.

Adds the named entry to the Atom if it is a DictAtom.

Add the indexed entry to the Atom if it is an ArrayAtom.

Test whether the two Atoms are the same.

Creates a deep copy of the current Atom.

A hash code for the Atom.

The string representation of the Atom as it would appear in a PDF.

Dispose of the Atom.

Dispose of the Atom.

An Atom containing a boolean value.

Construct a BoolAtom.

Construct a BoolAtom from a boolean value.

Whether the boolean is true or false.

An Atom containing a dictionary of other Atoms indexed by name.

The collection of names in a DictAtom.

Initializes a new instance that reflects the keys in the specified DictAtom.

Gets the number of elements contained.

Copies the DictAtom.KeyCollection elements to an existing one-dimensional Array, starting at the specified array index.

Returns an enumerator that iterates through the DictAtom.KeyCollection.

Enumerates the elements of a DictAtom.KeyCollection.

Releases all resources used by the DictAtom.KeyCollection.Enumerator.

Gets the element at the current position of the enumerator.

Advances the enumerator to the next element of the DictAtom.KeyCollection.

The collection of Atoms in a DictAtom.

Initializes a new instance that reflects the values in the specified DictAtom.

Gets the number of elements contained.

Copies the DictAtom.ValueCollection elements to an existing one-dimensional Array, starting at the specified array index.

Returns an enumerator that iterates through the DictAtom.ValueCollection.

Enumerates the elements of a DictAtom.ValueCollection.

Releases all resources used by the DictAtom.ValueCollection.Enumerator.

Gets the element at the current position of the enumerator.

Advances the enumerator to the next element of the DictAtom.ValueCollection.

DictAtom constructor.

Gets the number of elements in the dictionary.

Copies the Atoms into an array.

Copies the names and Atoms into an array.

Gets or set the Atom with the specified key.

Gets or set the integer with the specified key.

Gets or set the double with the specified key.

Gets or set the string with the specified key.

Add an Atom to the dictionary.

Add an integer to the dictionary.

Add a double to the dictionary.

Add a string to the dictionary.

Removes all elements from the dictionary.

Determines whether the dictionary contains an element with a specific name.

Remove an element from the dictionary.

Get an array of all the names in the dictionary.

Get an array of all the Atoms in the dictionary.

Get the collection of the keys in the dictionary.

Get the collection of the Atoms in the dictionary.

Gets an enumerator for the Dictionary.

Enumerates the elements of a DictAtom.

Releases all resources used by the DictAtom.Enumerator.

Gets the element at the current position of the enumerator.

Advances the enumerator to the next element of the DictAtom.

An atom representing a name.

Create a name atom.

Create a name atom from a string.

The text of the name.

A null atom.

Create a null atom.

An atom representing a numeric value.

Create a number atom.

Create a number atom from an integer.

Create a number atom from a floating point value.

The integer value of the number.

The floating point value of the number.

An atom which references an IndirectObject.

Create a reference atom.

Create a reference atom pointing to a IndirectObject.

The ID of the referenced IndirectObject.

The generation of the referenced IndirectObject.

Set the IndirectObject that the reference should point to.

Get the IndirectObject that the reference is pointing to.

An atom representing a textual value.

Create a string atom.

Create a string atom from a string.

Create a string atom from an array of bytes.

The text of the string.

The delegate called during HTML rendering.

The delegate called when embedding an object during HTML rendering.

An object encapsulating a PDF document.

Document constructor.

Doc destructor.

Dispose of the Doc.

Dispose of the Doc.

The ID of the current page.

The ID of the current font.

The current text size (points).

The current line width (points).

The horizontal positioning factor (0 to 1).

The vertical positioning factor (0 to 1).

The current drawing color.

The current drawing position.

The current drawing rectangle.

The page size.

The visible page size.

The current text style.

The current default transformation.

The current encryption settings.

The current license details.

The ID of the root catalog.

The content insertion position (one is top).

The number of layers in the current page.

Add a page - return the page ID.

Add a page at a specified location - return the page ID.

Add a font resource - return the font ID.

Add a font resource - return the font ID.

Add a font resource - return the font ID.

Add a block of text - return the text ID.

Add a block of HTML styled text - return the text ID.

Chain a block of HTML styled text - return the text ID.

Add a line - return the line ID.

Add an image - return the image ID.

Add an image - return the image ID.

Add an image - return the image ID.

Add an image - return the image ID.

Add an image - return the image ID.

Add an image - return the image ID.

Add an image - return the image ID.

Add an image - return the image ID.

Add an image - return the image ID.

Add a Bitmap to the current page - return the image ID.

Add a copy of an existing image to the current page - return the image ID.

Extract the first image from a chunk of data and add it to the current page - return the image ID.

Extract an image from a chunk of data and add it to the current page - return the image ID.

Draw a page from one PDF document onto the current page of this document - return the image ID.

Extract the first image from a file and add it to the current page - return the image ID.

Extract an image from a file and add it to the current page - return the image ID.

Adds an image to the current page - return the image ID.

Adds an image to the current page - return the image ID.

Add a new page from a paged HTML or PostScript render - return the image ID.

Renders a web page specified by URL - return the image ID.

Renders a web page specified as HTML - return the image ID.

Renders a web page specified by URL - return the image ID.

Renders a web page specified by URL - return the image ID.

Get a particular type of information about an object.

Get numeric information about an object.

Get numeric information about an object.

Get date and time information about an object.

Get date and time information about an object.

Add a framed rectangle - return the line ID.

Add a framed rounded rectangle - return the line ID.

Add a framed rounded rectangle - return the line ID.

Add a framed rounded rectangle - return the line ID.

Add a filled rectangle - return the line ID.

Add a filled rounded rectangle - return the line ID.

Delete a specified object.

Save the PDF as a file.

Write the PDF to a stream.

Get the PDF as raw data.

Read an existing document from file.

Read an existing document from file.

Read an existing document from file.

Read an existing PDF from data.

Read an existing PDF from data.

Read an existing PDF from data.

Read an existing PDF from stream.

Read an existing PDF from stream.

Read an existing PDF from stream.

Embed a font resource - return the font ID.

Embed a font resource - return the font ID.

Embed a font resource - return the font ID.

Embed a font resource - return the font ID.

Embed a font resource - return the font ID.

Alters an aspect of an existing object.

Alters an aspect of an existing object.

Alters an aspect of an existing object.

Alters an aspect of an existing object.

Adds a bookmark for the current page.

Adds a native PDF object to the document.

Flattens and compresses the current page.

Clears the document freeing up resources.

Clears the cached, decompressed data for stream objects.

Clears the cached, decompressed data for stream objects.

Adds an alignment grid to help position objects.

The page number (one is the first page).

The number of pages in the document.

Appends a PDF document to the end of the current document.

Add an arc - return the line ID.

Add an arc - return the arc ID.

The current line options.

The current measurement units.

Whether to measure from the top of the page.

The ID of the current color space.

Add an ICC based color space - return the ID.

Add a separation color space - return the ID.

Add an oval - return the line ID.

Add a pie slice - return the line ID.

Add a polygon - return the line ID.

Add a polygon - return the line ID.

Add a polygon - return the line ID.

Determine if an object is chainable.

Extract content from the current page in a specified format.

Remap pages for reordering, copying and deletion.

The PDF Indirect Object Collection.

The HTML and URL rendering options and control.

The save options and control.

The PDF rendering options and control.

The document form and fields.

The top level bookmark for the document.

An Annotation such as a text note or hyperlink.

The sub-type of Annotation.

The visible text of the annotation.

The full name of any form field associated with this annotation.

The field type of any form field associated with this annotation.

The value of any form field associated with this annotation.

The possible values for any form field associated with this annotation.

The Page on which this annotation is located.

The rectangle which defines the position and area of the annotation on the page.

Update the Appearance Stream for this Annotation.

A bookmark or outline item.

Whether the bookmark appears open or closed.

The parent of this bookmark.

The destination Page associated with this bookmark.

The destination Page ID associated with this bookmark.

The bookmark title to be displayed on screen.

Refresh and reload the document bookmarks.

Adopt a specified bookmark.

The number of Bookmarks in the collection.

Copies the Bookmarks into an array.

Gets or sets the Bookmark at the specified index.

Add a Bookmark to the end of the list.

Add a Bookmark to the end of the list.

Removes all child Bookmarks.

Determines whether the array contains a specific Bookmark.

Determines the index of a specific Bookmark.

Determines the index of a specific Bookmark.

Inserts a Bookmark into the list at the specified position.

Inserts a Bookmark into the list at the specified position.

Removes a Bookmark.

Removes a Bookmark at a specified position.

Gets an enumerator for the Collection.

The Catalog for the document.

The root Pages Object.

The root Outlines Object.

The names of all the eForm fields in the document.

Get all the eForm fields in the document.

ColorSpaceType Enumeration.

Unknown or undefined.

Device dependent Gray.

Device dependent RGB.

Device dependent CMYK.

Calibrated Gray.

Calibrated RGB.

ICC Color Profile Based.

Lab.

Indexed Color.

Pattern.

Separation.

DeviceN.

A color space.

ColorSpace constructor.

ColorSpace constructor.

The type of color space.

Any name associated with the color space.

The number of color components in the color space.

The type of color space.

Any ICC Color Profile associated with this color space.

FieldType Enumeration.

Pushbutton Type.

Checkbox Type.

Radio Type.

Text Type.

List Type.

Combo Type.

Signature Type.

Unknown Type.

A field in a PDF form.

The value of the field.

The type of the field.

The possible values for this field.

The fully qualified field name.

The Page on which this field is located.

The ID of the Page on which this field is located.

The rectangle which defines the position and area of the annotation on the page.

All the children of this field.

Prepare document for drawing at the field location.

Stamp this field into the document.

The partial field name.

The format for this field.

Whether the field supports multiple selections.

A collection of Fields.

The number of Fields in the collection.

Copies the Fields into an array.

Gets or sets the Field at the specified index.

Gets or sets the Field of the specified name.

Add a Field to the end of the list.

Removes all child Fields.

Determines whether the list contains a specific Field.

Determines the index of a specific Field.

Inserts a Field into the list at the specified position.

Removes a Field.

Removes a Field at a specified position.

Gets an enumerator for the Collection.

A specific font as used in the document.

The font writing mode type.

Horizontal writing mode.

Vertical writing mode.

The support for encoding text.

Encode all text.

Encode nothing if any character is not included in the font.

Encode up to and excluding the first character not included in the font.

The font writing mode.

Encode text for use with PDF text operators.

Encode text for use with PDF text operators.

A specific GraphicLayer as used in the document.

A pre-specified graphics state.

An ICC Color Profile.

IccProfile constructor.

IccProfile constructor.

Set the raw binary content of the stream.

A rendition of a image on a page.

The PixMap containing the image data.

A PDF Indirect Object.

Construct an appropriate type of IndirectObject given a string value.

IndirectObject constructor.

IndirectObject destructor.

Whether the two IndirectObjects are the same.

Creates a deep copy of the current IndirectObject.

A hash code for the IndirectObject.

The string representation of the IndirectObject.

Dispose of the IndirectObject.

Dispose of the IndirectObject.

The ID of the PDF object.

The Generation of the PDF object.

The minimum version of the PDF specification required to support this object.

The minimum extension level of Adobe Supplement to the PDF specification required to support this object.

Whether the IndirectObject is currently alive.

The atom contained by the IndirectObject.

Resolves any indirect references and returns the Atom.

Resolves any indirect references and returns the final RefAtom.

Resolves any indirect references and returns the final IndirectObject.

The Doc containing this IndirectObject.

A layer of visible content.

The rect defining the bounds of the visible content.

The collection of IndirectObjects for a PDF.

ObjectSoup destructor.

Dispose of the Collection.

Gets the number of items in the Collection.

Copies the objects in the Collection to an Array.

Gets or sets the object at the specified index.

Adds an object to the Collection.

Removes all objects from the Collection.

Determines whether the Collection contains a specific object.

Determines the index of a specific object.

Inserts an object into the Collection at the specified position.

Removes an object from the Collection.

Removes an object at a specified position from the Collection.

Gets an enumerator for the Collection.

The Catalog for the document.

The Trailer or XRef for the document.

The top level outline item.

A visible page within the document.

The parent of this page.

The number of degrees to rotate the page before display. Should be a multiple of 90.

The page number (one is the first page).

Gets all the named separations referenced by the page.

Gets all the content Layers for the page.

Gets all the Annotations on the page.

Converts the page from one color space to another.

Converts the page from one color space to another.

Replaces the content stream of a page containing text to one containing glyph outlines.

A Pages node within the document.

The parent of this node.

The number of visible pages under this node.

Gets all the visible Page objects under this node.

Converts all the visible Page objects from one color space to another.

Converts all the visible Page objects from one color space to another.

Interpolation Enumeration.

Automatically decide a good method.

Nearest neighbor interpolation.

Linear interpolation.

Cubic interpolation.

Supersampling interpolation (cannot be used for enlarging).

Interpolation using 3-lobed Lanczos window function.

Rendering Intent Enumeration.

Use a perceptual model for handling out of gamut colors (good for photographs).

Keep color values the same but allow the brightness to vary.

Use a saturation model for handling out of gamut colors (good for diagrams).

Use the closest color at the gamut boundary.

A bitmap based image.

The width of the image in pixels.

The height of the image in pixels.

The number of color components for each pixel.

The number of bits per color component.

The type of color space for this image.

The ColorSpace for this image.

Whether this image is a one bit image mask.

Sets a constant alpha value (0-255) for this image.

Sets a chromakey transparent color for this image.

Converts the image to grayscale.

Converts the image from indexed color to component color.

Converts the image from one color space to another.

Converts the image from one color space to another.

Vectorizes the image.

Changes the number of bits per color component.

Resizes the image.

Resizes the image.

JPEG compresses the image.

CCITT compresses the image.

JPEG 2000 compresses the image.

JBIG2 compresses the image.

A digital Signature Field.

The validation policy type for certificates.

Just verify that the certificate(s) in the doc has or have been signed with one of the certificates specified as a parameter in Verify().

Build a chain for the certificate(s) in the doc, optionally adding the certificates specified as a parameter in Verify, and then verify that this chain is trusted for the current user.

The validation policy for certificates.

Return binary X509 certificate(s) data.

Return binary X509 certificate(s) data.

Sign a signature using a private key and password.

Sign a signature using a private key and password.

Sign a signature using a private key and password.

Sign a signature using a private key.

Commit a previously signed signature to the document.

The location of the signing.

The reason for signing.

The name of the person signing.

The time of signing in UTC format.

True if the PDF was modified after signing.

Check and validate the status of this signature.

Check and validate the status of this signature.

CompressionType Enumeration.

Not compressed.

Compressed in an undefined or complex way.

Flate compressed.

LZW compressed.

CCITT compressed.

JPEG compressed.

JPEG 2000 compressed.

ASCII Hex encoded.

ASCII 85 encoded.

Run length compressed.

JBIG2 compressed.

Security handler encrypted.

StreamObjectTypes Enumeration.

No stream object.

All stream objects.

Other stream objects.

PixMap.

Form XObject.

Tiling pattern objects.

Shading objects that are streams.

Function objects that are streams.

A PDF data stream.

StreamObject constructor.

StreamObject constructor.

StreamObject constructor.

The number of bytes of encoded stream data.

Whether the stream data is compressed or otherwise encoded.

The primary compression type.

Get the raw binary content of the stream.

Set the raw binary content of the stream.

Set the raw binary content of the stream from data embedded in a file.

Get the content of the stream as a string.

Set the content of the stream as a string.

Compress the data in the stream.

Decompress the data in the stream.

Clear the data and compression settings for the stream.

Clear the cached, decompressed data for the stream.

A multistyled text object appearing on a page.

The number of characters appearing on the page.

The number of lines appearing on the page.

Whether the text had to be truncated.

The previous text object in the text chain.

The point defining the end position of the text.

A view onto a larger underlying graphic.

The content width of the image.

The content height of the image.

The scroll width of the image.

The scroll height of the image.

The offset to the top of the current page.

The width of the content on the current page.

The height of the content on the current page.

Whether the image is truncated.

The source type of operations.

No information was set.

A document.

A document page.

A page content.

A standard image (single-frame).

An image used as a mask.

A multi-frame image.

A frame in a multi-frame image.

A stream in a PDF document.

A path element in a PDF stream.

A text element in a PDF stream.

A form XObject in a PDF stream.

A shading operator in a PDF stream.

Provides generic information related to the ProcessingObject event.

ProcessingInfo constructor.

The event type.

The current document being processed, null if not applicable.

The total number of documents, null if not applicable.

The current page being processed, null if not applicable.

The total number of pages, null if not applicable.

The current frame being processed, null if not applicable.

The total number of frames, null if not applicable.

The number of frames per second, null if not applicable.

The object's horizontal location, null if not applicable.

The object's vertical location, null if not applicable.

The object's width, null if not applicable.

The object's height, null if not applicable.

The object's background color, null if not applicable.

Indicates whether the source has been handled by the event handler.

The stream position, null if not applicable.

The stream length, null if not applicable.

The object text, null if not applicable.

Provides data related to an Operation about to be performed on an IndirectObject.

ProcessingObjectEventArgs constructor.

The IndirectObject to be processed.

ProcessingObjectEventArgs constructor.

The IndirectObject to be processed. The ProcessingInfo containing related information.

Gets the IndirectObject to be processed.

Gets or sets an object which can be used to save data about the event.

Gets related information.

Provides data related to an Operation which has just been performed on an IndirectObject.

ProcessedObjectEventArgs constructor.

The IndirectObject processed. A value indicating whether the processing was successful.

Gets the IndirectObject which has just been processed.

Gets or sets an object which can be used to save data about the event.

Gets a value indicating whether the processing was successful.

Represents the method that handles the event of performing an Operation on an IndirectObject.

The source of the event. A ProcessingObjectEventArgs that contains the event data.

Represents the method that handles the event of performing an Operation on an IndirectObject.

The source of the event. A ProcessedObjectEventArgs that contains the event data.

An Operation to be performed on an IndirectObject.

Occurs before an IndirectObject is operated on. The EventArgs Tag property is passed to the ObjectProcessed event.

Occurs after an IndirectObject is operated on. The EventArgs Tag property is passed from the ObjectProcessing event.

Dispose of the Operation.

Dispose of the Operation.

Operation to recolor pages in a document.

RecolorOperation constructor.

Gets or sets a value indicating whether annotations are to be recolored.

Gets or sets the destination ColorSpace.

Recolors a document.

The Doc to be recolored.

Recolors a page.

The Page to be recolored.

Recolors the pages referenced by a Pages IndirectObject.

The Pages IndirectObject to be recolored

The Application for XpsImportOperation.ImportAny.

The application determined by the file association in the Shell (Windows Explorer).

Microsoft Word.

Microsoft Excel.

Microsoft PowerPoint.

Microsoft InfoPath.

Microsoft OneNote.

Microsoft Publisher.

Microsoft Project.

Microsoft Visio.

Microsoft Outlook.

Operation to import pages in an XPS document.

XpsImportOperation constructor.

The password needed to read the source.

The application that prints the document to XPS when ImportAny is called.

The folder of the application for printing documents to XPS when using ImportAny.

Whether to enable macros when opening MS Office documents. This property is supported only for Word, Excel and Powerpoint.

The document number for ImportAny, e.g. the Excel Worksheet number.

XpsImportOperation destructor.

Dispose of the Operation.

Enable an application process to be reused so that it is terminated only manually or when this operation is disposed of.

Whether an application is to be kept running and reused.

Whether an application is running.

Terminate a running application.

Import an XPS document.

Import a document by converting it to XPS using the Microsoft XPS print driver.

Import a document by converting it to XPS using the Microsoft XPS print driver.

The application installation folder.

SWF action data type code.

The undefined type.

The null type.

SWF action value.

The undefined value.

The null value.

The type code.

Parameters for initializing the SWF machine.

The stage width in twips when the scale mode is NoScale.

The stage height in twips when the scale mode is NoScale.

The stage alignment.

The stage scale mode.

The Flash variables.

Operation to import frames in a Flash movie.

SwfImportOperation constructor.

Dispose of the Operation.

The target PDF Document.

The time-out for script execution.

The background region.

The clip region.

Whether to reset regions to frame bounds before importing a frame.

The content alignment.

The content scale mode.

The parameters for initializing the SWF machine.

Import frames in a Flash movie.

Import frames in a Flash movie.

Operation to render pages in a document.

RenderOperation constructor.

RenderOperation destructor.

Dispose of the Operation.

Renders the current page in the document.

The destination file path.

Renders the current page in the document.

A dummy file name used to determine the type of image. The destination stream.

Renders the current page in the document.

A dummy file name used to determine the type of image. The data containing the rendered page.

Renders the current page in the document.

The bitmap containing the rendered page.

XColor Class.

XColor constructor.

XColor destructor.

Dispose of the XColor.

Dispose of the XColor.

A string representation of the color.

A string representation of the color.

The red intensity of the color (0 to 255).

The green intensity of the color (0 to 255).

The blue intensity of the color (0 to 255).

The gray intensity of the color (0 to 255).

The cyan intensity of the color (0 to 100).

The magenta intensity of the color (0 to 100).

The yellow intensity of the color (0 to 100).

The black intensity of the color (0 to 100).

The alpha opacity of the color (0 to 255).

The native color space for the color.

The color as a System.Drawing.Color.

Set the color.

EncryptionMethodType Enumeration.

(Not supported.)

No encryption.

Uses the RC4 algorithm.

Uses the AES algorithm with 128-bit encryption keys.

XEncryption class.

XEncryption destructor.

Dispose of the XEncryption.

Dispose of the XEncryption.

The level of encryption to use.

The crypt method for strings.

The crypt method for streams.

Sets the crypt methods.

Sets the crypt methods.

The user password.

The owner password.

Whether to encrypt the document metadata.

Whether a user can print the document.

Whether a user can modify the document.

Whether a user can copy from the document.

Whether a user can edit the document.

Whether a user can fill forms in the document.

Whether a user can extract detail from the document.

Whether a user can assemble the document.

Whether a user can print a high resolution copy of the document.

XFont Class.

FontWeight Enumeration.

Don't care.

Thin weight.

Extra-light weight.

Light weight.

Normal weight.

Medium weight.

Semi-bold weight.

Bold weight.

Extra-bold weight.

Heavy weight.

Find all the fonts currently installed on the system.

Find all fonts belonging to a particular family.

Find all fonts with a given name.

Return text width in TBD.

The complete set of names by which this font is known.

The weight of the font (which can be compared against the FontWeight enumeration).

Whether the font is in an italic style.

Whether the font is in a fixed pitch (rather than proportional) style.

Whether the font is in a script style.

Whether the font is in a serif style.

The complete, hopefully unique, human readable name of the font.

The name of the family to which the font belongs.

The name the font will be known by on a PostScript printer.

XForm Class.

All top level fields in the form.

Whether values should be formatted before insertion into fields.

The format provider for formatting dates and times.

Whether field appearances should be pre-generated.

Whether the viewer should automatically regenerate field appearances.

The full names of all the fields in the document.

Returns a particular field referenced by full name.

Stamp all fields into the document.

Refresh and reload the document fields.

Make fields unique across pages, duplicating fields if necessary.

Make fields unique across pages, duplicating fields if necessary.

The content type of the embedded file.

No content.

SWF file.

The conversion used for the values of HTML parameters.

No conversion.

Sets the value to the text content of the file pointed to by the value as a URL.

The request method for URL.

The GET request method.

The POST request method.

The HTML rendering conditions.

Never performs the action.

Always performs the action.

Performs the action when the default conditions are met.

Performs the action when some filter is disabled.

Performs the action when only partial content is available.

Performs the action when vector-output coercion has failed.

The page break logic for HTML.

Uses the cumulative cohesion of all objects occupying each horizontal line.

Uses the maximum cohesion among objects occupying each horizontal line.

Optimizes the break position globally around a candidate position.

Optimizes the break position locally around a candidate position.

No optimization.

The HTML parameter with conversion.

HtmlParameter constructor.

The source.

The parameter value.

The conversion for the value.

The information for an object embedded in HTML.

The URL of the embedded object.

The base URL for resolving relative URLs.

The content type of the embedded object.

Indicates whether parameter names are case-sensitive.

The parameters for the embedded object.

XHtmlOptions Class.

The width of the virtual browser in pixels.

A user name to be used for authentication.

A password to be used for authentication.

Whether hyperlinks should be live.

Whether form fields should be live.

Whether movies and other active content should be live.

Whether the location of certain tags should be noted.

Whether hyperlinks with targets should be allowed to open in a new browser window.

Whether the values of form elements, except radio buttons, with the same name are distinct.

Whether font substitution should be used to reduce file size.

Whether fonts should be embedded rather than referenced.

Whether embedded fonts should be subset.

Whether fonts with restricted licensing should be protected from embedding.

The quality of compression acceptable for continuous tone images such as JPEGs.

The maximum amount of time allowed for obtaining a page (ms).

The minimum number of content items required for a page to be valid.

The number of times a page should be retried if unavailable or invalid.

Whether content should be rendered in multipaged format.

Whether to hide the background color of a page.

Additional HTTP headers to send in the request.

A script to be run after the page is loaded.

The request method for URL.

Whether to disable automatic cookies.

The conditions under which to coerce a vector output.

The conditions under which to disable vector-output coercion.

Whether to host a WebBrowser control.

Whether to deactivate the WebBrowser.

Whether to enable JavaScript and VBScript.

Whether to enable ActiveX.

Whether to enable Java.

Whether to enable Video.

Whether to resynchronize page.

Whether any proxy servers should re-request items of content.

Whether the page cache should be searched first.

The length of time that pages can be held in the cache (ms).

The number of pages that can be held in the cache.

The maximum size at which an image may be regarded as atomic.

Whether HTML pages are marked up before conversion to PDF.

Whether to automatically clip redundant content at the end of the page.

The minimum width to be used for auto-sized pages.

The percentage of the current drawing area in which HTML breaks can occur.

The page break logic for HTML.

The delegate called during HTML rendering.

The delegate called when embedding an object during HTML rendering.

Clear all items from the page cache.

Clear all expired items from the page cache.

Convert external links to internal links wherever possible.

Convert external links to internal links.

Convert external links to internal links.

Gets an array of the HTML IDs of tagged visible items.

Gets an array of the locations of tagged visible items.

Gets an array of the locations of tagged visible items before Doc.Transform is applied.

Retrieves the HTTP status code.

Retrieves the client side onload script return value.

The collection of HTML parameter names and values.

The collection of parameter names in a HtmlParameterDictionary.

Initializes a new instance that reflects the keys in the specified HtmlParameterDictionary.

The HtmlParameterDictionary whose keys are reflected.

Gets the number of elements contained.

Copies the HtmlParameterDictionary.KeyCollection elements to an existing one-dimensional Array, starting at the specified array index.

The one-dimensional Array that is the destination of the elements copied. The zero-based index in array at which copying begins.

Enumerates the elements of a HtmlParameterDictionary.KeyCollection.

Releases all resources used by the HtmlParameterDictionary.KeyCollection.Enumerator.

Gets the element at the current position of the enumerator.

Advances the enumerator to the next element of the HtmlParameterDictionary.KeyCollection.

true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection.

Returns an enumerator that iterates through the HtmlParameterDictionary.KeyCollection.

A HtmlParameterDictionary.KeyCollection.Enumerator.

The collection of parameter values in a HtmlParameterDictionary.

Initializes a new instance that reflects the values in the specified HtmlParameterDictionary.

The HtmlParameterDictionary whose values are reflected.

Gets the number of elements contained.

Copies the HtmlParameterDictionary.ValueCollection elements to an existing one-dimensional Array, starting at the specified array index.

The one-dimensional Array that is the destination of the elements copied. The zero-based index in array at which copying begins.

Enumerates the elements of a HtmlParameterDictionary.ValueCollection.

Releases all resources used by the HtmlParameterDictionary.ValueCollection.Enumerator.

Gets the element at the current position of the enumerator.

Advances the enumerator to the next element of the HtmlParameterDictionary.ValueCollection.

true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection.

Returns an enumerator that iterates through the HtmlParameterDictionary.ValueCollection.

A HtmlParameterDictionary.ValueCollection.Enumerator.

Initializes a new empty instance that has the default initial capacity, and uses the default equality comparer for the key type.

Initializes a new empty instance that has the specified initial capacity, and uses the default equality comparer for the key type.

The initial number of elements that the HtmlParameterDictionary can contain.

Initializes a new empty instance that has the default initial capacity, and uses the specified IEqualityComparer.

The IEqualityComparer implementation to use when comparing keys, or null to use the default EqualityComparer for the type of the key.

Initializes a new empty instance that has the specified initial capacity, and uses the specified IEqualityComparer.

The initial number of elements that the HtmlParameterDictionary can contain. The IEqualityComparer implementation to use when comparing keys, or null to use the default EqualityComparer for the type of the key.

Initializes a new instance that contains elements copied from the specified IDictionary and uses the default equality comparer for the key type.

The IDictionary whose elements are copied.

Initializes a new instance that contains elements copied from the specified IDictionary and uses the specified IEqualityComparer.

The IDictionary whose elements are copied. The IEqualityComparer implementation to use when comparing keys, or null to use the default EqualityComparer for the type of the key.

Gets the IEqualityComparer that is used to determine equality of keys for the dictionary.

Gets a collection containing the keys.

Gets a collection containing the values.

Determines whether the HtmlParameterDictionary contains a specific value.

The value to locate. true if the HtmlParameterDictionary contains an element with the specified value; otherwise, false.

Gets or sets the value associated with the specified key.

The key of the value to get or set. The value associated with the specified key. If the specified key is not found, a get operation throws a KeyNotFoundException, and a set operation creates a new element with the specified key.

Determines whether the HtmlParameterDictionary contains the specified key.

The key to locate. true if the HtmlParameterDictionary contains an element with the specified key; otherwise, false.

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 value parameter. true if the HtmlParameterDictionary contains an element with the specified key; otherwise, false.

Adds the specified key and value to the dictionary.

The key of the element to add. The value of the element to add.

Removes the value with the specified key.

The key of the element to remove. true if the element is successfully found and removed; otherwise, false. This method returns false if key is not found.

Gets the number of key/value pairs contained.

Removes all keys and values.

Enumerates the elements of a HtmlParameterDictionary.

Releases all resources used by the HtmlParameterDictionary.Enumerator.

Gets the element at the current position of the enumerator.

Advances the enumerator to the next element of the HtmlParameterDictionary.

true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection.

Returns an enumerator that iterates through the HtmlParameterDictionary.

A HtmlParameterDictionary.Enumerator structure.

Image class.

Image constructor.

XPoint destructor.

Dispose of the XImage.

Dispose of the XImage.

Dispose of the XImage.

Load an image from a file.

Load an image from data.

Load an image from a stream.

Load an image from a file.

Load an image from data.

Load an image from a stream.

Assign a soft mask to the image.

The type of image.

The number of frames in the image.

The default frame rate for a moving image.

The currently selected frame.

The width of the current frame (pixels).

The height of the current frame (pixels).

Whether the image specifies the resolution.

The horizontal resolution of the current frame (DPI).

The vertical resolution of the current frame (DPI).

The current selection rectangle.

The physical bounds of the image in points.

Whether the image can be added indirect.

Whether the file needs to exist.

Whether the stream needs be kept open.

Clears the image freeing up resources.

Clears the image freeing up resources.

XPoint class.

XPoint constructor.

XPoint constructor.

XPoint destructor.

Dispose of the XPoint.

Dispose of the XPoint.

A string representation of the point.

A string representation of the point.

The horizontal offset of the point from the bottom left.

The vertical offset of the point from the bottom left.

The point as a System.Drawing Point.

Set the point.

The module used for read operations.

A default set of modules.

The SWF vector module.

The XPS module.

The XPS module with the XPS printer driver.

The OpenOffice.org PDF conversion.

The PDF read module.

The SVG vector import module.

The EPS vector import module.

The base raster image import module.

The error-handling option for read operations.

Produces output until an error is encountered.

No output is produced when an error is encountered.

Settings for read operations.

XReadOptions constructor.

Dispose of the XReadOptions.

The module to use.

The error-handling option.

The password needed to read the source.

The file extension when the source is specified not with a path or a file name.

The import warning and information log.

Indicates whether the transparency of raster images should be preserved.

The timeout for external components.

Whether to enable macros when opening MS Office documents. This property is supported only for Word, Excel and Powerpoint.

The Operation to use.

The frame to be read from a multiple frame image such as a movie.

OpenOffice.org PDF conversion control parameters.

The default document size for documents that do not specify a size.

The font to use for text that does not specify a font.

Perform extra checks when reading, for importing non-compliant PDF documents.

XRect class.

Corner Enumeration.

Bottom Left Corner.

Top Left Corner.

Bottom Right Corner.

Top Right Corner.

XRect constructor.

XRect constructor.

XRect destructor.

Dispose of the XPoint.

Dispose of the XPoint.

A string representation of the rectangle.

A string representation of the rectangle.

The offset of the top edge from the bottom left.

The offset of the left edge from the bottom left.

The offset of the bottom edge from the bottom left.

The offset of the right edge from the bottom left.

The width of the rectangle.

The height of the rectangle.

Translate the rectangle up and right.

Scale the rectangle, pinning the bottom left corner.

Move the bottom left corner to a position, preserving width and height.

Inset the rectangle horizontally and vertically.

The rectangle as a System.Drawing Rectangle.

The corner of the rectangle to pin.

Resize the rectangle preserving position.

Set the position and size of the rectangle.

Set the position and size of the rectangle.

Set the sides of the rectangle.

Intersect the rectangle with another rectangle.

Fit the rectangle as content inside another rectangle.

Content alignment.

Center.

Left.

Right.

Top.

Bottom.

Content scale mode.

Make the content the biggest and completely within the area while keeping the aspect ratio.

Make the content the smallest and covering the entire area while keeping the aspect ratio.

Scale the content possibly with distortion to fit the entire area.

No scaling.

XRendering Class.

Compression Enumeration.

Uncompressed

G3 Black and White Fax Compression

G4 Black and White Fax Compression

LZW Compression

Adobe Flate Compression

Flate Compression

Macintosh PackBits

The output resolution in dots per inch.

The horizontal output resolution in dots per inch.

The vertical output resolution in dots per inch.

A string representation of the output colorspace.

The output bits per color channel.

Whether to anti-alias text.

Whether to anti-alias polygons.

Whether to anti-alias images.

Whether to apply entire scene anti-aliasing.

Whether to save the alpha channel.

The output file quality factor for lossy compression (0 to 100).

The type of compression to prefer when saving.

Whether to append to (rather than overwrite) existing image files.

The path to the default Gray ICC color profile.

The path to the default RGB ICC color profile.

The path to the default CMYK ICC color profile.

The path to the default CMYK ICC color profile.

Whether to apply overprint.

Whether to render fields and annotations.

The named separation.

Halftone type and options.

Whether to use embedded halftones.

Whether pages should be automatically rotated.

Number of strips to generate when writing a tiff file.

The log for the last render.

Renders and saves the current area of the current page as data.

Renders and saves the current area of the current page to a Bitmap.

Renders and saves the current area of the current page as a file.

Renders and saves the current area of the current page to a stream.

XSaveOptions Class.

Whether to reduce size by remapping objects.

Whether to linearize the output for fast web viewing.

Whether to use incremental update to preserve the validity of signature fields.

Whether to update the file version identifier.

Whether to assign a constant file version identifier.

Whether to assign non-ASCII file identifiers.

The file extension when the target is specified not with a path or a file name.

The path to the template file.

The template data.

Raster Smoothing.

Specifies the default algorithm.

Specifies no anti-aliasing.

Specifies anti-aliasing.

XSaveTemplateData Class.

XSaveTemplateData constructor.

The horizontal measurement resolution.

The vertical measurement resolution.

The smoothing for displaying images.

Sets the measurement resolutions.

Sets the measurement resolutions.

XSettings Class.

The current license for the software.

The current license for the software.

Whether to log errors in the Application Event Log.

The software version.

Register and install trial license.

A trial license key used for remote deployment.

Install a redistribution license.

Install a trial license.

Install a system license.

Set the application configuration section.

XTextStyle class.

XTextStyle constructor.

XTextStyle destructor.

Dispose of the XTextStyle.

Dispose of the XTextStyle.

A string representation of the style.

A string representation of the style.

The text size (points).

The first line of paragraph indent (points).

The inter-character spacing (points).

The inter-word spacing (points).

The inter-line spacing (points).

The inter-paragraph spacing (points).

The distance between the line spacing below the top of the text frame and the first baseline (1000ths of em).

The horizontal justification factor (0 to 1).

Whether to apply an underline.

Whether to apply a strikethrough.

Whether to apply a double strikethrough.

The width of outline to use.

Whether to synthesize and apply an italic style.

Whether to synthesize and apply a bold style.

The paragraph indent (points).

XTransform class.

AngleUnitType Enumeration.

Degrees.

Radians.

XTransform constructor.

XTransform destructor.

Dispose of the XTransform.

Dispose of the XTransform.

A string representation of the transform.

A string representation of the transform.

The x translation.

The y translation.

Reset to the identity.

Invert the transform.

Translate horizontally and vertically.

Rotate about a locked anchor point (angle according to AngleUnit property).

Scale about a locked anchor point.

Skew horizontally and vertically about a locked anchor point.

Set the transform.

Set the transform.

The transform as an array of floating-point values.

The transform as a System.Drawing Matrix.

The angle units, degrees or radians.

An Atom containing an array of other Atoms.

ArrayAtom constructor.

The number of Atoms in the array.

Copies the Atoms into an array.

Gets or sets the Atom at the specified index.

Gets or sets the integer at the specified index.

Gets or sets the double at the specified index.

Gets or sets the string at the specified index.

Add an Atom to the end of the array.

Add an integer to the end of the array.

Add a double to the end of the array.

Add a string to the end of the array.

Removes all Atoms from the array.

Determines whether the array contains a specific Atom.

Determines the index of a specific Atom.

Inserts an Atom into the array at the specified position.

Removes an Atom from the array.

Removes an Atom at a specified position from the array.

Gets an enumerator for the Collection.

A PDF atomic object comprising a basic chunk of PDF data.

Atom destructor.

Create an appropriate type of Atom from a raw PDF string representation.

Gets the Name value from the Atom if it is a NameAtom.

Gets the String value from the Atom if it is a StringAtom.

Gets the Boolean value from the Atom if it is a BoolAtom.

Gets the Integer value from the Atom if it is a NumAtom.

Gets the Double value from the Atom if it is a NumAtom.

Gets the Object ID value from the Atom if it is a RefAtom.

Gets the named entry from the Atom if it is a DictAtom.

Gets the indexed entry from the Atom if it is a DictAtom or ArrayAtom.

Removes the named entry from the Atom if it is a DictAtom.

Adds the named entry to the Atom if it is a DictAtom.

Add the indexed entry to the Atom if it is an ArrayAtom.

Test whether the two Atoms are the same.

Creates a deep copy of the current Atom.

A hash code for the Atom.

The string representation of the Atom as it would appear in a PDF.

Dispose of the Atom.

Dispose of the Atom.

An Atom containing a boolean value.

Construct a BoolAtom.

Construct a BoolAtom from a boolean value.

Whether the boolean is true or false.

An Atom containing a dictionary of other Atoms indexed by name.

The collection of names in a DictAtom.

Initializes a new instance that reflects the keys in the specified DictAtom.

Gets the number of elements contained.

Copies the DictAtom.KeyCollection elements to an existing one-dimensional Array, starting at the specified array index.

Returns an enumerator that iterates through the DictAtom.KeyCollection.

Enumerates the elements of a DictAtom.KeyCollection.

Releases all resources used by the DictAtom.KeyCollection.Enumerator.

Gets the element at the current position of the enumerator.

Advances the enumerator to the next element of the DictAtom.KeyCollection.

The collection of Atoms in a DictAtom.

Initializes a new instance that reflects the values in the specified DictAtom.

Gets the number of elements contained.

Copies the DictAtom.ValueCollection elements to an existing one-dimensional Array, starting at the specified array index.

Returns an enumerator that iterates through the DictAtom.ValueCollection.

Enumerates the elements of a DictAtom.ValueCollection.

Releases all resources used by the DictAtom.ValueCollection.Enumerator.

Gets the element at the current position of the enumerator.

Advances the enumerator to the next element of the DictAtom.ValueCollection.

DictAtom constructor.

Gets the number of elements in the dictionary.

Copies the Atoms into an array.

Copies the names and Atoms into an array.

Gets or set the Atom with the specified key.

Gets or set the integer with the specified key.

Gets or set the double with the specified key.

Gets or set the string with the specified key.

Add an Atom to the dictionary.

Add an integer to the dictionary.

Add a double to the dictionary.

Add a string to the dictionary.

Removes all elements from the dictionary.

Determines whether the dictionary contains an element with a specific name.

Remove an element from the dictionary.

Get an array of all the names in the dictionary.

Get an array of all the Atoms in the dictionary.

Get the collection of the keys in the dictionary.

Get the collection of the Atoms in the dictionary.

Gets an enumerator for the Dictionary.

Enumerates the elements of a DictAtom.

Releases all resources used by the DictAtom.Enumerator.

Gets the element at the current position of the enumerator.

Advances the enumerator to the next element of the DictAtom.

An atom representing a name.

Create a name atom.

Create a name atom from a string.

The text of the name.

A null atom.

Create a null atom.

An atom representing a numeric value.

Create a number atom.

Create a number atom from an integer.

Create a number atom from a floating point value.

The integer value of the number.

The floating point value of the number.

An atom which references an IndirectObject.

Create a reference atom.

Create a reference atom pointing to a IndirectObject.

The ID of the referenced IndirectObject.

The generation of the referenced IndirectObject.

Set the IndirectObject that the reference should point to.

Get the IndirectObject that the reference is pointing to.

An atom representing a textual value.

Create a string atom.

Create a string atom from a string.

Create a string atom from an array of bytes.

The text of the string.

UnitType Enumeration.

PostScript Points - 1/72 of an Inch.

Twentieths of a Point - 1/20 of a PostScript Point.

Didot Points - 1/72 of a French Royal Inch.

ATA Points - 1/72.272 of an Inch.

TeX Points - 1/72.27 of an Inch.

L'Imprimerie Nationale Points - 0.4 mm.

Picas - 12 PostScript Points.

Ciceros - 12 Didot Points.

ATA Ciceros - 12 ATA Points.

TeX Ciceros - 12 TeX Points.

Microns - millionths of a metre.

Milimeters - thousandths of a metre.

Centimeters - hundredths of a metre.

Meters.

Inches.

Feet.

LanguageType Enumeration.

Latin - the default and most efficient encoding for Western languages.

Unicode - the setting you will most often want to use when embedding foreign character sets.

Korean.

Japanese.

Simplified Chinese.

Traditional Chinese.

The delegate called during HTML rendering.

The delegate called when embedding an object during HTML rendering.

An object encapsulating a PDF document.

Document constructor.

Doc destructor.

Dispose of the Doc.

Dispose of the Doc.

The ID of the current page.

The ID of the current font.

The current text size (points).

The current line width (points).

The horizontal positioning factor (0 to 1).

The vertical positioning factor (0 to 1).

The current drawing color.

The current drawing position.

The current drawing rectangle.

The page size.

The visible page size.

The current text style.

The current default transformation.

The current encryption settings.

The current license details.

The ID of the root catalog.

The content insertion position (one is top).

The number of layers in the current page.

Add a page - return the page ID.

Add a page at a specified location - return the page ID.

Add a font resource - return the font ID.

Add a font resource - return the font ID.

Add a font resource - return the font ID.

Add a font resource - return the font ID.

Add a font resource - return the font ID.

Add a block of text - return the text ID.

Add a block of HTML styled text - return the text ID.

Chain a block of HTML styled text - return the text ID.

Add a line - return the line ID.

Add an image - return the image ID.

Add an image - return the image ID.

Add an image - return the image ID.

Add an image - return the image ID.

Add an image - return the image ID.

Add an image - return the image ID.

Add an image - return the image ID.

Add an image - return the image ID.

Add an image - return the image ID.

Add a Bitmap to the current page - return the image ID.

Add a copy of an existing image to the current page - return the image ID.

Extract the first image from a chunk of data and add it to the current page - return the image ID.

Extract an image from a chunk of data and add it to the current page - return the image ID.

Draw a page from one PDF document onto the current page of this document - return the image ID.

Extract the first image from a file and add it to the current page - return the image ID.

Extract an image from a file and add it to the current page - return the image ID.

Adds an image to the current page - return the image ID.

Adds an image to the current page - return the image ID.

Add a new page from a paged HTML or PostScript render - return the image ID.

Renders a web page specified by URL - return the image ID.

Renders a web page specified as HTML - return the image ID.

Renders a web page specified by URL - return the image ID.

Renders a web page specified by URL - return the image ID.

Get a particular type of information about an object.

Get numeric information about an object.

Get numeric information about an object.

Get date and time information about an object.

Get date and time information about an object.

Add a framed rectangle - return the line ID.

Add a framed rounded rectangle - return the line ID.

Add a framed rounded rectangle - return the line ID.

Add a framed rounded rectangle - return the line ID.

Add a filled rectangle - return the line ID.

Add a filled rounded rectangle - return the line ID.

Delete a specified object.

Save the PDF as a file.

Write the PDF to a stream.

Get the PDF as raw data.

Read an existing document from file.

Read an existing document from file.

Read an existing document from file.

Read an existing PDF from data.

Read an existing PDF from data.

Read an existing PDF from data.

Read an existing PDF from stream.

Read an existing PDF from stream.

Read an existing PDF from stream.

Embed a font resource - return the font ID.

Embed a font resource - return the font ID.

Embed a font resource - return the font ID.

Embed a font resource - return the font ID.

Embed a font resource - return the font ID.

Embed a font resource - return the font ID.

Embed a font resource - return the font ID.

Embed a font resource - return the font ID.

Embed a font resource - return the font ID.

Alters an aspect of an existing object.

Alters an aspect of an existing object.

Alters an aspect of an existing object.

Alters an aspect of an existing object.

Adds a bookmark for the current page.

Adds a native PDF object to the document.

Flattens and compresses the current page.

Clears the document freeing up resources.

Clears the cached, decompressed data for stream objects.

Clears the cached, decompressed data for stream objects.

Adds an alignment grid to help position objects.

The page number (one is the first page).

The number of pages in the document.

Appends a PDF document to the end of the current document.

Add an arc - return the line ID.

Add an arc - return the arc ID.

The current line options.

The current measurement units.

Whether to measure from the top of the page.

The ID of the current color space.

Add an ICC based color space - return the ID.

Add a separation color space - return the ID.

Add an oval - return the line ID.

Add a pie slice - return the line ID.

Add a polygon - return the line ID.

Add a polygon - return the line ID.

Add a polygon - return the line ID.

Determine if an object is chainable.

Extract content from the current page in a specified format.

Remap pages for reordering, copying and deletion.

Remap pages for reordering, copying and deletion.

Remap pages for reordering, copying and deletion.

The PDF Indirect Object Collection.

The HTML and URL rendering options and control.

The save options and control.

The PDF rendering options and control.

The document form and fields.

The top level bookmark for the document.

An Annotation such as a text note or hyperlink.

The sub-type of Annotation.

The visible text of the annotation.

The full name of any form field associated with this annotation.

The field type of any form field associated with this annotation.

The value of any form field associated with this annotation.

The possible values for any form field associated with this annotation.

The Page on which this annotation is located.

The rectangle which defines the position and area of the annotation on the page.

Update the Appearance Stream for this Annotation.

Stamp this Annotation into the page.

A bookmark or outline item.

Whether the bookmark appears open or closed.

The parent of this bookmark.

The destination Page associated with this bookmark.

The destination Page ID associated with this bookmark.

The bookmark title to be displayed on screen.

Refresh and reload the document bookmarks.

Adopt a specified bookmark.

The number of Bookmarks in the collection.

Copies the Bookmarks into an array.

Gets or sets the Bookmark at the specified index.

Add a Bookmark to the end of the list.

Add a Bookmark to the end of the list.

Removes all child Bookmarks.

Determines whether the array contains a specific Bookmark.

Determines the index of a specific Bookmark.

Determines the index of a specific Bookmark.

Inserts a Bookmark into the list at the specified position.

Inserts a Bookmark into the list at the specified position.

Removes a Bookmark.

Removes a Bookmark at a specified position.

Gets an enumerator for the Collection.

The Catalog for the document.

The root Pages Object.

The root Outlines Object.

The names of all the eForm fields in the document.

Get all the eForm fields in the document.

Perform whole document analysis of page contents.

Gets all the fonts in this document.

ColorSpaceType Enumeration.

Unknown or undefined.

Device dependent Gray.

Device dependent RGB.

Device dependent CMYK.

Calibrated Gray.

Calibrated RGB.

ICC Color Profile Based.

Lab.

Indexed Color.

Pattern.

Separation.

DeviceN.

A color space.

ColorSpace constructor.

ColorSpace constructor.

The type of color space.

Any name associated with the color space.

The number of color components in the color space.

The type of color space.

Any ICC Color Profile associated with this color space.

FieldType Enumeration.

Pushbutton Type.

Checkbox Type.

Radio Type.

Text Type.

List Type.

Combo Type.

Signature Type.

Unknown Type.

A field in a PDF form.

The value of the field.

The type of the field.

The possible values for this field.

The fully qualified field name.

The Page on which this field is located.

The ID of the Page on which this field is located.

The rectangle which defines the position and area of the annotation on the page.

All the children of this field.

Prepare document for drawing at the field location.

Stamp this field into the document.

The partial field name.

The format for this field.

Whether the field supports multiple selections.

A collection of Fields.

The number of Fields in the collection.

Copies the Fields into an array.

Gets or sets the Field at the specified index.

Gets or sets the Field of the specified name.

Add a Field to the end of the list.

Removes all child Fields.

Determines whether the list contains a specific Field.

Determines the index of a specific Field.

Inserts a Field into the list at the specified position.

Removes a Field.

Removes a Field at a specified position.

Gets an enumerator for the Collection.

A specific font as used in the document.

The font writing mode type.

Horizontal writing mode.

Vertical writing mode.

The support for encoding text.

Encode all text.

Encode nothing if any character is not included in the font.

Encode up to and excluding the first character not included in the font.

The font writing mode.

Encode text for use with PDF text operators.

Encode text for use with PDF text operators.

Subset a previously embedded font.

Whether the font contains an embedded subset.

The PostScript name of the font.

The character widths in thousandths of a unit for all the characters in the font.

A specific GraphicLayer as used in the document.

A pre-specified graphics state.

An ICC Color Profile.

IccProfile constructor.

IccProfile constructor.

Set the raw binary content of the stream.

A rendition of a image on a page.

The PixMap containing the image data.

A PDF Indirect Object.

Construct an appropriate type of IndirectObject given a string value.

IndirectObject constructor.

IndirectObject destructor.

Whether the two IndirectObjects are the same.

Creates a deep copy of the current IndirectObject.

A hash code for the IndirectObject.

The string representation of the IndirectObject.

Dispose of the IndirectObject.

Dispose of the IndirectObject.

The ID of the PDF object.

The Generation of the PDF object.

The minimum version of the PDF specification required to support this object.

The minimum extension level of Adobe Supplement to the PDF specification required to support this object.

Whether the IndirectObject is currently alive.

The atom contained by the IndirectObject.

Resolves any indirect references and returns the Atom.

Resolves any indirect references and returns the final RefAtom.

Resolves any indirect references and returns the final IndirectObject.

The Doc containing this IndirectObject.

A layer of visible content.

The rect defining the bounds of the visible content.

The collection of IndirectObjects for a PDF.

ObjectSoup destructor.

Dispose of the Collection.

Gets the number of items in the Collection.

Copies the objects in the Collection to an Array.

Gets or sets the object at the specified index.

Adds an object to the Collection.

Removes all objects from the Collection.

Determines whether the Collection contains a specific object.

Determines the index of a specific object.

Inserts an object into the Collection at the specified position.

Removes an object from the Collection.

Removes an object at a specified position from the Collection.

Gets an enumerator for the Collection.

The Catalog for the document.

The Trailer or XRef for the document.

The top level outline item.

A visible page within the document.

The parent of this page.

The number of degrees to rotate the page before display. Should be a multiple of 90.

The page number (one is the first page).

Detaches a content stream from the page.

Gets all the named separations referenced by the page.

Gets all the content Layers for the page.

Gets all the Annotations on the page.

Converts the page from one color space to another.

Converts the page from one color space to another.

Replaces the content stream of a page containing text to one containing glyph outlines.

A Pages node within the document.

The parent of this node.

The number of visible pages under this node.

Gets all the visible Page objects under this node.

Converts all the visible Page objects from one color space to another.

Converts all the visible Page objects from one color space to another.

Interpolation Enumeration.

Automatically decide a good method.

Nearest neighbor interpolation.

Linear interpolation.

Cubic interpolation.

Supersampling interpolation (cannot be used for enlarging).

Interpolation using 3-lobed Lanczos window function.

Rendering Intent Enumeration.

Use a perceptual model for handling out of gamut colors (good for photographs).

Keep color values the same but allow the brightness to vary.

Use a saturation model for handling out of gamut colors (good for diagrams).

Use the closest color at the gamut boundary.

A bitmap based image.

The width of the image in pixels.

The height of the image in pixels.

The number of color components for each pixel.

The number of bits per color component.

The type of color space for this image.

The ColorSpace for this image.

Whether corrupt data should automatically be fixed.

Whether this image is a one bit image mask.

Sets a constant alpha value (0-255) for this image.

Sets a chromakey transparent color for this image.

Converts the image to grayscale.

Decompress the data in the stream using on-the-fly resizing. This type of scaling is fast but may change the depth of the image. Only some compression types support on-the-fly resizing.

Converts the image from indexed color to component color.

Converts the image from one color space to another.

Converts the image from one color space to another.

Gets the content of the object as a Bitmap.

Vectorizes the image.

Changes the number of bits per color component.

Resizes the image.

Resizes the image.

JPEG compresses the image.

CCITT compresses the image.

JPEG 2000 compresses the image.

JBIG2 compresses the image.

A digital Signature Field.

The validation policy type for certificates.

Perform an X.509 certificate path validation using the Windows Trusted Root CA store. Additional certificates passed in through Validate() will also be added as trust anchors.

Just verify that the certificate(s) in the document has or have been signed with one of the certificates specified as a parameter in Validate().

The validation policy for certificates.

Return binary X509 certificate(s) data.

Return binary X509 certificate(s) data.

Sign a signature using a private key and password.

Sign a signature using a private key and password.

Sign a signature using a private key and password.

Sign a signature using a private key.

Commit a previously signed signature to the document.

The location of the signing.

The reason for signing.

The name of the person signing.

The URL to a timestamping service.

The time of signing in UTC format.

True if the PDF was modified after signing.

True if the signature's certificate is trusted according to ValidationPolicy.

True if the signature's certificate was time-valid when the document was signed.

Check and validate the status of this signature.

Check and validate the status of this signature.

Check and validate the status of this signature.

CompressionType Enumeration.

Not compressed.

Compressed in an undefined or complex way.

Flate compressed.

LZW compressed.

CCITT compressed.

JPEG compressed.

JPEG 2000 compressed.

ASCII Hex encoded.

ASCII 85 encoded.

Run length compressed.

JBIG2 compressed.

Security handler encrypted.

StreamObjectTypes Enumeration.

No stream object.

All stream objects.

Other stream objects.

PixMap.

Form XObject.

Tiling pattern objects.

Shading objects that are streams.

Function objects that are streams.

A PDF data stream.

StreamObject constructor.

StreamObject constructor.

StreamObject constructor.

The number of bytes of encoded stream data.

Whether the stream data is compressed or otherwise encoded.

The primary compression type.

All compression types, ordered in terms of the complete decompression sequence required for the stream.

Get the raw binary content of the stream.

Set the raw binary content of the stream.

Set the raw binary content of the stream from data embedded in a file.

Get the content of the stream as a string.

Set the content of the stream as a string.

Compress the data in the stream.

Compress the data in the stream using Flate compression.

Compress the data in the stream using Flate compression.

Compress the data in the stream using ASCII Hex compression.

Compress the data in the stream using ASCII Hex compression.

Compress the data in the stream using ASCII85 (Base85) compression.

Compress the data in the stream using ASCII85 (Base85) compression.

Compress the data in the stream using run length compression.

Compress the data in the stream using run length compression.

Decompress the data in the stream.

Clear the data and compression settings for the stream.

Clear the cached, decompressed data for the stream.

A multistyled text object appearing on a page.

The number of characters appearing on the page.

The number of lines appearing on the page.

Whether the text had to be truncated.

The previous text object in the text chain.

The point defining the end position of the text.

The full text provided in the initial call to AddHtml or AddText. This text is shared between all the items in a chain.

The offset to the first character (in the full text) to be drawn onto this layer.

The offset to the last character (in the full text) to be drawn onto this layer.

The offset to the character (in the full text) which will be drawn at the start of the next item in the chain.

A view onto a larger underlying graphic.

The content width of the image.

The content height of the image.

The scroll width of the image.

The scroll height of the image.

The offset to the top of the current page.

The width of the content on the current page.

The height of the content on the current page.

Whether the image is truncated.

The source type of operations.

No information was set.

A document.

A document page.

A page content.

A standard image (single-frame).

An image used as a mask.

A multi-frame image.

A frame in a multi-frame image.

A stream in a PDF document.

A path element in a PDF stream.

A text element in a PDF stream.

A form XObject in a PDF stream.

A shading operator in a PDF stream.

Provides generic information related to the ProcessingObject event.

ProcessingInfo constructor.

The event type.

The current document being processed, null if not applicable.

The total number of documents, null if not applicable.

The current page being processed, null if not applicable.

The total number of pages, null if not applicable.

The current frame being processed, null if not applicable.

The total number of frames, null if not applicable.

The number of frames per second, null if not applicable.

The object's horizontal location, null if not applicable.

The object's vertical location, null if not applicable.

The object's width, null if not applicable.

The object's height, null if not applicable.

The object's background color, null if not applicable.

Indicates whether the source has been handled by the event handler.

The stream position, null if not applicable.

The stream length, null if not applicable.

The object text, null if not applicable.

Provides data related to an Operation about to be performed on an IndirectObject.

ProcessingObjectEventArgs constructor.

The IndirectObject to be processed.

ProcessingObjectEventArgs constructor.

The IndirectObject to be processed. The ProcessingInfo containing related information.

Gets the IndirectObject to be processed.

Gets or sets an object which can be used to save data about the event.

Gets related information.

Provides data related to an Operation which has just been performed on an IndirectObject.

ProcessedObjectEventArgs constructor.

The IndirectObject processed. A value indicating whether the processing was successful.

Gets the IndirectObject which has just been processed.

Gets or sets an object which can be used to save data about the event.

Gets a value indicating whether the processing was successful.

Represents the method that handles the event of performing an Operation on an IndirectObject.

The source of the event. A ProcessingObjectEventArgs that contains the event data.

Represents the method that handles the event of performing an Operation on an IndirectObject.

The source of the event. A ProcessedObjectEventArgs that contains the event data.

An Operation to be performed on an IndirectObject.

Occurs before an IndirectObject is operated on. The EventArgs Tag property is passed to the ObjectProcessed event.

Occurs after an IndirectObject is operated on. The EventArgs Tag property is passed from the ObjectProcessing event.

Dispose of the Operation.

Dispose of the Operation.

Operation to recolor pages in a document.

RecolorOperation constructor.

Gets or sets a value indicating whether annotations are to be recolored.

Gets or sets the destination ColorSpace.

Recolors a document.

The Doc to be recolored.

Recolors a page.

The Page to be recolored.

Recolors the pages referenced by a Pages IndirectObject.

The Pages IndirectObject to be recolored

The Application for XpsImportOperation.ImportAny.

The application determined by the file association in the Shell (Windows Explorer).

Microsoft Word.

Microsoft Excel.

Microsoft PowerPoint.

Microsoft InfoPath.

Microsoft OneNote.

Microsoft Publisher.

Microsoft Project.

Microsoft Visio.

Microsoft Outlook.

Operation to import pages in an XPS document.

XpsImportOperation constructor.

The password needed to read the source.

The application that prints the document to XPS when ImportAny is called.

The folder of the application for printing documents to XPS when using ImportAny.

Whether to enable macros when opening MS Office documents. This property is supported only for Word, Excel and Powerpoint.

The document number for ImportAny, e.g. the Excel Worksheet number.

XpsImportOperation destructor.

Dispose of the Operation.

Enable an application process to be reused so that it is terminated only manually or when this operation is disposed of.

Whether an application is to be kept running and reused.

Whether an application is running.

Terminate a running application.

Import an XPS document.

Import a document by converting it to XPS using the Microsoft XPS print driver.

Import a document by converting it to XPS using the Microsoft XPS print driver.

The application installation folder.

SWF action data type code.

The undefined type.

The null type.

SWF action value.

The undefined value.

The null value.

The type code.

Parameters for initializing the SWF machine.

The stage width in twips when the scale mode is NoScale.

The stage height in twips when the scale mode is NoScale.

The stage alignment.

The stage scale mode.

The Flash variables.

Operation to import frames in a Flash movie.

SwfImportOperation constructor.

Dispose of the Operation.

The target PDF Document.

The time-out for script execution.

The background region.

The clip region.

Whether to reset regions to frame bounds before importing a frame.

The content alignment.

The content scale mode.

The parameters for initializing the SWF machine.

Import frames in a Flash movie.

Import frames in a Flash movie.

Operation to render pages in a document.

RenderOperation constructor.

RenderOperation destructor.

Dispose of the Operation.

Renders the current page in the document.

The destination file path.

Renders the current page in the document.

A dummy file name used to determine the type of image. The destination stream.

Renders the current page in the document.

A dummy file name used to determine the type of image. The data containing the rendered page.

Renders the current page in the document.

The bitmap containing the rendered page.

XColor Class.

XColor constructor.

XColor destructor.

Dispose of the XColor.

Dispose of the XColor.

A string representation of the color.

A string representation of the color.

The red intensity of the color (0 to 255).

The green intensity of the color (0 to 255).

The blue intensity of the color (0 to 255).

The gray intensity of the color (0 to 255).

The cyan intensity of the color (0 to 100).

The magenta intensity of the color (0 to 100).

The yellow intensity of the color (0 to 100).

The black intensity of the color (0 to 100).

The alpha opacity of the color (0 to 255).

The native color space for the color.

The color as a System.Drawing.Color.

Set the color.

EncryptionMethodType Enumeration.

(Not supported.)

No encryption.

Uses the RC4 algorithm.

Uses the AES algorithm with 128-bit encryption keys.

Uses the AES algorithm with 256-bit encryption keys.

XEncryption class.

XEncryption destructor.

Dispose of the XEncryption.

Dispose of the XEncryption.

The level of encryption to use.

The crypt method for strings.

The crypt method for streams.

Sets the crypt methods.

Sets the crypt methods.

The user password.

The owner password.

Whether to encrypt the document metadata.

Whether a user can print the document.

Whether a user can modify the document.

Whether a user can copy from the document.

Whether a user can edit the document.

Whether a user can fill forms in the document.

Whether a user can extract detail from the document.

Whether a user can assemble the document.

Whether a user can print a high resolution copy of the document.

XFont Class.

FontWeight Enumeration.

Don't care.

Thin weight.

Extra-light weight.

Light weight.

Normal weight.

Medium weight.

Semi-bold weight.

Bold weight.

Extra-bold weight.

Heavy weight.

Find all the fonts currently installed on the system.

Find all fonts belonging to a particular family.

Find the names of all font families.

Find all fonts with a given name.

Find a font from a specific family, with a given style.

Find a font from a specific family, with a given style.

Return text width in thousandths of a unit.

The complete set of names by which this font is known.

The weight of the font (which can be compared against the FontWeight enumeration).

Whether the font is in an italic style.

Whether the font is in a fixed pitch (rather than proportional) style.

Whether the font is in a script style.

Whether the font is in a serif style.

The complete, hopefully unique, human readable name of the font.

The name of the family to which the font belongs.

The name the font will be known by on a PostScript printer.

The baseline of the font in thousandths of a unit.

The character widths in thousandths of a unit for all the characters in the font.

Unloads a font so that it is no longer available.

XForm Class.

All top level fields in the form.

Whether values should be formatted before insertion into fields.

The format provider for formatting dates and times.

Whether field appearances should be pre-generated.

Whether the viewer should automatically regenerate field appearances.

The full names of all the fields in the document.

Returns a particular field referenced by full name.

Stamp all fields into the document.

Refresh and reload the document fields.

Make fields unique across pages, duplicating fields if necessary.

Make fields unique across pages, duplicating fields if necessary.

The content type of the embedded file.

No content.

SWF file.

The CSS media type to use.

Print media

Screen media

The conversion used for the values of HTML parameters.

No conversion.

Sets the value to the text content of the file pointed to by the value as a URL.

The request method for URL.

The GET request method.

The POST request method.

The engine to use for HTML parsing and layout.

Rendering engine used in Microsoft Internet Explorer.

Rendering engine used in Mozilla Firefox.

The HTML rendering conditions.

Never performs the action.

Always performs the action.

Performs the action when the default conditions are met.

Performs the action when some filter is disabled.

Performs the action when only partial content is available.

Performs the action when vector-output coercion has failed.

The page break logic for HTML.

Uses the cumulative cohesion of all objects occupying each horizontal line.

Uses the maximum cohesion among objects occupying each horizontal line.

Optimizes the break position globally around a candidate position.

Optimizes the break position locally around a candidate position.

No optimization.

The HTML parameter with conversion.

HtmlParameter constructor.

The source.

The parameter value.

The conversion for the value.

The information for an object embedded in HTML.

The URL of the embedded object.

The base URL for resolving relative URLs.

The content type of the embedded object.

Indicates whether parameter names are case-sensitive.

The parameters for the embedded object.

XHtmlOptions Class.

A helper filter to give only the HtmlOptions supported by the MSHTML engine.

A helper filter to give only the HtmlOptions supported by the Gecko engine.

The width of the virtual browser in pixels.

A user name to be used for authentication.

A password to be used for authentication.

Whether hyperlinks should be live.

Whether form fields should be live.

Whether movies and other active content should be live.

Whether the location of certain tags should be noted.

Whether hyperlinks with targets should be allowed to open in a new browser window.

Whether the values of form elements, except radio buttons, with the same name are distinct.

Whether font substitution should be used to reduce file size.

Whether fonts should be embedded rather than referenced.

Whether embedded fonts should be subset.

Whether fonts with restricted licensing should be protected from embedding.

The quality of compression acceptable for continuous tone images such as JPEGs.

The maximum amount of time allowed for obtaining a page (ms).

The minimum number of content items required for a page to be valid.

The number of times a page should be retried if unavailable or invalid.

Whether content should be rendered in multipaged format.

Whether to hide the background color of a page.

Additional HTTP headers to send in the request.

A script to be run after the page is loaded.

The request method for URL.

Whether to disable automatic cookies.

The rendering engine to use for HTML conversion.

The CSS media to use.

The conditions under which to coerce a vector output.

The conditions under which to disable vector-output coercion.

Whether to host a WebBrowser control.

Whether to deactivate the WebBrowser.

Whether to enable JavaScript and VBScript.

Whether to enable ActiveX.

Whether to enable Java.

Whether to enable Video.

Whether to resynchronize page.

Whether any proxy servers should re-request items of content.

Whether the page cache should be searched first.

The length of time that pages can be held in the cache (ms).

The number of pages that can be held in the cache.

The maximum size at which an image may be regarded as atomic.

Whether HTML pages are marked up before conversion to PDF.

Whether to automatically clip redundant content at the end of the page.

The minimum width to be used for auto-sized pages.

The percentage of the current drawing area in which HTML breaks can occur.

The page break logic for HTML.

The delegate called during HTML rendering.

The delegate called when embedding an object during HTML rendering.

Clear all items from the page cache.

Clear all expired items from the page cache.

Convert external links to internal links wherever possible.

Convert external links to internal links.

Convert external links to internal links.

Gets an array of the HTML IDs of tagged visible items.

Gets an array of the locations of tagged visible items.

Gets an array of the locations of tagged visible items before Doc.Transform is applied.

Retrieves the HTTP status code.

Retrieves the client side onload script return value.

A helper filter to give only the HtmlOptions supported by Gecko HTML engine.

Whether hyperlinks should be live.

Whether movies and other active content should be live.

Whether form fields should be live.

Whether the location of certain tags should be noted.

Whether the values of form elements, except radio buttons, with the same name are distinct.

Whether font substitution should be used to reduce file size.

Whether fonts should be embedded rather than referenced.

Whether embedded fonts should be subset.

Whether fonts with restricted licensing should be protected from embedding.

The quality of compression acceptable for continuous tone images such as JPEGs.

The maximum amount of time allowed for obtaining a page (ms).

A user name to be used for authentication.

A password to be used for authentication.

The minimum width to be used for auto-sized pages.

The number of times a page should be retried if unavailable or invalid.

A script to be run after the page is loaded.

The request method for URL.

Whether to enable JavaScript and VBScript.

The CSS media to use.

Gets an array of the HTML IDs of tagged visible items.

Gets an array of the locations of tagged visible items.

A helper filter to give only the HtmlOptions supported by Internet Explorer HTML engine.

The width of the virtual browser in pixels.

A user name to be used for authentication.

A password to be used for authentication.

Whether hyperlinks should be live.

Whether form fields should be live.

Whether movies and other active content should be live.

Whether the location of certain tags should be noted.

Whether hyperlinks with targets should be allowed to open in a new browser window.

Whether the values of form elements, except radio buttons, with the same name are distinct.

Whether font substitution should be used to reduce file size.

Whether fonts should be embedded rather than referenced.

Whether embedded fonts should be subset.

Whether fonts with restricted licensing should be protected from embedding.

The quality of compression acceptable for continuous tone images such as JPEGs.

The maximum amount of time allowed for obtaining a page (ms).

The minimum number of content items required for a page to be valid.

The number of times a page should be retried if unavailable or invalid.

Whether content should be rendered in multipaged format.

Whether to hide the background color of a page.

Additional HTTP headers to send in the request.

A script to be run after the page is loaded.

The request method for URL.

Whether to disable automatic cookies.

The conditions under which to coerce a vector output.

The conditions under which to disable vector-output coercion.

Whether to host a WebBrowser control.

Whether to deactivate the WebBrowser.

Whether to enable JavaScript and VBScript.

Whether to enable ActiveX.

Whether to enable Java.

Whether to enable Video.

Whether to resynchronize page.

Whether any proxy servers should re-request items of content.

Whether the page cache should be searched first.

The length of time that pages can be held in the cache (ms).

The number of pages that can be held in the cache.

The maximum size at which an image may be regarded as atomic.

Whether HTML pages are marked up before conversion to PDF.

Whether to automatically clip redundant content at the end of the page.

The minimum width to be used for auto-sized pages.

The percentage of the current drawing area in which HTML breaks can occur.

The page break logic for HTML.

The delegate called during HTML rendering.

The delegate called when embedding an object during HTML rendering.

Clear all items from the page cache.

Clear all expired items from the page cache.

Convert external links to internal links wherever possible.

Convert external links to internal links.

Convert external links to internal links.

Gets an array of the HTML IDs of tagged visible items.

Gets an array of the locations of tagged visible items.

Gets an array of the locations of tagged visible items before Doc.Transform is applied.

Retrieves the HTTP status code.

Retrieves the client side onload script return value.

The collection of HTML parameter names and values.

The collection of parameter names in a HtmlParameterDictionary.

Initializes a new instance that reflects the keys in the specified HtmlParameterDictionary.

The HtmlParameterDictionary whose keys are reflected.

Gets the number of elements contained.

Copies the HtmlParameterDictionary.KeyCollection elements to an existing one-dimensional Array, starting at the specified array index.

The one-dimensional Array that is the destination of the elements copied. The zero-based index in array at which copying begins.

Enumerates the elements of a HtmlParameterDictionary.KeyCollection.

Releases all resources used by the HtmlParameterDictionary.KeyCollection.Enumerator.

Gets the element at the current position of the enumerator.

Advances the enumerator to the next element of the HtmlParameterDictionary.KeyCollection.

true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection.

Returns an enumerator that iterates through the HtmlParameterDictionary.KeyCollection.

A HtmlParameterDictionary.KeyCollection.Enumerator.

The collection of parameter values in a HtmlParameterDictionary.

Initializes a new instance that reflects the values in the specified HtmlParameterDictionary.

The HtmlParameterDictionary whose values are reflected.

Gets the number of elements contained.

Copies the HtmlParameterDictionary.ValueCollection elements to an existing one-dimensional Array, starting at the specified array index.

The one-dimensional Array that is the destination of the elements copied. The zero-based index in array at which copying begins.

Enumerates the elements of a HtmlParameterDictionary.ValueCollection.

Releases all resources used by the HtmlParameterDictionary.ValueCollection.Enumerator.

Gets the element at the current position of the enumerator.

Advances the enumerator to the next element of the HtmlParameterDictionary.ValueCollection.

true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection.

Returns an enumerator that iterates through the HtmlParameterDictionary.ValueCollection.

A HtmlParameterDictionary.ValueCollection.Enumerator.

Initializes a new empty instance that has the default initial capacity, and uses the default equality comparer for the key type.

Initializes a new empty instance that has the specified initial capacity, and uses the default equality comparer for the key type.

The initial number of elements that the HtmlParameterDictionary can contain.

Initializes a new empty instance that has the default initial capacity, and uses the specified IEqualityComparer.

The IEqualityComparer implementation to use when comparing keys, or null to use the default EqualityComparer for the type of the key.

Initializes a new empty instance that has the specified initial capacity, and uses the specified IEqualityComparer.

The initial number of elements that the HtmlParameterDictionary can contain. The IEqualityComparer implementation to use when comparing keys, or null to use the default EqualityComparer for the type of the key.

Initializes a new instance that contains elements copied from the specified IDictionary and uses the default equality comparer for the key type.

The IDictionary whose elements are copied.

Initializes a new instance that contains elements copied from the specified IDictionary and uses the specified IEqualityComparer.

The IDictionary whose elements are copied. The IEqualityComparer implementation to use when comparing keys, or null to use the default EqualityComparer for the type of the key.

Gets the IEqualityComparer that is used to determine equality of keys for the dictionary.

Gets a collection containing the keys.

Gets a collection containing the values.

Determines whether the HtmlParameterDictionary contains a specific value.

The value to locate. true if the HtmlParameterDictionary contains an element with the specified value; otherwise, false.

Gets or sets the value associated with the specified key.

The key of the value to get or set. The value associated with the specified key. If the specified key is not found, a get operation throws a KeyNotFoundException, and a set operation creates a new element with the specified key.

Determines whether the HtmlParameterDictionary contains the specified key.

The key to locate. true if the HtmlParameterDictionary contains an element with the specified key; otherwise, false.

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 value parameter. true if the HtmlParameterDictionary contains an element with the specified key; otherwise, false.

Adds the specified key and value to the dictionary.

The key of the element to add. The value of the element to add.

Removes the value with the specified key.

The key of the element to remove. true if the element is successfully found and removed; otherwise, false. This method returns false if key is not found.

Gets the number of key/value pairs contained.

Removes all keys and values.

Enumerates the elements of a HtmlParameterDictionary.

Releases all resources used by the HtmlParameterDictionary.Enumerator.

Gets the element at the current position of the enumerator.

Advances the enumerator to the next element of the HtmlParameterDictionary.

true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection.

Returns an enumerator that iterates through the HtmlParameterDictionary.

A HtmlParameterDictionary.Enumerator structure.

Image class.

Image constructor.

XPoint destructor.

Dispose of the XImage.

Dispose of the XImage.

Dispose of the XImage.

Load an image from a file.

Load an image from data.

Load an image from a stream.

Load an image from a file.

Load an image from data.

Load an image from a stream.

Assign a soft mask to the image.

The type of image.

The number of frames in the image.

The default frame rate for a moving image.

The currently selected frame.

The width of the current frame (pixels).

The height of the current frame (pixels).

Whether the image specifies the resolution.

The horizontal resolution of the current frame (DPI).

The vertical resolution of the current frame (DPI).

The current selection rectangle.

The physical bounds of the image in points.

Whether the image can be added indirect.

Whether the file needs to exist.

Whether the stream needs be kept open.

Clears the image freeing up resources.

Clears the image freeing up resources.

XPoint class.

XPoint constructor.

XPoint constructor.

XPoint destructor.

Dispose of the XPoint.

Dispose of the XPoint.

A string representation of the point.

A string representation of the point.

The horizontal offset of the point from the bottom left.

The vertical offset of the point from the bottom left.

The point as a System.Drawing Point.

Set the point.

The module used for read operations.

A default set of modules.

The SWF vector module.

The XPS module.

The XPS module with the XPS printer driver.

The OpenOffice.org PDF conversion.

The PDF read module.

The SVG vector import module.

The EPS vector import module.

The base raster image import module.

Microsoft Office import module.

Bookmark creation strategy.

Use module-specific default settings.

Do not import any bookmarks from source documents.

Use document headings as bookmarks.

Content items to process.

Use module-specific default settings.

Import only main content.

Import main content and mark-up.

The error-handling option for read operations.

Produces output until an error is encountered.

No output is produced when an error is encountered.

Settings for read operations.

XReadOptions constructor.

Dispose of the XReadOptions.

The module to use.

Bookmark creation strategy.

Content items to process.

The error-handling option.

The password needed to read the source.

The file extension when the source is specified not with a path or a file name.

The import warning and information log.

Indicates whether the transparency of raster images should be preserved.

The timeout for external components.

Whether to enable macros when opening MS Office documents. This property is supported only for Word, Excel and Powerpoint.

Whether the values of form elements with the same name are distinct.

The Operation to use.

The frame to be read from a multiple frame image such as a movie.

Whether form fields should be live.

OpenOffice.org PDF conversion control parameters.

The default document size for documents that do not specify a size.

The font to use for text that does not specify a font.

Perform extra checks when reading, for importing non-compliant PDF documents.

XRect class.

Corner Enumeration.

Bottom Left Corner.

Top Left Corner.

Bottom Right Corner.

Top Right Corner.

Create an XRect from the coordinates of two diagonally opposite corners.

Create an XRect from a bottom left corner, a width and a height.

Create an XRect from a top left corner, a width and a height.

XRect constructor.

XRect constructor.

XRect destructor.

Dispose of the XPoint.

Dispose of the XPoint.

A string representation of the rectangle.

A string representation of the rectangle.

The offset of the top edge from the bottom left.

The offset of the left edge from the bottom left.

The offset of the bottom edge from the bottom left.

The offset of the right edge from the bottom left.

The width of the rectangle.

The height of the rectangle.

Translate the rectangle up and right.

Scale the rectangle, pinning the bottom left corner.

Move the rectangle, preserving width and height.

Move the specified corner of the rectangle to a position, preserving width and height.

Inset the rectangle horizontally and vertically.

The rectangle as a System.Drawing Rectangle.

The corner of the rectangle to pin.

Resize the rectangle preserving position.

Resize the rectangle preserving the position of the specified corner.

Set the position and size of the rectangle.

Set the position and size of the rectangle.

Set the sides of the rectangle.

Intersect the rectangle with another rectangle.

Fit the rectangle as content inside another rectangle.

Content alignment.

Center.

Left.

Right.

Top.

Bottom.

Content scale mode.

Make the content the biggest and completely within the area while keeping the aspect ratio.

Make the content the smallest and covering the entire area while keeping the aspect ratio.

Scale the content possibly with distortion to fit the entire area.

No scaling.

XRendering Class.

Rendering Compression Enumeration.

Uncompressed

G3 Black and White Fax Compression

G4 Black and White Fax Compression

LZW Compression

Adobe Flate Compression

Flate Compression

Macintosh PackBits

Rendering Colorspace Enumeration.

Red, green and blue

Grayscale

Cyan, magenta, yellow and black

Lab - a device independent color space

Indexed RGB - see the PaletteSize property

The output resolution in dots per inch.

The horizontal output resolution in dots per inch.

The vertical output resolution in dots per inch.

The output colorspace.

The output bits per color channel.

The number of colors in the palette for indexed color output.

Whether to anti-alias text.

Whether to anti-alias polygons.

Whether to anti-alias images.

Whether to apply entire scene anti-aliasing.

Whether to save the alpha channel.

Whether to resize images for vector (emf, ps, etc.) output.

The output file quality factor for lossy compression (0 to 100).

The type of compression to prefer when saving.

The minimum stroked line width for output.

Whether to append to (rather than overwrite) existing image files.

The path to the default Gray ICC color profile.

The path to the default RGB ICC color profile.

The path to the default CMYK ICC color profile.

The path to the default CMYK ICC color profile.

Whether to apply overprint.

Whether to render fields and annotations.

The named separation.

Halftone type and options.

Whether to use embedded halftones.

Whether pages should be automatically rotated.

Number of strips to generate when writing a tiff file.

The log for the last render.

A collection of TIFF tags that should be written to the output file.

Renders and saves the current area of the current page as data.

Renders and saves the current area of the current page to a Bitmap.

Renders and saves the current area of the current page as a file.

Renders and saves the current area of the current page to a stream.

XSaveOptions Class.

Whether to reduce size by remapping objects.

Whether to linearize the output for fast web viewing.

Whether to use incremental update to preserve the validity of signature fields.

Whether to update the file version identifier.

Whether to assign a constant file version identifier.

Whether to assign non-ASCII file identifiers.

The file extension when the target is specified not with a path or a file name.

The path to the template file.

The template data.

The folder where to save additional files (images, fonts, etc).

Specify the type of graphic paths.

Use a sensible default type for the exporter.

Do not embed graphics in the final output.

Render graphics using images, valid for MS Word and HTML exporters.

Render graphics via VML, valid for MS Word exporter.

Render graphics via HTML 5 Canvas, valid for HTML exporter.

How to implement paths, valid values depend on exporter format.

//@HTML and MS Word Exporters only, throw on invalid format

The font substitution type.

Use a sensible default font substituion type.

Always substitute fonts with those installed on the machine.

Only substitute fonts which are missing or could not be converted to open type.

The font substitution type.

//@HTML and MS Word Exporters only

Raster Smoothing.

Specifies the default algorithm.

Specifies no anti-aliasing.

Specifies anti-aliasing.

XSaveTemplateData Class.

XSaveTemplateData constructor.

The horizontal measurement resolution.

The vertical measurement resolution.

The smoothing for displaying images.

The JPEG quality level.

Whether JPEG images are re-encoded in JPEG.

Sets the measurement resolutions.

Sets the measurement resolutions.

LicenseType Enumeration.

Unknown or undefined.

Trial license with professional feature set.

Standard feature set.

Professional feature set.

XSettings Class.

The current license for the software.

The current feature level for the software.

The current license for the software.

The current licensee for the software.

Whether to log errors in the Application Event Log.

The software version.

Register and install trial license.

A trial license key used for remote deployment.

Install a license. Return true if license is valid.

Install a redistribution license. Return true if license is valid.

Install a trial license.

Install a system license. Return true if license is installed.

Set the application configuration section.

Whether the current license is valid in this particular process.

XTextStyle class.

XTextStyle constructor.

XTextStyle destructor.

Dispose of the XTextStyle.

Dispose of the XTextStyle.

A string representation of the style.

A string representation of the style.

The text size (points).

The first line of paragraph indent (points).

The inter-character spacing (points).

The inter-word spacing (points).

The inter-line spacing (points).

The inter-paragraph spacing (points).

The distance between the line spacing below the top of the text frame and the first baseline (1000ths of em).

The horizontal justification factor (0 to 1).

Whether to apply an underline.

Whether to apply a strikethrough.

Whether to apply a double strikethrough.

The width of outline to use.

Whether to synthesize and apply an italic style.

Whether to synthesize and apply a bold style.

The paragraph indent (points).

XTransform class.

AngleUnitType Enumeration.

Degrees.

Radians.

XTransform constructor.

XTransform constructor.

XTransform constructor.

XTransform constructor.

XTransform destructor.

Dispose of the XTransform.

Dispose of the XTransform.

A string representation of the transform.

A string representation of the transform.

The x translation.

The y translation.

Reset to the identity.

Invert the transform.

Translate horizontally and vertically.

Rotate about a locked anchor point (angle according to AngleUnit property).

Scale about a locked anchor point.

Skew horizontally and vertically about a locked anchor point.

Set the transform.

Set the transform.

The transform as an array of floating-point values.

The transform as a System.Drawing Matrix.

The angle units, degrees or radians.

An Atom containing an array of other Atoms.

Create an ArrayAtom from a XRect representation.

The XRect representing the value of the object. The resulting ArrayAtom.

Create an ArrayAtom from a XTransform representation.

The XTransform representing the value of the object. The resulting ArrayAtom.

ArrayAtom constructor.

The number of Atoms in the array.

Copies the Atoms into an array.

The array that is the destination for the elements. The zero-based index in array at which copying begins.

Gets or sets the Atom at the specified index.

Gets or sets the integer at the specified index.

Gets or sets the double at the specified index.

Gets or sets the string at the specified index.

Add an Atom to the end of the array.

The Atom to be added. The position in which the new element was inserted.

Add an integer to the end of the array.

The integer to be added. The position in which the new element was inserted.

Add a double to the end of the array.

The floating point value to be added. The position in which the new element was inserted.

Add a string to the end of the array.

The string to be added. The position in which the new element was inserted.

Removes all Atoms from the array.

Determines whether the array contains a specific Atom.

The object to locate. True if the object is found, otherwise false.

Determines the index of a specific Atom.

The object to locate in the Collection. If found, the index of value, otherwise -1.

Inserts an Atom into the array at the specified position.

The zero-based index at which value should be inserted. The Atom to insert into the array.

Removes an Atom from the array.

The Atom to be removed. True if the Atom is removed, otherwise false.

Removes an Atom at a specified position from the array.

The zero-based index of the item to remove.

Gets an enumerator for the Collection.

The enumerator for the collection.

Test whether the two ArrayAtoms are the same.

The ArrayAtom to test against. Whether the ArrayAtoms are equal.

Compares this instance of an ArrayAtom to another and returns an indication of their relative values.

A System.Object that evaluates to an ArrayAtom. A signed number indicating the relative value of this instance.

A PDF atomic object comprising a basic chunk of PDF data.

Atom destructor.

Create an appropriate type of Atom from a raw PDF string representation.

The string representing the value of the object. The resulting Atom.

Gets the Name value from the Atom if it is a NameAtom.

The Atom to get the name from. The returned name.

Gets the String value from the Atom if it is a StringAtom.

The Atom to get the text from. The returned text.

Gets the Boolean value from the Atom if it is a BoolAtom.

The Atom to get the Boolean from. The returned Boolean.

Gets the Integer value from the Atom if it is a NumAtom.

The Atom to get the integer from. The returned integer.

Gets the Double value from the Atom if it is a NumAtom.

The Atom to get the double from. The returned double.

Gets the Object ID value from the Atom if it is a RefAtom.

The Atom to get the Object ID from. The returned Object ID.

Gets the named entry from the Atom if it is a DictAtom.

The Atom to get the item from. The name of the item to be retrieved. The returned Atom.

Gets the indexed entry from the Atom if it is a DictAtom or ArrayAtom.

The Atom to get the item from. The index of the item to be retrieved. The returned Atom.

Removes the named entry from the Atom if it is a DictAtom.

The Atom from which the item should be removed. The name of the item to be removed.

Adds the named entry to the Atom if it is a DictAtom.

The Atom to which the item should be added. The name of the item to be added. The item to be added. The returned Atom.

Add the indexed entry to the Atom if it is an ArrayAtom.

The Atom to which the item should be added. The index at which the item should be added. The item to be added. The returned Atom.

Test whether the two Atoms are the same.

The Atom to test against. Whether the Atoms are equal.

Test whether the two Atoms are the same.

The object to test against. Whether the objects are equal.

A hash code for the Atom.

The returned hash code.

Compares this instance of an Atom to another and returns an indication of their relative values.

A System.Object that evaluates to an Atom. A signed number indicating the relative value of this instance.

Creates a deep copy of the current Atom.

The newly created copy.

The string representation of the Atom as it would appear in a PDF.

The string representation of the object.

Dispose of the Atom.

Dispose of the Atom.

An Atom containing a boolean value.

Construct a BoolAtom.

Construct a BoolAtom from a boolean value.

The initial value that the Atom should adopt.

Whether the boolean is true or false.

Test whether the two BoolAtoms are the same.

The BoolAtom to test against. Whether the BoolAtoms are equal.

Compares this instance of a BoolAtom to another and returns an indication of their relative values.

A System.Object that evaluates to a BoolAtom. A signed number indicating the relative value of this instance.

An Atom containing a dictionary of other Atoms indexed by name.

The collection of names in a DictAtom.

Initializes a new instance that reflects the keys in the specified DictAtom.

The DictAtom.

Gets the number of elements contained.

Copies the DictAtom.KeyCollection elements to an existing one-dimensional Array, starting at the specified array index.

The array that is the destination for the elements. The zero-based index in array at which copying begins.

Returns an enumerator that iterates through the DictAtom.KeyCollection.

The enumerator for the key collection.

Enumerates the elements of a DictAtom.KeyCollection.

Releases all resources used by the DictAtom.KeyCollection.Enumerator.

Gets the element at the current position of the enumerator.

Advances the enumerator to the next element of the DictAtom.KeyCollection.

Whether the enumerator was successfully advanced to the next element.

The collection of Atoms in a DictAtom.

Initializes a new instance that reflects the values in the specified DictAtom.

Gets the number of elements contained.

Copies the DictAtom.ValueCollection elements to an existing one-dimensional Array, starting at the specified array index.

Returns an enumerator that iterates through the DictAtom.ValueCollection.

Enumerates the elements of a DictAtom.ValueCollection.

Releases all resources used by the DictAtom.ValueCollection.Enumerator.

Gets the element at the current position of the enumerator.

Advances the enumerator to the next element of the DictAtom.ValueCollection.

DictAtom constructor.

Gets the number of elements in the dictionary.

Copies the Atoms into an array.

The array that is the destination for the elements. The zero-based index in array at which copying begins.

Copies the names and Atoms into an array.

The array that is the destination for the elements. The zero-based index in array at which copying begins.

Gets or set the Atom with the specified key.

Gets or set the integer with the specified key.

Gets or set the double with the specified key.

Gets or set the string with the specified key.

Add an Atom to the dictionary.

The string to use as the key of the element to add. The Atom to be added.

Add an integer to the dictionary.

The string to use as the key of the element to add. The integer to be added.

Add a double to the dictionary.

The string to use as the key of the element to add. The floating point value to be added.

Add a string to the dictionary.

The string to use as the key of the element to add. The string to be added.

Removes all elements from the dictionary.

Determines whether the dictionary contains an element with a specific name.

Remove an element from the dictionary.

The name of the element to be removed.

Get an array of all the names in the dictionary.

An array of all the names in the dictionary.

Get an array of all the Atoms in the dictionary.

An array of all the Atoms in the dictionary.

Get the collection of the keys in the dictionary.

Get the collection of the Atoms in the dictionary.

Gets an enumerator for the Dictionary.

The enumerator for the dictionary.

Test whether the two DictAtoms are the same.

The DictAtom to test against. Whether the DictAtoms are equal.

Compares this instance of a DictAtom to another and returns an indication of their relative values.

A System.Object that evaluates to a DictAtom. A signed number indicating the relative value of this instance.

Enumerates the elements of a DictAtom.

Releases all resources used by the DictAtom.Enumerator.

Gets the element at the current position of the enumerator.

Advances the enumerator to the next element of the DictAtom.

true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection.

An atom representing a name.

Create a name atom.

Create a name atom from a string.

The initial value that the Atom should adopt.

The text of the name.

Test whether the two NameAtoms are the same.

The NameAtom to test against. Whether the NameAtoms are equal.

Compares this instance of a NameAtom to another and returns an indication of their relative values.

A System.Object that evaluates to a NameAtom. A signed number indicating the relative value of this instance.

A null atom.

Create a null atom.

Test whether the two NullAtoms are the same.

The NullAtom to test against. Whether the NullAtom are equal.

Compares this instance of a NullAtom to another and returns an indication of their relative values.

A System.Object that evaluates to a NullAtom. A signed number indicating the relative value of this instance.

An atom representing a numeric value.

Create a number atom.

Create a number atom from an integer.

The initial integer value that the Atom should adopt.

Create a number atom from a floating point value.

The initial floating point value that the Atom should adopt.

The integer value of the number.

The integer value of the number.

The floating point value of the number.

Test whether the two NumAtoms are the same.

The NumAtoms to test against. Whether the NumAtoms are equal.

Compares this instance of a NumAtom to another and returns an indication of their relative values.

A System.Object that evaluates to a NumAtom. A signed number indicating the relative value of this instance.

Encode a number into a PDF string. This format may be needed for direct insertion into a content stream.

The number to convert. The string representation.

An atom which references an IndirectObject.

Create a reference atom.

Create a reference atom pointing to a IndirectObject.

The initial IndirectObject that the Atom should point to.

The ID of the referenced IndirectObject.

The generation of the referenced IndirectObject.

Set the IndirectObject that the reference should point to.

The IndirectObject that the RefAtom should point to.

Get the IndirectObject that the reference is pointing to.

The collection of objects to be searched. The matching IndirectObject.

Test whether the two RefAtoms are the same.

The RefAtom to test against. Whether the RefAtoms are equal.

Compares this instance of a RefAtom to another and returns an indication of their relative values.

A System.Object that evaluates to a RefAtom. A signed number indicating the relative value of this instance.

An atom representing a textual value.

Create a string atom.

Create a string atom from a string.

The initial value that the Atom should adopt.

Create a string atom from an array of bytes.

The initial value that the Atom should adopt.

The text of the string.

Test whether the two StringAtoms are the same.

The StringAtom to test against. Whether the StringAtoms are equal.

Compares this instance of a StringAtom to another and returns an indication of their relative values.

A System.Object that evaluates to a StringAtom. A signed number indicating the relative value of this instance.

Encode a string into a PDF string format for use in a content stream using a normal or simple font. Typically you will obtain an appropriate encoding from a FontObject.

The text to be encoded. The encoding to use - typically obtained from the FontObject.GetEncoding method. If null an identify encoding will be used. The StringBuilder to which the encoded representation should be appended. If null then one will be created. The updated StringBuilder.

Encode a string into a PDF string format for use in a content stream using a Composite font with a double byte CMap.

The text to be encoded. The encoding to use - typically obtained from the FontObject.GetEncoding method. If null an identify encoding will be used. The StringBuilder to which the encoded representation should be appended. If null then one will be created. The updated StringBuilder.

UnitType Enumeration.

PostScript Points - 1/72 of an Inch.

Twentieths of a Point - 1/20 of a PostScript Point.

Didot Points - 1/72 of a French Royal Inch.

ATA Points - 1/72.272 of an Inch.

TeX Points - 1/72.27 of an Inch.

L'Imprimerie Nationale Points - 0.4 mm.

Picas - 12 PostScript Points.

Ciceros - 12 Didot Points.

ATA Ciceros - 12 ATA Points.

TeX Ciceros - 12 TeX Points.

Microns - millionths of a metre.

Milimeters - thousandths of a metre.

Centimeters - hundredths of a metre.

Meters.

Inches.

Feet.

LanguageType Enumeration.

Latin - the default and most efficient encoding for Western languages.

Unicode - the setting you will most often want to use when embedding foreign character sets.

Korean.

Japanese.

Simplified Chinese.

Traditional Chinese.

The delegate called during HTML rendering.

The delegate called when embedding an object during HTML rendering.

An object encapsulating a PDF document.

Document constructor.

Doc destructor.

Dispose of the Doc.

Dispose of the Doc.

The ID of the current page.

The ID of the current font.

The current text size (points).

The current line width (points).

The horizontal positioning factor (0 to 1).

The vertical positioning factor (0 to 1).

The current drawing color.

The current drawing position.

The current drawing rectangle.

The page size.

The visible page size.

The current text style.

The current default transformation.

The current encryption settings.

The current license details.

The ID of the root catalog.

The content insertion position (one is top).

The number of layers in the current page.

Add a page - return the page ID.

The Object ID of the newly added Page Object.

Add a page at a specified location - return the page ID.

The page insertion location. The Object ID of the newly added Page Object.

Add a font resource - return the font ID.

The name of the font typeface. The Object ID of the newly added Font Object.

Add a font resource - return the font ID.

The name of the font typeface. The language type to use. The Object ID of the newly added Font Object.

Add a font resource - return the font ID.

The name of the font typeface The language type to use. Whether the text direction should be vertical. The Object ID of the newly added Font Object.

Add a font resource - return the font ID.

The name of the font typeface. LanguageType enumeration value. The Object ID of the newly added Font Object.

Add a font resource - return the font ID.

The name of the font typeface. LanguageType enumeration value. Whether the text direction should be vertical. The Object ID of the newly added Font Object.

Add a block of text - return the text ID.

The text to be added to the page. The Object ID of the newly added Text Object.

Add a block of HTML styled text - return the text ID.

The HTML to be added to the page. The Object ID of the newly added Text Object.

Chain a block of HTML styled text - return the text ID.

A dummy parameter. The contents are not used. The Object ID of a previously added text block. The Object ID of the newly added Text Object.

Add a line - return the line ID.

The horizontal offset of the start point. The horizontal offset of the end point. The vertical offset of the start point. The vertical offset of the end point. The Object ID of the newly added Graphic Object.

Add an image - return the image ID.

An XImage containing the image to be added to the page. The ID of the newly added Image Object.

Add an image - return the image ID.

An existing image object ID to be copied to the page again. The ID of the newly added Image Object.

Add an image - return the image ID.

The raw JPEG data to be added to the page. The ID of the newly added Image Object.

Add an image - return the image ID.

The raw JPEG data to be added to the page. The page of the document to be added. The ID of the newly added Image Object.

Add an image - return the image ID.

A file path, URL or html string to be added to the page. The ID of the newly added Image Object.

Add an image - return the image ID.

A file path, URL or html string to be added to the page. The page of the document to be added. The ID of the newly added Image Object.

Add an image - return the image ID.

A .NET Bitmap to be added to the page. The ID of the newly added Image Object.

Add an image - return the image ID.

A PDF document page to be added to the page. The page of the document to be added. The source area of the document page to be added. The ID of the newly added Image Object.

Add an image - return the image ID.

A PDF document page to be added to the page. The page of the document to be added. The ID of the newly added Image Object.

Add a Bitmap to the current page - return the image ID.

A .NET Bitmap to be added to the page. Whether transparency information should be preserved. The ID of the newly added Image Object.

Add a copy of an existing image to the current page - return the image ID.

An existing image object ID to be copied to the page again. The ID of the newly added Image Object.

Extract the first image from a chunk of data and add it to the current page - return the image ID.

The data containing the image in a format such as JPEG or TIFF. The ID of the newly added Image Object.

Extract an image from a chunk of data and add it to the current page - return the image ID.

The data containing the image in a format such as JPEG or TIFF. Some image types support multiple frames or pages. This is the one based index specifying the required frame (default one). The ID of the newly added Image Object.

Draw a page from one PDF document onto the current page of this document - return the image ID.

The document to be used as the source. The page you want drawn. Use one to indicate the first page. The portion of the page you want drawn. Pass null to specify the entire page. The ID of the newly added Image Object.

Draw a page from one PDF document onto the current page of this document - return the image ID. Optionally copy annotations and fields where possible.

The document to be used as the source. The page you want drawn. Use one to indicate the first page. The portion of the page you want drawn. Pass null to specify the entire page. Whether to copy fields and annotations. The ID of the newly added Image Object.

Draw a page from one PDF document onto the current page of this document - return the image ID. Optionally copy annotations and fields where possible.

The document to be used as the source. The page you want drawn. Use one to indicate the first page. The portion of the page you want drawn. Pass null to specify the entire page. Whether to copy fields and annotations. The level of alpha to apply to the drawn page from transparent through to fully opaque (0 to 255). The ID of the newly added Image Object.

Extract the first image from a file and add it to the current page - return the image ID.

A file path, URL or html string to be added to the page. The Object ID of the newly added Image Object.

Extract an image from a file and add it to the current page - return the image ID.

A file path, URL or html string to be added to the page. Some image types support multiple frames or pages. This is the one based index specifying the required frame (default one). The Object ID of the newly added Image Object.

Adds an image to the current page - return the image ID.

An XImage containing the image to be added to the page. The ID of the newly added Image.

Adds an image to the current page - return the image ID.

An XImage containing the image to be added to the page. Whether transparency information should be preserved. The ID of the newly added Image.

Add a new page from a paged HTML or PostScript render - return the image ID.

The ID of the previous object in the chain. The ID of the newly added object.

Renders a web page specified by URL - return the image ID.

The HTML to be rendered. The ID of the newly added object.

Renders a web page specified as HTML - return the image ID.

The HTML to be rendered. Allows you to override the default XHtmlOptions.Paged property. Allows you to override the default XHtmlOptions.BrowserWidth property. Allows you to override and disable the page cache. The ID of the newly added object.

Renders a web page specified by URL - return the image ID.

The URL for the page to be rendered. The ID of the newly added object.

Renders a web page specified by URL - return the image ID.

The URL for the page to be rendered. Allows you to override the default XHtmlOptions.Paged property. Allows you to override the default XHtmlOptions.BrowserWidth property. Allows you to override and disable the page cache. The ID of the newly added object.

Get a particular type of information about an object.

The Object ID of the object to be queried. The type of information to be retrieved. The returned information.

Get numeric information about an object.

The Object ID of the object to be queried. The type of information to be retrieved. The returned integer.

Get numeric information about an object.

The Object ID of the object to be queried. The type of information to be retrieved. The returned integer.

Get numeric information about an object.

The Object ID of the object to be queried. The type of information to be retrieved. The returned value.

Get date and time information about an object.

The Object ID of the object to be queried. The type of information to be retrieved. The returned value.

Get date and time information about an object.

The Object ID of the object to be queried. The type of information to be retrieved. The returned value will be in local time if the date includes time zone information, otherwise it will be in UTC. The returned value.

Add a framed rectangle - return the line ID.

The Object ID of the newly added Graphic Object.

Add a framed rounded rectangle - return the line ID.

The horizontal radius to use for rounded corners. The vertical radius to use for rounded corners. The Object ID of the newly added Graphic Object.

Add a framed rounded rectangle - return the line ID.

The horizontal radius to use for rounded corners. The vertical radius to use for rounded corners. Whether to draw the frame inside the rectangle. The Object ID of the newly added Graphic Object.

Add a framed rounded rectangle - return the line ID.

Whether to draw the frame inside the rectangle. The Object ID of the newly added Graphic Object.

Add a filled rectangle - return the line ID.

The Object ID of the newly added Graphic Object.

Add a filled rounded rectangle - return the line ID.

The horizontal radius to use for rounded corners. The vertical radius to use for rounded corners. The Object ID of the newly added Graphic Object.

Delete a specified object.

The Object ID of the object to be deleted.

Save the PDF as a file.

The destination file path.

Write the PDF to a stream.

The destination stream.

Get the PDF as raw data.

The PDF document as an array of bytes.

Get the PDF as raw data stream.

The PDF document as a stream.

Read an existing document from file.

The file path to the PDF, OpenOffice.org, SVG, or XPS document.

Read an existing document from file.

The file path to the PDF, OpenOffice.org, SVG, or XPS document. Any password needed to open the document.

Read an existing document from file.

The file path to the PDF, OpenOffice.org, SVG, or XPS document. The settings for the read.

Read an existing PDF from data.

The source PDF data.

Read an existing PDF from data.

The source PDF data. Any password needed to open the document.

Read an existing PDF from data.

The source PDF data. The settings for the read.

Read an existing PDF from stream.

The source PDF or document stream.

Read an existing PDF from stream.

The source PDF or document stream. Any password needed to open the document.

Read an existing PDF from stream.

The source PDF or document stream. The settings for the read.

Embed a font resource - return the font ID.

The name of the font typeface. The Object ID of the newly embedded Font Object.

Embed a font resource - return the font ID.

The name of the font typeface. The language type to use. The Object ID of the newly embedded Font Object.

Embed a font resource - return the font ID.

The name of the font typeface. The language type to use. Whether the text direction should be vertical. The Object ID of the newly embedded Font Object.

Embed a font resource - return the font ID.

The name of the font typeface. The language type to use. Whether the text direction should be vertical. Whether to subset the font. The Object ID of the newly embedded Font Object.

Embed a font resource - return the font ID.

The name of the font typeface. The language type to use. Whether the text direction should be vertical. Whether to subset the font. Whether to override permissions on the font. The Object ID of the newly embedded Font Object.

Embed a font resource - return the font ID.

The name of the font typeface. LanguageType enumeration value. The Object ID of the newly embedded Font Object.

Embed a font resource - return the font ID.

The name of the font typeface. LanguageType enumeration value. Whether the text direction should be vertical. The Object ID of the newly embedded Font Object.

Embed a font resource - return the font ID.

The name of the font typeface. LanguageType enumeration value. Whether the text direction should be vertical. Whether to subset the font. The Object ID of the newly embedded Font Object.

Embed a font resource - return the font ID.

The name of the font typeface. LanguageType enumeration value. Whether the text direction should be vertical. Whether to subset the font. Whether to override permissions on the font. The Object ID of the newly embedded Font Object.

Alters an aspect of an existing object.

The Object ID of the object to be modified. The type of value to insert. The string value to insert.

Alters an aspect of an existing object.

The Object ID of the object to be modified. The type of value to insert. The integer value to insert.

Alters an aspect of an existing object.

The Object ID of the object to be modified. The type of value to insert. The long value to insert.

Alters an aspect of an existing object.

The Object ID of the object to be modified. The type of value to insert. The double value to insert.

Alters an aspect of an existing object.

The Object ID of the object to be modified. The type of value to insert. The DateTime value to insert.

Adds a bookmark for the current page.

The path to the bookmark. Whether the bookmark should be displayed open (expanded) or closed (collapsed). The Object ID of the newly added Bookmark Object.

Adds a native PDF object to the document.

The raw native object to be added. The Object ID of the newly added Object.

Flattens and compresses the current page.

n/a.

Clears the document freeing up resources.

Clears the cached, decompressed data for stream objects.

Clears the cached, decompressed data for stream objects.

The types of stream objects whose cached, decompressed data are discarded. The default value is All.

Adds an alignment grid to help position objects.

The Object ID of the newly added Grid Object.

The page number (one is the first page).

The number of pages in the document.

Appends a PDF document to the end of the current document.

The document to add to the end of this one.

Add an arc - return the line ID.

The start angle of the arc in degrees. The end angle of the arc in degrees. The horizontal center of the arc. The vertical center of the arc. The horizontal radius of the arc. The vertical radius of the arc. The Object ID of the newly added Graphic Object

Add an arc - return the arc ID.

The start angle of the arc in degrees. The end angle of the arc in degrees. The horizontal center of the arc. The vertical center of the arc. The horizontal radius of the arc. The vertical radius of the arc. Whether to fill the arc rather than simply drawing it. The Object ID of the newly added Graphic Object

The current line options.

The current measurement units.

Whether to measure from the top of the page.

The ID of the current color space.

Add an ICC based color space - return the ID.

The path to the ICC color space file. The Object ID of the newly added ColorSpace Object.

Add a separation color space - return the ID.

The name of the color. The display representation of the color. This should be supplied in the same format as the XColor.String uses. The Object ID of the newly added ColorSpace Object.

Add an oval - return the line ID.

Whether to fill the oval rather than simply outline it. The Object ID of the newly added Graphic Object.

Add a pie slice - return the line ID.

The start angle of the pie slice in degrees. The end angle of the pie slice in degrees. Whether to fill the pie slice rather than simply outline it. The Object ID of the newly added Graphic Object.

Add a polygon - return the line ID.

The coordinates of the vertices of the polygon. Whether to fill the polygon rather than simply outline it. The Object ID of the newly added Graphic Object.

Add a polygon - return the line ID.

The coordinates of the vertices of the polygon. Whether to fill the polygon rather than simply outline it. The Object ID of the newly added Graphic Object.

Add a polygon - return the line ID.

The coordinates of the vertices of the polygon. The index of the first coordinate into the array points. The number of coordinates in the array points to use. Whether to fill the polygon rather than simply outline it. The Object ID of the newly added Graphic Object.

Determine if an object is chainable.

The Object ID of the object to be tested. Whether the object is chainable or not.

Extract content from the current page in a specified format. Prefer the overload accepting a Page.TextType enumeration.

Extract content from the current page in a specified format.

The format in which to return the content. The returned content.

Remap pages for reordering, copying and deletion.

The list of page numbers.

Remap pages for reordering, copying and deletion.

The list of page numbers.

Remap pages for reordering, copying and deletion.

The list of page numbers. The index of the first page number into the array pages. The number of page numbers in the array pages to use.

The PDF Indirect Object Collection.

The HTML and URL rendering options and control.

The save options and control.

The PDF rendering options and control.

The document form and fields.

The top level bookmark for the document.

An Annotation such as a text note or hyperlink.

The sub-type of Annotation.

The visible text of the annotation.

The full name of any form field associated with this annotation.

The field type of any form field associated with this annotation.

The value of any form field associated with this annotation.

The possible values for any form field associated with this annotation.

The Page on which this annotation is located.

The rectangle which defines the position and area of the annotation on the page.

Update the Appearance Stream for this Annotation.

Dispose of the Annotation.

A bookmark or outline item.

Whether the bookmark appears open or closed.

The parent of this bookmark.

The destination Page associated with this bookmark.

The destination Page ID associated with this bookmark.

The bookmark title to be displayed on screen.

Refresh and reload the document bookmarks.

Adopt a specified bookmark.

The bookmark to be adopted.

The number of Bookmarks in the collection.

Copies the Bookmarks into an array.

The array that is the destination for the elements. The zero-based index in array at which copying begins.

Gets or sets the Bookmark at the specified index.

Add a Bookmark to the end of the list.

The bookmark to be added. The position in which the new element was inserted.

Add a Bookmark to the end of the list.

The title for the bookmark to be added. The position in which the new element was inserted.

Removes all child Bookmarks.

Determines whether the array contains a specific Bookmark.

The object to locate. True if the object is found, otherwise false.

Determines the index of a specific Bookmark.

The object or the title of the object to locate in the Collection. If found, the index of value, otherwise -1.

Determines the index of a specific Bookmark.

The object or the title of the object to locate in the Collection. If found, the index of value, otherwise -1.

Inserts a Bookmark into the list at the specified position.

The zero-based index at which value should be inserted. The bookmark to be added.

Inserts a Bookmark into the list at the specified position.

The zero-based index at which value should be inserted. The title for the bookmark to be added.

Removes a Bookmark.

The Bookmark to be removed. True if the Bookmark is removed, otherwise false.

Removes a Bookmark at a specified position.

The zero based index specifying the Bookmark to be removed.

Gets an enumerator for the Collection.

The enumerator for the collection.

The Catalog for the document.

The root Pages Object.

The root Outlines Object.

The names of all the eForm fields in the document.

The names of all the eForm fields in the document.

Get all the eForm fields in the document.

The names of all the eForm fields in the document.

Perform whole document analysis of page contents.

Gets all the fonts in this document.

All the fonts in the document.

ColorSpaceType Enumeration.

Unknown or undefined.

Device dependent Gray.

Device dependent RGB.

Device dependent CMYK.

Calibrated Gray.

Calibrated RGB.

ICC Color Profile Based.

Lab.

Indexed Color.

Pattern.

Separation.

DeviceN.

A color space.

ColorSpace constructor.

The ObjectSoup to contain the newly created StreamObject.

ColorSpace constructor.

The ObjectSoup to contain the newly created StreamObject. The type of color space required.

The type of color space.

Any name associated with the color space.

The number of color components in the color space.

The type of color space.

Any ICC Color Profile associated with this color space.

FieldType Enumeration.

Pushbutton Type.

Checkbox Type.

Radio Type.

Text Type.

List Type.

Combo Type.

Signature Type.

Unknown Type.

A field in a PDF form.

The value of the field.

The type of the field.

The possible values for this field.

The fully qualified field name.

The Page on which this field is located.

The ID of the Page on which this field is located.

The rectangle which defines the position and area of the annotation on the page.

All the immediate children of this field.

Prepare document for drawing at the field location.

True if the focus operation was successful.

Stamp this field into the document.

The partial field name.

The format for this field.

Whether the field supports multiple selections.

Dispose of the Field.

A collection of Fields.

The number of Fields in the collection.

Copies the Fields into an array.

The array that is the destination for the elements. The zero-based index in array at which copying begins.

Gets or sets the Field at the specified index.

Gets or sets the Field of the specified name.

Add a Field to the end of the list.

The item to be added. The position in which the new element was inserted.

Removes all child Fields.

Determines whether the list contains a specific Field.

The object to locate. True if the object is found, otherwise false.

Determines the index of a specific Field.

The object to locate in the collection. If found, the index of value, otherwise -1.

Inserts a Field into the list at the specified position.

The zero-based index at which value should be inserted. The item to insert into the array.

Removes a Field.

The name of the element to be removed. True if the Field is removed, otherwise false.

Removes a Field at a specified position.

The zero-based index of the item to remove.

Gets an enumerator for the Collection.

The enumerator for the collection.

A specific font as used in the document.

The font writing mode type.

Horizontal writing mode.

Vertical writing mode.

The support for encoding text.

Encode all text.

Encode nothing if any character is not included in the font.

Encode up to and excluding the first character not included in the font.

All glyphs have the same width; as opposed to proportional or variable-pitch fonts, which have different widths.

Glyphs have serifs - short strokes drawn at an angle on the top and bottom of glyph stems. Sans serif fonts do not have serifs.

Font contains glyphs outside the Adobe standard Latin character set. This flag and the Nonsymbolic flag are mutually exclusive.

Glyphs look like cursive handwriting.

Font uses the Adobe standard Latin character set or a subset of it.

Glyphs have slanted dominant vertical strokes.

Font contains no lowercase letters.

Lower case letters in this font look like smaller versions of their upper case equivalents.

Whether bold glyphs shall be painted with extra pixels even at very small text sizes.

The font writing mode.

Encode text for use with PDF text operators.

The text to be encoded. The way in which characters not included in the font are to be encoded. The PDF string containing the encoded text.

Encode text for use with PDF text operators.

The text to be encoded. The way in which characters not included in the font are to be encoded. The number of characters in (parameter) text that are encoded in the return value. The PDF string containing the encoded text.

Subset a previously embedded font.

Whether subsetting was performed succesfully.

Subset a previously embedded font to include only those characters in the provided string.

Attempt to regenerate a ToUnicode map.

Whether a new ToUnicode map was generated.

Whether the font contains an embedded subset.

The PostScript name of the font.

The character widths in thousandths of a unit for all the characters in the font.

Whether the font is a complex composite font.

Whether the font is for vertical writing.

The embedded font file.

Unembed the font if this is a simple operation. Latin based fonts can often be unembedded as a simple and fast operation. However Unicode and symbolic fonts are more complex to unembed and cannot be simply removed from the document.

The number of bytes of font data that were removed as a result of this call. Note that if multiple font objects reference the same embedded font then the same number may be returned multiple times.

Obtain a standard encoding dictionary for use with PDF text operators.

The language type for the desired encoding. Whether the writing direction should be horizontal or vertical. A dictionary mapping Unicode values to native character IDs.

A Form XObject is a self contained stream of graphics operations which can be referenced as a group.

FormXObject constructor.

The ObjectSoup to contain the newly created FormXObject.

The rect defining the bounding box of the graphic. Content will be clipped to this area.

The transformation matrix used for mapping the Form XObject space into user space. This entry may be null which signifies the identity matrix.

A specific GraphicLayer as used in the document.

A pre-specified graphics state.

An ICC Color Profile.

IccProfile constructor.

The ObjectSoup to contain the newly created IccProfile. A path to an ICC file.

IccProfile constructor.

The ObjectSoup to contain the newly created IccProfile. An ICC profile stored in an array of bytes.

Set the raw binary content of the stream.

The raw binary content of the stream.

A rendition of a image on a page.

The PixMap containing the image data.

A PDF Indirect Object.

Construct an appropriate type of IndirectObject given a string value.

The string representing the value of the object. The resulting IndirectObject.

IndirectObject constructor.

IndirectObject destructor.

Whether the two IndirectObjects are the same.

The object to test against. Whether the objects are equal.

Creates a deep copy of the current IndirectObject.

The newly created copy.

A hash code for the IndirectObject.

The returned hash code.

The string representation of the IndirectObject.

The string representation of the object.

Dispose of the IndirectObject.

Dispose of the IndirectObject.

The ID of the PDF object.

The Generation of the PDF object.

The revision of the document in which this object is stored. One is the oldest update and larger values are more recent. A value of zero indicates that the object was not read from stream.

The minimum version of the PDF specification required to support this object.

The minimum extension level of Adobe Supplement to the PDF specification required to support this object.

Whether the IndirectObject is currently alive.

The atom contained by the IndirectObject.

Resolves any indirect references and returns the Atom.

The Atom to resolve. The final Atom or null if no Atom could be found.

Resolves any indirect references and returns the final RefAtom.

The Atom to resolve. The final RefAtom or null if no valid RefAtom could be found.

Resolves any indirect references and returns the final IndirectObject.

The Atom to resolve. The final IndirectObject or null if no valid object could be found.

The Doc containing this IndirectObject.

A layer of visible content.

The rect defining the bounds of the visible content.

The collection of IndirectObjects for a PDF.

ObjectSoup destructor.

Dispose of the Collection.

Gets the number of items in the Collection.

Gets the number of incremental updates. No object in the collection will have a Revision higher than this.

Copies the objects in the Collection to an Array.

The array that is the destination for the elements. The zero-based index in array at which copying begins.

Gets or sets the object at the specified index.

Adds an object to the Collection.

The IndirectObject to be added. The position in which the new element was inserted.

Removes all objects from the Collection.

Determines whether the Collection contains a specific object.

The object to locate. True if the object is found, otherwise false.

Determines the index of a specific object.

The object to locate in the Soup. If found, the index of value, otherwise -1.

Inserts an object into the Collection at the specified position.

The zero-based index at which value should be inserted. The Object to insert into the Soup.

Removes an object from the Collection.

The IndirectObject to be removed. True if the IndirectObject is removed, otherwise false.

Removes an object at a specified position from the Collection.

The zero-based index of the item to remove.

Gets an enumerator for the Collection.

The enumerator for the collection.

The Catalog for the document.

The Trailer or XRef for the document.

A set of IndirectObjects from an ObjectSoup. This may be used for selecting related objects and copying them to a new soup while maintaining the relationships between the items in the selection.

ObjectSet constructor.

The soup from which objects will be selected.

Gets a dictionary used to redirect all objects of a specific type to a specific object ID.

Gets the dictionary used to map object IDs from the source soup to new object IDs in the final soup. Some mappings may be populated via the RemapTypes as IndirectObjects are added. Most will be populated at the point that the CopyTo method is called.

Gets the collection of IndirectObjects currently contained in the subset.

Add a parent object along with all objects it refers to.

The IndirectObject to be added. The number of objects that were added.

Add all the objects this dictionary refers to.

A dictionary atom to be added. The number of objects that were added.

Add just this object ignoring any objects it may refer to.

The IndirectObject to be added. True if the item was added.

Copy the objects in this subset to a new soup while preserving the relationships between the items in the selection.

The destination soup.

The top level outline item.

A visible page within the document.

TextType Enumeration.

Unicode Text.

Unicode Text without features like inferred spaces and de-hyphenation.

Scalable Vector Graphics (SVG).

Scalable Vector Graphics (SVG). Extra attributes related to PDF drawing operators.

Scalable Vector Graphics (SVG). Extra attributes related to PDF drawing operators. Form XObject content included.

The parent of this page.

The number of degrees to rotate the page before display. Should be a multiple of 90.

The page number (one is the first page).

Detaches a content stream from the page.

The stream to detach from the page.

Gets all the named separations referenced by the page.

An array of the names of the separations.

Gets all the content Layers for the page.

An array of all the content Layers on the page.

Gets all the Annotations on the page.

An array of all the Annotations on the page.

Converts the page from one color space to another.

The destination color space. Whether to convert the color space of annotation appearance streams.

Converts the page from one color space to another.

The destination color space. Whether to convert the color space of annotation appearance streams. All the PixMaps which were recolored as a result of the call.

Makes any inline images into external images.

Makes any inline images into external images. Return the extracted images.

Replaces the content stream of a page containing text to one containing glyph outlines.

Extract content from the current page in a specified format.

Extract content from the current page in a specified format.

Flatten and compress the page content stream.

Whether to force the flattening even if the streams contain extra information which might be lost. Whether the page is flat.

Flatten the page content stream.

Whether to force the flattening even if the streams contain extra information which might be lost. Whether to compress the resulting stream or whether to leave it as undetermined compression. Whether the page is flat.

Get all the resources of a named type, optionally including any used by referenced objects.

The type of resource to be found. Whether to include resources in annotations. Whether to include resources in referenced Form XObjects. Whether to include resources in pattern dictionaries. Whether to include resources in parent objects. A set of IndirectObject IDs that should be skipped when performing the scan. May be null. A set of matching resource Atoms.

Get a dictionary mapping the names of a particular type of resource to Atoms.

The ID of the resource containing object. This is typically the Page ID but you may also use a Form XObject ID. The type of resource to be indexed. A dictionary mapping resource names to Atoms.

A Pages node within the document.

The parent of this node.

The number of visible pages under this node.

Gets all the Page objects under this node. Only immediate children are returned. Any Pages objects are returned as null Page objects.

An array of all the Page objects under this node. Only immediate children are returned. Any Pages objects are returned as null Page objects.

Gets all the Page objects under this node and descendents of this node.

Gets all the Page objects under this node and descendents of this node.

Converts all the visible Page objects from one color space to another.

The destination color space. Whether to convert the color space of annotation appearance streams.

Converts all the visible Page objects from one color space to another.

The destination color space. Whether to convert the color space of annotation appearance streams. All the PixMaps which were recolored as a result of the call.

Interpolation Enumeration.

Automatically decide a good method.

Nearest neighbor interpolation.

Linear interpolation.

Cubic interpolation.

Supersampling interpolation (cannot be used for enlarging).

Interpolation using 3-lobed Lanczos window function.

Rendering Intent Enumeration.

Use a perceptual model for handling out of gamut colors (good for photographs).

Keep color values the same but allow the brightness to vary.

Use a saturation model for handling out of gamut colors (good for diagrams).

Use the closest color at the gamut boundary.

A bitmap based image.

The width of the image in pixels.

The height of the image in pixels.

The number of color components for each pixel.

The number of bits per color component.

The type of color space for this image.

The ColorSpace for this image.

Whether corrupt data should automatically be fixed.

Whether this image is a one bit image mask.

Sets a constant alpha value (0-255) for this image.

A constant alpha value to assign to this image.

Sets a chromakey transparent color for this image.

A chromakey string to assign to this image.

Converts the image to grayscale.

Decompress the data in the stream using on-the-fly resizing. This type of scaling is fast but may change the depth of the image. Only some compression types support on-the-fly resizing.

Converts the image from indexed color to component color.

Converts the image from one color space to another.

The destination color space.

Converts the image from one color space to another.

The destination color space. The rendering intent enumeration.

Gets the content of the object as a Bitmap.

The Bitmap containing the image.

Changes the number of bits per color component.

The number of bits per color component.

Resizes the image.

The destination width for the image. The destination height for the image.

Resizes the image.

The destination width for the image. The destination height for the image. The type of interpolation to be used when resizing the image.

JPEG compresses the image.

The quality of compression to use (0 to 100).

CCITT compresses the image.

JPEG 2000 compresses the image.

The quality of compression to use (0 to 100).

JBIG2 compresses the image.

A digital Signature Field.

The validation policy type for certificates.

Perform an X.509 certificate path validation using the Windows Trusted Root CA store. Additional certificates passed in through Validate() will also be added as trust anchors.

Just verify that the certificate(s) in the document has or have been signed with one of the certificates specified as a parameter in Validate().

The validation policy for certificates.

Return binary X509 certificate(s) data.

The encoded X.509 data for the certificate(s).

Return binary X509 certificate(s) data.

The number of certificates. The encoded X.509 data for the certificate(s).

Sign a signature using a private key and password.

The path to the PFX/PKCS #12 (.pfx or .p12) file used for signing. The password used to authorize use of the private key.

Sign a signature using a private key and password.

The data for the PFX/PKCS #12 (.pfx or .p12) file used for signing. The password used to authorize use of the private key.

Sign a signature using a private key and password.

The stream for the PFX/PKCS #12 (.pfx or .p12) file used for signing. The password used to authorize use of the private key.

Sign a signature using a private key.

The System.Security.Cryptography.X509Certificates.X509Certificate2 object for the PFX/PKCS #12 (.pfx or .p12) certificate used for signing. Whether to suppress prompting the user to use the private key.

Commit a previously signed signature to the document.

The location of the signing.

The reason for signing.

The name of the person signing.

The URL to a timestamping service.

The time of signing in UTC format.

True if the PDF was modified after signing.

True if the signature's certificate is trusted according to ValidationPolicy.

True if the signature's certificate was time-valid when the document was signed.

True if the signature and document look well formed and well applied.

Check and validate the status of this signature.

True if the certificate is valid.

Check and validate the status of this signature.

Check and validate the status of this signature.

An array of paths to X.509 certificate (.cer) files. True if the certificate is valid.

CompressionType Enumeration.

Not compressed.

Compressed in an undefined or complex way.

Flate compressed.

LZW compressed.

CCITT compressed.

JPEG compressed.

JPEG 2000 compressed.

ASCII Hex encoded.

ASCII 85 encoded.

Run length compressed.

JBIG2 compressed.

Security handler encrypted.

StreamObjectTypes Enumeration.

No stream object.

All stream objects.

Other stream objects.

PixMap.

Form XObject.

Tiling pattern objects.

Shading objects that are streams.

Function objects that are streams.

A PDF data stream.

StreamObject constructor.

The ObjectSoup to contain the newly created StreamObject.

StreamObject constructor.

The ObjectSoup to contain the newly created StreamObject. A path to a file containing data which should be placed in the StreamObject.

StreamObject constructor.

The ObjectSoup to contain the newly created StreamObject. An array of bytes which should be placed in the StreamObject.

The number of bytes of encoded stream data.

Whether the stream data is compressed or otherwise encoded.

The primary compression type.

All compression types, ordered in terms of the complete decompression sequence required for the stream.

Get the raw binary content of the stream.

The raw binary content of the stream.

Set the raw binary content of the stream.

The raw binary content of the stream.

Set the raw binary content of the stream from data embedded in a file.

A path to a file containing data which should be placed in the StreamObject.

Get the content of the stream as a string.

The content of the stream as a string.

Set the content of the stream as a string.

The content of the stream as a string.

Compress the data in the stream.

Compress the data in the stream using Flate compression.

Whether the compression was applied.

Compress the data in the stream using Flate compression.

Whether to force the stream to be compressed in this way. Whether the compression was applied.

Compress the data in the stream using ASCII Hex compression.

Whether the compression was applied.

Compress the data in the stream using ASCII Hex compression.

Whether to force the stream to be compressed in this way. Whether the compression was applied.

Compress the data in the stream using ASCII85 (Base85) compression.

Whether the compression was applied.

Compress the data in the stream using ASCII85 (Base85) compression.

Whether to force the stream to be compressed in this way. Whether the compression was applied.

Compress the data in the stream using run length compression.

Whether the compression was applied.

Compress the data in the stream using run length compression.

Whether to force the stream to be compressed in this way. Whether the compression was applied.

Decompress the data in the stream.

Whether the data in the stream is uncompressed.

Clear the data and compression settings for the stream.

Clear the cached, decompressed data for the stream.

A multistyled text object appearing on a page.

The number of characters appearing on the page.

The number of lines appearing on the page.

Whether the text had to be truncated.

The previous text object in the text chain.

The point defining the end position of the text.

The full text provided in the initial call to AddHtml or AddText. This text is shared between all the items in a chain.

The offset to the first character (in the full text) to be drawn onto this layer.

The offset to the last character (in the full text) to be drawn onto this layer.

The offset to the character (in the full text) which will be drawn at the start of the next item in the chain.

A view onto a larger underlying graphic.

The content width of the image.

The content height of the image.

The scroll width of the image.

The scroll height of the image.

The offset to the top of the current page.

The width of the content on the current page.

The height of the content on the current page.

Whether the image is truncated.

The source type of operations.

No information was set.

A document.

A document page.

A page content.

A standard image (single-frame).

An image used as a mask.

A multi-frame image.

A frame in a multi-frame image.

A stream in a PDF document.

A path element in a PDF stream.

A text element in a PDF stream.

A form XObject in a PDF stream.

A shading operator in a PDF stream.

A font in a PDF.

Provides generic information related to the ProcessingObject event.

ProcessingInfo constructor.

The event type.

The current document being processed, null if not applicable.

The total number of documents, null if not applicable.

The current page being processed, null if not applicable.

The total number of pages, null if not applicable.

The current frame being processed, null if not applicable.

The total number of frames, null if not applicable.

The number of frames per second, null if not applicable.

The object's horizontal location, null if not applicable.

The object's vertical location, null if not applicable.

The object's width, null if not applicable.

The object's height, null if not applicable.

The object's background color, null if not applicable.

Indicates whether the source has been handled by the event handler.

The stream position, null if not applicable.

The stream length, null if not applicable.

The object text, null if not applicable.

Provides data related to an Operation about to be performed on an IndirectObject.

ProcessingObjectEventArgs constructor.

The IndirectObject to be processed.

ProcessingObjectEventArgs constructor.

The IndirectObject to be processed. The ProcessingInfo containing related information.

Gets the IndirectObject to be processed.

Gets or sets an object which can be used to save data about the event.

Gets related information.

Provides data related to an Operation which has just been performed on an IndirectObject.

ProcessedObjectEventArgs constructor.

The IndirectObject processed. A value indicating whether the processing was successful.

Gets the IndirectObject which has just been processed.

Gets or sets an object which can be used to save data about the event.

Gets a value indicating whether the processing was successful.

Represents the method that handles the event of performing an Operation on an IndirectObject.

The source of the event. A ProcessingObjectEventArgs that contains the event data.

Represents the method that handles the event of performing an Operation on an IndirectObject.

The source of the event. A ProcessedObjectEventArgs that contains the event data.

An Operation to be performed on an IndirectObject.

Occurs before an IndirectObject is operated on. The EventArgs Tag property is passed to the ObjectProcessed event.

Occurs after an IndirectObject is operated on. The EventArgs Tag property is passed from the ObjectProcessing event.

Dispose of the Operation.

Dispose of the Operation.

Operation to recolor pages in a document.

RecolorOperation constructor.

Gets or sets a value indicating whether annotations are to be recolored.

Gets or sets the destination ColorSpace.

Recolors a document.

The Doc to be recolored.

Recolors a page.

The Page to be recolored.

Recolors the pages referenced by a Pages IndirectObject.

The Pages IndirectObject to be recolored

Replace transparent overlaps with opaque results of transparent object interactions.

FlattenTransOperation constructor.

Gets or sets a value indicating whether annotations are to be flattened.

The rasterized resolution in dots per inch.

Whether to anti-alias flattened rasterized text.

Whether to anti-alias flattened rasterized polygons.

Compositing ColorSpace (Gray (Grey), RGB, CMYK)

Log message with details on the previous Flattening operation

The alpha of the backdrop, range 0..1 (default 1)

The path to the default Gray ICC color profile.

The path to the default RGB ICC color profile.

The path to the default CMYK ICC color profile.

Flatten the transparency in a document.

The Doc to be flattened.

Flatten the transparency in a page.

The Page to be flattened.

Flattens the transparency in the pages referenced by a Pages IndirectObject.

The Pages IndirectObject to be flattened

The Application for XpsImportOperation.ImportAny.

The application determined by the file association in the Shell (Windows Explorer).

Microsoft Word.

Microsoft Excel.

Microsoft PowerPoint.

Microsoft InfoPath.

Microsoft OneNote.

Microsoft Publisher.

Microsoft Project.

Microsoft Visio.

Microsoft Outlook.

Operation to import pages in an XPS document.

XpsImportOperation constructor.

The password needed to read the source.

The application that prints the document to XPS when ImportAny is called.

The folder of the application for printing documents to XPS when using ImportAny.

Whether to enable macros when opening MS Office documents. This property is supported only for Word, Excel and Powerpoint.

The document number for ImportAny, e.g. the Excel Worksheet number.

XpsImportOperation destructor.

Dispose of the Operation.

Enable an application process to be reused so that it is terminated only manually or when this operation is disposed of.

The import application. Whether the application process is to be reused. Whether the reuse status of the application has been changed.

Whether an application is to be kept running and reused.

The import application. Whether the application process is to be kept running and reused.

Whether an application is running.

The import application. Whether the application is running.

Terminate a running application.

The import application. Whether the application has been running and killed.

Import an XPS document.

Import a document by converting it to XPS using the Microsoft XPS print driver.

The target PDF document. The file path to the source document.

Import a document by converting it to XPS using the Microsoft XPS print driver.

The target PDF document. The file path to the source document. The timeout in milliseconds for the XPS printer driver.

The application installation folder.

The import application. The installation folder of the application.

SWF action data type code.

The undefined type.

The null type.

SWF action value.

The undefined value.

The null value.

The type code.

Parameters for initializing the SWF machine.

The stage width in twips when the scale mode is NoScale.

The stage height in twips when the scale mode is NoScale.

The stage alignment.

The stage scale mode.

The Flash variables.

Operation to import frames in a Flash movie.

SwfImportOperation constructor.

Dispose of the Operation.

The target PDF Document.

The time-out for script execution.

The background region.

The clip region.

Whether to reset regions to frame bounds before importing a frame.

The content alignment.

The content scale mode.

The parameters for initializing the SWF machine.

Import frames in a Flash movie.

Import frames in a Flash movie.

Operation to render pages in a document.

RenderOperation constructor.

RenderOperation destructor.

Dispose of the Operation.

Renders the current page in the document.

The destination file path.

Renders the current page in the document.

A dummy file name used to determine the type of image. The destination stream.

Renders the current page in the document.

A dummy file name used to determine the type of image. The data containing the rendered page.

Renders the current page in the document.

The bitmap containing the rendered page.

The PDF conformance.

PDF conformance.

PDF/A Part 1 Level B conformance.

PDF/A Part 1 Level A conformance.

The PDF conformity.

No conformity.

Removes JavaScript actions.

The PDF conformance identification.

Conformance version identifier.

Conformance amendment identifier.

Conformance level.

The effective PdfConformance value.

Gets the conformance identification from a document.

Operation to validate PDF files.

Dispose of the Operation.

The target PDF Document.

The PDF conformance.

The validation errors.

The validation warnings.

Read and validate an existing document from file.

Read and validate an existing document from data.

Read and validate an existing document from stream.

Operation to produce conforming PDF files.

Dispose of the Operation.

The PDF conformance.

The PDF conformance.

The conformity errors.

The conformity messages.

Write the conforming document to a file.

The document. The destination file path.

Write the conforming document to a stream.

The document. The destination stream.

Get the conforming document as raw data.

The document. The PDF document as an array of bytes.

Get the conforming document as raw data stream.

The document. The PDF document as a stream.

Operation to reduce the size of a document.

ReduceSizeOperation constructor.

The PDF Document.

The pages to be operated upon.

Whether to unembed simple Latin based fonts where possible.

Whether to unembed complex Unicode based fonts where possible.

Whether to unembed embedded fonts that do not have an obvious substitute on the local machine.

Whether to unembed embedded fonts that appear to be corrupt or non-standard.

Whether to resize and recompress images where possible.

Whether to compress uncompressed streams where possible.

The target resolution for the resampling of color images.

The target compression type for the re-encoding of color images.

The target compression quality for the re-encoding of color images.

The target resolution for the resampling of grayscale images.

The target compression type for the re-encoding of grayscale images.

The target compression quality for the re-encoding of grayscale images.

The target resolution for the resampling of monochrome images.

The target compression type for the re-encoding of monochrome images.

The target compression quality for the re-encoding of monochrome images.

Compact and compress the document.

Whether to compact the entire document or only selected pages.

Operation to tag a document and make it accessible.

Default constructor.

The document.

The pages to be operated upon.

Tags the document for accessibility.

Operation to analyse the semantic structure of a document. In terms of visualization the GetHtml method is terribly useful to be able to see what kind of results have been obtained and how they are structured.

Default constructor.

The document.

The pages to be operated upon.

The text operation which will be used for page analysis.

The imgae operation which will be used for page analysis.

A line of text in a paragraph.

A collection of text lines forming a paragraph.

A block of text that can contain other blocks of text in either a columnar or blockular layout.

A class for representing a 'Do' draw image operation

A class for gathering up TextFragments that are actually all part of one DrawTextOperator. For example a DrawTextOperator might consist of the following: [(Yea) 10 (r) -9000 (Description) -9000 (Total)] TJ Because the three chunks of text are widely spaced the TextFragments associated with each one might not actually fall into the same line. Instead they might be grouped into columns. So column one might contain the two fragments making up "Year" and the other two text chunks might fall into separater lines. This class allows you to group these partial bits of a DrawTextOperator for later use. They fall into a kind of span so that consecutive operators can be held.

Base class for implementing a class that takes a content stream and processes it line by line. This is typically used for rewriting a content stream eg to prettify the format or to add comments.

A class for rewriting a content stream adding tags as you go along.

General purpose utilities for tagging.

An analog of XRect but done as a struct. Not only is this easier to use in terms of assignment but also it's faster (I estimate about three to five times). Perhaps some optimizations to XRect would be good for places where XRects are used standalone and we don't need to go back to unmanaged code.

Set the sides of the rectangle.

The new left position. The new bottom position. The new right position. The new top position.

Determine if this rectangle intersects with another.

Union the rectangle with another rectangle. This rectangle becomes the smallest rectangle that encloses both rectangles. Rectangles with no area are ignored.

The rectangle to add to this one. The supplied rectangle is left unchanged by this function.

Union the rectangle with another rectangle. This rectangle becomes the smallest rectangle that encloses both rectangles.

The rectangle to add to this one. The supplied rectangle is left unchanged by this function. Whether rectangles with no area should be ignored.

Determine if the rectangle encloses any area.

Object to hold the extracted content of a document.

PageContents constructor.

The document.

Whether to include annotation and field text in the output.

Whether to include color information in the output.

Whether to attempt to regenerate missing Unicode tables from embedded fonts.

Add and process all the pages in the document.

Add and process one particular page in the document.

The number of the page to be processed. This is a one based index.

Add and process a range of pages in the document.

The number of the first page to be processed. This is a one based index. The number of the last page to be processed. This is a one based index.

Operation to analyse and extract the text in a document.

TextOperation constructor.

The document.

The pages to be operated upon.

The minimum distance at which two text fragments will be assumed to be part of one undivided word. This value is specified in terms of a fraction of the font size.

The minimum distance at which two text fragments will be assumed to be part of separate tab groups. This value is specified in terms of a fraction of the font size.

The character used to separate out tab groups when GetText is called.

Whether to de-hyphenate words that appear to be split across two lines.

Whether to show text which is invisible because it is affected by a clip path.

Whether to get information on the BT and ET text object markers used to contain and group text operators.

A set of character to string substitutions used for translating typographic characters like ligatures into more normal text.

Get all the text in the page contents.

The text from the specified pages.

Get all the text in the page contents.

The area of interest from which text should be returned. The page from which text should be returned. This is a one based index. The text from the specified pages within the specified area of interest.

Get all the text in the page contents.

The areas of interest from which text should be returned. The pages from which text should be returned. These are one based indexes. The text from the specified pages within the specified areas of interest.

Select a range of text in the document.

The start index for the selection as related to the string returned by the GetText method. The length for the selection as related to the string returned by the GetText method. Returns a list of find matches encompassing the selected text.

Group a range of text fragments into a set of lines.

The fragments to be grouped. Returns a list of groups defining the lines.

A fragment of text as it appears in a document.

The ID of the Page on which this text fragment is located.

The Stream ID of the content stream in which this text fragment is located.

The offset within the content stream to the start of the drawing operation that contains this fragment.

The length within the content stream of the drawing operation that contains this fragment.

The zero based index of the drawing operator text array item that contains this fragment. For non text array operators this value is zero.

The text of the fragment. A fragment may span only a portion of the complete text drawing operator.

The text specified in the drawing operator or the text array item of the drawing operator.

The rectangle that contains the text of the fragment.

The angle of rotation of the fragment in degrees.

The font object used for drawing this text fragment.

The effective font size used for drawing this text fragment.

The color used for drawing this text fragment.

The skew angle of the font as used for oblique styles to simulate italic.

A group of text fragments that belong together.

The ID of the Page on which this group is located.

The rectangle that contains the group.

The text of the group.

The text fragments in the group.

Operation to analyse the placement of raster images (bitmaps) in a document.

ImageOperation constructor.

The document.

Whether to include all images in the analysis to allow the detection of orphans.

The pages to be operated upon.

Get the image information for all the raster images.

A collection of all the image properties.

A class that represents one raster image (bitmap) in a document.

The PixMap object associated with the image.

The set of renditions of the image at different locations within the document.

The resolution of the image in dots per inch.

The horizontal resolution of the image in dots per inch.

The vertical resolution of the image in dots per inch.

A class that represents one image placement in a document.

The ID of the Page on which the image is placed.

The ID of the Stream in which the image draw operation is contained.

The StreamObject in which the image draw operation is contained.

The offset within the uncompressed StreamObject to the start of the drawing operation that contains this image draw operation.

The length within the uncompressed StreamObject of the drawing operation that contains this image draw operation.

The transformation matrix for the placement of the image.

The bounding rectangle for the placement of the image. Note that images may be rotated or otherwise transformed. For this reason consider whether the Matrix property or the Focus method might be more appropriately used in place of the BoundingBox property.

The resolution of the image in dots per inch.

The horizontal resolution of the image in dots per inch.

The vertical resolution of the image in dots per inch.

Focus the document on the location of the image placement.

XColor Class.

XColor constructor.

Creates a deep copy of the current XColor.

XColor destructor.

Dispose of the XColor.

Dispose of the XColor.

A string representation of the color.

The string representation of the object.

A string representation of the color.

The red intensity of the color (0 to 255).

The green intensity of the color (0 to 255).

The blue intensity of the color (0 to 255).

The gray intensity of the color (0 to 255).

The cyan intensity of the color (0 to 100).

The magenta intensity of the color (0 to 100).

The yellow intensity of the color (0 to 100).

The black intensity of the color (0 to 100).

The alpha opacity of the color (0 to 255).

The native color space for the color.

The color as a System.Drawing.Color.

Set the color.

The source color.

Set the color to an opaque grayscale value.

The amount of black (0 to 255)

Set the color to a transparent grayscale value.

The amount of black (0 to 255) The level of opacity from transparent through to fully opaque (0 to 255)

Set the color to an opaque RGB value.

The amount of red (0 to 255) The amount of green (0 to 255) The amount of blue (0 to 255)

Set the color to a transparent RGB value.

The amount of red (0 to 255) The amount of green (0 to 255) The amount of blue (0 to 255) The level of opacity from transparent through to fully opaque (0 to 255)

Set the color to an opaque CMYK value.

The amount of cyan (0 to 100) The amount of magenta (0 to 100) The amount of yellow (0 to 100) The amount of black (0 to 100)

Set the color to a transparent CMYK value.

The amount of cyan (0 to 100) The amount of magenta (0 to 100) The amount of yellow (0 to 100) The amount of black (0 to 100) The level of opacity from transparent through to fully opaque (0 to 255)

Set the color to a random opaque value in the current color space.

Test whether the two colors are the same.

The XColor to test against. Whether the XColors are equal.

Test whether the two colors are the same.

The object to test against. Whether the objects are equal.

A hash code for the XColor.

The returned hash code.

Compares this instance of an XColor to another and returns an indication of their relative values.

A System.Object that evaluates to an XColor. A signed number indicating the relative value of this instance.

EncryptionMethodType Enumeration.

(Not supported.)

No encryption.

Uses the RC4 algorithm.

Uses the AES algorithm with 128-bit encryption keys.

Uses the AES algorithm with 256-bit encryption keys.

XEncryption class.

XEncryption destructor.

Dispose of the XEncryption.

Dispose of the XEncryption.

The level of encryption to use.

The crypt method for strings.

The crypt method for streams.

Sets the crypt methods.

The crypt method for strings and streams.

Sets the crypt methods.

The crypt method for strings. The crypt method for streams.

The user password.

The owner password.

Whether to encrypt the document metadata.

Whether a user can print the document.

Whether a user can modify the document.

Whether a user can copy from the document.

Whether a user can edit the document.

Whether a user can fill forms in the document.

Whether a user can extract detail from the document.

Whether a user can assemble the document.

Whether a user can print a high resolution copy of the document.

XFont Class.

FontWeight Enumeration.

Don't care.

Thin weight.

Extra-light weight.

Light weight.

Normal weight.

Medium weight.

Semi-bold weight.

Bold weight.

Extra-bold weight.

Heavy weight.

Find all the fonts currently installed on the system.

The set of matching fonts.

Find all fonts belonging to a particular family.

The name of the font family. The set of matching fonts.

Find the names of all font families.

The set of family names.

Find all fonts with a given name.

The name of the font. The set of matching fonts.

Find a font in a list, with a given style.

The list of fonts. The weight of the required font. (The midpoint of the weight range.) The maximum difference of the weight of the required font. (The radius of the weight range.) Whether an italic font is required. A matching font. Null if no matching font could be found.

Find a font from a specific family, with a given style.

The name of the font family. The weight of the required font. Whether an italic font is required. A matching font. Null if no matching font could be found.

Find a font from a specific family, with a given style.

The name of the font family. The weight of the required font. Whether an italic font is required. A matching font. Null if no matching font could be found.

Return text width in thousandths of a unit.

The text. The width of the text in 1000ths.

The complete set of names by which this font is known.

The weight of the font (which can be compared against the FontWeight enumeration).

Whether the font is in an italic style.

Whether the font is in a fixed pitch (rather than proportional) style.

Whether the font is in a script style.

Whether the font is in a serif style.

The complete, hopefully unique, human readable name of the font.

The name of the family to which the font belongs.

The name the font will be known by on a PostScript printer.

The baseline of the font in thousandths of a unit.

The character widths in thousandths of a unit for all the characters in the font.

Unloads a font so that it is no longer available.

XForm Class.

All top level fields in the form.

Whether values should be formatted before insertion into fields.

The format provider for formatting dates and times.

Whether field appearances should be pre-generated.

Whether the viewer should automatically regenerate field appearances.

The full names of all the fields in the document.

The names of all the eForm fields in the document.

Returns a particular field referenced by full name.

Stamp all fields into the document.

Refresh and reload the document fields.

Make fields unique across pages, duplicating fields if necessary.

Make fields unique across pages, duplicating fields if necessary.

The token to append to existing field names.

The condition of the state of thread or process.

No thread or process.

Idle threads or processes.

Threads or processes that are idle or when they become idle.

All threads or processes.

The content type of the embedded file.

No content.

SWF file.

The CSS media type to use.

Print media

Screen media

The conversion used for the values of HTML parameters.

No conversion.

Sets the value to the text content of the file pointed to by the value as a URL.

The method for loading URI/HTML.

Uses the default method.

Uses Moniker and treats input as HTML.

Uses the Navigate method of WebBrowser.

The module for obtaining URI/HTML data.

Uses the default module.

Uses the engine's module.

Uses System.Net.WebRequest.

Uses System.Net.WebRequest when access by the engine's module has been denied.

The request method for URL.

The GET request method.

The POST request method.

The engine to use for HTML parsing and layout.

Rendering engine used in Microsoft Internet Explorer.

Rendering engine used in Mozilla Firefox.

The HTML rendering conditions.

Never performs the action.

Always performs the action.

Performs the action when the default conditions are met.

Performs the action when some filter is disabled.

Performs the action when only partial content is available.

Performs the action when vector-output coercion has failed.

The page break logic for HTML.

Uses the cumulative cohesion of all objects occupying each horizontal line.

Uses the maximum cohesion among objects occupying each horizontal line.

Optimizes the break position globally around a candidate position.

Optimizes the break position locally around a candidate position.

No optimization.

The options for new worker processes.

Whether the process pool for the HTML Engine has started.

The number of existing processes for the HTML Engine.

Whether to load the user profile.

The maximum time for which a process can be idle before being terminated (ms).

The number of times a page should be retried if there is a problem with the process.

Start the process pool for the HTML Engine.

Whether the process pool is started anew.

The HTML parameter with conversion.

HtmlParameter constructor.

The source.

The parameter value.

The conversion for the value.

The information for an object embedded in HTML.

The URL of the embedded object.

The base URL for resolving relative URLs.

The content type of the embedded object.

Indicates whether parameter names are case-sensitive.

The parameters for the embedded object.

XHtmlOptions Class.

An object that provides access to only the HTML options supported by the MSHTML engine.

An object that provides access to only the HTML options supported by the Gecko HTML engine.

A helper filter to give only the HtmlOptions supported by the MSHTML engine.

A helper filter to give only the HtmlOptions supported by the Gecko engine.

The width of the virtual browser in pixels.

A user name to be used for authentication.

A password to be used for authentication.

Whether hyperlinks should be live.

Whether form fields should be live.

Whether movies and other active content should be live.

Whether the location of certain tags should be noted.

Whether hyperlinks with targets should be allowed to open in a new browser window.

Whether the values of form elements, except radio buttons, with the same name are distinct.

Whether font substitution should be used to reduce file size.

Whether fonts should be embedded rather than referenced.

Whether embedded fonts should be subset.

Whether fonts with restricted licensing should be protected from embedding.

The quality of compression acceptable for continuous tone images such as JPEGs.

The maximum amount of time allowed for obtaining a page (ms).

The minimum number of content items required for a page to be valid.

The number of times a page should be retried if unavailable or invalid.

Whether content should be rendered in multipaged format.

Whether to hide the background color of a page.

Additional HTTP headers to send in the request.

A script to be run after the page is loaded.

The request method for URL.

Whether to disable automatic cookies.

Whether to reload page.

The rendering engine to use for HTML conversion.

The CSS media to use.

The conditions under which to coerce a vector output.

The conditions under which to disable vector-output coercion.

Whether to host a WebBrowser control.

Whether to deactivate the WebBrowser.

The method for loading URI/HTML.

The module for obtaining URI/HTML data.

Whether to enable JavaScript and VBScript.

Whether to enable ActiveX.

Whether to enable Java.

Whether to enable Video.

Whether to resynchronize page.

Whether any proxy servers should re-request items of content.

Whether to use theme.

Whether not to use theme.

Whether the page cache should be searched first.

The length of time that pages can be held in the cache (ms).

The number of pages that can be held in the cache.

The maximum size at which an image may be regarded as atomic.

Whether HTML pages are marked up before conversion to PDF.

Whether to automatically clip redundant content at the end of the page.

The minimum width to be used for auto-sized pages.

The percentage of the current drawing area in which HTML breaks can occur.

The page break logic for HTML.

The options for new worker processes.

The delegate called during HTML rendering.

The delegate called when embedding an object during HTML rendering.

Sets whether to use theme or not.

Whether to use theme or not.

Sets whether to use theme or not.

Whether to use theme. Whether not to use theme.

Clear all items from the page cache.

Clear all expired items from the page cache.

Convert external links to internal links wherever possible.

Convert external links to internal links.

Specifies both linkIDs and destIDs. The number of links converted.

Convert external links to internal links.

The list of IDs of view objects containing links (anchor tags with href attributes). The list of IDs of view objects containing destinations (anchor tags with name attributes). Whether links pointing to the URLs of HTML pages (URLs without fragments) are converted to internal links. The number of links converted.

Gets an array of the HTML IDs of tagged visible items.

The Object ID of the object. The IDs of tagged visible HTML objects.

Gets an array of the locations of tagged visible items.

The Object ID of the object. The location of tagged visible HTML objects.

Gets an array of the locations of tagged visible items before Doc.Transform is applied.

The Object ID of the object. The location (before Doc.Transform is applied) of tagged visible HTML objects.

Retrieves the HTTP status code.

The Object ID of the web page to be accessed. The HTTP status code or zero if not available.

Retrieves the client side onload script return value.

The Object ID of the web page to be accessed. The return value.

Ends any HTML Engine worker threads or processes.

The way in which to select threads or processes that should be ended. The number of selected threads or processes.

A helper filter to give only the HtmlOptions supported by Gecko HTML engine.

Whether hyperlinks should be live.

Whether movies and other active content should be live.

Whether form fields should be live.

Whether the location of certain tags should be noted.

Whether the values of form elements, except radio buttons, with the same name are distinct.

Whether font substitution should be used to reduce file size.

Whether fonts should be embedded rather than referenced.

Whether embedded fonts should be subset.

Whether fonts with restricted licensing should be protected from embedding.

The quality of compression acceptable for continuous tone images such as JPEGs.

The maximum amount of time allowed for obtaining a page (ms).

A user name to be used for authentication.

A password to be used for authentication.

The minimum width to be used for auto-sized pages.

The number of times a page should be retried if unavailable or invalid.

A script to be run after the page is loaded.

The request method for URL.

Whether to enable JavaScript and VBScript.

The CSS media to use.

Gets an array of the HTML IDs of tagged visible items.

The Object ID of the object. The IDs of tagged visible HTML objects.

Gets an array of the locations of tagged visible items.

The Object ID of the object. The location of tagged visible HTML objects.

A helper filter to give only the HtmlOptions supported by Internet Explorer HTML engine.

The width of the virtual browser in pixels.

A user name to be used for authentication.

A password to be used for authentication.

Whether hyperlinks should be live.

Whether form fields should be live.

Whether movies and other active content should be live.

Whether the location of certain tags should be noted.

Whether hyperlinks with targets should be allowed to open in a new browser window.

Whether the values of form elements, except radio buttons, with the same name are distinct.

Whether font substitution should be used to reduce file size.

Whether fonts should be embedded rather than referenced.

Whether embedded fonts should be subset.

Whether fonts with restricted licensing should be protected from embedding.

The quality of compression acceptable for continuous tone images such as JPEGs.

The maximum amount of time allowed for obtaining a page (ms).

The minimum number of content items required for a page to be valid.

The number of times a page should be retried if unavailable or invalid.

Whether content should be rendered in multipaged format.

Whether to hide the background color of a page.

Additional HTTP headers to send in the request.

A script to be run after the page is loaded.

The request method for URL.

Whether to disable automatic cookies.

The conditions under which to coerce a vector output.

The conditions under which to disable vector-output coercion.

Whether to host a WebBrowser control.

Whether to deactivate the WebBrowser.

Whether to enable JavaScript and VBScript.

Whether to enable ActiveX.

Whether to enable Java.

Whether to enable Video.

Whether to resynchronize page.

Whether any proxy servers should re-request items of content.

Whether the page cache should be searched first.

The length of time that pages can be held in the cache (ms).

The number of pages that can be held in the cache.

The maximum size at which an image may be regarded as atomic.

Whether HTML pages are marked up before conversion to PDF.

Whether to automatically clip redundant content at the end of the page.

The minimum width to be used for auto-sized pages.

The percentage of the current drawing area in which HTML breaks can occur.

The page break logic for HTML.

The delegate called during HTML rendering.

The delegate called when embedding an object during HTML rendering.

Clear all items from the page cache.

Clear all expired items from the page cache.

Convert external links to internal links wherever possible.

Convert external links to internal links.

Specifies both linkIDs and destIDs. The number of links converted.

Convert external links to internal links.

The list of IDs of view objects containing links (anchor tags with href attributes). The list of IDs of view objects containing destinations (anchor tags with name attributes). Whether links pointing to the URLs of HTML pages (URLs without fragments) are converted to internal links. The default value is false. The number of links converted.

Gets an array of the HTML IDs of tagged visible items.

The Object ID of the object. The IDs of tagged visible HTML objects.

Gets an array of the locations of tagged visible items.

The Object ID of the object. The location of tagged visible HTML objects.

Gets an array of the locations of tagged visible items before Doc.Transform is applied.

The Object ID of the object. The location (before Doc.Transform is applied) of tagged visible HTML objects.

Retrieves the HTTP status code.

The Object ID of the web page to be accessed. The HTTP status code or zero if not available.

Retrieves the client side onload script return value.

The Object ID of the web page to be accessed. The return value.

The collection of HTML parameter names and values.

The collection of parameter names in a HtmlParameterDictionary.

Initializes a new instance that reflects the keys in the specified HtmlParameterDictionary.

The HtmlParameterDictionary whose keys are reflected.

Gets the number of elements contained.

Copies the HtmlParameterDictionary.KeyCollection elements to an existing one-dimensional Array, starting at the specified array index.

The one-dimensional Array that is the destination of the elements copied. The zero-based index in array at which copying begins.

Enumerates the elements of a HtmlParameterDictionary.KeyCollection.

Releases all resources used by the HtmlParameterDictionary.KeyCollection.Enumerator.

Gets the element at the current position of the enumerator.

Advances the enumerator to the next element of the HtmlParameterDictionary.KeyCollection.

true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection.

Returns an enumerator that iterates through the HtmlParameterDictionary.KeyCollection.

A HtmlParameterDictionary.KeyCollection.Enumerator.

The collection of parameter values in a HtmlParameterDictionary.

Initializes a new instance that reflects the values in the specified HtmlParameterDictionary.

The HtmlParameterDictionary whose values are reflected.

Gets the number of elements contained.

Copies the HtmlParameterDictionary.ValueCollection elements to an existing one-dimensional Array, starting at the specified array index.

The one-dimensional Array that is the destination of the elements copied. The zero-based index in array at which copying begins.

Enumerates the elements of a HtmlParameterDictionary.ValueCollection.

Releases all resources used by the HtmlParameterDictionary.ValueCollection.Enumerator.

Gets the element at the current position of the enumerator.

Advances the enumerator to the next element of the HtmlParameterDictionary.ValueCollection.

true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection.

Returns an enumerator that iterates through the HtmlParameterDictionary.ValueCollection.

A HtmlParameterDictionary.ValueCollection.Enumerator.

Initializes a new empty instance that has the default initial capacity, and uses the default equality comparer for the key type.

Initializes a new empty instance that has the specified initial capacity, and uses the default equality comparer for the key type.

The initial number of elements that the HtmlParameterDictionary can contain.

Initializes a new empty instance that has the default initial capacity, and uses the specified IEqualityComparer.

The IEqualityComparer implementation to use when comparing keys, or null to use the default EqualityComparer for the type of the key.

Initializes a new empty instance that has the specified initial capacity, and uses the specified IEqualityComparer.

The initial number of elements that the HtmlParameterDictionary can contain. The IEqualityComparer implementation to use when comparing keys, or null to use the default EqualityComparer for the type of the key.

Initializes a new instance that contains elements copied from the specified IDictionary and uses the default equality comparer for the key type.

The IDictionary whose elements are copied.

Initializes a new instance that contains elements copied from the specified IDictionary and uses the specified IEqualityComparer.

The IDictionary whose elements are copied. The IEqualityComparer implementation to use when comparing keys, or null to use the default EqualityComparer for the type of the key.

Gets the IEqualityComparer that is used to determine equality of keys for the dictionary.

Gets a collection containing the keys.

Gets a collection containing the values.

Determines whether the HtmlParameterDictionary contains a specific value.

The value to locate. true if the HtmlParameterDictionary contains an element with the specified value; otherwise, false.

Gets or sets the value associated with the specified key.

The key of the value to get or set. The value associated with the specified key. If the specified key is not found, a get operation throws a KeyNotFoundException, and a set operation creates a new element with the specified key.

Determines whether the HtmlParameterDictionary contains the specified key.

The key to locate. true if the HtmlParameterDictionary contains an element with the specified key; otherwise, false.

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 value parameter. true if the HtmlParameterDictionary contains an element with the specified key; otherwise, false.

Adds the specified key and value to the dictionary.

The key of the element to add. The value of the element to add.

Removes the value with the specified key.

The key of the element to remove. true if the element is successfully found and removed; otherwise, false. This method returns false if key is not found.

Gets the number of key/value pairs contained.

Removes all keys and values.

Enumerates the elements of a HtmlParameterDictionary.

Releases all resources used by the HtmlParameterDictionary.Enumerator.

Gets the element at the current position of the enumerator.

Advances the enumerator to the next element of the HtmlParameterDictionary.

true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection.

Returns an enumerator that iterates through the HtmlParameterDictionary.

A HtmlParameterDictionary.Enumerator structure.

A helper filter to give only the HtmlOptions supported by Gecko HTML engine.

Gets the version of the Gecko engine.

The version of the Gecko engine.

Whether hyperlinks should be live.

Whether movies and other active content should be live.

Whether form fields should be live.

Whether the location of certain tags should be noted.

Whether the values of form elements, except radio buttons, with the same name are distinct.

Whether font substitution should be used to reduce file size.

Whether fonts should be embedded rather than referenced.

Whether embedded fonts should be subset.

Whether fonts with restricted licensing should be protected from embedding.

The quality of compression acceptable for continuous tone images such as JPEGs.

The maximum amount of time allowed for obtaining a page (ms).

A user name to be used for authentication.

A password to be used for authentication.

The minimum width to be used for auto-sized pages.

The number of times a page should be retried if unavailable or invalid.

A script to be run after the page is loaded.

The request method for URL.

Whether to enable JavaScript and VBScript.

The CSS media to use.

The options for new worker processes.

Gets an array of the HTML IDs of tagged visible items.

The Object ID of the object. The IDs of tagged visible HTML objects.

Gets an array of the locations of tagged visible items.

The Object ID of the object. The location of tagged visible HTML objects.

Ends any HTML Engine worker threads or processes.

The way in which to select threads or processes that should be ended. The number of selected threads or processes.

A helper filter to give only the HtmlOptions supported by Internet Explorer HTML engine.

The width of the virtual browser in pixels.

A user name to be used for authentication.

A password to be used for authentication.

Whether hyperlinks should be live.

Whether form fields should be live.

Whether movies and other active content should be live.

Whether the location of certain tags should be noted.

Whether hyperlinks with targets should be allowed to open in a new browser window.

Whether the values of form elements, except radio buttons, with the same name are distinct.

Whether font substitution should be used to reduce file size.

Whether fonts should be embedded rather than referenced.

Whether embedded fonts should be subset.

Whether fonts with restricted licensing should be protected from embedding.

The quality of compression acceptable for continuous tone images such as JPEGs.

The maximum amount of time allowed for obtaining a page (ms).

The minimum number of content items required for a page to be valid.

The number of times a page should be retried if unavailable or invalid.

Whether content should be rendered in multipaged format.

Whether to hide the background color of a page.

Additional HTTP headers to send in the request.

A script to be run after the page is loaded.

The request method for URL.

Whether to disable automatic cookies.

Whether to reload page.

The conditions under which to coerce a vector output.

The conditions under which to disable vector-output coercion.

Whether to host a WebBrowser control.

Whether to deactivate the WebBrowser.

The method for loading URI/HTML.

The module for obtaining URI/HTML data.

Whether to enable JavaScript and VBScript.

Whether to enable ActiveX.

Whether to enable Java.

Whether to enable Video.

Whether to resynchronize page.

Whether any proxy servers should re-request items of content.

Whether to use theme.

Whether not to use theme.

Whether the page cache should be searched first.

The length of time that pages can be held in the cache (ms).

The number of pages that can be held in the cache.

The maximum size at which an image may be regarded as atomic.

Whether HTML pages are marked up before conversion to PDF.

Whether to automatically clip redundant content at the end of the page.

The minimum width to be used for auto-sized pages.

The percentage of the current drawing area in which HTML breaks can occur.

The page break logic for HTML.

The options for new worker processes.

The delegate called during HTML rendering.

The delegate called when embedding an object during HTML rendering.

Sets whether to use theme or not.

Whether to use theme or not.

Sets whether to use theme or not.

Whether to use theme. Whether not to use theme.

Clear all items from the page cache.

Clear all expired items from the page cache.

Convert external links to internal links wherever possible.

Convert external links to internal links.

Specifies both linkIDs and destIDs. The number of links converted.

Convert external links to internal links.

The list of IDs of view objects containing links (anchor tags with href attributes). The list of IDs of view objects containing destinations (anchor tags with name attributes). Whether links pointing to the URLs of HTML pages (URLs without fragments) are converted to internal links. The default value is false. The number of links converted.

Gets an array of the HTML IDs of tagged visible items.

The Object ID of the object. The IDs of tagged visible HTML objects.

Gets an array of the locations of tagged visible items.

The Object ID of the object. The location of tagged visible HTML objects.

Gets an array of the locations of tagged visible items before Doc.Transform is applied.

The Object ID of the object. The location (before Doc.Transform is applied) of tagged visible HTML objects.

Retrieves the HTTP status code.

The Object ID of the web page to be accessed. The HTTP status code or zero if not available.

Retrieves the client side onload script return value.

The Object ID of the web page to be accessed. The return value.

Image class.

Image constructor.

XPoint destructor.

Dispose of the XImage.

Dispose of the XImage.

The XReadOptions used to create the object. The Stream used to create the object if NeedsStream is true.

Dispose of the XImage.

Load an image from a file.

The path to the graphic file. The settings for the read. The resulting IndirectObject.

Load an image from data.

The data containing the graphic. The settings for the read. The resulting IndirectObject.

Load an image from a stream.

The stream containing the graphic. The settings for the read. The resulting IndirectObject.

Load an image from a file.

The path to the graphic file.

Load an image from data.

The data containing the graphic.

Load an image from a stream.

The stream containing the graphic.

Assign a soft mask to the image.

The image containing the soft mask. Whether to invert the mask.

The type of image.

The number of frames in the image.

The default frame rate for a moving image.

The currently selected frame.

The width of the current frame (pixels).

The height of the current frame (pixels).

Whether the image specifies the resolution.

The horizontal resolution of the current frame (DPI).

The vertical resolution of the current frame (DPI).

The current selection rectangle.

The physical bounds of the image in points.

Whether the image can be added indirect.

Whether the file needs to exist.

Whether the stream needs be kept open.

Clears the image freeing up resources.

Clears the image freeing up resources.

The XReadOptions used to create the object. The Stream used to create the object if NeedsStream is true.

XPoint class.

XPoint constructor.

XPoint constructor.

A string defining the initial point in the format "x y".

XPoint constructor.

Creates a deep copy of the current XPoint.

XPoint destructor.

Dispose of the XPoint.

Dispose of the XPoint.

A string representation of the point.

The string representation of the object.

A string representation of the point.

The horizontal offset of the point from the bottom left.

The vertical offset of the point from the bottom left.

The point as a System.Drawing Point.

Set the point.

The source point.

Test whether two points are the same.

The XPoint to test against. Whether the two XPoints are equal.

Test whether the two points are the same.

The object to test against. Whether the objects are equal.

A hash code for the XPoint.

The returned hash code.

Compares this instance of an XPoint to another and returns an indication of their relative values.

A System.Object that evaluates to an XPoint. A signed number indicating the relative value of this instance.

The module used for read operations.

A default set of modules.

The SWF vector module.

The XPS module.

The XPS module with the XPS printer driver.

The OpenOffice.org PDF conversion.

The PDF read module.

The SVG vector import module.

The EPS vector import module.

The base raster image import module.

Microsoft Office import module.

WordGlue import module.

Bookmark creation strategy.

Use module-specific default settings.

Do not import any bookmarks from source documents.

Use document headings as bookmarks.

Content items to process.

Use module-specific default settings.

Import only main content.

Import main content and mark-up.

The error-handling option for read operations.

Produces output until an error is encountered.

No output is produced when an error is encountered.

Settings for read operations.

XReadOptions constructor.

Dispose of the XReadOptions.

The module to use.

Bookmark creation strategy.

Content items to process.

The error-handling option.

The password needed to read the source.

The file extension when the source is specified not with a path or a file name.

The import warning and information log.

Indicates whether the transparency of raster images should be preserved.

The timeout for external components.

Whether to enable macros when opening MS Office documents. This property is supported only for Word, Excel and Powerpoint.

Whether the values of form elements with the same name are distinct.

The Operation to use.

The frame to be read from a multiple frame image such as a movie.

Whether form fields should be live.

OpenOffice.org PDF conversion control parameters.

The default document size for documents that do not specify a size.

The font to use for text that does not specify a font.

Perform extra checks when reading, for importing non-compliant PDF documents.

Skip back a number of revisions when reading an incrementally saved PDF document.

Clear cached data and terminate worker threads and worker processes for a read module.

Whether it has taken an action.

Test whether two XReadOptions are the same.

The XReadOption to test against. Whether the two XReadOption are equal.

Test whether the two read options are the same.

The object to test against. Whether the objects are equal.

A hash code for the XReadOption.

The returned hash code.

Creates a deep copy of the current XReadOptions.

XRect class.

Corner Enumeration.

Bottom Left Corner.

Top Left Corner.

Bottom Right Corner.

Top Right Corner.

Create an XRect from the coordinates of two diagonally opposite corners.

The minimum x coordinate. The minimum y coordinate. The maximum x coordinate. The maximum y coordinate. The newly created XRect object.

Create an XRect from a bottom left corner, a width and a height.

The left coordinate. The bottom coordinate. The width of the rectangle. The height of the rectangle. The newly created XRect object.

Create an XRect from a top left corner, a width and a height.

The left coordinate. The top coordinate. The width of the rectangle. The height of the rectangle. The newly created XRect object.

Create the smallest XRect that encloses all the XPoints supplied. If no points or null is supplied then the return value is null.

XRect constructor. To construct an XRect with initial values use one of the static constructors such as XRect.FromSides, XRect.FromLbwh or XRect.FromPoints.

XRect constructor using a string initializer.

A string defining the initial rectangle in the format "left bottom right top".

Creates a deep copy of the current XRect.

XRect destructor.

Dispose of the XPoint.

Dispose of the XPoint.

A string representation of the rectangle.

The string representation of the object.

A string representation of the rectangle.

The offset of the top edge from the bottom left.

The offset of the left edge from the bottom left.

The offset of the bottom edge from the bottom left.

The offset of the right edge from the bottom left.

The width of the rectangle.

The height of the rectangle.

Translate the rectangle up and right.

The horizontal distance to move the rectangle. The vertical distance to move the rectangle.

Scale the rectangle, pinning the bottom left corner.

The horizontal scale factor. The vertical scale factor.

Move the rectangle, preserving width and height.

The new left position. The new bottom position.

Move the specified corner of the rectangle to a position, preserving width and height.

The new left position. The new bottom position. The corner to position.

Inset the rectangle horizontally and vertically.

The amount to inset the left and right edges. The amount to inset the top and bottom edges.

Get the four corners of the rectangle from the bottom left going clockwise.

The rectangle as a System.Drawing Rectangle.

The corner of the rectangle to pin.

Resize the rectangle preserving position.

The new width. The new height.

Resize the rectangle preserving the position of the specified corner.

The new width. The new height. The corner to pin.

Set the position and size of the rectangle.

The new left position. The new bottom position. The new width. The new height.

Set the position and size of the rectangle.

The source rectangle.

Set the sides of the rectangle.

The new left position. The new bottom position. The new right position. The new top position.

Intersect this rectangle with another rectangle.

The other rectangle to intersect with.

Determine if this rectangle intersects with another.

Union the rectangle with another rectangle. This rectangle becomes the smallest rectangle that encloses both rectangles. Rectangles with no area are ignored.

The rectangle to add to this one. The supplied rectangle is left unchanged by this function.

Union the rectangle with another rectangle. This rectangle becomes the smallest rectangle that encloses both rectangles.

The rectangle to add to this one. The supplied rectangle is left unchanged by this function. Whether rectangles with no area should be ignored.

Determine if the rectangle encloses any area.

Determine if the rectangle contains a point.

Determine if the rectangle contains a point.

Determine if the rectangle contains a point.

Determine if the rectangle contains a point.

Determine if the rectangle contains a point.

Determine if this rectangle fully contains another rectangle.

Test whether two rects are the same.

The XRect to test against. Whether the two XRects are equal.

Test whether the two rects are the same.

The object to test against. Whether the objects are equal.

A hash code for the XRect.

The returned hash code.

Compares this instance of an XRect to another and returns an indication of their relative values.

A System.Object that evaluates to an XRect. A signed number indicating the relative value of this instance.

Fit the rectangle as content inside another rectangle.

Content alignment.

Center.

Left.

Right.

Top.

Bottom.

Content scale mode.

Make the content the biggest and completely within the area while keeping the aspect ratio.

Make the content the smallest and covering the entire area while keeping the aspect ratio.

Scale the content possibly with distortion to fit the entire area.

No scaling.

XRendering Class.

Rendering Compression Enumeration.

Uncompressed

G3 Black and White Fax Compression

G4 Black and White Fax Compression

LZW Compression

JPEG Compression

Adobe Flate Compression

Flate Compression

Macintosh PackBits

Rendering Colorspace Enumeration.

Red, green and blue

Grayscale

Cyan, magenta, yellow and black

Lab - a device independent color space

Indexed RGB - see the PaletteSize property

The output resolution in dots per inch.

The horizontal output resolution in dots per inch.

The vertical output resolution in dots per inch.

The output colorspace.

The output bits per color channel.

The number of colors in the palette for indexed color output.

Whether to anti-alias text.

Whether to anti-alias polygons.

Whether to anti-alias images.

Whether to apply entire scene anti-aliasing.

Whether to save the alpha channel.

Whether to resize images for vector (emf, ps, etc.) output.

The output file quality factor for lossy compression (0 to 100).

The type of compression to prefer when saving.

The minimum stroked line width for output.

Whether to append to (rather than overwrite) existing image files.

The path to the default Gray ICC color profile.

The path to the default RGB ICC color profile.

The path to the default CMYK ICC color profile.

The path to the default CMYK ICC color profile.

Whether to apply overprint.

Whether to render fields and annotations.

The named separation.

Halftone type and options.

Whether to use embedded halftones.

Whether pages should be automatically rotated.

Number of strips to generate when writing a tiff file.

The log for the last render.

A collection of TIFF tags that should be written to the output file.

Renders and saves the current area of the current page as data.

A dummy file name used to determine the type of image required. The image as an array of bytes.

Renders and saves the current area of the current page to a Bitmap.

The Bitmap containing the image.

Renders and saves the current area of the current page as a file.

The destination file path.

Renders and saves the current area of the current page to a stream.

A dummy file name used to determine the type of image required. The destination stream.

XSaveOptions Class.

Whether to reduce size by remapping objects.

Whether to linearize the output for fast web viewing.

Whether to use incremental update to preserve the validity of signature fields.

Whether to update the file version identifier.

Whether to assign a constant file version identifier.

Whether to assign non-ASCII file identifiers.

The file extension when the target is specified not with a path or a file name.

The path to the template file.

The template data.

The folder where to save additional files (images, fonts, etc).

The XPS output quality for lossy compression (0 to 100).

Specify the type of graphic paths.

Use a sensible default type for the exporter.

Do not embed graphics in the final output.

Render graphics using images, valid for MS Word and HTML exporters.

Render graphics via VML, valid for MS Word exporter.

Render graphics via HTML 5 Canvas, valid for HTML exporter.

How to implement paths, valid values depend on exporter format.

//@HTML and MS Word Exporters only, throw on invalid format

The font substitution type.

Use a sensible default font substituion type.

Always substitute fonts with those installed on the machine.

Only substitute fonts which are missing or could not be converted to open type.

The font substitution type.

//@HTML and MS Word Exporters only

Raster Smoothing.

Specifies the default algorithm.

Specifies no anti-aliasing.

Specifies anti-aliasing.

XSaveTemplateData Class.

The template that specifies one page per frame.

XSaveTemplateData constructor.

The horizontal measurement resolution.

The vertical measurement resolution.

The smoothing for displaying images.

The JPEG quality level.

Whether JPEG images are re-encoded in JPEG.

Sets the measurement resolutions.

The new measurement resolution in DPI.

Sets the measurement resolutions.

The new horizontal measurement resolution in DPI. The new vertical measurement resolution in DPI.

LicenseType Enumeration.

Unknown or undefined.

Trial license with professional feature set.

Standard feature set.

Professional feature set.

XSettings Class.

The current license for the software.

The current feature level for the software.

The current license for the software.

The current licensee for the software.

Whether to log errors in the Application Event Log.

The software version.

Register and install trial license.

A trial license key used for remote deployment.

Install a license. Return true if license is valid.

The license to install. True if a license is installed, otherwise false.

Install a redistribution license. Return true if license is valid.

The license to install. True if a license is installed, otherwise false.

Install a trial license.

The license to install. True if a license is installed, otherwise false.

Install a system license. Return true if license is installed.

The license to install. True if a license is installed, otherwise false.

Set the application configuration section.

The ABCpdf configuration section.

Whether the current license is valid in this particular process.

XTextStyle class.

XTextStyle constructor.

XTextStyle destructor.

Dispose of the XTextStyle.

Dispose of the XTextStyle.

A string representation of the style.

The string representation of the object.

A string representation of the style.

The text size (points).

The first line of paragraph indent (points).

The inter-character spacing (points).

The inter-word spacing (points).

The inter-line spacing (points).

The inter-paragraph spacing (points).

The distance between the line spacing below the top of the text frame and the first baseline (1000ths of em).

The horizontal justification factor (0 to 1).

Whether to apply an underline.

Whether to apply a strikethrough.

Whether to apply a double strikethrough.

The width of outline to use.

Whether to synthesize and apply an italic style.

Whether to synthesize and apply a bold style.

Whether to preserve white space characters for plain text.

The paragraph indent (points).

XTransform class.

AngleUnitType Enumeration.

Degrees.

Radians.

XTransform constructor.

Matrix entry 1,1. Matrix entry 1,2. Matrix entry 2,1. Matrix entry 2,2. The x translation to be applied. The y translation to be applied.

XTransform constructor.

An array of doubles specifying the values for the matrix. These are in the order m11, m12, m21, m22, tx and ty.

XTransform constructor.

A string defining the initial transform in the format returned by the String property.

XTransform constructor.

XTransform constructor.

XTransform constructor.

Creates a deep copy of the current XTransform.

XTransform destructor.

Dispose of the XTransform.

Dispose of the XTransform.

A string representation of the transform.

The string representation of the object.

A string representation of the transform.

The x translation.

The y translation.

Reset to the identity.

Invert the transform.

Translate horizontally and vertically.

The distance to translate to the right. The distance to translate upwards.

Rotate about a locked anchor point (angle according to AngleUnit property).

The angle to rotate in degrees. The horizontal coordinate about which the rotation should be applied. The vertical coordinate about which the rotation should be applied.

Scale about a locked anchor point.

The amount of horizontal scaling to apply. The amount of vertical scaling to apply. The horizontal coordinate about which the stretch should be applied. The vertical coordinate about which the stretch should be applied.

Skew horizontally and vertically about a locked anchor point.

The amount of horizontal skewing to apply. The amount of vertical skewing to apply. The horizontal coordinate about which the stretch should be applied. The vertical coordinate about which the stretch should be applied.

Set the transform.

The new horizontal scale. The new vertical skew. The new horizontal skew. The new vertical scale. The new horizontal translation. The new vertical translation.

Set the transform.

The source transform.

Pre-multiplies this tranformation matrix by the supplied transform, by prepending the specified transform matrix.

The transform to be prepended.

Multiplies this tranformation matrix by the supplied transform, by appending the specified transform matrix.

The transform to be appended.

Determines if two transforms are effectively the same.

The transform to be compared against this one. The largest difference in values which will still be defined as equal.

Applies this transform to a specified array of points.

The array of points to be transformed.

Applies this transform to a specified array of points.

The array of points to be transformed.

Applies this transform to a specified array of points.

The array of points to be transformed.

Applies this transform to a specified point.

The point to be transformed.

Applies this transform to a specified point.

The point to be transformed.

Applies this transform to a specified point.

The point to be transformed.

Applies this transform to a specified point.

The point to be transformed.

The transform as an array of floating-point values.

The transform as a System.Drawing Matrix.

The transform as a System.Windows.Media Matrix.

The angle units, degrees or radians.

Test whether two transforms are the same.

The XTransform to test against. Whether the two XTransform are equal.

Test whether the two transforms are the same.

The object to test against. Whether the objects are equal.

A hash code for the XTransform.

The returned hash code.

Compares this instance of an XTransform to another and returns an indication of their relative values.

A System.Object that evaluates to an XTransform. A signed number indicating the relative value of this instance.