PDFExplorer Class

Properties   Methods   Events   Config Settings   Errors  

The PDFExplorer class provides access to the low-level PDF document structure.

Syntax

class securepdf.PDFExplorer

Remarks

The PDFExplorer class can be used to inspect the internals of a PDF document and make changes to the low-level document structure.

Object Types and Document Structure

The PDF specification defines eight object types:

• Name
• String
• Real
• Integer
• Boolean
• Array
• Dictionary
• Stream

In PDFExplorer, name, string, real, integer, and boolean objects are categorized as "primitive" objects, and array, dictionary, and stream objects are categorized as "container" objects.

Before accessing individual objects with the class, it is important to understand how they are structured in the document. PDFExplorer aims to distinguish between the logical and physical representations of objects.

The logical representation is that a PDF document is a tree of objects that can be traversed to extract data. For example, every document contains a document catalog that references a next-level object /Pages, which in turn references individual pages via a /Kids array. So to get a page, you would first look for the /Root object in the document trailer, then proceed to its /Pages element, and then work with the /Kids array.

Then, there is the physical structure that consists of all the objects that constitute the document. Every object is recorded as either:

• A direct (in-place) object (e.g., /Numbers [1 2 3 888]),
• An indirect (numbered) object, or
• A reference to an indirect object (e.g., /Numbers 8 0 R).

The way the objects are physically stored is generally independent from their logical structure. If you are looking for a page, it is of little importance whether each object that you need to traverse to reach it is stored in-place, in one of the indirect objects, or in a compressed object stream.

Note that most heavy objects (such as streams and dictionaries) are recorded in PDF files as indirect objects, with other objects referencing them. An indirect object is a global object that is uniquely identified by its object number followed by its generation number (e.g., 1 0 obj).

Navigating the Document

To navigate the object tree, first provide the input document as a file (input_file), byte array (input_data), or stream (set_input_stream) and call the open method. This method will populate the root_objects properties with the existing objects in the document trailer, as the trailer is considered to be the root of the logical object tree. The keys in the document trailer will typically be /Size, /Info, /Root, /ID, and /Encrypt for encrypted documents.

These objects can then be used as a starting point for the document tree navigation, which is done using the select method. This method and others operate the following syntax for specifying objects in the document:

• Slashes separate levels of hierarchy, like in file paths.
• The "root" slash (/) points to the document trailer dictionary.
• A path that does not start with a slash specifies an indirect object in the list of global numbered objects.
• The asterisk character (*) specifies all objects at the provided path.

Examples:

Consider the following PDF document:

%PDF-1.4
%cmmt
1 0 obj
<< /Type /Catalog
/Pages 2 0 R
>>
endobj

2 0 obj
<< /Type /Pages
/Kids [ 3 0 R ]
/Count 1
>>
endobj

3 0 obj
<< /Type /Page
/Parent 2 0 R
/MediaBox [ 0  0  612  792 ]
/Resources << /ProcSet 4 0 R >>
>>
endobj

4 0 obj
[ /PDF ]
endobj

xref
0 5
0000000000 65535 f
0000000015 00000 n
0000000065 00000 n
0000000125 00000 n
0000000234 00000 n
trailer
<< /Size 5
/Root 1 0 R
>>
startxref
259
%%EOF

select would return the following results for the respective paths:

• / - a dictionary object that corresponds to the trailer dictionary.
• /Root - a dictionary object that corresponds to the dictionary at 1 0 obj, with its property set to Reference (as this is a reference to an indirect object).
• /Size - an integer object whose is 5 and is Direct (as this is a direct, in-place object).
• /Root/Type - a name object whose is Catalog ( = Direct).
• /Root/Pages - a dictionary object that corresponds to the dictionary at 2 0 obj ( = Reference).
• /Root/Pages/Kids - an array object ( = Direct).
• /Root/Pages/Kids[0] - a dictionary object that corresponds to the dictionary at 3 0 obj ( = Reference).
• /Root/Pages/Kids[0]/MediaBox - an array object with four integer elements ( = Direct).
• /Root/Pages/Kids[0]/MediaBox[2] - an integer object whose is 612 ( = Direct).
• 3 0 obj - a dictionary object that corresponds to the dictionary at 3 0 obj ( = Indirect).
• 3 0 obj/Type - a name object whose is Page ( = Direct).
• 3 0 obj/Parent - a dictionary object that corresponds to the dictionary at 2 0 obj ( = Reference).

