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

Public Member Functions

HPS.Publish.DocumentKey AddAttachment (string in_filename, string in_description)
 
HPS.Publish.DocumentKey AddAttachments (string[] in_filenames, string[] in_descriptions)
 
HPS.Publish.DocumentKey AddIconImage (string in_name, HPS.Publish.ImageKit in_image)
 
HPS.Publish.DocumentKey AddIconImages (string[] in_names, HPS.Publish.ImageKit[] in_images)
 
HPS.Publish.DocumentKey AddJavaScript (string in_script_name, string in_source, HPS.Publish.Source.Type in_type)
 
HPS.Publish.DocumentKey AddJavaScript (string in_script_name, string in_source)
 
HPS.Publish.DocumentKey AddJavaScript (string[] in_script_names, string[] in_sources, HPS.Publish.Source.Type[] in_types)
 
HPS.Publish.DocumentKey AddPage (HPS.Publish.PageKit in_page)
 
HPS.Publish.DocumentKey AddPages (HPS.Publish.PageKit[] in_pages)
 
virtual void Assign (HPS.Publish.DocumentKey in_that)
 
void Delete ()
 
override void Dispose ()
 
 DocumentKey ()
 
 DocumentKey (HPS.Publish.DocumentKey in_that)
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.Publish.DocumentKey in_that)
 
override int GetHashCode ()
 
HPS.Publish.PageControl GetPageControl (ulong in_index)
 
ulong GetPageCount ()
 
override HPS.Type ObjectType ()
 
HPS.Publish.DocumentKey RemoveAllPages ()
 
HPS.Publish.DocumentKey RemovePage (ulong in_index)
 
HPS.Publish.DocumentKey RemovePages (ulong in_start, ulong in_count)
 
HPS.Publish.DocumentKey RemovePages (ulong[] in_indices)
 
HPS.Publish.DocumentKey SetInformation (string in_title, string in_author, string in_subject, string in_creator)
 
HPS.Publish.DocumentKey SetPasswords (string in_user_password, string in_owner_password)
 
HPS.Publish.DocumentKey SetPermissions (HPS.Publish.Permission.Type[] in_permissions)
 
- Public Member Functions inherited from HPS.Sprocket
Sprocket (HPS.Sprocket in_that)
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
Object (HPS.Object that)
 
virtual void Reset ()
 
virtual HPS.Type Type ()
 

Static Public Member Functions

static bool operator!= (HPS.Publish.DocumentKey a, HPS.Publish.DocumentKey b)
 
static bool operator== (HPS.Publish.DocumentKey a, HPS.Publish.DocumentKey b)
 
- Static 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

- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

Detailed Description

The DocumentKey class is a smart pointer to a Publish PDF document. It allows direct interaction with a PDF document.

Constructor & Destructor Documentation

◆ DocumentKey() [1/2]

HPS.Publish.DocumentKey.DocumentKey ( )
inline

The default constructor creates an uninitialized DocumentKey object. The Type() function will return Type.None.

◆ DocumentKey() [2/2]

HPS.Publish.DocumentKey.DocumentKey ( HPS.Publish.DocumentKey  in_that)
inline

The copy constructor creates a DocumentKey object that shares the underlying smart-pointer of the source DocumentKey.

Parameters
in_thatThe source DocumentKey to copy.

Member Function Documentation

◆ AddAttachment()

HPS.Publish.DocumentKey HPS.Publish.DocumentKey.AddAttachment ( string  in_filename,
string  in_description 
)
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_filenameUTF8-encoded filename of the file to be attached.
in_descriptionUTF8-encoded description of the file to be attached.
Returns
A reference to this DocumentKey.

◆ AddAttachments()

HPS.Publish.DocumentKey HPS.Publish.DocumentKey.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_filenamesFilenames of the files to be attached.
in_descriptionsDescriptions of the files to be attached.
Returns
A reference to this DocumentKey.

◆ AddIconImage()

HPS.Publish.DocumentKey HPS.Publish.DocumentKey.AddIconImage ( string  in_name,
HPS.Publish.ImageKit  in_image 
)
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_nameUTF8-encoded name of the icon image to be attached.
in_imageImage to be attached as an icon.
Returns
A reference to this DocumentKey.

◆ AddIconImages()

HPS.Publish.DocumentKey HPS.Publish.DocumentKey.AddIconImages ( string []  in_names,
HPS.Publish.ImageKit []  in_images 
)
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_namesNames of the icon images to be attached.
in_imagesImages to be attached as icons.
Returns
A reference to this DocumentKey.

◆ AddJavaScript() [1/3]

HPS.Publish.DocumentKey HPS.Publish.DocumentKey.AddJavaScript ( string  in_script_name,
string  in_source,
HPS.Publish.Source.Type  in_type 
)
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_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 Source.Type.Code.
Returns
A reference to this DocumentKey.

◆ AddJavaScript() [2/3]

