SDFDoc

Saves the document in a manner that maximizes compatibility with older PDF consumers (e.g. the file will not use object and compressed xref streams).

Save all string in hexadecimal format.

Save the document using incremental mode.

Save the document in linearized (fast web-view) format. Requires full save.

Do not save cross-reference table

Remove unused objects. Requires full save.

Default constructor. Creates a new document. The new document contains only trailer and Info dictionary. To build the rest of the document get document's root dictionary using GetTrailer() and populate it with new key/value pairs.

Open a SDF/Cos document from a file.

Note: Make sure to call InitStdSecurityHandler() or InitSecurityHandler() after SDFDoc(...) in case the document is encrypted.

Open a SDF/Cos document from a Filter (i.e. a data stream) object.

Note: if the input stream doesn't support Seek() operation the document will load whole data stream in memory before parsing. In case of linearized PDF, the document may be parsed on-the-fly while it is being loaded in memory. Note that since StdFile implements Seek() interface, the document does not have to be fully in memory before it is used.

Make sure to call InitStdSecurityHandler() or InitSecurityHandler() after SDFDoc(...) in case the document is encrypted.

Open a SDF/Cos document from a memory buffer.

Note: the document should be fully loaded in the memory buffer.

the buffer ownership is not transfered to the Document so the user should clean-up if necessary.

Make sure to call InitStdSecurityHandler() or InitSecurityHandler() after SDFDoc(...) in case the document is encrypted.

Instantiates a new SDFDoc from stream.

Instantiates a new SDFDoc from stream with specified size.

Checks if a path is valid for a planned save operation

Removes 'marked' flag from all objects in cross reference table.

Close SDFDoc and release resources Frees the native memory of the object. This can be explicity called to control the deallocation of native memory and avoid situations where the garbage collector does not free the object in a timely manner.

Create an indirect array.

Create an indirect boolean

Create an indirect dictionary

The following list of methods is used to create SDF/Cos indirect objects. Unlike direct objects, indirect objects can be referenced by more than one object (i.e. indirect objects they can be shared).

Create an indirect null

Create an indirect number.

Create an indirect stream from buffer

Create an indirect stream from FilterReader

Create an indirect stream

Create an indirect stream from FilterReader

Create an indirect string.

Create an indirect string.

Enable or disable disk caching feature

Note: A document uses a temporary file which is used to cache the contents of any new stream object created in the document (that is the default behavior).

Get SDFDoc filename

Get the file header.

Get document's initial linearization hint stream if it is available.

Get document's initial linearization dictionary if it is available.

Get the Obj with specified object number

Get the security handler.

Note: InitSecurityHandler() should be called before GetSecurityHandler() in order to initialize the handler.

Returned security handler can be modified in order to change the security settings of the exisitng document. Changes to the current handler will not invalidate the access to the original file and will take effect during document Save().

If the security handler is modified, document will perform a full save even if INCREMENTAL was given in Save() method.

Get root of the document as Obj

