< Home

< Table of Contents

REFERENCE MANUAL

HPS.Publish.DocumentKit Class Reference

The DocumentKit class is a user space object. More...

Inheritance diagram for HPS.Publish.DocumentKit:
HPS.Sprocket HPS.Object

Public Member Functions

HPS.Publish.DocumentKit AddAttachment (string in_filename, string in_description)
 Adds an attachment to the document. More...
 
HPS.Publish.DocumentKit AddAttachments (string[] in_filenames, string[] in_descriptions)
 Adds a list of attachments to the document. More...
 
HPS.Publish.DocumentKit AddIconImage (string in_name, HPS.Publish.ImageKit in_image)
 Adds an icon image to the document. More...
 
HPS.Publish.DocumentKit AddIconImages (string[] in_names, HPS.Publish.ImageKit[] in_images)
 Adds icon images to the document. 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. More...
 
HPS.Publish.DocumentKit AddJavaScript (string in_script_name, string in_source)
 Adds a named JavaScript source or file to the document. 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. More...
 
HPS.Publish.DocumentKit AddPage (HPS.Publish.PageKit in_page)
 Adds the given page to the document. More...
 
HPS.Publish.DocumentKit AddPages (HPS.Publish.PageKit[] in_pages)
 Adds the given pages to the document. 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. 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. More...
 
HPS.Publish.DocumentKit SetPage (HPS.Publish.PageKit in_page)
 Adds the given page to the document. More...
 
HPS.Publish.DocumentKit SetPages (HPS.Publish.PageKit[] in_pages)
 Adds the given pages to the document. More...
 
HPS.Publish.DocumentKit SetPasswords (string in_user_password, string in_owner_password)
 Sets the passwords for this document. More...
 
HPS.Publish.DocumentKit SetPermissions (HPS.Publish.Permission.Type[] in_permissions)
 Sets document permissions. 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...
 
- Public Member Functions inherited from HPS.Sprocket
 Sprocket (HPS.Sprocket in_that)
 
- Public Member Functions inherited from HPS.Object
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 HPS.Publish.DocumentKit GetDefault ()
 Creates a DocumentKit which contains the default settings. More...
 
static bool operator!= (HPS.Publish.DocumentKit a, HPS.Publish.DocumentKit b)
 
static bool operator== (HPS.Publish.DocumentKit a, HPS.Publish.DocumentKit b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Public Types inherited from HPS.Sprocket
enum  UpdateType { Synchronous = 0, Asynchronous = 1 }
 
- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 
HandleRef scptr
 

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

HPS.Publish.DocumentKit.DocumentKit ( )

The default constructor creates an empty DocumentKit object.

HPS.Publish.DocumentKit.DocumentKit ( HPS.Publish.DocumentKit  in_kit)

The copy constructor creates a new DocumentKit object that contains the same settings as the source DocumentKit.

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_publish_1_1_document_kit" kindref="compound">DocumentKit</ref> to copy.

Member Function Documentation

HPS.Publish.DocumentKit 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>.

Parameters
in_filenameUTF8-encoded filename of the file to be attached.
in_descriptionUTF8-encoded description of the file to be attached.
Returns
A reference to this DocumentKit.
HPS.Publish.DocumentKit 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>.

Parameters
in_countSize of the following arrays.
in_filenamesFilenames of the files to be attached.
in_descriptionsDescriptions of the files to be attached.
Returns
A reference to this DocumentKit.
HPS.Publish.DocumentKit 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>.

Parameters
in_nameUTF8-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.
Returns
A reference to this DocumentKit.
HPS.Publish.DocumentKit 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>.

Parameters
in_countSize of the following arrays.
in_namesNames of the icon images to be attached.
in_imagesImages to be attached as icons.
Returns
A reference to this DocumentKit.
HPS.Publish.DocumentKit 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>.

Parameters
in_script_nameUTF8-encoded script name to be added to the document.
in_sourceUTF8-encoded JavaScript source or file (depending on the following argument) to be added to the document.
in_typeThe 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>.
Returns
A reference to this DocumentKit.
HPS.Publish.DocumentKit 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>.

Parameters
in_script_nameUTF8-encoded script name to be added to the document.
in_sourceUTF8-encoded JavaScript source or file (depending on the following argument) to be added to the document.
Returns
A reference to this DocumentKit.
HPS.Publish.DocumentKit 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>.

Parameters
in_countSize of the following arrays.
in_script_namesScript names to be added to the document.
in_sourcesJavaScript sources and/or files (depending on the corresponding entry in the following argument) to be added to the document.
in_typesTypes for each item in the preceding argument array.
Returns
A reference to this DocumentKit.
HPS.Publish.DocumentKit 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>.

Parameters
in_page<ref refid="class_h_p_s_1_1_publish_1_1_page" kindref="compound">Page</ref> to add to the document.
Returns
A reference to this DocumentKit.
HPS.Publish.DocumentKit 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>.

Parameters
in_countSize of the following array.
in_pagesPages to add to the document.
Returns
A reference to this DocumentKit.
override bool HPS.Publish.DocumentKit.Empty ( )
virtual

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.

bool HPS.Publish.DocumentKit.Equals ( HPS.Publish.DocumentKit  in_kit)

Check if the source DocumentKit is equivalent to this DocumentKit.

Parameters
in_kitThe 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>.
Returns
true if the objects are equivalent, false otherwise.
static HPS.Publish.DocumentKit HPS.Publish.DocumentKit.GetDefault ( )
static

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.
override HPS.Type HPS.Publish.DocumentKit.ObjectType ( )
virtual

This function returns the type the object, as declared.

This does not necessarily give the true type of the underlying object.

Returns
The declared type of the object in question, which may differ from the true, underlying type.

Reimplemented from HPS.Object.

void HPS.Publish.DocumentKit.Set ( HPS.Publish.DocumentKit  in_kit)

Copies the source DocumentKit into this DocumentKit.

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_publish_1_1_document_kit" kindref="compound">DocumentKit</ref> to copy.
HPS.Publish.DocumentKit 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).