Once select returns, the selected object(s) will be available in the selected_objects properties.

Adding and Modifying Objects

The below sections contain instructions for adding and modifying each type of object. Note that each of the following Add* methods returns the path of the newly added object in the document, making it easy to access the PDFObject object later using the select method. These objects' values can then be adjusted to ensure the PDF document meets your requirements.

Primitive Objects

A primitive object is a non-container object that represents a name, string, real (double), integer, or boolean value. Primitive objects are typically stored in-place and referenced directly. Use the add_primitive method to add a direct primitive object and the add_object method (with the Indirect parameter set to True) to add an indirect primitive object: // Adding a direct string object to the /Info dictionary string stringPath = pdfexplorer.AddPrimitive("/Info", "Creator", "Microsoft Word"); // Adding an indirect boolean object to the root string booleanPath = pdfexplorer.AddObject("", 5, "", "true", true);

5 0 obj
<<
...
/Creator (Microsoft Word)
>>
endobj

...

6 0 obj
true
endobj

The value of a primitive object can then be modified if desired: pdfexplorer.Select(stringPath, true); pdfexplorer.SelectedObjects[0].Value = "nsoftware.SecurePDF"; pdfexplorer.Select(booleanPath, true); pdfexplorer.SelectedObjects[0].Value = "false";

5 0 obj
<<
...
/Creator (nsoftware.SecurePDF)
>>
endobj

...

6 0 obj
false
endobj

Array and Dictionary Objects

Unlike primitives, arrays and dictionaries are objects that contain other objects. Elements within array objects are arranged sequentially and have implicit zero-based indices, whereas dictionary objects contain named key-value pairs that are unordered. Use the add_container method to add a direct or indirect array or dictionary object: // Adding a direct array object to the first page's /Page dictionary string arrayPath = pdfexplorer.AddContainer("/Root/Pages/Kids[0]", "CropBox", false, false); // Adding an indirect dictionary object to the root string dictPath = pdfexplorer.AddContainer("", "", true, true);

3 0 obj
<< /Type /Page
...
/CropBox [
]>>
endobj

...

7 0 obj
<<
>>
endobj

An array or dictionary object can then be modified by adding elements to it. The example below populates the /CropBox array with four integer objects and adds a /Type key to the newly created dictionary. string cropBox0Path = pdfexplorer.AddPrimitive(arrayPath, "", "0"); string cropBox1Path = pdfexplorer.AddPrimitive(arrayPath, "", "0"); string cropBox2Path = pdfexplorer.AddPrimitive(arrayPath, "", "612"); string cropBox3Path = pdfexplorer.AddPrimitive(arrayPath, "", "792"); string typePath = pdfexplorer.AddPrimitive(dictPath, "Type", "/SampleType");

3 0 obj
<< /Type /Page
...
/CropBox [
0
0
612
792
]>>
endobj

...

7 0 obj
<<
/Type /SampleType
>>
endobj

Stream Objects

A stream object is a compound object consisting of a dictionary and a sequence of bytes. Stream objects are always indirect and are used to store data such as images, fonts, and other resources. Use the add_stream method to add a stream object: // Adding a stream object to the root byte[] image1Data = File.ReadAllBytes("image1.png"); string streamPath = pdfexplorer.AddStream("", "", image1Data);

8 0 obj
<<
/Length 6317
>>stream
... % binary data for image1.png
endstream
endobj

To modify a stream object, use the set_object_data or set_object_stream method: byte[] image2Data = File.ReadAllBytes("image2.png"); pdfexplorer.SetObjectData(streamPath, image2Data); // or pdfexplorer.SetObjectStream(streamPath, new MemoryStream(image2Data));

8 0 obj
<<
/Length 197
>>stream
... % binary data for image2.png
endstream
endobj

Object References

An (indirect) object reference is a reference to an indirect object from another object. Its syntax consists of the destination object's object number, its generation number, and R (e.g., 1 0 R). Use the add_reference method to add a reference to an existing object: // Creating a reference to the stream at 8 0 obj and adding it to the dictionary at 7 0 obj string path = pdfexplorer.AddReference("7 0 obj", "Image", "8 0 obj");

