PDFExplorer Component

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

TispPDFExplorer

Remarks

The PDFExplorer component 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 component, 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 (InputFile), byte array (InputData), or stream (SetInputStream) and call the Open method. This method will populate the RootObjects 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 SelectedObjects 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 AddPrimitive method to add a direct primitive object and the AddObject 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 AddContainer 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 AddStream 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 SetObjectData or SetObjectStream 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 AddReference 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 AddReference 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 RemoveObject 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 OutputFile, OutputData, or the stream set in SetOutputStream.

Property List

---

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

Method List

---

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

Event List

---

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

Config Settings

---

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

InputData Property (PDFExplorer Component)

A byte array containing the PDF document to process.

Syntax

__property DynamicArray InputData = { read=FInputData, write=FSetInputData };

Remarks

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

This property is not available at design time.

Data Type

Byte Array

InputFile Property (PDFExplorer Component)

The PDF file to process.

Syntax

__property String InputFile = { read=FInputFile, write=FSetInputFile };

Default Value

""

Remarks

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

Data Type

String

OutputData Property (PDFExplorer Component)

A byte array containing the PDF document after processing.

Syntax

__property DynamicArray OutputData = { read=FOutputData };

Remarks

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

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

Data Type

Byte Array

OutputFile Property (PDFExplorer Component)

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

Syntax

__property String OutputFile = { read=FOutputFile, write=FSetOutputFile };

Default Value

""

Remarks

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

Data Type

String

Overwrite Property (PDFExplorer Component)

Whether or not the component should overwrite files.

Syntax

__property bool Overwrite = { read=FOverwrite, write=FSetOverwrite };

Default Value

false

Remarks

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

Data Type

Boolean

RootObjectCount Property (PDFExplorer Component)

The number of records in the RootObject arrays.

Syntax

