REFERENCE MANUAL
The DocumentKey class is a smart pointer to a Publish PDF document. More...
Public Member Functions | |
HPS.Publish.DocumentKey | AddAttachment (string in_filename, string in_description) |
Adds an attachment to the document. More... | |
HPS.Publish.DocumentKey | AddAttachments (string[] in_filenames, string[] in_descriptions) |
Adds a list of attachments to the document. More... | |
HPS.Publish.DocumentKey | AddIconImage (string in_name, HPS.Publish.ImageKit in_image) |
Adds an icon image to the document. More... | |
HPS.Publish.DocumentKey | AddIconImages (string[] in_names, HPS.Publish.ImageKit[] in_images) |
Adds icon images to the document. More... | |
HPS.Publish.DocumentKey | AddJavaScript (string in_script_name, string in_source, HPS.Publish.Source.Type in_type) |
Adds a named JavaScript source or file to the document. More... | |
HPS.Publish.DocumentKey | AddJavaScript (string in_script_name, string in_source) |
Adds a named JavaScript source or file to the document. More... | |
HPS.Publish.DocumentKey | AddJavaScript (string[] in_script_names, string[] in_sources, HPS.Publish.Source.Type[] in_types) |
Adds a list of named JavaScript sources or files to the document. More... | |
HPS.Publish.DocumentKey | AddPage (HPS.Publish.PageKit in_page) |
Adds the given page to the document. More... | |
HPS.Publish.DocumentKey | AddPages (HPS.Publish.PageKit[] in_pages) |
Adds the given pages to the document. More... | |
virtual void | Assign (HPS.Publish.DocumentKey in_that) |
Share the underlying smart-pointer of the DocumentKey source. More... | |
void | Delete () |
Closes the PDF document underlying this DocumentKey and frees the associated memory in Publish. More... | |
override void | Dispose () |
DocumentKey () | |
The default constructor creates an uninitialized DocumentKey object. More... | |
DocumentKey (HPS.Publish.DocumentKey in_that) | |
The copy constructor creates a DocumentKey object that shares the underlying smart-pointer of the source DocumentKey. More... | |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.Publish.DocumentKey in_that) |
Check if the source DocumentKey points to the same underlying impl as this DocumentKey. More... | |
override int | GetHashCode () |
HPS.Publish.PageControl | GetPageControl (ulong in_index) |
Returns a control that allows the user to manipulate and query details of a page at the given index in the underlying PDF document. More... | |
ulong | GetPageCount () |
Gets the number of pages in the underlying PDF document. More... | |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. More... | |
HPS.Publish.DocumentKey | RemoveAllPages () |
Removes all pages from the underlying PDF document. More... | |
HPS.Publish.DocumentKey | RemovePage (ulong in_index) |
Removes the page at the given index from the underlying PDF document. More... | |
HPS.Publish.DocumentKey | RemovePages (ulong in_start, ulong in_count) |
Removes the specified number of pages starting at the given index from the underlying PDF document. More... | |
HPS.Publish.DocumentKey | RemovePages (ulong[] in_indices) |
Removes the pages at the given indices from the underlying PDF document. More... | |
HPS.Publish.DocumentKey | SetInformation (string in_title, string in_author, string in_subject, string in_creator) |
Sets the title, author, subject and creator for this document. More... | |
HPS.Publish.DocumentKey | SetPasswords (string in_user_password, string in_owner_password) |
Sets the passwords for this document. More... | |
HPS.Publish.DocumentKey | SetPermissions (HPS.Publish.Permission.Type[] in_permissions) |
Sets document permissions. More... | |
![]() | |
Sprocket (HPS.Sprocket in_that) | |
![]() | |
virtual bool | Empty () |
Indicates whether this object has any values set on it. More... | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns an identifier that can be used to identify which instance of a class an object is. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object in_that) | |
The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More... | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
HPS.Type | Type () |
This function returns the true type of the underlying object. More... | |
Static Public Member Functions | |
static bool | operator!= (HPS.Publish.DocumentKey a, HPS.Publish.DocumentKey b) |
static bool | operator== (HPS.Publish.DocumentKey a, HPS.Publish.DocumentKey b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
enum | UpdateType { Synchronous = 0, Asynchronous = 1 } |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
HandleRef | scptr |
The DocumentKey class is a smart pointer to a Publish PDF document.
It allows direct interaction with a PDF document.
HPS.Publish.DocumentKey.DocumentKey | ( | ) |
The default constructor creates an uninitialized DocumentKey object.
The Type() function will return Type::None.
HPS.Publish.DocumentKey.DocumentKey | ( | HPS.Publish.DocumentKey | in_that | ) |
The copy constructor creates a DocumentKey object that shares the underlying smart-pointer of the source DocumentKey.
in_that | The source <ref refid="class_h_p_s_1_1_publish_1_1_document_key" kindref="compound">DocumentKey</ref> to copy. |
HPS.Publish.DocumentKey HPS.Publish.DocumentKey.AddAttachment | ( | string | in_filename, |
string | in_description | ||
) |
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 <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/group__a3d__publish__document__module.html#ga3f4bcf1bf99759ba44543b5ab7462b99">A3DPDFDocumentAddFileAttachment</ulink>.
in_filename | UTF8-encoded filename of the file to be attached. |
in_description | UTF8-encoded description of the file to be attached. |
HPS.Publish.DocumentKey HPS.Publish.DocumentKey.AddAttachments | ( | string[] | in_filenames, |
string[] | in_descriptions | ||
) |
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 <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/group__a3d__publish__document__module.html#ga3f4bcf1bf99759ba44543b5ab7462b99">A3DPDFDocumentAddFileAttachment</ulink>.
in_count | Size of the following arrays. |
in_filenames | Filenames of the files to be attached. |
in_descriptions | Descriptions of the files to be attached. |
HPS.Publish.DocumentKey HPS.Publish.DocumentKey.AddIconImage | ( | string | in_name, |
HPS.Publish.ImageKit | in_image | ||
) |
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 <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/group__a3d__publish__document__module.html#ga7acb308303e1a5f8092e2fa368999048">A3DPDFDocumentAddImageAsIcon</ulink>.
in_name | UTF8-encoded name of the icon image to be attached. |
in_image | <ref refid="class_h_p_s_1_1_publish_1_1_image" kindref="compound">Image</ref> to be attached as an icon. |
HPS.Publish.DocumentKey HPS.Publish.DocumentKey.AddIconImages | ( | string[] | in_names, |
HPS.Publish.ImageKit[] | in_images | ||
) |
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 <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/group__a3d__publish__document__module.html#ga7acb308303e1a5f8092e2fa368999048">A3DPDFDocumentAddImageAsIcon</ulink>.
in_count | Size of the following arrays. |
in_names | Names of the icon images to be attached. |
in_images | Images to be attached as icons. |
HPS.Publish.DocumentKey HPS.Publish.DocumentKey.AddJavaScript | ( | string | in_script_name, |
string | in_source, | ||
HPS.Publish.Source.Type | in_type | ||
) |
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 <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/group__a3d__publish__document__module.html#ga4e6020563c56827aa43faf9566f043df">A3DPDFDocumentAddJavascriptFromString</ulink>.
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 <ref refid="class_h_p_s_1_1_publish_1_1_source_1a5e72b242e24c67a4d9d777bce395bb92aca0dbad92a874b2f69b549293387925e" kindref="member">Source::Type::Code</ref>. |
HPS.Publish.DocumentKey HPS.Publish.DocumentKey.AddJavaScript | ( | string | in_script_name, |
string | in_source | ||
) |
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 <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/group__a3d__publish__document__module.html#ga4e6020563c56827aa43faf9566f043df">A3DPDFDocumentAddJavascriptFromString</ulink>.
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. |
HPS.Publish.DocumentKey HPS.Publish.DocumentKey.AddJavaScript | ( | string[] | in_script_names, |
string[] | in_sources, | ||
HPS.Publish.Source.Type[] | in_types | ||
) |
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 <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/group__a3d__publish__document__module.html#ga4e6020563c56827aa43faf9566f043df">A3DPDFDocumentAddJavascriptFromString</ulink>.
in_count | Size of the following arrays. |
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. |
HPS.Publish.DocumentKey HPS.Publish.DocumentKey.AddPage | ( | HPS.Publish.PageKit | in_page | ) |
Adds the given page to the document.
This will append the page after any existing pages on the document. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/group__a3d__publish__document__module.html#gaeae4478957db2ff1e61c850ced4aad89">A3DPDFDocumentAppendNewPage</ulink> or <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/group__a3d__publish__document__module.html#ga1b57273ec442dbe92ca20d858f5d5e12">A3DPDFDocumentAppendPageFromPDFFileEx</ulink>.
in_page | <ref refid="class_h_p_s_1_1_publish_1_1_page" kindref="compound">Page</ref> to add to the document. |
HPS.Publish.DocumentKey HPS.Publish.DocumentKey.AddPages | ( | HPS.Publish.PageKit[] | in_pages | ) |
Adds the given pages to the document.
This will append the pages after any existing pages on the document. These correspond to values that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/group__a3d__publish__document__module.html#gaeae4478957db2ff1e61c850ced4aad89">A3DPDFDocumentAppendNewPage</ulink> or <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/group__a3d__publish__document__module.html#ga1b57273ec442dbe92ca20d858f5d5e12">A3DPDFDocumentAppendPageFromPDFFileEx</ulink>.
in_count | Size of the Following array. |
in_pages | Pages to add to the document. |
|
virtual |
Share the underlying smart-pointer of the DocumentKey source.
in_that | The <ref refid="class_h_p_s_1_1_publish_1_1_document_key" kindref="compound">DocumentKey</ref> source of the assignment. |
void HPS.Publish.DocumentKey.Delete | ( | ) |
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.
bool HPS.Publish.DocumentKey.Equals | ( | HPS.Publish.DocumentKey | in_that | ) |
Check if the source DocumentKey points to the same underlying impl as this DocumentKey.
in_that | The source <ref refid="class_h_p_s_1_1_publish_1_1_document_key" kindref="compound">DocumentKey</ref> to compare to this <ref refid="class_h_p_s_1_1_publish_1_1_document_key" kindref="compound">DocumentKey</ref>. |
HPS.Publish.PageControl HPS.Publish.DocumentKey.GetPageControl | ( | ulong | in_index | ) |
Returns a control that allows the user to manipulate and query details of a page at the given index in the underlying PDF document.
in_index | The index of the page for which to create a <ref refid="class_h_p_s_1_1_publish_1_1_page_control" kindref="compound">PageControl</ref>. The index of the first page is 0. |
ulong HPS.Publish.DocumentKey.GetPageCount | ( | ) |
Gets the number of pages in the underlying PDF document.
|
virtual |
This function returns the type the object, as declared.
This does not necessarily give the true type of the underlying object.
Reimplemented from HPS.Object.
HPS.Publish.DocumentKey HPS.Publish.DocumentKey.RemoveAllPages | ( | ) |
Removes all pages from the underlying PDF document.
HPS.Publish.DocumentKey HPS.Publish.DocumentKey.RemovePage | ( | ulong | in_index | ) |
Removes the page at the given index from the underlying PDF document.
in_index | The index of the page to remove from the underlying PDF document. The index of the first page is 0. |
HPS.Publish.DocumentKey HPS.Publish.DocumentKey.RemovePages | ( | ulong | in_start, |
ulong | in_count | ||
) |
Removes the specified number of pages starting at the given index from the underlying PDF document.
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. |
HPS.Publish.DocumentKey HPS.Publish.DocumentKey.RemovePages | ( | ulong[] | in_indices | ) |
Removes the pages at the given indices from the underlying PDF document.
in_count | Size of the following array. |
in_indices | The indices of pages to remove from the underlying PDF document. The index of the first page is 0. |
HPS.Publish.DocumentKey HPS.Publish.DocumentKey.SetInformation | ( | string | in_title, |
string | in_author, | ||
string | in_subject, | ||
string | in_creator | ||
) |
Sets the title, author, subject and creator for this document.
These corresponds to the values that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_document_information_data.html#a23a95fae20138d1c2b41e72d1e023f65">A3DPDFDocumentInformationData::m_pcTitle</ulink>, <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_document_information_data.html#a80251b9b9e2a5943f44841cb9c996c36">A3DPDFDocumentInformationData::m_pcAuthor</ulink>, <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_document_information_data.html#a7a2428427055c10dd5b5b625e1a3ddf1">A3DPDFDocumentInformationData::m_pcSubject</ulink>, and <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_document_information_data.html#a233e35e235385a13f5f26153223aed1a">A3DPDFDocumentInformationData::m_pcCreator</ulink> (respectively).
in_title | UTF8-encoded title string to set on the document. |
in_author | UTF8-encoded author string to set on the document. |
in_subject | UTF8-encoded subject string to set on the document. |
in_creator | UTF8-encoded creator string to set on the document. |
HPS.Publish.DocumentKey HPS.Publish.DocumentKey.SetPasswords | ( | string | in_user_password, |
string | in_owner_password | ||
) |
Sets the passwords for this document.
This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/group__a3d__publish__document__module.html#ga3caa56b7a947ac2b42f2e9c66ede5aa4">A3DPDFDocumentSetPassword</ulink>.
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. |
HPS.Publish.DocumentKey HPS.Publish.DocumentKey.SetPermissions | ( | HPS.Publish.Permission.Type[] | in_permissions | ) |
Sets document permissions.
This correspond to the values that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/group__a3d__publish__document__module.html#gaa3cd3a52f56a9f817801f8b021afa64a">A3DPDFDocumentSetDocumentPermissions</ulink>.
in_count | Size of the following array. |
in_permissions | The permissions to be set on the document. |