Checks whether or not the underlying file has an XRef table that had to be repaired when the file was opened. If the document had an invalid XRef table when opened, PDFNet will have repaired the XRef table for its working representation of the document. Note: If this function returns true, it is not possible to incrementally save the document (see http://www.pdftron.com/kb_corrupt_xref)

Import obj to SDFDoc

Note: If the object belongs to a document the function will perform deep or shallow clone depending whether deep_copy flag was specified. If the object does not belong to any document ImportObj does not take the object ownership. ImportObj copies the source object and it is users responibility to delete free objects.

The function performs a deep copy of all objects specified in the 'obj_list'. If objects in the list are directly or indirectly reffering to the same object/s, only one copy of the shared object/s will be copied. Therefore, unlike repeated calls to ImportObj, this method will import only one copy of shared objects (objects representing an intersection of graphs specified through 'obj_list' of root pointers.

Note: - All object in the import list must belong to the same source document.

- The function does not perform the shallow copy since ImportObj() can be used instead.

The function performs a deep copy of all objects specified in the 'obj_list'. If objects in the list are directly or indirectly reffering to the same object/s, only one copy of the shared object/s will be copied. Therefore, unlike repeated calls to ImportObj, this method will import only one copy of shared objects (objects representing an intersection of graphs specified through 'obj_list' of root pointers.

Note: - All object in the import list must belong to the same source document.

- The function does not perform the shallow copy since ImportObj() can be used instead.

Initializes document's SecurityHandler.

This version of InitSecurityHandler() works with Standard and Custom PDF security and can be used in situations where the password is obtained dynamically via user feedback. See EncTest sample for example code.

If the security handler was successfully initialized it can be later obtained using GetSecurityHandler() method.

Note: This function should be called immediately after an encrypted document is opened. The function does not have any side effects on documents that are not encrypted.

Initializes document's SecurityHandler. This version of InitSecurityHandler() works with Standard and Custom PDF security and can be used in situations where the password is obtained dynamically via user feedback. See EncTest sample for example code. This function should be called immediately after an encrypted document is opened. The function does not have any side effects on documents that are not encrypted. If the security handler was successfully initialized it can be later obtained using GetSecurityHandler() method.

Initializes document's SecurityHandler using the supplied password. This version of InitSecurityHandler() assumes that document uses Standard security and that a password is specified directly. This function should be called immediately after an encrypted document is opened. The function does not have any side effects on documents that are not encrypted. If the security handler was successfully initialized, it can be later obtained using GetSecurityHandler() method.

Initializes document's SecurityHandler using the supplied password. This version of InitSecurityHandler() assumes that document uses Standard security and that a password is specified directly. This function should be called immediately after an encrypted document is opened. The function does not have any side effects on documents that are not encrypted. If the security handler was successfully initialized, it can be later obtained using GetSecurityHandler() method.

Checks if SDFDoc is encrypted.

Checks if is full save required.

Call this function to determine whether the document is represented in linearized (fast web view) format.

Note: any changes to the document can invalidate linearization. The function will return 'true' only if the original document is linearized and if it is not modified. In order to provide good performance over relatively slow communication links, PDFNet can generate PDF documents with linearized objects and hint tables that can allow a PDF viewer application to download and view one page of a PDF file at a time, rather than requiring the entire file (including fonts and images) to be downloaded before any of it can be viewed. To save a document in linearized (fast web view) format you only need to pass INCREMENTAL in the Save() method.

Checks if SDFDoc is modified.

Locks the document to prevent competing threads from accessiong the document at the same time. Threads attempting to access the document will wait in suspended state until the thread that owns the lock calls doc.Unlock().

Locks the document to prevent competing write threads (using lock()) from accessing the document at the same time. Other reader threads however, will be allowed to access the document. Threads attempting to obtain write access to the document will wait in suspended state until the thread that owns the lock calls doc.unlockRead(). Note: To avoid deadlocks obtaining a write lock while holding a read lock is not permitted and will throw an exception. If this situation is encountered please either unlock the read lock before the write lock is obtained or acquire a write lock (rather than read lock) in the first place.

Removes all security from SDFDoc.

Saves the document to a file. If a full save is requested to the original path, the file is saved to a file system-determined temporary file, the old file is deleted, and the temporary file is renamed to path. A full save with remove unused or linearization option may re-arrange object in the cross reference table. Therefore all pointers and references to document objects and resources should be re acquired in order to continue document editing. In order to use incremental save the specified path must match original path and INCREMENTAL should be given.

Note: - Save will modify the SDFDoc object's internal representation. As such, the user should acquire a write lock before calling save.

Note: - If the original pdf has a corrupt xref table (see HasRepairedXref or http://www.pdftron.com/kb_corrupt_xref), then it can not be saved using the INCREMENTAL.

Save SDFDoc to output stream

- Save will modify the SDFDoc object's internal representation. As such, the user should acquire a write lock before calling save.

Saves the document to a memory buffer.

- Save will modify the SDFDoc object's internal representation. As such, the user should acquire a write lock before calling save.

Save SDFDoc to output stream

- Save will modify the SDFDoc object's internal representation. As such, the user should acquire a write lock before calling save.

The function sets a new SecurityHandler as the current security handler.

Sometimes it is desirable to modify all indirect references to a given indirect object. It would be inefficient to manually search for all indirect references to a given indirect object. A more efficient and less error prone method is to replace the indirect object in the cross reference table with a new object. This way the object that is referred to is modified (or replaced) and indirect references do not have to be changed.

Try locking the document, waiting no longer than specified number of milliseconds.

Tries to obtain a read lock the document for <milliseconds> duration, and returns true if the lock was successfully acquired

Try obtaining a read lock on the document in non-blocking manner.

Removes the lock from the document.

Removes the read lock from the document.

Get size of the cross reference table