7 0 obj
<<
/Image 8 0 R
/Type /SampleType
>>
endobj

The contents of the destination object can be modified using the path returned by add_reference in the same way as any other indirect object - the reference will remain intact because the object and generation numbers of the destination object will not be affected.

Removing Objects

The remove_object method can be used to remove an object from the document. While this method will invalidate the former path of the object itself, if it was an indirect object any references to it will not be removed. pdfexplorer.RemoveObject("7 0 obj/Image");

7 0 obj
<<
/Type /SampleType
>>
endobj

When finished adding, modifying, or removing objects, call the close method to close the document and save the changes to either output_file, output_data, or the stream set in set_output_stream.

Property List

---

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

Method List

---

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

Event List

---

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

Config Settings

---

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

input_data property

A byte array containing the PDF document to process.

Syntax

def get_input_data() -> bytes: ...
def set_input_data(value: bytes) -> None: ...

input_data = property(get_input_data, set_input_data)

Remarks

This property is used to assign a byte array containing the PDF document to be processed.

input_file property

The PDF file to process.

Syntax

def get_input_file() -> str: ...
def set_input_file(value: str) -> None: ...

input_file = property(get_input_file, set_input_file)

Default Value

""

Remarks

This property is used to provide a path to the PDF document to be processed.

output_data property

A byte array containing the PDF document after processing.

Syntax

def get_output_data() -> bytes: ...

output_data = property(get_output_data, None)

Remarks

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

This property is read-only.

output_file property

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

Syntax

def get_output_file() -> str: ...
def set_output_file(value: str) -> None: ...

output_file = property(get_output_file, set_output_file)

Default Value

""

Remarks

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

overwrite property

Whether or not the class should overwrite files.

Syntax

def get_overwrite() -> bool: ...
def set_overwrite(value: bool) -> None: ...

overwrite = property(get_overwrite, set_overwrite)

Default Value

FALSE

Remarks

This property indicates whether or not the class will overwrite output_file, output_data, or the stream set in set_output_stream. If set to False, an error will be thrown whenever output_file, output_data, or the stream set in set_output_stream exists before an operation.

root_object_count property

The number of records in the RootObject arrays.

Syntax

def get_root_object_count() -> int: ...

root_object_count = property(get_root_object_count, None)

Default Value

0

Remarks

This property controls the size of the following arrays:

• root_object_container
• root_object_disposition
• root_object_element_count
• root_object_gen_number
• root_object_keys
• root_object_object_number
• root_object_object_type
• root_object_offset
• root_object_path
• root_object_size
• root_object_value

The array indices start at 0 and end at root_object_count - 1.

This property is read-only.

root_object_container property

