|
HPS.Publish.DocumentKey | AddAttachment (string in_filename, string in_description) |
|
HPS.Publish.DocumentKey | AddAttachments (string[] in_filenames, string[] in_descriptions) |
|
HPS.Publish.DocumentKey | AddIconImage (string in_name, HPS.Publish.ImageKit in_image) |
|
HPS.Publish.DocumentKey | AddIconImages (string[] in_names, HPS.Publish.ImageKit[] in_images) |
|
HPS.Publish.DocumentKey | AddJavaScript (string in_script_name, string in_source, HPS.Publish.Source.Type in_type) |
|
HPS.Publish.DocumentKey | AddJavaScript (string in_script_name, string in_source) |
|
HPS.Publish.DocumentKey | AddJavaScript (string[] in_script_names, string[] in_sources, HPS.Publish.Source.Type[] in_types) |
|
HPS.Publish.DocumentKey | AddPage (HPS.Publish.PageKit in_page) |
|
HPS.Publish.DocumentKey | AddPages (HPS.Publish.PageKit[] in_pages) |
|
virtual void | Assign (HPS.Publish.DocumentKey in_that) |
|
void | Delete () |
|
override void | Dispose () |
|
| DocumentKey () |
|
| DocumentKey (HPS.Publish.DocumentKey in_that) |
|
override bool | Equals (System.Object obj) |
|
bool | Equals (HPS.Publish.DocumentKey in_that) |
|
override int | GetHashCode () |
|
HPS.Publish.PageControl | GetPageControl (ulong in_index) |
|
ulong | GetPageCount () |
|
override HPS.Type | ObjectType () |
|
HPS.Publish.DocumentKey | RemoveAllPages () |
|
HPS.Publish.DocumentKey | RemovePage (ulong in_index) |
|
HPS.Publish.DocumentKey | RemovePages (ulong in_start, ulong in_count) |
|
HPS.Publish.DocumentKey | RemovePages (ulong[] in_indices) |
|
HPS.Publish.DocumentKey | SetInformation (string in_title, string in_author, string in_subject, string in_creator) |
|
HPS.Publish.DocumentKey | SetPasswords (string in_user_password, string in_owner_password) |
|
HPS.Publish.DocumentKey | SetPermissions (HPS.Publish.Permission.Type[] in_permissions) |
|
| Sprocket (HPS.Sprocket in_that) |
|
virtual bool | Empty () |
|
IntPtr | GetClassID () |
|
IntPtr | GetInstanceID () |
|
bool | HasType (HPS.Type in_mask) |
|
| Object (HPS.Object that) |
|
virtual void | Reset () |
|
virtual HPS.Type | Type () |
|
|
override void | deleteCptr () |
|
virtual IntPtr | GetNonDirectorClassID () |
|
|
bool | cMemOwn |
|
HandleRef | cptr |
|
The DocumentKey class is a smart pointer to a Publish PDF document. It allows direct interaction with a PDF document.
◆ DocumentKey() [1/2]
HPS.Publish.DocumentKey.DocumentKey |
( |
| ) |
|
|
inline |
The default constructor creates an uninitialized DocumentKey object. The Type() function will return Type.None.
◆ DocumentKey() [2/2]
The copy constructor creates a DocumentKey object that shares the underlying smart-pointer of the source DocumentKey.
- Parameters
-
◆ AddAttachment()
Adds an attachment to the document. If there is an existing attachment on the document with the given filename, it will get overwritten. This corresponds to the value that will be passed to A3DPDFDocumentAddFileAttachment.
- Parameters
-
in_filename | UTF8-encoded filename of the file to be attached. |
in_description | UTF8-encoded description of the file to be attached. |
- Returns
- A reference to this DocumentKey.
◆ AddAttachments()
HPS.Publish.DocumentKey HPS.Publish.DocumentKey.AddAttachments |
( |
string [] |
in_filenames, |
|
|
string [] |
in_descriptions |
|
) |
| |
|
inline |
Adds a list of attachments to the document. If there is an existing attachment on the document with a filename which is in the given list, it will get overwritten. These correspond to values that will be passed to A3DPDFDocumentAddFileAttachment.
- Parameters
-
in_filenames | Filenames of the files to be attached. |
in_descriptions | Descriptions of the files to be attached. |
- Returns
- A reference to this DocumentKey.
◆ AddIconImage()
Adds an icon image to the document. If there is an existing icon image on the document with the given name, it will get overwritten. This corresponds to the value that will be passed to A3DPDFDocumentAddImageAsIcon.
- Parameters
-
in_name | UTF8-encoded name of the icon image to be attached. |
in_image | Image to be attached as an icon. |
- Returns
- A reference to this DocumentKey.
◆ AddIconImages()
Adds icon images to the document. If there is an existing icon image on the document with a name which is in the given list, it will get overwritten. These correspond to the values that will be passed to A3DPDFDocumentAddImageAsIcon.
- Parameters
-
in_names | Names of the icon images to be attached. |
in_images | Images to be attached as icons. |
- Returns
- A reference to this DocumentKey.
◆ AddJavaScript() [1/3]
Adds a named JavaScript source or file to the document. If there is an existing script on the document with the given name, it will get overwritten. This corresponds to the value that will be passed to A3DPDFDocumentAddJavascriptFromString.
- Parameters
-
in_script_name | UTF8-encoded script name to be added to the document. |
in_source | UTF8-encoded JavaScript source or file (depending on the following argument) to be added to the document. |
in_type | The types of the preceding argument. Defaults to Source.Type.Code. |
- Returns
- A reference to this DocumentKey.
◆ AddJavaScript() [2/3]
Adds a named JavaScript source or file to the document. If there is an existing script on the document with the given name, it will get overwritten. This corresponds to the value that will be passed to A3DPDFDocumentAddJavascriptFromString.
- Parameters
-
in_script_name | UTF8-encoded script name to be added to the document. |
in_source | UTF8-encoded JavaScript source or file (depending on the following argument) to be added to the document. |
- Returns
- A reference to this DocumentKey.
◆ AddJavaScript() [3/3]
Adds a list of named JavaScript sources or files to the document. If there is an existing script on the document with a name which is in the given list, it will get overwritten. These correspond to values that will be passed to A3DPDFDocumentAddJavascriptFromString.
- Parameters
-
in_script_names | Script names to be added to the document. |
in_sources | JavaScript sources and/or files (depending on the corresponding entry in the following argument) to be added to the document. |
in_types | Types for each item in the preceding argument array. |
- Returns
- A reference to this DocumentKey.
◆ AddPage()
◆ AddPages()
◆ Assign()
Share the underlying smart-pointer of the DocumentKey source.
- Parameters
-
- Returns
- A reference to this DocumentKey.
◆ Delete()
void HPS.Publish.DocumentKey.Delete |
( |
| ) |
|
|
inline |
Closes the PDF document underlying this DocumentKey and frees the associated memory in Publish. This will effectively invalidate all references to the underlying PDF document (including other DocumentKey or PageControl objects which refer to the same document). This will not write the underlying PDF document out to disk.
◆ Equals()
Check if the source DocumentKey points to the same underlying impl as this DocumentKey.
- Parameters
-
- Returns
- true if the objects reference the same impl, false otherwise.
◆ GetPageControl()
Returns a control that allows the user to manipulate and query details of a page at the given index in the underlying PDF document.
- Parameters
-
in_index | The index of the page for which to create a PageControl. The index of the first page is 0. |
- Returns
- A PageControl object for the specified page.
◆ GetPageCount()
ulong HPS.Publish.DocumentKey.GetPageCount |
( |
| ) |
|
|
inline |
Gets the number of pages in the underlying PDF document.
◆ ObjectType()
override HPS.Type HPS.Publish.DocumentKey.ObjectType |
( |
| ) |
|
|
inlinevirtual |
This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).
- Returns
- The declared type of the object in question, which may differ from the true, underlying type.
Reimplemented from HPS.Object.
◆ RemoveAllPages()
Removes all pages from the underlying PDF document.
- Returns
- A reference to this DocumentKey.
◆ RemovePage()
Removes the page at the given index from the underlying PDF document.
- Parameters
-
in_index | The index of the page to remove from the underlying PDF document. The index of the first page is 0. |
- Returns
- A reference to this DocumentKey.
◆ RemovePages() [1/2]
Removes the specified number of pages starting at the given index from the underlying PDF document.
- Parameters
-
in_start | The first index at which to start to removing pages from the underlying PDF document. The index of the first page is 0. |
in_count | The number of pages to remove from the underlying PDF document. |
- Returns
- A reference to this DocumentKey.
◆ RemovePages() [2/2]
Removes the pages at the given indices from the underlying PDF document.
- Parameters
-
in_indices | The indices of pages to remove from the underlying PDF document. The index of the first page is 0. |
- Returns
- A reference to this DocumentKey.
◆ SetInformation()
HPS.Publish.DocumentKey HPS.Publish.DocumentKey.SetInformation |
( |
string |
in_title, |
|
|
string |
in_author, |
|
|
string |
in_subject, |
|
|
string |
in_creator |
|
) |
| |
|
inline |
◆ SetPasswords()
Sets the passwords for this document. This corresponds to the value that will be passed to A3DPDFDocumentSetPassword.
- Parameters
-
in_user_password | UTF8-encoded password string required when opening, modifying or printing the document. If an empty string is specified, no password will be required. |
in_owner_password | UTF8-encoded password string required when changing security features of document. If an empty string is specified, no password will be required. |
- Returns
- A reference to this DocumentKey.
◆ SetPermissions()
The documentation for this class was generated from the following file:
- internals/hps_sprk_publish/source/cs/HPS.Publish.cs