HPS.Publish.DocumentKey HPS.Publish.DocumentKey.AddJavaScript ( string  in_script_name,
string  in_source 
)
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_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 DocumentKey.

◆ AddJavaScript() [3/3]

HPS.Publish.DocumentKey HPS.Publish.DocumentKey.AddJavaScript ( string []  in_script_names,
string []  in_sources,
HPS.Publish.Source.Type []  in_types 
)
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_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 DocumentKey.

◆ AddPage()

HPS.Publish.DocumentKey HPS.Publish.DocumentKey.AddPage ( HPS.Publish.PageKit  in_page)
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_pagePage to add to the document.
Returns
A reference to this DocumentKey.

◆ AddPages()

HPS.Publish.DocumentKey HPS.Publish.DocumentKey.AddPages ( HPS.Publish.PageKit []  in_pages)
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_pagesPages to add to the document.
Returns
A reference to this DocumentKey.

◆ Assign()

virtual void HPS.Publish.DocumentKey.Assign ( HPS.Publish.DocumentKey  in_that)
inlinevirtual

Share the underlying smart-pointer of the DocumentKey source.

Parameters
in_thatThe DocumentKey source of the assignment.
Returns
A reference to this DocumentKey.

◆ Delete()

void HPS.Publish.DocumentKey.Delete ( )
inline

Closes the PDF document underlying this DocumentKey and frees the associated memory in Publish. This will effectively invalidate all references to the underlying PDF document (including other DocumentKey or PageControl objects which refer to the same document). This will not write the underlying PDF document out to disk.

◆ Equals()

bool HPS.Publish.DocumentKey.Equals ( HPS.Publish.DocumentKey  in_that)
inline

Check if the source DocumentKey points to the same underlying impl as this DocumentKey.

Parameters
in_thatThe source DocumentKey to compare to this DocumentKey.
Returns
true if the objects reference the same impl, false otherwise.

◆ GetPageControl()

HPS.Publish.PageControl HPS.Publish.DocumentKey.GetPageControl ( ulong  in_index)
inline

Returns a control that allows the user to manipulate and query details of a page at the given index in the underlying PDF document.

Parameters
in_indexThe index of the page for which to create a PageControl. The index of the first page is 0.
Returns
A PageControl object for the specified page.

◆ GetPageCount()

ulong HPS.Publish.DocumentKey.GetPageCount ( )
inline

Gets the number of pages in the underlying PDF document.

◆ ObjectType()

override HPS.Type HPS.Publish.DocumentKey.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.Object.

◆ RemoveAllPages()

HPS.Publish.DocumentKey HPS.Publish.DocumentKey.RemoveAllPages ( )
inline

Removes all pages from the underlying PDF document.

Returns
A reference to this DocumentKey.

◆ RemovePage()

HPS.Publish.DocumentKey HPS.Publish.DocumentKey.RemovePage ( ulong  in_index)
inline

Removes the page at the given index from the underlying PDF document.

Parameters
in_indexThe index of the page to remove from the underlying PDF document. The index of the first page is 0.
Returns
A reference to this DocumentKey.

◆ RemovePages() [1/2]

HPS.Publish.DocumentKey HPS.Publish.DocumentKey.RemovePages ( ulong  in_start,
ulong  in_count 
)
inline

Removes the specified number of pages starting at the given index from the underlying PDF document.

Parameters
in_startThe first index at which to start to removing pages from the underlying PDF document. The index of the first page is 0.
in_countThe number of pages to remove from the underlying PDF document.
Returns
A reference to this DocumentKey.

◆ RemovePages() [2/2]

HPS.Publish.DocumentKey HPS.Publish.DocumentKey.RemovePages ( ulong []  in_indices)
inline

Removes the pages at the given indices from the underlying PDF document.

Parameters
in_indicesThe indices of pages to remove from the underlying PDF document. The index of the first page is 0.
Returns
A reference to this DocumentKey.

◆ SetInformation()

HPS.Publish.DocumentKey HPS.Publish.DocumentKey.SetInformation ( string  in_title,
string  in_author,
string  in_subject,
string  in_creator 
)
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_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 DocumentKey.

◆ SetPasswords()

HPS.Publish.DocumentKey HPS.Publish.DocumentKey.SetPasswords ( string  in_user_password,
string  in_owner_password 
)
inline

Sets the passwords for this document. This corresponds to the value that will be passed to A3DPDFDocumentSetPassword.

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 DocumentKey.

◆ SetPermissions()

HPS.Publish.DocumentKey HPS.Publish.DocumentKey.SetPermissions ( HPS.Publish.Permission.Type []  in_permissions)
inline

Sets document permissions. This correspond to the values that will be passed to A3DPDFDocumentSetDocumentPermissions.

Parameters
in_permissionsThe permissions to be set on the document.
Returns
A reference to this DocumentKey.

The documentation for this class was generated from the following file:
  • internals/hps_sprk_publish/source/cs/HPS.Publish.cs