HPDFLayoutManager Class Reference

#include <HIOUtilityPublish.h>

Public Member Functions

void AddImageModification (const wchar_t *name, const wchar_t *imagename, HPDFLayoutImageType imagetype, int imagewidth, int imageheight)
 
void AddMiscModification (const wchar_t *name, wchar_t *javascript=0, HPDFLayoutVisibility visibility=HUnchanged)
 
void AddTextModification (const wchar_t *name, const wchar_t *text)
 
wchar_t * Get3DFieldName ()
 
vlist_s * GetFieldModificationList ()
 
wchar_t * GetTemplateName ()
 
 HPDFLayoutManager ()
 
void Set3DFieldName (const wchar_t *name)
 
void SetTemplateName (const wchar_t *name)
 
 ~HPDFLayoutManager ()
 

Detailed Description

The HPDFLayoutManager class allows for modifications of an existing PDF template

Constructor & Destructor Documentation

◆ HPDFLayoutManager()

HPDFLayoutManager::HPDFLayoutManager ( )
inline

Constructs an HPDFLayoutManager object.

◆ ~HPDFLayoutManager()

HPDFLayoutManager::~HPDFLayoutManager ( )
inline

HPDFLayoutManager destructor.

Member Function Documentation

◆ AddImageModification()

void HPDFLayoutManager::AddImageModification ( const wchar_t *  name,
const wchar_t *  imagename,
HPDFLayoutImageType  imagetype,
int  imagewidth,
int  imageheight 
)
inline

This method allows the user to change the image of a PDF form field

Parameters
nameName of PDF form field
imagenameFull path to the image
imagetypeType of image
imagewidthWidth of Image
imageheightHeight of Image

◆ AddMiscModification()

void HPDFLayoutManager::AddMiscModification ( const wchar_t *  name,
wchar_t *  javascript = 0,
HPDFLayoutVisibility  visibility = HUnchanged 
)
inline

This method allows the user to attach javascript to a field and change its visibility

Parameters
nameName of PDF form field
javascriptJavascript code to attach to this PDF form field
visibilityNew visibility setting for this PDF form field.

◆ AddTextModification()

void HPDFLayoutManager::AddTextModification ( const wchar_t *  name,
const wchar_t *  text 
)
inline

This method allows the user to change the text of a PDF form field

Parameters
nameName of PDF form field
textNew text of PDF form field
isTextSpecifies if PDF form field to modify is text field or button

◆ Get3DFieldName()

wchar_t* HPDFLayoutManager::Get3DFieldName ( )
inline
Returns
A pointer to the PDF field name for the 3d object.

◆ GetFieldModificationList()

vlist_s* HPDFLayoutManager::GetFieldModificationList ( )
inline
Returns
A pointer to the list of field modifications.

◆ GetTemplateName()

wchar_t* HPDFLayoutManager::GetTemplateName ( )
inline
Returns
A pointer to the template name

◆ Set3DFieldName()

void HPDFLayoutManager::Set3DFieldName ( const wchar_t *  name)
inline

This method sets the name of the PDF field which serves as the 3D container

Parameters
nameName of PDF field

◆ SetTemplateName()

void HPDFLayoutManager::SetTemplateName ( const wchar_t *  name)
inline

This method sets the filename of the template to modify

Parameters
nameFully qualified path of PDF template

The documentation for this class was generated from the following file: