
Public Member Functions | |
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 A3DPDFDocumentAddFileAttachment. 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 A3DPDFDocumentAddFileAttachment. 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 A3DPDFDocumentAddImageAsIcon. 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 A3DPDFDocumentAddImageAsIcon. 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 A3DPDFDocumentAddJavascriptFromString. 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 A3DPDFDocumentAddJavascriptFromString. 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 A3DPDFDocumentAddJavascriptFromString. 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 A3DPDFDocumentAppendNewPage or A3DPDFDocumentAppendPageFromPDFFileEx. 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 A3DPDFDocumentAppendNewPage or A3DPDFDocumentAppendPageFromPDFFileEx. More... | |
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 bool | Empty () |
Indicates whether this DocumentKit has any values set on it. More... | |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.Publish.DocumentKit in_kit) |
Check if the source DocumentKit is equivalent to this DocumentKit. More... | |
override int | GetHashCode () |
override HPS.Type | ObjectType () |
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). More... | |
void | Set (HPS.Publish.DocumentKit in_kit) |
Copies the source DocumentKit into 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 A3DPDFDocumentInformationData::m_pcTitle, A3DPDFDocumentInformationData::m_pcAuthor, A3DPDFDocumentInformationData::m_pcSubject, and A3DPDFDocumentInformationData::m_pcCreator (respectively). 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 A3DPDFDocumentAppendNewPage or A3DPDFDocumentAppendPageFromPDFFileEx. 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 A3DPDFDocumentAppendNewPage or A3DPDFDocumentAppendPageFromPDFFileEx. 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 A3DPDFDocumentSetPassword. More... | |
HPS.Publish.DocumentKit | SetPermissions (HPS.Publish.Permission.Type[] in_permissions) |
Sets document permissions. This correspond to the values that will be passed to A3DPDFDocumentSetDocumentPermissions. More... | |
void | Show (out HPS.Publish.DocumentKit out_kit) |
Copies this DocumentKit into the given DocumentKit. 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 | 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 | 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 | ShowPages (out HPS.Publish.PageKit[] out_pages) |
Shows the pages on the document. More... | |
bool | ShowPasswords (out string out_user_password, out string out_owner_password) |
Shows the document passwords. More... | |
bool | ShowPermissions (out HPS.Publish.Permission.Type[] out_permissions) |
Shows permissions on 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 | UnsetEverything () |
Removes all data 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 | UnsetInformation () |
Removes the document title, author, subject and creator. 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 | 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 | UnsetPasswords () |
Removes the document passwords. More... | |
HPS.Publish.DocumentKit | UnsetPermissions () |
Removes permission settings from the document. More... | |
![]() | |
SprocketKit (HPS.SprocketKit in_that) | |
![]() | |
Sprocket (HPS.Sprocket in_that) | |
![]() | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns the object's database handle, which can be used to determine which instance of a class the object is. For example, controls are simply aliases for segment keys that group related functions. Therefore, a SegmentKey and all of its controls would return the same instance id. Different keys and controls will return the same value if they are backed by the same database resource. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object that) | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
virtual 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... | |
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 | |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
Detailed Description
The DocumentKit class is a user space object. It acts as the root container for all pages in a Publish PDF.
Constructor & Destructor Documentation
◆ DocumentKit() [1/2]
|
inline |
The default constructor creates an empty DocumentKit object.
◆ DocumentKit() [2/2]
|
inline |
The copy constructor creates a new DocumentKit object that contains the same settings as the source DocumentKit.
- Parameters
-
in_kit The source DocumentKit to copy.
Member Function Documentation
◆ AddAttachment()
|
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 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()
|
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.
◆ AddIconImage()
|
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 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()
|
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 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]
|
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 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]
|
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 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]
|
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 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()
|
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 A3DPDFDocumentAppendNewPage or A3DPDFDocumentAppendPageFromPDFFileEx.
- Parameters
-
in_page Page to add to the document.
- Returns
- A reference to this DocumentKit.
◆ AddPages()
|
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 A3DPDFDocumentAppendNewPage or A3DPDFDocumentAppendPageFromPDFFileEx.
- Parameters
-
in_pages Pages to add to the document.
- Returns
- A reference to this 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()
|
inline |
Check if the source DocumentKit is equivalent to this DocumentKit.
- Parameters
-
in_kit The source DocumentKit to compare to this DocumentKit.
- Returns
- true if the objects are equivalent, false otherwise.
◆ GetDefault()
|
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.
- Returns
- A DocumentKit with the default settings.
◆ 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()
|
inline |
Copies the source DocumentKit into this DocumentKit.
- Parameters
-
in_kit The source DocumentKit to copy.
◆ SetInformation()
|
inline |
Sets the title, author, subject and creator for this document. These corresponds to the values that will be passed to A3DPDFDocumentInformationData::m_pcTitle, A3DPDFDocumentInformationData::m_pcAuthor, A3DPDFDocumentInformationData::m_pcSubject, and A3DPDFDocumentInformationData::m_pcCreator (respectively).
- Parameters
-
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.
- Returns
- A reference to this DocumentKit.
◆ SetPage()
|
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 A3DPDFDocumentAppendNewPage or A3DPDFDocumentAppendPageFromPDFFileEx.
- Parameters
-
in_page Page to add to the document.
- Returns
- A reference to this DocumentKit.
◆ SetPages()
|
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 A3DPDFDocumentAppendNewPage or A3DPDFDocumentAppendPageFromPDFFileEx.
- Parameters
-
in_pages Pages to add to the document.
- Returns
- A reference to this DocumentKit.
◆ SetPasswords()
|
inline |
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()
|
inline |
Sets document permissions. This correspond to the values that will be passed to A3DPDFDocumentSetDocumentPermissions.
- Parameters
-
in_permissions The permissions to be set on the document.
- Returns
- A reference to this DocumentKit.
◆ Show()
|
inline |
Copies this DocumentKit into the given DocumentKit.
- Parameters
-
out_kit The DocumentKit to populate with the contents of this DocumentKit.
◆ ShowAttachments()
|
inline |
Shows the attachments on the document.
- Parameters
-
out_filenames Filenames of the attachments on the document. out_descriptions Descriptions of the attachments on the document.
- Returns
- true if attachments were specified, false otherwise.
◆ ShowIconImages()
|
inline |
Shows the icon images on the document.
- Parameters
-
out_names Names of the icon images on the document. out_images Icon images on the document.
- Returns
- true if icon images were specified, false otherwise.
◆ ShowInformation()
|
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.
◆ ShowJavaScript()
|
inline |
Shows the JavaScript sources and/or files on the document.
- Parameters
-
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.
- Returns
- true if scripts were specified, false otherwise.
◆ ShowPages()
|
inline |
Shows the pages on the document.
- Parameters
-
out_pages Pages on the document.
- Returns
- true if pages were specified, false otherwise.
◆ ShowPasswords()
|
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()
|
inline |
Shows permissions on the document
- Parameters
-
out_permissions Permissions on the document.
- Returns
- true if permissions were specified, false otherwise.
◆ UnsetAttachment()
|
inline |
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]
|
inline |
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]
|
inline |
Removes all attachments from the document.
- Returns
- A reference to this DocumentKit.
◆ UnsetEverything()
|
inline |
Removes all data from the document.
- Returns
- A reference to this DocumentKit.
◆ UnsetIconImage()
|
inline |
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]
|
inline |
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]
|
inline |
Removes all icon images from the document.
- Returns
- A reference to this DocumentKit.
◆ UnsetInformation()
|
inline |
Removes the document title, author, subject and creator.
- Returns
- A reference to this DocumentKit.
◆ UnsetJavaScript() [1/3]
|
inline |
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]
|
inline |
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]
|
inline |
Removes all scripts from the document.
- Returns
- A reference to this DocumentKit.
◆ UnsetPage()
|
inline |
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]
|
inline |
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]
|
inline |
Removes all pages from the document.
- Returns
- A reference to this DocumentKit.
◆ UnsetPasswords()
|
inline |
Removes the document passwords.
- Returns
- A reference to this DocumentKit.
◆ UnsetPermissions()
|
inline |
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