Whether the object is a container for other objects (i.

Syntax

def get_root_object_container(root_object_index: int) -> bool: ...

Default Value

FALSE

Remarks

Whether the object is a container for other objects (i.e., a dictionary, array, or stream).

The root_object_index parameter specifies the index of the item in the array. The size of the array is controlled by the root_object_count property.

This property is read-only.

root_object_disposition property

The method by which the object is addressed in the document.

Syntax

def get_root_object_disposition(root_object_index: int) -> int: ...

Default Value

0

Remarks

The method by which the object is addressed in the document.

Possible values are:

Example:

5 0 obj
<<
  /KeyM (Electricity)
>>

...

<<
  /KeyA (Some Value)
  /KeyB << /X /Y >>
  /KeyC 5 0 R
>>

• The value of /KeyA (Some Value) is a direct string object.
• The value of /X (/Y) is a direct name object.
• The value of /KeyB is a direct dictionary object.
• The value of /KeyC is a reference to the indirect dictionary object 5 0 obj.
• The value of 5 0 obj is an indirect dictionary object.

The root_object_index parameter specifies the index of the item in the array. The size of the array is controlled by the root_object_count property.

This property is read-only.

root_object_element_count property

The number of sub-elements in the object, such as keys in the dictionary or elements in the array.

Syntax

def get_root_object_element_count(root_object_index: int) -> int: ...

Default Value

0

Remarks

The number of sub-elements in the object, such as keys in the dictionary or elements in the array.

The root_object_index parameter specifies the index of the item in the array. The size of the array is controlled by the root_object_count property.

This property is read-only.

root_object_gen_number property

The generation number of the indirect (top-level) object.

Syntax

def get_root_object_gen_number(root_object_index: int) -> int: ...

Default Value

0

Remarks

The generation number of the indirect (top-level) object.

The root_object_index parameter specifies the index of the item in the array. The size of the array is controlled by the root_object_count property.

This property is read-only.

root_object_keys property

A CRLF-separated list of the keys of the dictionary or indices of the array.

Syntax

def get_root_object_keys(root_object_index: int) -> str: ...

Default Value

""

Remarks

A CRLF-separated list of the keys of the dictionary or indices of the array.

The root_object_index parameter specifies the index of the item in the array. The size of the array is controlled by the root_object_count property.

This property is read-only.

root_object_object_number property

The object number of the indirect (top-level) object.

Syntax

def get_root_object_object_number(root_object_index: int) -> int: ...

Default Value

0

Remarks

The object number of the indirect (top-level) object.

The root_object_index parameter specifies the index of the item in the array. The size of the array is controlled by the root_object_count property.

This property is read-only.

root_object_object_type property

The type of the object.

Syntax

def get_root_object_object_type(root_object_index: int) -> int: ...

Default Value

0

Remarks

The type of the object.

Possible values are:

The root_object_index parameter specifies the index of the item in the array. The size of the array is controlled by the root_object_count property.

This property is read-only.

root_object_offset property

The start offset of the object, in bytes, from the beginning of the PDF document.

Syntax

def get_root_object_offset(root_object_index: int) -> int: ...

Default Value

0

Remarks

The start offset of the object, in bytes, from the beginning of the PDF document.

The root_object_index parameter specifies the index of the item in the array. The size of the array is controlled by the root_object_count property.

This property is read-only.

root_object_path property

The path to the object, for example /Root/Pages .

Syntax

def get_root_object_path(root_object_index: int) -> str: ...

Default Value

""

Remarks

The path to the object, for example /Root/Pages.

The root_object_index parameter specifies the index of the item in the array. The size of the array is controlled by the root_object_count property.

This property is read-only.

root_object_size property

The physical length of the object in bytes.

Syntax

def get_root_object_size(root_object_index: int) -> int: ...

Default Value

0

Remarks

The physical length of the object in bytes.

The root_object_index parameter specifies the index of the item in the array. The size of the array is controlled by the root_object_count property.

This property is read-only.

root_object_value property

The value of the object.

Syntax

def get_root_object_value(root_object_index: int) -> str: ...
def set_root_object_value(root_object_index: int, value: str) -> None: ...

Default Value

""

Remarks

The value of the object.

NOTE: This property only applies to primitive objects (strings, names, integers, reals, and booleans). To access and modify contents of complex objects such as streams, use the get_object_data and set_object_data methods.

The root_object_index parameter specifies the index of the item in the array. The size of the array is controlled by the root_object_count property.

selected_object_count property

The number of records in the SelectedObject arrays.

Syntax

def get_selected_object_count() -> int: ...

selected_object_count = property(get_selected_object_count, None)

Default Value

0

Remarks

This property controls the size of the following arrays:

• selected_object_container
• selected_object_disposition
• selected_object_element_count
• selected_object_gen_number
• selected_object_keys
• selected_object_object_number
• selected_object_object_type
• selected_object_offset
• selected_object_path
• selected_object_size
• selected_object_value

The array indices start at 0 and end at selected_object_count - 1.

This property is read-only.

selected_object_container property

Whether the object is a container for other objects (i.

Syntax

def get_selected_object_container(selected_object_index: int) -> bool: ...

Default Value

FALSE

Remarks

Whether the object is a container for other objects (i.e., a dictionary, array, or stream).

The selected_object_index parameter specifies the index of the item in the array. The size of the array is controlled by the selected_object_count property.

This property is read-only.

selected_object_disposition property

The method by which the object is addressed in the document.

Syntax

def get_selected_object_disposition(selected_object_index: int) -> int: ...

Default Value

0

Remarks

The method by which the object is addressed in the document.

Possible values are:

Example:

5 0 obj
<<
  /KeyM (Electricity)
>>

...

<<
  /KeyA (Some Value)
  /KeyB << /X /Y >>
  /KeyC 5 0 R
>>

• The value of /KeyA (Some Value) is a direct string object.
• The value of /X (/Y) is a direct name object.
• The value of /KeyB is a direct dictionary object.
• The value of /KeyC is a reference to the indirect dictionary object 5 0 obj.
• The value of 5 0 obj is an indirect dictionary object.

The selected_object_index parameter specifies the index of the item in the array. The size of the array is controlled by the selected_object_count property.

This property is read-only.

selected_object_element_count property

The number of sub-elements in the object, such as keys in the dictionary or elements in the array.

Syntax

def get_selected_object_element_count(selected_object_index: int) -> int: ...

Default Value

0

Remarks

The number of sub-elements in the object, such as keys in the dictionary or elements in the array.

The selected_object_index parameter specifies the index of the item in the array. The size of the array is controlled by the selected_object_count property.

This property is read-only.

selected_object_gen_number property

The generation number of the indirect (top-level) object.

Syntax

def get_selected_object_gen_number(selected_object_index: int) -> int: ...

Default Value

0

Remarks

The generation number of the indirect (top-level) object.

The selected_object_index parameter specifies the index of the item in the array. The size of the array is controlled by the selected_object_count property.

This property is read-only.

selected_object_keys property

A CRLF-separated list of the keys of the dictionary or indices of the array.

Syntax

def get_selected_object_keys(selected_object_index: int) -> str: ...

Default Value

""

Remarks

A CRLF-separated list of the keys of the dictionary or indices of the array.

The selected_object_index parameter specifies the index of the item in the array. The size of the array is controlled by the selected_object_count property.

This property is read-only.

selected_object_object_number property

The object number of the indirect (top-level) object.

Syntax

def get_selected_object_object_number(selected_object_index: int) -> int: ...

Default Value

0

Remarks

The object number of the indirect (top-level) object.

The selected_object_index parameter specifies the index of the item in the array. The size of the array is controlled by the selected_object_count property.

This property is read-only.

selected_object_object_type property

The type of the object.

Syntax

def get_selected_object_object_type(selected_object_index: int) -> int: ...

Default Value

0

Remarks

The type of the object.

Possible values are:

The selected_object_index parameter specifies the index of the item in the array. The size of the array is controlled by the selected_object_count property.

This property is read-only.

selected_object_offset property

The start offset of the object, in bytes, from the beginning of the PDF document.

Syntax

def get_selected_object_offset(selected_object_index: int) -> int: ...

Default Value

0

Remarks

The start offset of the object, in bytes, from the beginning of the PDF document.

The selected_object_index parameter specifies the index of the item in the array. The size of the array is controlled by the selected_object_count property.

This property is read-only.

selected_object_path property

The path to the object, for example /Root/Pages .

Syntax

def get_selected_object_path(selected_object_index: int) -> str: ...

Default Value

""

Remarks

The path to the object, for example /Root/Pages.

The selected_object_index parameter specifies the index of the item in the array. The size of the array is controlled by the selected_object_count property.

This property is read-only.

selected_object_size property

The physical length of the object in bytes.

Syntax

def get_selected_object_size(selected_object_index: int) -> int: ...

Default Value

0

Remarks

The physical length of the object in bytes.

The selected_object_index parameter specifies the index of the item in the array. The size of the array is controlled by the selected_object_count property.

This property is read-only.

selected_object_value property

The value of the object.

Syntax

def get_selected_object_value(selected_object_index: int) -> str: ...
def set_selected_object_value(selected_object_index: int, value: str) -> None: ...

Default Value

""

Remarks

The value of the object.

NOTE: This property only applies to primitive objects (strings, names, integers, reals, and booleans). To access and modify contents of complex objects such as streams, use the get_object_data and set_object_data methods.

The selected_object_index parameter specifies the index of the item in the array. The size of the array is controlled by the selected_object_count property.

add_container method

Adds a dictionary or array object to the document.

Syntax

def add_container(base_path: str, object_name: str, dictionary: bool, indirect: bool) -> str: ...

Remarks

This method is used to add a new dictionary or array object to the document at BasePath. If adding to an existing dictionary, set ObjectName to the key that the new object will be added or referenced under.

The Dictionary parameter specifies whether to create a dictionary object.

The Indirect parameter specifies whether to add the dictionary or array to the indirect (numbered) object list and reference it from BasePath instead of creating an in-place object.

This method returns the path of the new object in the document.

Please see Navigating the Document for more details about object paths.

add_object method

Inserts an object into the document.

Syntax

def add_object(base_path: str, object_type: int, object_name: str, value: str, indirect: bool) -> str: ...

Remarks

This method is used to add a new object with value Value to the document at BasePath. If adding to an existing dictionary, set ObjectName to the key that the new object will be added or referenced under.

The ObjectType parameter specifies the type of the object and can be one of the following values:

• 1 (Name)
• 2 (String)
• 3 (Real)
• 4 (Integer)
• 5 (Boolean)
• 6 (Array)
• 7 (Dictionary)
• 8 (Stream)

The Indirect parameter specifies whether to add the object to the indirect (numbered) object list and reference it from BasePath instead of creating an in-place object.

NOTE: This method can be particularly useful to add a primitive object (name, string, real, integer, or boolean) to the list of indirect (numbered) objects.

This method returns the path of the new object in the document.

Please see Navigating the Document for more details about object paths.

add_opaque method

Adds an opaque piece of PDF to the document.

Syntax

def add_opaque(base_path: str, object_name: str, value: str) -> str: ...

Remarks

This method is used to add an uninterpreted string of PDF objects with value Value to the document at BasePath. If adding to an existing dictionary, set ObjectName to the key that the new object will be added under.

Example: pdfexplorer.InputFile = "input.pdf"; pdfexplorer.OutputFile = "modified.pdf"; pdfexplorer.Open(); string value = "<< /Producer (Secure PDF)\r\n" + "/CreationDate (D:20250725102001Z00'00')\r\n" + "/ModDate (D:20250725102001Z00'00')\r\n" + "/Author (Edvard Grieg)\r\n" + "/Title (In the Hall of the Mountain King)\r\n" + ">>"; string path = pdfexplorer.AddOpaque("/", "Info", value); pdfexplorer.Close(); This method returns the path of the new object in the document.

Please see Navigating the Document for more details about object paths.

add_primitive method

Adds a primitive object to the document.

Syntax

def add_primitive(base_path: str, object_name: str, value: str) -> str: ...

Remarks

This method is used to add a new name, string, real (double), integer, or boolean object with value Value to the document at BasePath. If adding to an existing dictionary, set ObjectName to the key that the new object will be added under.

The class will automatically determine the type of the object based on the Value parameter.

Examples: pdfexplorer.InputFile = "input.pdf"; pdfexplorer.OutputFile = "modified.pdf"; pdfexplorer.Open(); // Adding a name object to the dictionary at 3 0 obj string namePath = pdfexplorer.AddPrimitive("3 0 obj", "Type", "/Font"); // Adding a string object to the dictionary at 1 0 obj string stringPath = pdfexplorer.AddPrimitive("1 0 obj", "Name", "John Doe"); // Adding a real object to an array string realPath = pdfexplorer.AddPrimitive("5 0 obj/Rect", "", "100.5"); // Adding an integer object to an array string integerPath = pdfexplorer.AddPrimitive("/Root/Pages/Kids[0]/MediaBox", "", "792"); // Adding a boolean object to a dictionary string booleanPath = pdfexplorer.AddPrimitive("/Root/AcroForm", "NeedAppearances", "true"); pdfexplorer.Close(); This method returns the path of the new object in the document.

Please see Navigating the Document for more details about object paths.

add_reference method

Adds an object reference to the document.

Syntax

def add_reference(base_path: str, object_name: str, ref_path: str) -> str: ...

Remarks

This method is used to create a new reference to an existing object, such as a page dictionary, at BasePath. If adding to an existing dictionary, set ObjectName to the key that the new reference will be added under.

The RefPath parameter specifies the destination object and must point to one of the indirect (numbered) objects.

This method returns the path of the new object in the document.

Please see Navigating the Document for more details about object paths.

add_stream method

Adds a stream object to the document.

Syntax

def add_stream(base_path: str, object_name: str, value: bytes) -> str: ...

Remarks

This method is used to create a new stream object with value Value at BasePath. If adding to an existing dictionary, set ObjectName to the key that the new stream will be referenced under.

NOTE: Stream objects are always indirect (i.e., part of the numbered object list).

This method returns the path of the new object in the document.

Please see Navigating the Document for more details about object paths.

close method

Closes the opened document.

Syntax

def close() -> None: ...

Remarks

This method is used to close the previously opened document. It should always be preceded by a call to the open method.

Example: component.InputFile = "input.pdf"; component.Open(); // Some operation component.Close(); If any changes are made to the document, they will be saved automatically to output_file, output_data, or the stream set in set_output_stream when this method is called. To configure this saving behavior, set the SaveChanges configuration setting.

config method

Sets or retrieves a configuration setting.

Syntax

def config(configuration_string: str) -> str: ...

Remarks

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

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

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

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

create_new method

Creates a new PDF document.

Syntax

def create_new() -> None: ...

Remarks

This method is used to create a blank PDF document with one empty page. Having created the baseline document, use the class's methods (such as add_stream) to add objects to it.

get_object_data method

Returns the content of a stream object.

Syntax

def get_object_data(path: str) -> bytes: ...

Remarks

This method is used to retrieve the content of the PDF stream object at Path.

Please see Navigating the Document for more details about object paths.

open method

Opens the document for processing.

Syntax

def open() -> None: ...

Remarks

This method is used to open the document specified in input_file, input_data, or set_input_stream before performing some operation on it, such as accessing or modifying individual PDF objects. When finished, call close to complete or discard the operation.

It is recommended to use this method (alongside close) when performing multiple operations on the document at once.

NOTE: This method will populate the root_objects properties with the keys found in the document trailer dictionary.

remove_object method

Removes an object from the document.

Syntax

def remove_object(path: str) -> None: ...

Remarks

This method is used to remove the object at Path from the document.

Note the following peculiarities of the PDF format:

• Certain objects ("indirect objects") are global, numbered objects that can be referenced from other objects in the document. To remove an indirect object, all the references to it must be removed first, followed by the object itself.
• Indirect objects may have more than one reference. Removing such an object may inadvertently invalidate other references in the document.

Please see Navigating the Document for more details about object paths.

reset method

Resets the class.

Syntax

def reset() -> None: ...

Remarks

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

select method

Selects an object or multiple objects from the document.

Syntax

def select(filter: str, clear_existing_selection: bool) -> None: ...

Remarks

This method is used to select objects from the document using an XPath-like language. Upon completion of this method, objects with paths matching the Filter parameter will be populated in the selected_objects properties.

The ClearExistingSelection parameter specifies whether selected_objects will be cleared before performing the select operation.

NOTE: Since streams are compound objects consisting of a dictionary and data, when selecting a stream object this method will select its dictionary. Use the get_object_data or get_object_stream methods to extract the content of stream objects.

Please see Navigating the Document for more details about object paths.

set_object_data method

Sets the content of a stream object.

Syntax

def set_object_data(path: str, value: bytes) -> None: ...

Remarks

This method is used to set the content of the PDF stream object at Path. The Value parameter specifies the data of the stream.

Please see Navigating the Document for more details about object paths.

on_error event

Fired when information is available about errors during data delivery.

Syntax

class PDFExplorerErrorEventParams(object):
  @property
  def error_code() -> int: ...

  @property
  def description() -> str: ...

# In class PDFExplorer:
@property
def on_error() -> Callable[[PDFExplorerErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[PDFExplorerErrorEventParams], None]) -> None: ...

Remarks

The on_error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

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

on_log event

Fired once for each log message.

Syntax

class PDFExplorerLogEventParams(object):
  @property
  def log_level() -> int: ...

  @property
  def message() -> str: ...

  @property
  def log_type() -> str: ...

# In class PDFExplorer:
@property
def on_log() -> Callable[[PDFExplorerLogEventParams], None]: ...
@on_log.setter
def on_log(event_hook: Callable[[PDFExplorerLogEventParams], None]) -> None: ...

Remarks

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

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

The Message parameter is the log message.

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

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

PDFExplorer Config Settings

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

PDFExplorer Config Settings

Base Config Settings

PDFExplorer Errors

PDFExplorer Errors

PDF Errors

Parsing Errors