|
HPS.Publish.DocumentKit | AddAttachment (string in_filename, string in_description) |
|
HPS.Publish.DocumentKit | AddAttachments (string[] in_filenames, string[] in_descriptions) |
|
HPS.Publish.DocumentKit | AddDataTable (HPS.Publish.DataTableKit in_data_table) |
|
HPS.Publish.DocumentKit | AddDataTables (HPS.Publish.DataTableKit[] in_data_table) |
|
HPS.Publish.DocumentKit | AddIconImage (string in_name, HPS.Publish.ImageKit in_image) |
|
HPS.Publish.DocumentKit | AddIconImages (string[] in_names, HPS.Publish.ImageKit[] in_images) |
|
HPS.Publish.DocumentKit | AddJavaScript (string in_script_name, string in_source, HPS.Publish.Source.Type in_type) |
|
HPS.Publish.DocumentKit | AddJavaScript (string in_script_name, string in_source) |
|
HPS.Publish.DocumentKit | AddJavaScript (string[] in_script_names, string[] in_sources, HPS.Publish.Source.Type[] in_types) |
|
HPS.Publish.DocumentKit | AddPage (HPS.Publish.PageKit in_page) |
|
HPS.Publish.DocumentKit | AddPages (HPS.Publish.PageKit[] in_pages) |
|
override void | Dispose () |
|
| DocumentKit () |
|
| DocumentKit (HPS.Publish.DocumentKit in_kit) |
|
override bool | Empty () |
|
override bool | Equals (System.Object obj) |
|
bool | Equals (HPS.Publish.DocumentKit in_kit) |
|
override int | GetHashCode () |
|
override HPS.Type | ObjectType () |
|
void | Set (HPS.Publish.DocumentKit in_kit) |
|
HPS.Publish.DocumentKit | SetInformation (string in_title, string in_author, string in_subject, string in_creator) |
|
HPS.Publish.DocumentKit | SetPage (HPS.Publish.PageKit in_page) |
|
HPS.Publish.DocumentKit | SetPages (HPS.Publish.PageKit[] in_pages) |
|
HPS.Publish.DocumentKit | SetPasswords (string in_user_password, string in_owner_password) |
|
HPS.Publish.DocumentKit | SetPermissions (HPS.Publish.Permission.Type[] in_permissions) |
|
void | Show (out HPS.Publish.DocumentKit out_kit) |
|
bool | ShowAttachments (out string[] out_filenames, out string[] out_descriptions) |
|
bool | ShowDataTables (out HPS.Publish.DataTableKit[] out_data_tables) |
|
bool | ShowIconImages (out string[] out_names, out HPS.Publish.ImageKit[] out_images) |
|
bool | ShowInformation (out string out_title, out string out_author, out string out_subject, out string out_creator) |
|
bool | ShowJavaScript (out string[] out_script_names, out string[] out_sources, out HPS.Publish.Source.Type[] out_types) |
|
bool | ShowPages (out HPS.Publish.PageKit[] out_pages) |
|
bool | ShowPasswords (out string out_user_password, out string out_owner_password) |
|
bool | ShowPermissions (out HPS.Publish.Permission.Type[] out_permissions) |
|
HPS.Publish.DocumentKit | UnsetAttachment (string in_filename) |
|
HPS.Publish.DocumentKit | UnsetAttachments (string[] in_filenames) |
|
HPS.Publish.DocumentKit | UnsetAttachments () |
|
HPS.Publish.DocumentKit | UnsetDatatables () |
|
HPS.Publish.DocumentKit | UnsetEverything () |
|
HPS.Publish.DocumentKit | UnsetIconImage (string in_name) |
|
HPS.Publish.DocumentKit | UnsetIconImages (string[] in_names) |
|
HPS.Publish.DocumentKit | UnsetIconImages () |
|
HPS.Publish.DocumentKit | UnsetInformation () |
|
HPS.Publish.DocumentKit | UnsetJavaScript (string in_script_name) |
|
HPS.Publish.DocumentKit | UnsetJavaScript (string[] in_script_names) |
|
HPS.Publish.DocumentKit | UnsetJavaScript () |
|
HPS.Publish.DocumentKit | UnsetPage (ulong in_index) |
|
HPS.Publish.DocumentKit | UnsetPages (ulong[] in_indices) |
|
HPS.Publish.DocumentKit | UnsetPages () |
|
HPS.Publish.DocumentKit | UnsetPasswords () |
|
HPS.Publish.DocumentKit | UnsetPermissions () |
|
| SprocketKit (HPS.SprocketKit in_that) |
|
| Sprocket (HPS.Sprocket in_that) |
|
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 DocumentKit class is a user space object. It acts as the root container for all pages in a Publish PDF.
◆ DocumentKit() [1/2]
HPS.Publish.DocumentKit.DocumentKit |
( |
| ) |
|
|
inline |
The default constructor creates an empty DocumentKit object.
◆ DocumentKit() [2/2]
The copy constructor creates a new DocumentKit object that contains the same settings as the source DocumentKit.
- 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 DocumentKit.
◆ AddAttachments()
HPS.Publish.DocumentKit HPS.Publish.DocumentKit.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 DocumentKit.
◆ AddDataTable()
Adds an data table to the document.
- Parameters
-
in_data_table | Data Table to be added into the document. |
- Returns
- A reference to this DocumentKit.
◆ AddDataTables()
Adds data tables to the document.
- Parameters
-
in_data_table | Data Tables to be added into the document. |
- Returns
- A reference to this DocumentKit.
◆ 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 DocumentKit.
◆ 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 DocumentKit.
◆ 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 DocumentKit.
◆ 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 DocumentKit.
◆ 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 DocumentKit.
◆ AddPage()
◆ AddPages()
◆ Empty()
override bool HPS.Publish.DocumentKit.Empty |
( |
| ) |
|
|
inlinevirtual |
Indicates whether this DocumentKit has any values set on it.
- Returns
- true if no values are set on this DocumentKit, false otherwise.
Reimplemented from HPS.Object.
◆ Equals()
Check if the source DocumentKit is equivalent to this DocumentKit.
- Parameters
-
- Returns
- true if the objects are equivalent, false otherwise.
◆ 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.
- Returns
- A DocumentKit with the default settings.
◆ ObjectType()
override HPS.Type HPS.Publish.DocumentKit.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.SprocketKit.
◆ Set()
◆ SetInformation()
HPS.Publish.DocumentKit HPS.Publish.DocumentKit.SetInformation |
( |
string |
in_title, |
|
|
string |
in_author, |
|
|
string |
in_subject, |
|
|
string |
in_creator |
|
) |
| |
|
inline |
◆ SetPage()
◆ SetPages()
◆ 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 DocumentKit.
◆ SetPermissions()
◆ Show()
◆ ShowDataTables()
Shows data tables on the document
- Parameters
-
out_data_tables | Data tables on the document. |
- Returns
- true if data tables were set, false otherwise.
◆ ShowInformation()
bool HPS.Publish.DocumentKit.ShowInformation |
( |
out string |
out_title, |
|
|
out string |
out_author, |
|
|
out string |
out_subject, |
|
|
out string |
out_creator |
|
) |
| |
|
inline |
Shows the document title, author, subject and creator.
- Parameters
-
out_title | Title of the document |
out_author | Author of the document |
out_subject | Subject of the document |
out_creator | Creator of the document |
- Returns
- true if a title, author, subject and creator were specified, false otherwise.
◆ ShowPages()
Shows the pages on the document.
- Parameters
-
out_pages | Pages on the document. |
- Returns
- true if pages were specified, false otherwise.
◆ ShowPasswords()
bool HPS.Publish.DocumentKit.ShowPasswords |
( |
out string |
out_user_password, |
|
|
out string |
out_owner_password |
|
) |
| |
|
inline |
Shows the document passwords.
- Parameters
-
out_user_password | User password of the document. |
out_owner_password | Owner password of the document. |
- Returns
- true if passwords were specified, false otherwise.
◆ ShowPermissions()
Shows permissions on the document
- Parameters
-
out_permissions | Permissions on the document. |
- Returns
- true if permissions were specified, false otherwise.
◆ UnsetAttachment()
Removes the attachment with a given filename from the document.
- Parameters
-
in_filename | UTF8-encoded filename of attachment to remove from the document. |
- Returns
- A reference to this DocumentKit.
◆ UnsetAttachments() [1/2]
Removes the attachments with the given filenames from the document.
- Parameters
-
in_filenames | Filenames of attachments to remove from the document. |
- Returns
- A reference to this DocumentKit.
◆ UnsetAttachments() [2/2]
Removes all attachments from the document.
- Returns
- A reference to this DocumentKit.
◆ UnsetDatatables()
Removes Data Table settings from the document.
- Returns
- A reference to this DocumentKit.
◆ UnsetEverything()
Removes all data from the document.
- Returns
- A reference to this DocumentKit.
◆ UnsetIconImage()
Removes the icon image with a given name from the document.
- Parameters
-
in_name | UTF8-encoded name of icon image to remove from the document. |
- Returns
- A reference to this DocumentKit.
◆ UnsetIconImages() [1/2]
Removes the icon images with the given names from the document.
- Parameters
-
in_names | Names of icon images to remove from the document. |
- Returns
- A reference to this DocumentKit.
◆ UnsetIconImages() [2/2]
Removes all icon images from the document.
- Returns
- A reference to this DocumentKit.
◆ UnsetInformation()
Removes the document title, author, subject and creator.
- Returns
- A reference to this DocumentKit.
◆ UnsetJavaScript() [1/3]
Removes the script with a given name from the document.
- Parameters
-
in_script_name | UTF8-encoded script name to remove from the document. |
- Returns
- A reference to this DocumentKit.
◆ UnsetJavaScript() [2/3]
Removes the scripts with the given names from the document.
- Parameters
-
in_script_names | Script names to remove from the document. |
- Returns
- A reference to this DocumentKit.
◆ UnsetJavaScript() [3/3]
Removes all scripts from the document.
- Returns
- A reference to this DocumentKit.
◆ UnsetPage()
Removes the page at the given index from the document.
- Parameters
-
in_index | Index of the page to remove from the document. |
- Returns
- A reference to this DocumentKit.
◆ UnsetPages() [1/2]
Removes the pages at the given indices from the document.
- Parameters
-
in_indices | Indices of the pages to remove from the document. |
- Returns
- A reference to this DocumentKit.
◆ UnsetPages() [2/2]
Removes all pages from the document.
- Returns
- A reference to this DocumentKit.
◆ UnsetPasswords()
Removes the document passwords.
- Returns
- A reference to this DocumentKit.
◆ UnsetPermissions()
Removes permission settings from the document.
- Returns
- A reference to this DocumentKit.
The documentation for this class was generated from the following file:
- internals/hps_sprk_publish/source/cs/HPS.Publish.cs