The DocumentKit class is a user space object. It acts as the root container for all pages in a Publish PDF. More...
Public Member Functions | |
override void | Dispose () |
DocumentKit () | |
The default constructor creates an empty DocumentKit object. More... | |
DocumentKit (HPS.Publish.DocumentKit in_kit) | |
The copy constructor creates a new DocumentKit object that contains the same settings as the source DocumentKit. More... | |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object. More... | |
void | Set (HPS.Publish.DocumentKit in_kit) |
Copies the source DocumentKit into this DocumentKit. More... | |
void | Show (out HPS.Publish.DocumentKit out_kit) |
Copies this DocumentKit into the given DocumentKit. More... | |
override bool | Empty () |
Indicates whether this DocumentKit has any values set on it. More... | |
override bool | Equals (System.Object obj) |
override int | GetHashCode () |
bool | Equals (HPS.Publish.DocumentKit in_kit) |
Check if the source DocumentKit is equivalent to this DocumentKit. More... | |
HPS.Publish.DocumentKit | 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). More... | |
HPS.Publish.DocumentKit | 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>. More... | |
HPS.Publish.DocumentKit | 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>. More... | |
HPS.Publish.DocumentKit | 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>. More... | |
HPS.Publish.DocumentKit | 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>. More... | |
HPS.Publish.DocumentKit | 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>. More... | |
HPS.Publish.DocumentKit | 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>. More... | |
HPS.Publish.DocumentKit | 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>. More... | |
HPS.Publish.DocumentKit | 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>. More... | |
HPS.Publish.DocumentKit | SetPage (HPS.Publish.PageKit in_page) |
Adds the given page to the document. This will replace all pages (if any) which are already 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>. More... | |
HPS.Publish.DocumentKit | 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>. More... | |
HPS.Publish.DocumentKit | SetPages (HPS.Publish.PageKit[] in_pages) |
Adds the given pages to the document. This will replace all pages (if any) which are already 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>. More... | |
HPS.Publish.DocumentKit | 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>. More... | |
HPS.Publish.DocumentKit | 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>. More... | |
HPS.Publish.DocumentKit | UnsetInformation () |
Removes the document title, author, subject and creator. More... | |
HPS.Publish.DocumentKit | UnsetPasswords () |
Removes the document passwords. More... | |
HPS.Publish.DocumentKit | UnsetJavaScript (string in_script_name) |
Removes the script with a given name from the document. More... | |
HPS.Publish.DocumentKit | UnsetJavaScript (string[] in_script_names) |
Removes the scripts with the given names from the document. More... | |
HPS.Publish.DocumentKit | UnsetJavaScript () |
Removes all scripts from the document. More... | |
HPS.Publish.DocumentKit | UnsetAttachment (string in_filename) |
Removes the attachment with a given filename from the document. More... | |
HPS.Publish.DocumentKit | UnsetAttachments (string[] in_filenames) |
Removes the attachments with the given filenames from the document. More... | |
HPS.Publish.DocumentKit | UnsetAttachments () |
Removes all attachments from the document. More... | |
HPS.Publish.DocumentKit | UnsetIconImage (string in_name) |
Removes the icon image with a given name from the document. More... | |
HPS.Publish.DocumentKit | UnsetIconImages (string[] in_names) |
Removes the icon images with the given names from the document. More... | |
HPS.Publish.DocumentKit | UnsetIconImages () |
Removes all icon images from the document. More... | |
HPS.Publish.DocumentKit | UnsetPage (ulong in_index) |
Removes the page at the given index from the document. More... | |
HPS.Publish.DocumentKit | UnsetPages (ulong[] in_indices) |
Removes the pages at the given indices from the document. More... | |
HPS.Publish.DocumentKit | UnsetPages () |
Removes all pages from the document. More... | |
HPS.Publish.DocumentKit | UnsetPermissions () |
Removes permission settings from the document. More... | |
HPS.Publish.DocumentKit | UnsetEverything () |
Removes all data from the document. More... | |
bool | ShowInformation (out string out_title, out string out_author, out string out_subject, out string out_creator) |
Shows the document title, author, subject and creator. More... | |
bool | ShowPasswords (out string out_user_password, out string out_owner_password) |
Shows the document passwords. More... | |
bool | ShowJavaScript (out string[] out_script_names, out string[] out_sources, out HPS.Publish.Source.Type[] out_types) |
Shows the JavaScript sources and/or files on the document. More... | |
bool | ShowAttachments (out string[] out_filenames, out string[] out_descriptions) |
Shows the attachments on the document. More... | |
bool | ShowIconImages (out string[] out_names, out HPS.Publish.ImageKit[] out_images) |
Shows the icon images on the document. More... | |
bool | ShowPages (out HPS.Publish.PageKit[] out_pages) |
Shows the pages on the document. More... | |
bool | ShowPermissions (out HPS.Publish.Permission.Type[] out_permissions) |
Shows permissions on the document More... | |
![]() | |
Sprocket (HPS.Sprocket in_that) | |
![]() | |
IntPtr | GetClassID () |
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... | |
HPS.Type | Type () |
This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types. More... | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
IntPtr | GetInstanceID () |
Returns an identifier that can be used to identify which instance of a class an object is. Different keys and controls will return the same value if they are backed by the same database resource. More... | |
Static Public Member Functions | |
static HPS.Publish.DocumentKit | GetDefault () |
Creates a DocumentKit which contains the default settings. The returned object will not necessarily have values for every setting, but it will have them where it is reasonable to have a default. These values will be used for export unless a setting is overridden by the DocumentKit passed to File::Export. More... | |
static bool | operator== (HPS.Publish.DocumentKit a, HPS.Publish.DocumentKit b) |
static bool | operator!= (HPS.Publish.DocumentKit a, HPS.Publish.DocumentKit b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
enum | UpdateType { Synchronous = 0, Asynchronous = 1 } |
The type of update to perform, either synchronous or asynchronous. More... | |
![]() | |
HandleRef | cptr |
HandleRef | scptr |
bool | cMemOwn |
The DocumentKit class is a user space object. It acts as the root container for all pages in a Publish PDF.
|
inline |
The default constructor creates an empty DocumentKit object.
|
inline |
The copy constructor creates a new DocumentKit object that contains the same settings as the source DocumentKit.
in_kit | The source <ref refid="class_h_p_s_1_1_publish_1_1_document_kit" kindref="compound">DocumentKit</ref> to copy. |
|
inline |
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. |
|
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 <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. |
|
inline |
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. |
|
inline |
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. |
|
inline |
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>. |
|
inline |
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. |
|
inline |
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. |
|
inline |
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. |
|
inline |
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. |
|
inlinevirtual |
Indicates whether this DocumentKit has any values set on it.
Reimplemented from HPS.Object.
|
inline |
Check if the source DocumentKit is equivalent to this DocumentKit.
in_kit | The source <ref refid="class_h_p_s_1_1_publish_1_1_document_kit" kindref="compound">DocumentKit</ref> to compare to this <ref refid="class_h_p_s_1_1_publish_1_1_document_kit" kindref="compound">DocumentKit</ref>. |
|
inlinestatic |
Creates a DocumentKit which contains the default settings. The returned object will not necessarily have values for every setting, but it will have them where it is reasonable to have a default. These values will be used for export unless a setting is overridden by the DocumentKit passed to File::Export.
|
inlinevirtual |
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.
|
inline |
Copies the source DocumentKit into this DocumentKit.
in_kit | The source <ref refid="class_h_p_s_1_1_publish_1_1_document_kit" kindref="compound">DocumentKit</ref> to copy. |
|
inline |
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. |
|
inline |
Adds the given page to the document. This will replace all pages (if any) which are already 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. |
|
inline |
Adds the given pages to the document. This will replace all pages (if any) which are already 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. |
|
inline |
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. |
|
inline |
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. |
|
inline |
Copies this DocumentKit into the given DocumentKit.
out_kit | The <ref refid="class_h_p_s_1_1_publish_1_1_document_kit" kindref="compound">DocumentKit</ref> to populate with the contents of this <ref refid="class_h_p_s_1_1_publish_1_1_document_kit" kindref="compound">DocumentKit</ref>. |
|
inline |
Shows the attachments on the document.
out_filenames | Filenames of the attachments on the document. |
out_descriptions | Descriptions of the attachments on the document. |
|
inline |
Shows the icon images on the document.
out_names | Names of the icon images on the document. |
out_images | Icon images on the document. |
|
inline |
Shows the document title, author, subject and creator.
out_title | Title of the document |
out_author | Author of the document |
out_subject | Subject of the document |
out_creator | Creator of the document |
|
inline |
Shows the JavaScript sources and/or files on the document.
out_script_names | Script names on the document. |
out_sources | JavaScript sources and/or files on the document. |
out_types | Types for each item in the preceding array. |
|
inline |
Shows the pages on the document.
out_pages | Pages on the document. |
|
inline |
Shows the document passwords.
out_user_password | User password of the document. |
out_owner_password | Owner password of the document. |
|
inline |
Shows permissions on the document
out_permissions | Permissions on the document. |
|
inline |
Removes the attachment with a given filename from the document.
in_filename | UTF8-encoded filename of attachment to remove from the document. |
|
inline |
Removes the attachments with the given filenames from the document.
in_count | Size of the following array. |
in_filenames | Filenames of attachments to remove from the document. |
|
inline |
Removes all attachments from the document.
|
inline |
Removes all data from the document.
|
inline |
Removes the icon image with a given name from the document.
in_name | UTF8-encoded name of icon image to remove from the document. |
|
inline |
Removes the icon images with the given names from the document.
in_count | Size of the following array. |
in_names | Names of icon images to remove from the document. |
|
inline |
Removes all icon images from the document.
|
inline |
Removes the document title, author, subject and creator.
|
inline |
Removes the script with a given name from the document.
in_script_name | UTF8-encoded script name to remove from the document. |
|
inline |
Removes the scripts with the given names from the document.
in_count | Size of the following array. |
in_script_names | Script names to remove from the document. |
|
inline |
Removes all scripts from the document.
|
inline |
Removes the page at the given index from the document.
in_index | Index of the page to remove from the document. |
|
inline |
Removes the pages at the given indices from the document.
in_count | Size of the following array. |
in_indices | Indices of the pages to remove from the document. |
|
inline |
Removes all pages from the document.
|
inline |
Removes the document passwords.
|
inline |
Removes permission settings from the document.