OdDocument Class

Syntax

C++

class OdDocument : public OdObject;

Description

This class implements working with a .pdf document created with Publish SDK. A document is a container for other elements and controls (such as pages, images, links, annotations, and so on).

Class Hierarchy

File: PdfPublishDocument.h

Namespace: OdPdfPublish

Module: API Reference

Methods

Show:Inherited

No members matching the current filter

OdRxObject	Default constructor for this class. (Inherited from OdRxObject)
~OdDocument	Destroys the Publish SDK document.
~OdObject	Destroys an instance of a Publish SDK object. (Inherited from OdObject)
~OdRxObject	The virtual destructor for this class. (Inherited from OdRxObject)

Methods

Show:Inherited

No members matching the current filter

addAttachment	Adds a new attachment file to the ODA Publish document.
addIconImage	Adds a new icon image to the Publish SDK document.
addJavaScript	Adds a new JavaScript scenario to the Publish SDK document.
addPage	Adds a new page to the Publish SDK document.
addRef	Declares the method incrementing the reference counter in objects derived from this class. (Inherited from OdRxObject)
appServices	Gets the current application services object for the document.
appendRootBookmark	Appends a new root bookmark to the PDF document.
cast	Casts the specified raw pointer to the smart pointer. (Inherited from OdRxObject)
clear	Clears the Publish SDK object. (Inherited from OdObject)
clone	Creates a clone of this object, and returns a pointer to the clone. (Inherited from OdRxObject)
comparedTo	Compares another object to this one in a some meaning. (Inherited from OdRxObject)
copyFrom	details Copies the contents of the specified object into this object. (Inherited from OdRxObject)
desc	Returns the raw pointer to the class describing instance statically associated with this object as the OdRxClass object. (Inherited from OdRxObject)
getAccessPermissionFlags	Sets new access permission flags for the output PDF document.
getAttachments	Retrieves names of files currently attached to the Publish document. The method fills passed string arrays with file names and descriptions; then returns them to a calling subroutine.
getIconImages	Returns a collection of icon images from the Publish SDK document. This method fills the passed string array and smart pointer array with image names and pointers to image objects, then returns them to a calling subroutine.
getInformation	Returns the current common information about the Publish SDK document. This method fills the passed strings and returns them to a calling subroutine.
getJavaScripts	Returns the collection of JavaScript scenarios encapsulated in the Publish SDK document. This method fills the passed arrays with names, source code text and source code types, then returns them to a calling subroutine.
getOwnerPassword	Retrieves the current owner password for the output PDF document.
getPages	Returns the array of pages that the Publish SDK document contains. This method fills the passed array with the OdPage object that represents the document pages and returns it to a calling subroutine.
getRootBookmarks	Returns root bookmarks for the current bookmark from the PDF document. The method fills the passed array with smart pointers to OdBookmark objects that represents the child bookmarks of the current bookmark and returns it to a calling subroutine.
getUserPassword	Retrieves the current user password for the output PDF document.
isA	Returns the raw pointer to the class describing instance dynamically associated with this object as the OdRxClass object. (Inherited from OdRxObject)
isEmpty	Determines whether the Publish SDK object is empty. (Inherited from OdObject)
isEqualTo	Returns true if and only if the specified object is equal to this one in a some meaning. (Inherited from OdRxObject)
isKindOf	Checks whether the object belongs to the specified class and returns true if and only if this object is an instance of the specified class or a subclass of the specified class. (Inherited from OdRxObject)
isValid	Determines whether the Publish SDK object is valid. (Inherited from OdObject)
numRefs	Returns the value of the reference counter, that is, the number of references to an instance of this class. (Inherited from OdRxObject)
queryX	Checks whether the object belongs to the specified class and returns a pointer to this object if this object can be converted to the specified class. (Inherited from OdRxObject)
release	Declares the method decrementing the reference counter in objects derived from this class. (Inherited from OdRxObject)
rxInit	for internal use (Inherited from OdRxObject)
rxUninit	(Inherited from OdRxObject)
setAccessPermissionFlags	Sets new access permission flags for the output PDF document.
setHostServices	Sets a new application services object for the document.
setInformation	Sets common information about the Publish SDK document.
setOwnerPassword	Sets a new owner password for the output PDF document.
setRootBookmarks	Sets root bookmarks for the PDF document.
setUserPassword	Sets a new user password for the output PDF document.
x	Checks whether the object belongs to the specified class and returns a pointer to this object if this object can be converted to the specified class, or throws an exception if it cannot. (Inherited from OdRxObject)

Links

OdDocument Methods

Relief for ODA Team in Ukraine