PDFDocument is one of the PDF Builder objects and is derived from PDFModel. It imports data from a DataWindow object, a DataWindowChild object or a DataStore object, or an existing PDF document to a new PDF document and saves the document.
To view the full hierarchy of the PDF Builder objects, find "pdfobject" in the Browser, right-click the object, and then select "Show Hierarchy” in the pop-up menu.
PDFDocument provides the following properties. In addition, it inherits the properties from its parent, PDFModel.
|
PDFDocument property |
Datatype |
Description |
|---|---|---|
|
PDFAttachment |
Gets or sets the attachment of the PDF document. |
|
|
Double |
Gets or sets the size of the bottom margin between the PDF document and the printed page. |
|
|
ClassDefinition |
PowerObject |
An object of type PowerObject containing information about the class definition of the object or control. |
|
Long |
Gets or sets the compression level of the PDF document. There are 10 compression levels, 0 to 9, from no compression to the largest compression. 6 is the default value. |
|
|
Double |
Gets or sets the size of the left margin between the PDF document and the printed page. |
|
|
PDFDocumentProperties |
Gets or sets the properties of the PDF document. |
|
|
Double |
Gets or sets the size of the right margin between the PDF document and the printed page. |
|
|
PDFSecurity |
Gets or sets the security property of the PDF document. |
|
|
Double |
Gets or sets the size of the top margin between the PDF document and the printed page. |
|
|
PDFWatermark |
Gets or sets the watermark of the PDF document. |
|
PDFDocument event |
Occurs |
|---|---|
|
Immediately before the Open event occurs in the window. |
|
|
Immediately after the Close event occurs in the window. |
PDFDocument provides the following functions.
|
PDFDocument function |
Datatype returned |
Description |
|---|---|---|
|
Long |
Adds a page to an existing PDF document. The page is added to the end of the document. |
|
|
String |
Returns the name assigned to the control. |
|
|
PDFDocument |
Clones the document. |
|
|
Double |
Gets the bottom margin between the document and the bottom border of the page. |
|
|
Integer |
Creates a reference to a context-specific instance of the specified service. |
|
|
Double |
Gets the margin between the document and the left border of the page. |
|
|
PDFPage |
Gets the specified page in the document. |
|
|
Long |
Gets the page count of the document. |
|
|
PowerObject |
Returns a reference to the name of the parent object. |
|
|
Double |
Gets the margin between the document and the right border of the page. |
|
|
PDFTableOfContents |
Gets the table of contents of the document. |
|
|
Double |
Gets the top margin between the document and the top border of the page. |
|
|
Long |
Imports data from the DataWindow control, DataStore object, or DataWindowChild object to a PDF document. |
|
|
Long |
Imports an existing PDF document to a new PDF document. |
|
|
Long |
Imports the documentation information of the specified PDF document. |
|
|
Long |
Imports the content in the RichTextEdit control to the document. |
|
|
Long |
Gets the index of the specified page in the document. |
|
|
Long |
Inserts a page to the specified location in the document. |
|
|
Boolean |
Adds an event to the end of the message queue for the control. |
|
|
Long |
Removes a page from the document. |
|
|
Long |
Saves the contents of a PDF document. |
|
|
PDFModel |
Searches for the specified object in the document. |
|
|
None |
Sets the margin between the document and the bottom border of the page. |
|
|
None |
Sets the margin between the document and the left border of the page. |
|
|
None |
Sets the margin between the document and the right border of the page. |
|
|
None |
Sets the table of content for the document. |
|
|
None |
Sets the margin between the document and the top border of the page. |
|
|
Integer |
Triggers a specified event in the control and executes the script for the event. |
|
|
Object |
Returns the type of the control. |