Parameters
in_titleUTF8-encoded title string to set on the document.
in_authorUTF8-encoded author string to set on the document.
in_subjectUTF8-encoded subject string to set on the document.
in_creatorUTF8-encoded creator string to set on the document.
Returns
A reference to this DocumentKit.
HPS.Publish.DocumentKit 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>.

Parameters
in_page<ref refid="class_h_p_s_1_1_publish_1_1_page" kindref="compound">Page</ref> to add to the document.
Returns
A reference to this DocumentKit.
HPS.Publish.DocumentKit 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>.

Parameters
in_countSize of the following array.
in_pagesPages to add to the document.
Returns
A reference to this DocumentKit.
HPS.Publish.DocumentKit 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>.

Parameters
in_user_passwordUTF8-encoded password string required when opening, modifying or printing the document. If an empty string is specified, no password will be required.
in_owner_passwordUTF8-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.
HPS.Publish.DocumentKit 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>.

Parameters
in_countSize of the following array.
in_permissionsThe permissions to be set on the document.
Returns
A reference to this DocumentKit.
void HPS.Publish.DocumentKit.Show ( out HPS.Publish.DocumentKit  out_kit)

Copies this DocumentKit into the given DocumentKit.

Parameters
out_kitThe <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>.
bool HPS.Publish.DocumentKit.ShowAttachments ( out string[]  out_filenames,
out string[]  out_descriptions 
)

Shows the attachments on the document.

Parameters
out_filenamesFilenames of the attachments on the document.
out_descriptionsDescriptions of the attachments on the document.
Returns
true if attachments were specified, false otherwise.
bool HPS.Publish.DocumentKit.ShowIconImages ( out string[]  out_names,
out HPS.Publish.ImageKit[]  out_images 
)

Shows the icon images on the document.

Parameters
out_namesNames of the icon images on the document.
out_imagesIcon images on the document.
Returns
true if icon images were specified, false otherwise.
bool HPS.Publish.DocumentKit.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.

Parameters
out_titleTitle of the document
out_authorAuthor of the document
out_subjectSubject of the document
out_creatorCreator of the document
Returns
true if a title, author, subject and creator were specified, false otherwise.
bool HPS.Publish.DocumentKit.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.

Parameters
out_script_namesScript names on the document.
out_sourcesJavaScript sources and/or files on the document.
out_typesTypes for each item in the preceding array.
Returns
true if scripts were specified, false otherwise.
bool HPS.Publish.DocumentKit.ShowPages ( out HPS.Publish.PageKit[]  out_pages)