__property int RootObjectCount = { read=FRootObjectCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• RootObjectContainer
• RootObjectDisposition
• RootObjectElementCount
• RootObjectGenNumber
• RootObjectKeys
• RootObjectObjectNumber
• RootObjectObjectType
• RootObjectOffset
• RootObjectPath
• RootObjectSize
• RootObjectValue

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

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

Data Type

Integer

RootObjectContainer Property (PDFExplorer Component)

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

Syntax

__property bool RootObjectContainer[int RootObjectIndex] = { read=FRootObjectContainer };

Default Value

false

Remarks

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

The RootObjectIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RootObjectCount property.

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

Data Type

Boolean

RootObjectDisposition Property (PDFExplorer Component)

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

Syntax

__property int RootObjectDisposition[int RootObjectIndex] = { read=FRootObjectDisposition };

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 RootObjectIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RootObjectCount property.

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

Data Type

Integer

RootObjectElementCount Property (PDFExplorer Component)

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

Syntax

__property int RootObjectElementCount[int RootObjectIndex] = { read=FRootObjectElementCount };

Default Value

0

Remarks

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

The RootObjectIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RootObjectCount property.

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

Data Type

Integer

RootObjectGenNumber Property (PDFExplorer Component)

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

Syntax

__property int RootObjectGenNumber[int RootObjectIndex] = { read=FRootObjectGenNumber };

Default Value

0

Remarks

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

The RootObjectIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RootObjectCount property.

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

Data Type

Integer

RootObjectKeys Property (PDFExplorer Component)

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

Syntax

__property String RootObjectKeys[int RootObjectIndex] = { read=FRootObjectKeys };

Default Value

""

Remarks

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

The RootObjectIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RootObjectCount property.

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

Data Type

String

RootObjectObjectNumber Property (PDFExplorer Component)

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

Syntax

__property int RootObjectObjectNumber[int RootObjectIndex] = { read=FRootObjectObjectNumber };

Default Value

0

Remarks

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

The RootObjectIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RootObjectCount property.

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

Data Type

Integer

RootObjectObjectType Property (PDFExplorer Component)

The type of the object.

Syntax

__property int RootObjectObjectType[int RootObjectIndex] = { read=FRootObjectObjectType };

Default Value

0

Remarks

The type of the object.

Possible values are:

The RootObjectIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RootObjectCount property.

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

Data Type

Integer

RootObjectOffset Property (PDFExplorer Component)

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

Syntax

__property __int64 RootObjectOffset[int RootObjectIndex] = { read=FRootObjectOffset };

Default Value

0

Remarks

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

The RootObjectIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RootObjectCount property.

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

Data Type

Long64

RootObjectPath Property (PDFExplorer Component)

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

Syntax

__property String RootObjectPath[int RootObjectIndex] = { read=FRootObjectPath };

Default Value

""

Remarks

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

The RootObjectIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RootObjectCount property.

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

Data Type

String

RootObjectSize Property (PDFExplorer Component)

The physical length of the object in bytes.

Syntax

__property __int64 RootObjectSize[int RootObjectIndex] = { read=FRootObjectSize };

Default Value

0

Remarks

The physical length of the object in bytes.

The RootObjectIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RootObjectCount property.

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

Data Type

Long64

RootObjectValue Property (PDFExplorer Component)

The value of the object.

Syntax

__property String RootObjectValue[int RootObjectIndex] = { read=FRootObjectValue, write=FSetRootObjectValue };

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 GetObjectData and SetObjectData methods.

The RootObjectIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RootObjectCount property.

This property is not available at design time.

Data Type

String

SelectedObjectCount Property (PDFExplorer Component)

The number of records in the SelectedObject arrays.

Syntax

__property int SelectedObjectCount = { read=FSelectedObjectCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• SelectedObjectContainer
• SelectedObjectDisposition
• SelectedObjectElementCount
• SelectedObjectGenNumber
• SelectedObjectKeys
• SelectedObjectObjectNumber
• SelectedObjectObjectType
• SelectedObjectOffset
• SelectedObjectPath
• SelectedObjectSize
• SelectedObjectValue

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

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

Data Type

Integer

SelectedObjectContainer Property (PDFExplorer Component)

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

Syntax

__property bool SelectedObjectContainer[int SelectedObjectIndex] = { read=FSelectedObjectContainer };

Default Value

false

Remarks

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

The SelectedObjectIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedObjectCount property.

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

Data Type

Boolean

SelectedObjectDisposition Property (PDFExplorer Component)

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

Syntax

__property int SelectedObjectDisposition[int SelectedObjectIndex] = { read=FSelectedObjectDisposition };

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 SelectedObjectIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedObjectCount property.

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

Data Type

Integer

SelectedObjectElementCount Property (PDFExplorer Component)

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

Syntax

__property int SelectedObjectElementCount[int SelectedObjectIndex] = { read=FSelectedObjectElementCount };

Default Value

0

Remarks

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

The SelectedObjectIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedObjectCount property.

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

Data Type

Integer

SelectedObjectGenNumber Property (PDFExplorer Component)

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

Syntax

__property int SelectedObjectGenNumber[int SelectedObjectIndex] = { read=FSelectedObjectGenNumber };

Default Value

0

Remarks

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

The SelectedObjectIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedObjectCount property.

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

Data Type

Integer

SelectedObjectKeys Property (PDFExplorer Component)

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

Syntax

__property String SelectedObjectKeys[int SelectedObjectIndex] = { read=FSelectedObjectKeys };

Default Value

""

Remarks

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

The SelectedObjectIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedObjectCount property.

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

Data Type

String

SelectedObjectObjectNumber Property (PDFExplorer Component)

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

Syntax

__property int SelectedObjectObjectNumber[int SelectedObjectIndex] = { read=FSelectedObjectObjectNumber };

Default Value

0

Remarks

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

The SelectedObjectIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedObjectCount property.

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

Data Type

Integer

SelectedObjectObjectType Property (PDFExplorer Component)

The type of the object.

Syntax

__property int SelectedObjectObjectType[int SelectedObjectIndex] = { read=FSelectedObjectObjectType };

Default Value

0

Remarks

The type of the object.

Possible values are:

The SelectedObjectIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedObjectCount property.

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

Data Type

Integer

SelectedObjectOffset Property (PDFExplorer Component)

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

Syntax

__property __int64 SelectedObjectOffset[int SelectedObjectIndex] = { read=FSelectedObjectOffset };

Default Value

0

Remarks

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

The SelectedObjectIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedObjectCount property.

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

Data Type

Long64

SelectedObjectPath Property (PDFExplorer Component)

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

Syntax

__property String SelectedObjectPath[int SelectedObjectIndex] = { read=FSelectedObjectPath };

Default Value

""

Remarks

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

The SelectedObjectIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedObjectCount property.

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

Data Type

String

SelectedObjectSize Property (PDFExplorer Component)

The physical length of the object in bytes.

Syntax

__property __int64 SelectedObjectSize[int SelectedObjectIndex] = { read=FSelectedObjectSize };

Default Value

0

Remarks

The physical length of the object in bytes.

The SelectedObjectIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedObjectCount property.

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

Data Type

Long64

SelectedObjectValue Property (PDFExplorer Component)

The value of the object.

Syntax

__property String SelectedObjectValue[int SelectedObjectIndex] = { read=FSelectedObjectValue, write=FSetSelectedObjectValue };

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 GetObjectData and SetObjectData methods.

The SelectedObjectIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedObjectCount property.

This property is not available at design time.

Data Type

String

AddContainer Method (PDFExplorer Component)

Adds a dictionary or array object to the document.

Syntax

String __fastcall AddContainer(String BasePath, String ObjectName, bool Dictionary, bool Indirect);

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.

AddObject Method (PDFExplorer Component)

Inserts an object into the document.

Syntax

String __fastcall AddObject(String BasePath, int ObjectType, String ObjectName, String Value, bool Indirect);

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.

AddOpaque Method (PDFExplorer Component)

Adds an opaque piece of PDF to the document.

Syntax

String __fastcall AddOpaque(String BasePath, String ObjectName, String Value);

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.

AddPrimitive Method (PDFExplorer Component)

Adds a primitive object to the document.

Syntax

String __fastcall AddPrimitive(String BasePath, String ObjectName, String Value);

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

AddReference Method (PDFExplorer Component)

Adds an object reference to the document.

Syntax

String __fastcall AddReference(String BasePath, String ObjectName, String RefPath);

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.

AddStream Method (PDFExplorer Component)

Adds a stream object to the document.

Syntax

String __fastcall AddStream(String BasePath, String ObjectName, DynamicArray<Byte> Value);

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

Closes the opened document.

Syntax

void __fastcall Close();

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 OutputFile, OutputData, or the stream set in SetOutputStream when this method is called. To configure this saving behavior, set the SaveChanges configuration setting.

Config Method (PDFExplorer Component)

Sets or retrieves a configuration setting.

Syntax

String __fastcall Config(String ConfigurationString);

Remarks

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

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

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

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

CreateNew Method (PDFExplorer Component)

Creates a new PDF document.

Syntax

void __fastcall CreateNew();

Remarks

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

GetObjectData Method (PDFExplorer Component)

Returns the content of a stream object.

Syntax

DynamicArray<Byte> __fastcall GetObjectData(String Path);

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

Opens the document for processing.

Syntax

void __fastcall Open();

Remarks

This method is used to open the document specified in InputFile, InputData, or SetInputStream 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 RootObjects properties with the keys found in the document trailer dictionary.

RemoveObject Method (PDFExplorer Component)

Removes an object from the document.

Syntax

void __fastcall RemoveObject(String Path);

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

Resets the component.

Syntax

void __fastcall Reset();

Remarks

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

Select Method (PDFExplorer Component)

Selects an object or multiple objects from the document.

Syntax

void __fastcall Select(String Filter, bool ClearExistingSelection);

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 SelectedObjects properties.

The ClearExistingSelection parameter specifies whether SelectedObjects 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 GetObjectData or GetObjectStream methods to extract the content of stream objects.

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

SetObjectData Method (PDFExplorer Component)

Sets the content of a stream object.

Syntax

void __fastcall SetObjectData(String Path, DynamicArray<Byte> Value);

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.

Error Event (PDFExplorer Component)

Fired when information is available about errors during data delivery.

Syntax

typedef struct {
  int ErrorCode;
  String Description;
} TispPDFExplorerErrorEventParams;
typedef void __fastcall (__closure *TispPDFExplorerErrorEvent)(System::TObject* Sender, TispPDFExplorerErrorEventParams *e);
__property TispPDFExplorerErrorEvent OnError = { read=FOnError, write=FOnError };

Remarks

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

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

Log Event (PDFExplorer Component)

Fired once for each log message.

Syntax

typedef struct {
  int LogLevel;
  String Message;
  String LogType;
} TispPDFExplorerLogEventParams;
typedef void __fastcall (__closure *TispPDFExplorerLogEvent)(System::TObject* Sender, TispPDFExplorerLogEventParams *e);
__property TispPDFExplorerLogEvent OnLog = { read=FOnLog, write=FOnLog };

Remarks

This event is fired once for each log message generated by the component. 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

Config Settings (PDFExplorer Component)

The component 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 component, access to these internal properties is provided through the Config method.

PDFExplorer Config Settings

Base Config Settings

Trappable Errors (PDFExplorer Component)

PDFExplorer Errors

PDF Errors

Parsing Errors