Shows the pages on the document.

Parameters
out_pagesPages on the document.
Returns
true if pages were specified, false otherwise.
bool HPS.Publish.DocumentKit.ShowPasswords ( out string  out_user_password,
out string  out_owner_password 
)

Shows the document passwords.

Parameters
out_user_passwordUser password of the document.
out_owner_passwordOwner password of the document.
Returns
true if passwords were specified, false otherwise.
bool HPS.Publish.DocumentKit.ShowPermissions ( out HPS.Publish.Permission.Type[]  out_permissions)

Shows permissions on the document

Parameters
out_permissionsPermissions on the document.
Returns
true if permissions were specified, false otherwise.
HPS.Publish.DocumentKit HPS.Publish.DocumentKit.UnsetAttachment ( string  in_filename)

Removes the attachment with a given filename from the document.

Parameters
in_filenameUTF8-encoded filename of attachment to remove from the document.
Returns
A reference to this DocumentKit.
HPS.Publish.DocumentKit HPS.Publish.DocumentKit.UnsetAttachments ( string[]  in_filenames)

Removes the attachments with the given filenames from the document.

Parameters
in_countSize of the following array.
in_filenamesFilenames of attachments to remove from the document.
Returns
A reference to this DocumentKit.
HPS.Publish.DocumentKit HPS.Publish.DocumentKit.UnsetAttachments ( )

Removes all attachments from the document.

Returns
A reference to this DocumentKit.
HPS.Publish.DocumentKit HPS.Publish.DocumentKit.UnsetEverything ( )

Removes all data from the document.

Returns
A reference to this DocumentKit.
HPS.Publish.DocumentKit HPS.Publish.DocumentKit.UnsetIconImage ( string  in_name)

Removes the icon image with a given name from the document.

Parameters
in_nameUTF8-encoded name of icon image to remove from the document.
Returns
A reference to this DocumentKit.
HPS.Publish.DocumentKit HPS.Publish.DocumentKit.UnsetIconImages ( string[]  in_names)

Removes the icon images with the given names from the document.

Parameters
in_countSize of the following array.
in_namesNames of icon images to remove from the document.
Returns
A reference to this DocumentKit.
HPS.Publish.DocumentKit HPS.Publish.DocumentKit.UnsetIconImages ( )

Removes all icon images from the document.

Returns
A reference to this DocumentKit.
HPS.Publish.DocumentKit HPS.Publish.DocumentKit.UnsetInformation ( )

Removes the document title, author, subject and creator.

Returns
A reference to this DocumentKit.
HPS.Publish.DocumentKit HPS.Publish.DocumentKit.UnsetJavaScript ( string  in_script_name)

Removes the script with a given name from the document.

Parameters
in_script_nameUTF8-encoded script name to remove from the document.
Returns
A reference to this DocumentKit.
HPS.Publish.DocumentKit HPS.Publish.DocumentKit.UnsetJavaScript ( string[]  in_script_names)

Removes the scripts with the given names from the document.

Parameters
in_countSize of the following array.
in_script_namesScript names to remove from the document.
Returns
A reference to this DocumentKit.
HPS.Publish.DocumentKit HPS.Publish.DocumentKit.UnsetJavaScript ( )

Removes all scripts from the document.

Returns
A reference to this DocumentKit.
HPS.Publish.DocumentKit HPS.Publish.DocumentKit.UnsetPage ( ulong  in_index)

Removes the page at the given index from the document.

Parameters
in_indexIndex of the page to remove from the document.
Returns
A reference to this DocumentKit.
HPS.Publish.DocumentKit HPS.Publish.DocumentKit.UnsetPages ( ulong[]  in_indices)

Removes the pages at the given indices from the document.

Parameters
in_countSize of the following array.
in_indicesIndices of the pages to remove from the document.
Returns
A reference to this DocumentKit.
HPS.Publish.DocumentKit HPS.Publish.DocumentKit.UnsetPages ( )

Removes all pages from the document.

Returns
A reference to this DocumentKit.
HPS.Publish.DocumentKit HPS.Publish.DocumentKit.UnsetPasswords ( )

Removes the document passwords.

Returns
A reference to this DocumentKit.
HPS.Publish.DocumentKit HPS.Publish.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: