Inheritance diagram for HPS.Publish.PageKit:
HPS.SprocketKit HPS.Sprocket HPS.Object

Public Member Functions

HPS.Publish.PageKit AddAnnotation (HPS.Publish.AnnotationKit in_annotation, HPS.IntRectangle in_location)
 
HPS.Publish.PageKit AddAnnotations (HPS.Publish.AnnotationKit[] in_annotations, HPS.IntRectangle[] in_locations)
 
HPS.Publish.PageKit AddButton (HPS.Publish.ButtonKit in_button, HPS.IntRectangle in_location)
 
HPS.Publish.PageKit AddButtons (HPS.Publish.ButtonKit[] in_buttons, HPS.IntRectangle[] in_locations)
 
HPS.Publish.PageKit AddCheckBox (HPS.Publish.CheckBoxKit in_checkbox, HPS.IntRectangle in_location)
 
HPS.Publish.PageKit AddCheckBoxes (HPS.Publish.CheckBoxKit[] in_checkbox, HPS.IntRectangle[] in_locations)
 
HPS.Publish.PageKit AddDropDownList (HPS.Publish.DropDownListKit in_drop_down_list, HPS.IntRectangle in_location)
 
HPS.Publish.PageKit AddDropDownLists (HPS.Publish.DropDownListKit[] in_drop_down_list, HPS.IntRectangle[] in_locations)
 
HPS.Publish.PageKit AddImage (HPS.Publish.ImageKit in_image, HPS.IntRectangle in_location)
 
HPS.Publish.PageKit AddImages (HPS.Publish.ImageKit[] in_images, HPS.IntRectangle[] in_locations)
 
HPS.Publish.PageKit AddLink (HPS.Publish.LinkKit in_link, HPS.IntRectangle in_location)
 
HPS.Publish.PageKit AddLinks (HPS.Publish.LinkKit[] in_links, HPS.IntRectangle[] in_locations)
 
HPS.Publish.PageKit AddListBox (HPS.Publish.ListBoxKit in_list_box, HPS.IntRectangle in_location)
 
HPS.Publish.PageKit AddListBoxes (HPS.Publish.ListBoxKit[] in_list_box, HPS.IntRectangle[] in_locations)
 
HPS.Publish.PageKit AddListItemByField (string in_field, string in_value, string in_export_value)
 
HPS.Publish.PageKit AddListItemsByField (string in_field, string[] in_values, string[] in_export_values)
 
HPS.Publish.PageKit AddRadioButton (HPS.Publish.RadioButtonKit in_radio_button, HPS.IntRectangle in_location)
 
HPS.Publish.PageKit AddRadioButtons (HPS.Publish.RadioButtonKit[] in_radio_buttons, HPS.IntRectangle[] in_locations)
 
HPS.Publish.PageKit AddSignatureField (HPS.Publish.SignatureFieldKit in_signature_field, HPS.IntRectangle in_location)
 
HPS.Publish.PageKit AddSignatureFields (HPS.Publish.SignatureFieldKit[] in_signature_field, HPS.IntRectangle[] in_locations)
 
HPS.Publish.PageKit AddSlideTable (HPS.Publish.SlideTableKit in_slide_table, HPS.IntRectangle in_location)
 
HPS.Publish.PageKit AddSlideTables (HPS.Publish.SlideTableKit[] in_slide_tables, HPS.IntRectangle[] in_locations)
 
HPS.Publish.PageKit AddTable (HPS.Publish.TableKit in_table, HPS.IntRectangle in_location)
 
HPS.Publish.PageKit AddTables (HPS.Publish.TableKit[] in_tables, HPS.IntRectangle[] in_locations)
 
HPS.Publish.PageKit AddText (HPS.Publish.TextKit in_text, HPS.IntRectangle in_location)
 
HPS.Publish.PageKit AddText (HPS.Publish.TextKit[] in_text, HPS.IntRectangle[] in_locations)
 
HPS.Publish.PageKit AddTextField (HPS.Publish.TextFieldKit in_text_field, HPS.IntRectangle in_location)
 
HPS.Publish.PageKit AddTextFields (HPS.Publish.TextFieldKit[] in_text_fields, HPS.IntRectangle[] in_locations)
 
override void Dispose ()
 
override bool Empty ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.Publish.PageKit in_kit)
 
override int GetHashCode ()
 
override HPS.Type ObjectType ()
 
 PageKit ()
 
 PageKit (HPS.Publish.Page.Format in_format, HPS.Publish.Page.Orientation in_orientation)
 
 PageKit (string in_filename)
 
 PageKit (HPS.Publish.PageKit in_kit)
 
void Set (HPS.Publish.PageKit in_kit)
 
HPS.Publish.PageKit SetAnnotation (HPS.Publish.AnnotationKit in_annotation, HPS.IntRectangle in_location)
 
HPS.Publish.PageKit SetAnnotationByField (string in_field, HPS.Publish.AnnotationKit in_annotation)
 
HPS.Publish.PageKit SetAnnotations (HPS.Publish.AnnotationKit[] in_annotations, HPS.IntRectangle[] in_locations)
 
HPS.Publish.PageKit SetAnnotationsByField (string[] in_fields, HPS.Publish.AnnotationKit[] in_annotations)
 
HPS.Publish.PageKit SetButton (HPS.Publish.ButtonKit in_button, HPS.IntRectangle in_location)
 
HPS.Publish.PageKit SetButtonIconByField (string in_field, HPS.Publish.ImageKit in_image)
 
HPS.Publish.PageKit SetButtonIconsByField (string[] in_fields, HPS.Publish.ImageKit[] in_images)
 
HPS.Publish.PageKit SetButtonLabelByField (string in_field, string in_label)
 
HPS.Publish.PageKit SetButtonLabelsByField (string[] in_fields, string[] in_labels)
 
HPS.Publish.PageKit SetButtons (HPS.Publish.ButtonKit[] in_buttons, HPS.IntRectangle[] in_locations)
 
HPS.Publish.PageKit SetCheckBox (HPS.Publish.CheckBoxKit in_checkbox, HPS.IntRectangle in_location)
 
HPS.Publish.PageKit SetCheckBoxes (HPS.Publish.CheckBoxKit[] in_checkbox, HPS.IntRectangle[] in_locations)
 
HPS.Publish.PageKit SetDropDownList (HPS.Publish.DropDownListKit in_drop_down_list, HPS.IntRectangle in_location)
 
HPS.Publish.PageKit SetDropDownLists (HPS.Publish.DropDownListKit[] in_drop_down_list, HPS.IntRectangle[] in_locations)
 
HPS.Publish.PageKit SetFormat (HPS.Publish.Page.Format in_format)
 
HPS.Publish.PageKit SetImage (HPS.Publish.ImageKit in_image, HPS.IntRectangle in_location)
 
HPS.Publish.PageKit SetImages (HPS.Publish.ImageKit[] in_images, HPS.IntRectangle[] in_locations)
 
HPS.Publish.PageKit SetJavaScriptActionByField (string in_field, string in_source, HPS.Publish.Source.Type in_type)
 
HPS.Publish.PageKit SetJavaScriptActionByField (string in_field, string in_source)
 
HPS.Publish.PageKit SetJavaScriptActionsByField (string[] in_fields, string[] in_sources, HPS.Publish.Source.Type[] in_types)
 
HPS.Publish.PageKit SetLink (HPS.Publish.LinkKit in_link, HPS.IntRectangle in_location)
 
HPS.Publish.PageKit SetLinks (HPS.Publish.LinkKit[] in_links, HPS.IntRectangle[] in_locations)
 
HPS.Publish.PageKit SetListBox (HPS.Publish.ListBoxKit in_list_box, HPS.IntRectangle in_location)
 
HPS.Publish.PageKit SetListBoxes (HPS.Publish.ListBoxKit[] in_list_box, HPS.IntRectangle[] in_locations)
 
HPS.Publish.PageKit SetListItemByField (string in_field, string in_value, string in_export_value)
 
HPS.Publish.PageKit SetListItemsByField (string in_field, string[] in_values, string[] in_export_values)
 
HPS.Publish.PageKit SetOrientation (HPS.Publish.Page.Orientation in_orientation)
 
HPS.Publish.PageKit SetRadioButton (HPS.Publish.RadioButtonKit in_radio_button, HPS.IntRectangle in_location)
 
HPS.Publish.PageKit SetRadioButtons (HPS.Publish.RadioButtonKit[] in_radio_buttons, HPS.IntRectangle[] in_locations)
 
HPS.Publish.PageKit SetSignatureField (HPS.Publish.SignatureFieldKit in_signature_field, HPS.IntRectangle in_location)
 
HPS.Publish.PageKit SetSignatureFields (HPS.Publish.SignatureFieldKit[] in_signature_field, HPS.IntRectangle[] in_locations)
 
HPS.Publish.PageKit SetSlideTable (HPS.Publish.SlideTableKit in_slide_table, HPS.IntRectangle in_location)
 
HPS.Publish.PageKit SetSlideTables (HPS.Publish.SlideTableKit[] in_slide_tables, HPS.IntRectangle[] in_locations)
 
HPS.Publish.PageKit SetTable (HPS.Publish.TableKit in_table, HPS.IntRectangle in_location)
 
HPS.Publish.PageKit SetTables (HPS.Publish.TableKit[] in_tables, HPS.IntRectangle[] in_locations)
 
HPS.Publish.PageKit SetTemplateFile (string in_filename)
 
HPS.Publish.PageKit SetText (HPS.Publish.TextKit in_text, HPS.IntRectangle in_location)
 
HPS.Publish.PageKit SetText (HPS.Publish.TextKit[] in_text, HPS.IntRectangle[] in_locations)
 
HPS.Publish.PageKit SetTextField (HPS.Publish.TextFieldKit in_text_field, HPS.IntRectangle in_location)
 
HPS.Publish.PageKit SetTextFields (HPS.Publish.TextFieldKit[] in_text_fields, HPS.IntRectangle[] in_locations)
 
HPS.Publish.PageKit SetTextValueByField (string in_field, string in_value)
 
HPS.Publish.PageKit SetTextValuesByField (string[] in_fields, string[] in_values)
 
HPS.Publish.PageKit SetVisibilitiesByField (string[] in_fields, bool[] in_states)
 
HPS.Publish.PageKit SetVisibilityByField (string in_field, bool in_state)
 
void Show (out HPS.Publish.PageKit out_kit)
 
bool ShowAnnotations (out HPS.Publish.AnnotationKit[] out_annotations, out HPS.IntRectangle[] out_locations)
 
bool ShowAnnotationsByField (out string[] out_fields, out HPS.Publish.AnnotationKit[] out_annotations)
 
bool ShowButtonIconsByField (out string[] out_fields, out HPS.Publish.ImageKit[] out_images)
 
bool ShowButtonLabelsByField (out string[] out_fields, out string[] out_labels)
 
bool ShowButtons (out HPS.Publish.ButtonKit[] out_buttons, out HPS.IntRectangle[] out_locations)
 
bool ShowCheckBoxes (out HPS.Publish.CheckBoxKit[] out_check_boxes, out HPS.IntRectangle[] out_locations)
 
bool ShowDropDownLists (out HPS.Publish.DropDownListKit[] out_drop_down_lists, out HPS.IntRectangle[] out_locations)
 
bool ShowFormat (out HPS.Publish.Page.Format out_format)
 
bool ShowImages (out HPS.Publish.ImageKit[] out_images, out HPS.IntRectangle[] out_locations)
 
bool ShowJavaScriptActionsByField (out string[] out_fields, out string[] out_sources, out HPS.Publish.Source.Type[] out_types)
 
bool ShowLinks (out HPS.Publish.LinkKit[] out_links, out HPS.IntRectangle[] out_locations)
 
bool ShowListBoxes (out HPS.Publish.ListBoxKit[] out_list_boxes, out HPS.IntRectangle[] out_locations)
 
bool ShowListItemFields (out string[] out_fields)
 
bool ShowListItemsByField (string in_field, out string[] out_values, out string[] out_export_values)
 
bool ShowOrientation (out HPS.Publish.Page.Orientation out_orientation)
 
bool ShowRadioButtons (out HPS.Publish.RadioButtonKit[] out_radio_buttons, out HPS.IntRectangle[] out_locations)
 
bool ShowSignatureFields (out HPS.Publish.SignatureFieldKit[] out_signature_fields, out HPS.IntRectangle[] out_locations)
 
bool ShowSlideTables (out HPS.Publish.SlideTableKit[] out_slide_tables, out HPS.IntRectangle[] out_locations)
 
bool ShowTables (out HPS.Publish.TableKit[] out_tables, out HPS.IntRectangle[] out_locations)
 
bool ShowTemplateFile (out string out_filename)
 
bool ShowText (out HPS.Publish.TextKit[] out_text, out HPS.IntRectangle[] out_locations)
 
bool ShowTextFields (out HPS.Publish.TextFieldKit[] out_text_fields, out HPS.IntRectangle[] out_locations)
 
bool ShowTextValuesByField (out string[] out_fields, out string[] out_values)
 
bool ShowVisibilitiesByField (out string[] out_fields, out bool[] out_states)
 
HPS.Publish.PageKit UnsetAnnotation (ulong in_index)
 
HPS.Publish.PageKit UnsetAnnotationByField (string in_field)
 
HPS.Publish.PageKit UnsetAnnotations (ulong[] in_indices)
 
HPS.Publish.PageKit UnsetAnnotations ()
 
HPS.Publish.PageKit UnsetAnnotationsByField (string[] in_fields)
 
HPS.Publish.PageKit UnsetAnnotationsByField ()
 
HPS.Publish.PageKit UnsetButton (ulong in_index)
 
HPS.Publish.PageKit UnsetButtonIconByField (string in_field)
 
HPS.Publish.PageKit UnsetButtonIconsByField (string[] in_fields)
 
HPS.Publish.PageKit UnsetButtonIconsByField ()
 
HPS.Publish.PageKit UnsetButtonLabelByField (string in_field)
 
HPS.Publish.PageKit UnsetButtonLabelsByField (string[] in_fields)
 
HPS.Publish.PageKit UnsetButtonLabelsByField ()
 
HPS.Publish.PageKit UnsetButtons (ulong[] in_indices)
 
HPS.Publish.PageKit UnsetButtons ()
 
HPS.Publish.PageKit UnsetCheckBox (ulong in_index)
 
HPS.Publish.PageKit UnsetCheckBoxes (ulong[] in_indices)
 
HPS.Publish.PageKit UnsetCheckBoxes ()
 
HPS.Publish.PageKit UnsetDropDownList (ulong in_index)
 
HPS.Publish.PageKit UnsetDropDownLists (ulong[] in_indices)
 
HPS.Publish.PageKit UnsetDropDownLists ()
 
HPS.Publish.PageKit UnsetEverything ()
 
HPS.Publish.PageKit UnsetFormat ()
 
HPS.Publish.PageKit UnsetImage (ulong in_index)
 
HPS.Publish.PageKit UnsetImages (ulong[] in_indices)
 
HPS.Publish.PageKit UnsetImages ()
 
HPS.Publish.PageKit UnsetJavaScriptActionByField (string in_field)
 
HPS.Publish.PageKit UnsetJavaScriptActionsByField (string[] in_fields)
 
HPS.Publish.PageKit UnsetJavaScriptActionsByField ()
 
HPS.Publish.PageKit UnsetLink (ulong in_index)
 
HPS.Publish.PageKit UnsetLinks (ulong[] in_indices)
 
HPS.Publish.PageKit UnsetLinks ()
 
HPS.Publish.PageKit UnsetListBox (ulong in_index)
 
HPS.Publish.PageKit UnsetListBoxes (ulong[] in_indices)
 
HPS.Publish.PageKit UnsetListBoxes ()
 
HPS.Publish.PageKit UnsetListItemByField (string in_field, ulong in_index)
 
HPS.Publish.PageKit UnsetListItemsByField (string in_field, ulong[] in_indices)
 
HPS.Publish.PageKit UnsetListItemsByField (string in_field)
 
HPS.Publish.PageKit UnsetListItemsByField (string[] in_fields)
 
HPS.Publish.PageKit UnsetListItemsByField ()
 
HPS.Publish.PageKit UnsetOrientation ()
 
HPS.Publish.PageKit UnsetRadioButton (ulong in_index)
 
HPS.Publish.PageKit UnsetRadioButtons (ulong[] in_indices)
 
HPS.Publish.PageKit UnsetRadioButtons ()
 
HPS.Publish.PageKit UnsetSignatureField (ulong in_index)
 
HPS.Publish.PageKit UnsetSignatureFields (ulong[] in_indices)
 
HPS.Publish.PageKit UnsetSignatureFields ()
 
HPS.Publish.PageKit UnsetSlideTable (ulong in_index)
 
HPS.Publish.PageKit UnsetSlideTables (ulong[] in_indices)
 
HPS.Publish.PageKit UnsetSlideTables ()
 
HPS.Publish.PageKit UnsetTable (ulong in_index)
 
HPS.Publish.PageKit UnsetTables (ulong[] in_indices)
 
HPS.Publish.PageKit UnsetTables ()
 
HPS.Publish.PageKit UnsetTemplateFile ()
 
HPS.Publish.PageKit UnsetText (ulong in_index)
 
HPS.Publish.PageKit UnsetText (ulong[] in_indices)
 
HPS.Publish.PageKit UnsetText ()
 
HPS.Publish.PageKit UnsetTextField (ulong in_index)
 
HPS.Publish.PageKit UnsetTextFields (ulong[] in_indices)
 
HPS.Publish.PageKit UnsetTextFields ()
 
HPS.Publish.PageKit UnsetTextValueByField (string in_field)
 
HPS.Publish.PageKit UnsetTextValuesByField (string[] in_fields)
 
HPS.Publish.PageKit UnsetTextValuesByField ()
 
HPS.Publish.PageKit UnsetVisibilitiesByField (string[] in_fields)
 
HPS.Publish.PageKit UnsetVisibilitiesByField ()
 
HPS.Publish.PageKit UnsetVisibilityByField (string in_field)
 
- Public Member Functions inherited from HPS.SprocketKit
SprocketKit (HPS.SprocketKit in_that)
 
- Public Member Functions inherited from HPS.Sprocket
Sprocket (HPS.Sprocket in_that)
 
- Public Member Functions inherited from HPS.Object
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 HPS.Publish.PageKit GetDefault ()
 
static bool operator!= (HPS.Publish.PageKit a, HPS.Publish.PageKit b)
 
static bool operator== (HPS.Publish.PageKit a, HPS.Publish.PageKit 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 PageKit class is a user space object. It acts as the container for all data that can be on a page in a Publish PDF.

Constructor & Destructor Documentation

◆ PageKit() [1/4]

HPS.Publish.PageKit.PageKit ( )
inline

The default constructor creates an empty PageKit object.

◆ PageKit() [2/4]

HPS.Publish.PageKit.PageKit ( HPS.Publish.Page.Format  in_format,
HPS.Publish.Page.Orientation  in_orientation 
)
inline

This constructor creates a PageKit with the given format and orientation.

Parameters
in_formatFormat of the page.
in_orientationOrientation of the page.

◆ PageKit() [3/4]

HPS.Publish.PageKit.PageKit ( string  in_filename)
inline

This constructor creates a PageKit from the given PDF template file.

Parameters
in_filenameUTF8-encoded filename for the PDF file to act as a template.

◆ PageKit() [4/4]

HPS.Publish.PageKit.PageKit ( HPS.Publish.PageKit  in_kit)
inline

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

Parameters
in_kitThe source PageKit to copy.

Member Function Documentation

◆ AddAnnotation()

HPS.Publish.PageKit HPS.Publish.PageKit.AddAnnotation ( HPS.Publish.AnnotationKit  in_annotation,
HPS.IntRectangle  in_location 
)
inline

Adds an annotation to the page. This will not replace any existing annotations on the page. This corresponds to the value that will be passed to A3DPDFPageInsert3DAnnot.

Parameters
in_annotationAnnotation to add to the page.
in_locationAnnotation location in points relative to bottom left of the page. All fields in the location will be used.
Returns
A reference to this PageKit.

◆ AddAnnotations()

HPS.Publish.PageKit HPS.Publish.PageKit.AddAnnotations ( HPS.Publish.AnnotationKit []  in_annotations,
HPS.IntRectangle []  in_locations 
)
inline

Adds a list of annotations to the page. This will not replace any existing annotations on the page. These correspond to the values that will be passed to A3DPDFPageInsert3DAnnot.

Parameters
in_annotationsAnnotations to add to the page.
in_locationsAnnotation locations in points relative to bottom left of the page.
Returns
A reference to this PageKit.

◆ AddButton()

HPS.Publish.PageKit HPS.Publish.PageKit.AddButton ( HPS.Publish.ButtonKit  in_button,
HPS.IntRectangle  in_location 
)
inline

Adds a button to the page. This will not replace any buttons on the page. This corresponds to the value that will be passed to A3DPDFPageInsertButton.

Parameters
in_buttonButton to add to the page.
in_locationButton location in points relative to bottom left of the page. All fields in the location will be used.
Returns
A reference to this PageKit.

◆ AddButtons()

HPS.Publish.PageKit HPS.Publish.PageKit.AddButtons ( HPS.Publish.ButtonKit []  in_buttons,
HPS.IntRectangle []  in_locations 
)
inline

Adds a list of buttons to the page. This will not replace any buttons on the page. These correspond to values that will be passed to A3DPDFPageInsertButton.

Parameters
in_buttonsButtons to add to the page.
in_locationsButton locations in points relative to bottom left of the page. All fields in the locations will be used.
Returns
A reference to this PageKit.

◆ AddCheckBox()

HPS.Publish.PageKit HPS.Publish.PageKit.AddCheckBox ( HPS.Publish.CheckBoxKit  in_checkbox,
HPS.IntRectangle  in_location 
)
inline

Adds a check box to the page. This will not replace any check boxes on the page. This corresponds to the value that will be passed to A3DPDFPageInsertCheckBox.

Parameters
in_checkboxCheck Box to add to the page.
in_locationCheck Box location in points relative to bottom left of the page. Only the left and bottom fields in the location will be used.
Returns
A reference to this PageKit.

◆ AddCheckBoxes()

HPS.Publish.PageKit HPS.Publish.PageKit.AddCheckBoxes ( HPS.Publish.CheckBoxKit []  in_checkbox,
HPS.IntRectangle []  in_locations 
)
inline

Adds check boxes to the page. This will not replace any check boxes on the page. These correspond to values that will be passed to A3DPDFPageInsertCheckBox.

Parameters
in_checkboxCheck Box to add to the page.
in_locationsCheck Box locations in points relative to bottom left of the page. Only the left and bottom fields in the locations will be used.
Returns
A reference to this PageKit.

◆ AddDropDownList()

HPS.Publish.PageKit HPS.Publish.PageKit.AddDropDownList ( HPS.Publish.DropDownListKit  in_drop_down_list,
HPS.IntRectangle  in_location 
)
inline

Adds a drop down list to the page. This will not replace any drop down lists on the page. This corresponds to the value that will be passed to A3DPDFPageInsertDropDownList.

Parameters
in_drop_down_listDrop Down List to add to the page.
in_locationDrop Down List location in points relative to bottom left of the page. Only the left and bottom fields in the location will be used.
Returns
A reference to this PageKit.

◆ AddDropDownLists()

HPS.Publish.PageKit HPS.Publish.PageKit.AddDropDownLists ( HPS.Publish.DropDownListKit []  in_drop_down_list,
HPS.IntRectangle []  in_locations 
)
inline

Adds drop down lists to the page. This will not replace any drop down lists on the page. These correspond to values that will be passed to A3DPDFPageInsertDropDownList.

Parameters
in_drop_down_listDrop Down List to add to the page.
in_locationsDrop Down List locations in points relative to bottom left of the page. Only the left and bottom fields in the locations will be used.
Returns
A reference to this PageKit.

◆ AddImage()

HPS.Publish.PageKit HPS.Publish.PageKit.AddImage ( HPS.Publish.ImageKit  in_image,
HPS.IntRectangle  in_location 
)
inline

Adds an image to the page. This will not replace any images on the page. This corresponds to the value that will be passed to A3DPDFPageInsertImage.

Parameters
in_imageImage to add to the page.
in_locationImage location in points relative to bottom left of the page. Only the left and bottom fields in the location will be used.
Returns
A reference to this PageKit.

◆ AddImages()

HPS.Publish.PageKit HPS.Publish.PageKit.AddImages ( HPS.Publish.ImageKit []  in_images,
HPS.IntRectangle []  in_locations 
)
inline

Adds a list of images to the page. This will not replace any images on the page. These correspond to values that will be passed to A3DPDFPageInsertImage.

Parameters
in_imagesImages to add to the page.
in_locationsImage locations in points relative to bottom left of the page. Only the left and bottom fields in the locations will be used.
Returns
A reference to this PageKit.

◆ AddLink()

HPS.Publish.PageKit HPS.Publish.PageKit.AddLink ( HPS.Publish.LinkKit  in_link,
HPS.IntRectangle  in_location 
)
inline

Adds a link to the page. This will not replace any links on the page. This corresponds to the value that will be passed to A3DPDFPageInsertLink.

Parameters
in_linkLink to add to the page.
in_locationLink location in points relative to bottom left of the page. All fields in the location will be used.
Returns
A reference to this PageKit.

◆ AddLinks()

HPS.Publish.PageKit HPS.Publish.PageKit.AddLinks ( HPS.Publish.LinkKit []  in_links,
HPS.IntRectangle []  in_locations 
)
inline

Adds a list of links to the page. This will not replace any links on the page. These correspond to values that will be passed to A3DPDFPageInsertLink.

Parameters
in_linksLinks to add to the page.
in_locationsLink locations in points relative to bottom left of the page. All fields in the locations will be used.
Returns
A reference to this PageKit.

◆ AddListBox()

HPS.Publish.PageKit HPS.Publish.PageKit.AddListBox ( HPS.Publish.ListBoxKit  in_list_box,
HPS.IntRectangle  in_location 
)
inline

Adds a list box to the page. This will not replace any list boxes on the page. This corresponds to the value that will be passed to A3DPDFPageInsertListBox.

Parameters
in_list_boxList Box to add to the page.
in_locationList Box location in points relative to bottom left of the page. Only the left and bottom fields in the location will be used.
Returns
A reference to this PageKit.

◆ AddListBoxes()

HPS.Publish.PageKit HPS.Publish.PageKit.AddListBoxes ( HPS.Publish.ListBoxKit []  in_list_box,
HPS.IntRectangle []  in_locations 
)
inline

Adds list boxes to the page. This will not replace any list boxes on the page. These correspond to values that will be passed to A3DPDFPageInsertListBox.

Parameters
in_list_boxList Box to add to the page.
in_locationsList Box locations in points relative to bottom left of the page. Only the left and bottom fields in the locations will be used.
Returns
A reference to this PageKit.

◆ AddListItemByField()

HPS.Publish.PageKit HPS.Publish.PageKit.AddListItemByField ( string  in_field,
string  in_value,
string  in_export_value 
)
inline

Adds an item to the list at the given form field. The item to will be appended to any existing items in the list at the given form field. This corresponds to the value that will be passed to A3DPDFPageFieldListAddItem. This will only have an effect if the page has a template file.

Parameters
in_fieldUTF8-encoded form field name for the list.
in_valueUTF8-encoded value for the item to be added to the list at the given form field.
in_export_valueUTF8-encoded export value for the item to be added to the list at the given form field.
Returns
A reference to this PageKit.

◆ AddListItemsByField()

HPS.Publish.PageKit HPS.Publish.PageKit.AddListItemsByField ( string  in_field,
string []  in_values,
string []  in_export_values 
)
inline

Adds items to the list at the given form field. The items to will be appended to any existing items in the list at the given form field. These correspond to values that will be passed to A3DPDFPageFieldListAddItem. This will only have an effect if the page has a template file.

Parameters
in_fieldUTF8-encoded form field name for the list.
in_valuesThe values for the items to be added to the list at the given form field.
in_export_valuesThe export values for the items to be added to the list at the given form field.
Returns
A reference to this PageKit.

◆ AddRadioButton()

HPS.Publish.PageKit HPS.Publish.PageKit.AddRadioButton ( HPS.Publish.RadioButtonKit  in_radio_button,
HPS.IntRectangle  in_location 
)
inline

Adds a radio button to the page. This will not replace any radio buttons on the page. This corresponds to the value that will be passed to A3DPDFPageInsertRadioButton.

Parameters
in_radio_buttonRadio button to add to the page.
in_locationButton location in points relative to bottom left of the page. All fields in the location will be used.
Returns
A reference to this PageKit.

◆ AddRadioButtons()

HPS.Publish.PageKit HPS.Publish.PageKit.AddRadioButtons ( HPS.Publish.RadioButtonKit []  in_radio_buttons,
HPS.IntRectangle []  in_locations 
)
inline

Adds a list of buttons to the page. This will not replace any radio buttons on the page. These correspond to values that will be passed to A3DPDFPageInsertRadioButton.

Parameters
in_radio_buttonsRadio buttons to add to the page.
in_locationsButton locations in points relative to bottom left of the page. All fields in the locations will be used.
Returns
A reference to this PageKit.

◆ AddSignatureField()

HPS.Publish.PageKit HPS.Publish.PageKit.AddSignatureField ( HPS.Publish.SignatureFieldKit  in_signature_field,
HPS.IntRectangle  in_location 
)
inline

Adds a signature field to the page. This will not replace any signature fields on the page. This corresponds to the value that will be passed to A3DPDFPageInsertSignatureField.

Parameters
in_signature_fieldSignature Field to add to the page.
in_locationSignature Field location in points relative to bottom left of the page. Only the left and bottom fields in the location will be used.
Returns
A reference to this PageKit.

◆ AddSignatureFields()

HPS.Publish.PageKit HPS.Publish.PageKit.AddSignatureFields ( HPS.Publish.SignatureFieldKit []  in_signature_field,
HPS.IntRectangle []  in_locations 
)
inline

Adds signature fields to the page. This will not replace any signature fields on the page. These correspond to values that will be passed to A3DPDFPageInsertSignatureField.

Parameters
in_signature_fieldSignature Field to add to the page.
in_locationsSignature Field locations in points relative to bottom left of the page. Only the left and bottom fields in the locations will be used.
Returns
A reference to this PageKit.

◆ AddSlideTable()

HPS.Publish.PageKit HPS.Publish.PageKit.AddSlideTable ( HPS.Publish.SlideTableKit  in_slide_table,
HPS.IntRectangle  in_location 
)
inline

Adds a slide table to the page. This will not replace any slide tables on the page. This corresponds to the value that will be passed to A3DPDFDefineSlideTable.

Parameters
in_slide_tableSlide table to add to the page.
in_locationSlide table location in points relative to upper left of the page. Only the left and top fields in the location will be used.
Returns
A reference to this PageKit.

◆ AddSlideTables()

HPS.Publish.PageKit HPS.Publish.PageKit.AddSlideTables ( HPS.Publish.SlideTableKit []  in_slide_tables,
HPS.IntRectangle []  in_locations 
)
inline

Adds a list of slide tables to the page. This will not replace any slide tables on the page. These correspond to values that will be passed to A3DPDFDefineSlideTable.

Parameters
in_slide_tablesSlide tables to add to the page.
in_locationsSlide table locations in points relative to upper left of the page. Only the left and top fields in the locations will be used.
Returns
A reference to this PageKit.

◆ AddTable()

HPS.Publish.PageKit HPS.Publish.PageKit.AddTable ( HPS.Publish.TableKit  in_table,
HPS.IntRectangle  in_location 
)
inline

Adds a table to the page. This will not replace any tables on the page. This corresponds to the value that will be passed to A3DPDFPageInsertTable.

Parameters
in_tableTable to add to the page.
in_locationTable location in points relative to upper left of the page. Only the left and top fields in the location will be used.
Returns
A reference to this PageKit.

◆ AddTables()

HPS.Publish.PageKit HPS.Publish.PageKit.AddTables ( HPS.Publish.TableKit []  in_tables,
HPS.IntRectangle []  in_locations 
)
inline

Adds a list of tables to the page. This will not replace any tables on the page. These correspond to values that will be passed to A3DPDFPageInsertTable.

Parameters
in_tablesTables to add to the page.
in_locationsTable locations in points relative to upper left of the page. Only the left and top fields in the locations will be used.
Returns
A reference to this PageKit.

◆ AddText() [1/2]

HPS.Publish.PageKit HPS.Publish.PageKit.AddText ( HPS.Publish.TextKit  in_text,
HPS.IntRectangle  in_location 
)
inline

Adds a text string to the page. This will not replace any text on the page. This corresponds to the value that will be passed to A3DPDFPageInsertText.

Parameters
in_textText to add to the page.
in_locationText location in points relative to bottom left of the page. Only the left and bottom fields in the location will be used.
Returns
A reference to this PageKit.

◆ AddText() [2/2]

HPS.Publish.PageKit HPS.Publish.PageKit.AddText ( HPS.Publish.TextKit []  in_text,
HPS.IntRectangle []  in_locations 
)
inline

Adds text strings to the page. This will not replace any text on the page. These correspond to values that will be passed to A3DPDFPageInsertText.

Parameters
in_textText to add to the page.
in_locationsText locations in points relative to bottom left of the page. Only the left and bottom fields in the locations will be used.
Returns
A reference to this PageKit.

◆ AddTextField()

HPS.Publish.PageKit HPS.Publish.PageKit.AddTextField ( HPS.Publish.TextFieldKit  in_text_field,
HPS.IntRectangle  in_location 
)
inline

Adds a text field to the page. This will not replace any text fields on the page. This corresponds to the value that will be passed to A3DPDFPageInsertTextField.

Parameters
in_text_fieldText field to add to the page.
in_locationText field location in points relative to bottom left of the page. All fields in the location will be used.
Returns
A reference to this PageKit.

◆ AddTextFields()

HPS.Publish.PageKit HPS.Publish.PageKit.AddTextFields ( HPS.Publish.TextFieldKit []  in_text_fields,
HPS.IntRectangle []  in_locations 
)
inline

Adds a list of text fields to the page. This will not replace any text fields on the page. These correspond to values that will be passed to A3DPDFPageInsertTextField.

Parameters
in_text_fieldsText fields to add to the page.
in_locationsText field locations in points relative to bottom left of the page. All fields in the locations will be used.
Returns
A reference to this PageKit.

◆ Empty()

override bool HPS.Publish.PageKit.Empty ( )
inlinevirtual

Indicates whether this PageKit has any values set on it.

Returns
true if no values are set on this PageKit, false otherwise.

Reimplemented from HPS.Object.

◆ Equals()

bool HPS.Publish.PageKit.Equals ( HPS.Publish.PageKit  in_kit)
inline

Check if the source PageKit is equivalent to this PageKit.

Parameters
in_kitThe source PageKit to compare to this PageKit.
Returns
true if the objects are equivalent, false otherwise.

◆ GetDefault()

static HPS.Publish.PageKit HPS.Publish.PageKit.GetDefault ( )
inlinestatic

Creates a PageKit 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 PageKit passed to File.Export.

Returns
A PageKit with the default settings.

◆ ObjectType()

override HPS.Type HPS.Publish.PageKit.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()

void HPS.Publish.PageKit.Set ( HPS.Publish.PageKit  in_kit)
inline

Copies the source PageKit into this PageKit.

Parameters
in_kitThe source PageKit to copy.

◆ SetAnnotation()

HPS.Publish.PageKit HPS.Publish.PageKit.SetAnnotation ( HPS.Publish.AnnotationKit  in_annotation,
HPS.IntRectangle  in_location 
)
inline

Adds an annotation to the page. This will replace all annotations (if any) on the page. This corresponds to the value that will be passed to A3DPDFPageInsert3DAnnot.

Parameters
in_annotationAnnotation to add to the page.
in_locationAnnotation location in points relative to bottom left of the page. All fields in the location will be used.
Returns
A reference to this PageKit.

◆ SetAnnotationByField()

HPS.Publish.PageKit HPS.Publish.PageKit.SetAnnotationByField ( string  in_field,
HPS.Publish.AnnotationKit  in_annotation 
)
inline

Sets an annotation on the given form field. If there is an existing annotation on the given form field, it will get overwritten. This corresponds to the value that will be passed to A3DPDFPageFieldSet3DAnnot. This will only have an effect if the page has a template file.

Parameters
in_fieldUTF8-encoded form field name for the annotation.
in_annotationThe annotation to be set on the given form field.
Returns
A reference to this PageKit.

◆ SetAnnotations()

HPS.Publish.PageKit HPS.Publish.PageKit.SetAnnotations ( HPS.Publish.AnnotationKit []  in_annotations,
HPS.IntRectangle []  in_locations 
)
inline

Adds a list of annotations to the page. This will replace all annotations (if any) on the page. These correspond to the values that will be passed to A3DPDFPageInsert3DAnnot.

Parameters
in_annotationsAnnotations to add to the page.
in_locationsAnnotation locations in points relative to bottom left of the page. All fields in the locations will be used.
Returns
A reference to this PageKit.

◆ SetAnnotationsByField()

HPS.Publish.PageKit HPS.Publish.PageKit.SetAnnotationsByField ( string []  in_fields,
HPS.Publish.AnnotationKit []  in_annotations 
)
inline

Sets annotations on the given form fields. If there is an existing annotation on a given form field, it will get overwritten. These correspond to values that will be passed to A3DPDFPageFieldSet3DAnnot. This will only have an effect if the page has a template file.

Parameters
in_fieldsThe form field names for the annotations.
in_annotationsThe annotations to be set on the corresponding form fields.
Returns
A reference to this PageKit.

◆ SetButton()

HPS.Publish.PageKit HPS.Publish.PageKit.SetButton ( HPS.Publish.ButtonKit  in_button,
HPS.IntRectangle  in_location 
)
inline

Adds a button to the page. This will replace all buttons (if any) on the page. This corresponds to the value that will be passed to A3DPDFPageInsertButton.

Parameters
in_buttonButton to add to the page.
in_locationButton location in points relative to bottom left of the page. All fields in the location will be used.
Returns
A reference to this PageKit.

◆ SetButtonIconByField()

HPS.Publish.PageKit HPS.Publish.PageKit.SetButtonIconByField ( string  in_field,
HPS.Publish.ImageKit  in_image 
)
inline

Sets an image on the icon at the given form field. If there is an existing image on an icon at the given form field, it will get overwritten. This corresponds to the value that will be passed to A3DPDFPageFieldButtonSetIcon. This will only have an effect if the page has a template file.

Parameters
in_fieldUTF8-encoded form field name for the icon.
in_imageThe image to be set on the icon at the given form field.
Returns
A reference to this PageKit.

◆ SetButtonIconsByField()

HPS.Publish.PageKit HPS.Publish.PageKit.SetButtonIconsByField ( string []  in_fields,
HPS.Publish.ImageKit []  in_images 
)
inline

Sets images on the icons at the given form fields. If there is an existing image on an icon at a given form field, it will get overwritten. These correspond to values that will be passed to A3DPDFPageFieldButtonSetIcon. This will only have an effect if the page has a template file.

Parameters
in_fieldsThe form field names for the icons.
in_imagesThe images to be set on the icons at the corresponding form fields.
Returns
A reference to this PageKit.

◆ SetButtonLabelByField()

HPS.Publish.PageKit HPS.Publish.PageKit.SetButtonLabelByField ( string  in_field,
string  in_label 
)
inline

Sets a label on the given form field. If there is an existing label on the given form field, it will get overwritten. This corresponds to the value that will be passed to A3DPDFPageFieldButtonSetLabel. This will only have an effect if the page has a template file.

Parameters
in_fieldUTF8-encoded form field name for the label.
in_labelUTF8-encoded label to be set on the given form field.
Returns
A reference to this PageKit.

◆ SetButtonLabelsByField()

HPS.Publish.PageKit HPS.Publish.PageKit.SetButtonLabelsByField ( string []  in_fields,
string []  in_labels 
)
inline

Sets labels on the given form fields. If there is an existing label on a given form field, it will get overwritten. These correspond to the values that will be passed to A3DPDFPageFieldButtonSetLabel. This will only have an effect if the page has a template file.

Parameters
in_fieldsThe form field names for the labels.
in_labelsThe labels to be set on the corresponding form fields.
Returns
A reference to this PageKit.

◆ SetButtons()

HPS.Publish.PageKit HPS.Publish.PageKit.SetButtons ( HPS.Publish.ButtonKit []  in_buttons,
HPS.IntRectangle []  in_locations 
)
inline

Adds a list of buttons to the page. This will replace all buttons (if any) on the page. These correspond to values that will be passed to A3DPDFPageInsertButton.

Parameters
in_buttonsButtons to add to the page.
in_locationsButton locations in points relative to bottom left of the page. All fields in the locations will be used.
Returns
A reference to this PageKit.

◆ SetCheckBox()

HPS.Publish.PageKit HPS.Publish.PageKit.SetCheckBox ( HPS.Publish.CheckBoxKit  in_checkbox,
HPS.IntRectangle  in_location 
)
inline

Adds a check box to the page. This will replace all check box (if any) on the page. This corresponds to the value that will be passed to A3DPDFPageInsertCheckBox.

Parameters
in_checkboxCheck Box to add to the page.
in_locationCheck Box location in points relative to bottom left of the page. Only the left and bottom fields in the location will be used.
Returns
A reference to this PageKit.

◆ SetCheckBoxes()

HPS.Publish.PageKit HPS.Publish.PageKit.SetCheckBoxes ( HPS.Publish.CheckBoxKit []  in_checkbox,
HPS.IntRectangle []  in_locations 
)
inline

Adds check boxes to the page. This will replace all check boxes (if any) on the page. These correspond to values that will be passed to A3DPDFPageInsertCheckBox.

Parameters
in_checkboxCheck Box to add to the page.
in_locationsCheck Box locations in points relative to bottom left of the page. Only the left and bottom fields in the locations will be used.
Returns
A reference to this PageKit.

◆ SetDropDownList()

HPS.Publish.PageKit HPS.Publish.PageKit.SetDropDownList ( HPS.Publish.DropDownListKit  in_drop_down_list,
HPS.IntRectangle  in_location 
)
inline

Adds a drop down list to the page. This will replace all drop down list (if any) on the page. This corresponds to the value that will be passed to A3DPDFPageInsertDropDownList.

Parameters
in_drop_down_listDrop Down List to add to the page.
in_locationDrop Down List location in points relative to bottom left of the page. Only the left and bottom fields in the location will be used.
Returns
A reference to this PageKit.

◆ SetDropDownLists()

HPS.Publish.PageKit HPS.Publish.PageKit.SetDropDownLists ( HPS.Publish.DropDownListKit []  in_drop_down_list,
HPS.IntRectangle []  in_locations 
)
inline

Adds drop down lists to the page. This will replace all drop down lists (if any) on the page. These correspond to values that will be passed to A3DPDFPageInsertDropDownList.

Parameters
in_drop_down_listDrop Down List to add to the page.
in_locationsDrop Down List locations in points relative to bottom left of the page. Only the left and bottom fields in the locations will be used.
Returns
A reference to this PageKit.

◆ SetFormat()

HPS.Publish.PageKit HPS.Publish.PageKit.SetFormat ( HPS.Publish.Page.Format  in_format)
inline

Sets the format of the page. This corresponds to the value that will be passed to A3DPDFPageData::m_ePageSize. This has no effect if this page has a template file.

Parameters
in_formatFormat of the page.
Returns
A reference to this PageKit.

◆ SetImage()

HPS.Publish.PageKit HPS.Publish.PageKit.SetImage ( HPS.Publish.ImageKit  in_image,
HPS.IntRectangle  in_location 
)
inline

Adds an image to the page. This will replace all images (if any) on the page. This corresponds to the value that will be passed to A3DPDFPageInsertImage.

Parameters
in_imageImage to add to the page.
in_locationImage location in points relative to bottom left of the page. Only the left and bottom fields in the location will be used.
Returns
A reference to this PageKit.

◆ SetImages()

HPS.Publish.PageKit HPS.Publish.PageKit.SetImages ( HPS.Publish.ImageKit []  in_images,
HPS.IntRectangle []  in_locations 
)
inline

Adds a list of images to the page. This will replace all images (if any) on the page. These correspond to values that will be passed to A3DPDFPageInsertImage.

Parameters
in_imagesImages to add to the page.
in_locationsImage locations in points relative to bottom left of the page. Only the left and bottom fields in the locations will be used.
Returns
A reference to this PageKit.

◆ SetJavaScriptActionByField() [1/2]

HPS.Publish.PageKit HPS.Publish.PageKit.SetJavaScriptActionByField ( string  in_field,
string  in_source,
HPS.Publish.Source.Type  in_type 
)
inline

Sets a JavaScript source or file on the given form field. If there is any existing JavaScript source or file at the given form field, it will be overwritten. This corresponds to the value that will be passed to A3DPDFPageFieldSetActionJavascriptFromString or A3DPDFPageFieldSetActionJavascriptFromFile. This will only have an effect if the page has a template file.

Parameters
in_fieldUTF8-encoded form field name for the JavaScript action.
in_sourceUTF8-encoded JavaScript source or file (depending on the following argument) to be set on the given form field.
in_typeThe type of the preceding argument. Defaults to Source.Type.Code.
Returns
A reference to this PageKit.

◆ SetJavaScriptActionByField() [2/2]

HPS.Publish.PageKit HPS.Publish.PageKit.SetJavaScriptActionByField ( string  in_field,
string  in_source 
)
inline

Sets a JavaScript source or file on the given form field. If there is any existing JavaScript source or file at the given form field, it will be overwritten. This corresponds to the value that will be passed to A3DPDFPageFieldSetActionJavascriptFromString or A3DPDFPageFieldSetActionJavascriptFromFile. This will only have an effect if the page has a template file.

Parameters
in_fieldUTF8-encoded form field name for the JavaScript action.
in_sourceUTF8-encoded JavaScript source or file (depending on the following argument) to be set on the given form field.
Returns
A reference to this PageKit.

◆ SetJavaScriptActionsByField()

HPS.Publish.PageKit HPS.Publish.PageKit.SetJavaScriptActionsByField ( string []  in_fields,
string []  in_sources,
HPS.Publish.Source.Type []  in_types 
)
inline

Sets JavaScript sources and/or files on the given form fields. If there is any existing JavaScript source or file at a given form field, it will be overwritten. These correspond to values that will be passed to A3DPDFPageFieldSetActionJavascriptFromString or A3DPDFPageFieldSetActionJavascriptFromFile. This will only have an effect if the page has a template file.

Parameters
in_fieldsThe form field names for the JavaScript actions.
in_sourcesThe JavaScript sources and/or files (depending on the corresponding entry in the following argument) to be set on the corresponding form fields.
in_typesThe types for each item in the preceding argument array.
Returns
A reference to this PageKit.

◆ SetLink()

HPS.Publish.PageKit HPS.Publish.PageKit.SetLink ( HPS.Publish.LinkKit  in_link,
HPS.IntRectangle  in_location 
)
inline

Adds a link to the page. This will replace all links (if any) on the page. This corresponds to the value that will be passed to A3DPDFPageInsertLink.

Parameters
in_linkLink to add to the page.
in_locationLink location in points relative to bottom left of the page. All fields in the location will be used.
Returns
A reference to this PageKit.

◆ SetLinks()

HPS.Publish.PageKit HPS.Publish.PageKit.SetLinks ( HPS.Publish.LinkKit []  in_links,
HPS.IntRectangle []  in_locations 
)
inline

Adds a list of links to the page. This will replace all links (if any) on the page. These correspond to values that will be passed to A3DPDFPageInsertLink.

Parameters
in_linksLinks to add to the page.
in_locationsLink locations in points relative to bottom left of the page. All fields in the locations will be used.
Returns
A reference to this PageKit.

◆ SetListBox()

HPS.Publish.PageKit HPS.Publish.PageKit.SetListBox ( HPS.Publish.ListBoxKit  in_list_box,
HPS.IntRectangle  in_location 
)
inline

Adds a list box to the page. This will replace all list box (if any) on the page. This corresponds to the value that will be passed to A3DPDFPageInsertListBox.

Parameters
in_list_boxList Box to add to the page.
in_locationList Box location in points relative to bottom left of the page. Only the left and bottom fields in the location will be used.
Returns
A reference to this PageKit.

◆ SetListBoxes()

HPS.Publish.PageKit HPS.Publish.PageKit.SetListBoxes ( HPS.Publish.ListBoxKit []  in_list_box,
HPS.IntRectangle []  in_locations 
)
inline

Adds list boxes to the page. This will replace all list boxes (if any) on the page. These correspond to values that will be passed to A3DPDFPageInsertListBox.

Parameters
in_list_boxList Box to add to the page.
in_locationsList Box locations in points relative to bottom left of the page. Only the left and bottom fields in the locations will be used.
Returns
A reference to this PageKit.

◆ SetListItemByField()

HPS.Publish.PageKit HPS.Publish.PageKit.SetListItemByField ( string  in_field,
string  in_value,
string  in_export_value 
)
inline

Adds an item to the list at the given form field. If there are any existing items in the list at the given form field, they will be overwritten. This corresponds to the value that will be passed to A3DPDFPageFieldListAddItem. This will only have an effect if the page has a template file.

Parameters
in_fieldUTF8-encoded form field name for the list.
in_valueUTF8-encoded value for the item to be added to the list at the given form field.
in_export_valueUTF8-encoded export value for the item to be added to the list at the given form field.
Returns
A reference to this PageKit.

◆ SetListItemsByField()

HPS.Publish.PageKit HPS.Publish.PageKit.SetListItemsByField ( string  in_field,
string []  in_values,
string []  in_export_values 
)
inline

Adds items to the list at the given form field. If there are any existing items in the list at the given form field, they will be overwritten. These correspond to values that will be passed to A3DPDFPageFieldListAddItem. This will only have an effect if the page has a template file.

Parameters
in_fieldUTF8-encoded form field name for the list.
in_valuesThe values for the items to be added to the list at the given form field.
in_export_valuesThe export values for the items to be added to the list at the given form field.
Returns
A reference to this PageKit.

◆ SetOrientation()

HPS.Publish.PageKit HPS.Publish.PageKit.SetOrientation ( HPS.Publish.Page.Orientation  in_orientation)
inline

Sets the orientation of the page. This corresponds to the value that will be passed to A3DPDFPageData::m_ePageOrientation. This has no effect if this page has a template file.

Parameters
in_orientationOrientation of the page.
Returns
A reference to this PageKit.

◆ SetRadioButton()

HPS.Publish.PageKit HPS.Publish.PageKit.SetRadioButton ( HPS.Publish.RadioButtonKit  in_radio_button,
HPS.IntRectangle  in_location 
)
inline

Adds a radio button to the page. This will replace all radio buttons (if any) on the page. This corresponds to the value that will be passed to A3DPDFPageInsertRadioButton.

Parameters
in_radio_buttonRadio button to add to the page.
in_locationButton location in points relative to bottom left of the page. All fields in the location will be used.
Returns
A reference to this PageKit.

◆ SetRadioButtons()

HPS.Publish.PageKit HPS.Publish.PageKit.SetRadioButtons ( HPS.Publish.RadioButtonKit []  in_radio_buttons,
HPS.IntRectangle []  in_locations 
)
inline

Adds a list of buttons to the page. This will replace all radio buttons (if any) on the page. These correspond to values that will be passed to A3DPDFPageInsertRadioButton.

Parameters
in_radio_buttonsRadio buttons to add to the page.
in_locationsButton locations in points relative to bottom left of the page. All fields in the locations will be used.
Returns
A reference to this PageKit.

◆ SetSignatureField()

HPS.Publish.PageKit HPS.Publish.PageKit.SetSignatureField ( HPS.Publish.SignatureFieldKit  in_signature_field,
HPS.IntRectangle  in_location 
)
inline

Adds a signature field to the page. This will replace all signature field (if any) on the page. This corresponds to the value that will be passed to A3DPDFPageInsertSignatureField.

Parameters
in_signature_fieldSignature Field to add to the page.
in_locationSignature Field location in points relative to bottom left of the page. Only the left and bottom fields in the location will be used.
Returns
A reference to this PageKit.

◆ SetSignatureFields()

HPS.Publish.PageKit HPS.Publish.PageKit.SetSignatureFields ( HPS.Publish.SignatureFieldKit []  in_signature_field,
HPS.IntRectangle []  in_locations 
)
inline

Adds signature fields to the page. This will replace all signature fields (if any) on the page. These correspond to values that will be passed to A3DPDFPageInsertSignatureField.

Parameters
in_signature_fieldSignature Field to add to the page.
in_locationsSignature Field locations in points relative to bottom left of the page. Only the left and bottom fields in the locations will be used.
Returns
A reference to this PageKit.

◆ SetSlideTable()

HPS.Publish.PageKit HPS.Publish.PageKit.SetSlideTable ( HPS.Publish.SlideTableKit  in_slide_table,
HPS.IntRectangle  in_location 
)
inline

Adds a slide table to the page. This will replace all slide tables (if any) on the page. This corresponds to the value that will be passed to A3DPDFDefineSlideTable.

Parameters
in_slide_tableSlide table to add to the page.
in_locationSlide table location in points relative to upper left of the page. Only the left and top fields in the location will be used.
Returns
A reference to this PageKit.

◆ SetSlideTables()

HPS.Publish.PageKit HPS.Publish.PageKit.SetSlideTables ( HPS.Publish.SlideTableKit []  in_slide_tables,
HPS.IntRectangle []  in_locations 
)
inline

Adds a list of slide tables to the page. This will replace all slide tables (if any) on the page. These correspond to values that will be passed to A3DPDFDefineSlideTable.

Parameters
in_slide_tablesSlide tables to add to the page.
in_locationsSlide table locations in points relative to upper left of the page. Only the left and top fields in the locations will be used.
Returns
A reference to this PageKit.

◆ SetTable()

HPS.Publish.PageKit HPS.Publish.PageKit.SetTable ( HPS.Publish.TableKit  in_table,
HPS.IntRectangle  in_location 
)
inline

Adds a table to the page. This will replace all tables (if any) on the page. This corresponds to the value that will be passed to A3DPDFPageInsertTable.

Parameters
in_tableTable to add to the page.
in_locationTable location in points relative to upper left of the page. Only the left and top fields in the location will be used.
Returns
A reference to this PageKit.

◆ SetTables()

HPS.Publish.PageKit HPS.Publish.PageKit.SetTables ( HPS.Publish.TableKit []  in_tables,
HPS.IntRectangle []  in_locations 
)
inline

Adds a list of tables to the page. This will replace all tables (if any) on the page. These correspond to values that will be passed to A3DPDFPageInsertTable.

Parameters
in_tablesTables to add to the page.
in_locationsTable locations in points relative to upper left of the page. Only the left and top fields in the locations will be used.
Returns
A reference to this PageKit.

◆ SetTemplateFile()

HPS.Publish.PageKit HPS.Publish.PageKit.SetTemplateFile ( string  in_filename)
inline

Sets the PDF file which will act as a template.

Parameters
in_filenameUTF8-encoded filename for the PDF file to act as a template.
Returns
A reference to this PageKit.

◆ SetText() [1/2]

HPS.Publish.PageKit HPS.Publish.PageKit.SetText ( HPS.Publish.TextKit  in_text,
HPS.IntRectangle  in_location 
)
inline

Adds a text string to the page. This will replace all text (if any) on the page. This corresponds to the value that will be passed to A3DPDFPageInsertText.

Parameters
in_textText to add to the page.
in_locationText location in points relative to bottom left of the page. Only the left and bottom fields in the location will be used.
Returns
A reference to this PageKit.

◆ SetText() [2/2]

HPS.Publish.PageKit HPS.Publish.PageKit.SetText ( HPS.Publish.TextKit []  in_text,
HPS.IntRectangle []  in_locations 
)
inline

Adds text strings to the page. This will replace all text (if any) on the page. These correspond to values that will be passed to A3DPDFPageInsertText.

Parameters
in_textText to add to the page.
in_locationsText locations in points relative to bottom left of the page. Only the left and bottom fields in the locations will be used.
Returns
A reference to this PageKit.

◆ SetTextField()

HPS.Publish.PageKit HPS.Publish.PageKit.SetTextField ( HPS.Publish.TextFieldKit  in_text_field,
HPS.IntRectangle  in_location 
)
inline

Adds a text field to the page. This will replace all text fields (if any) on the page. This corresponds to the value that will be passed to A3DPDFPageInsertTextField.

Parameters
in_text_fieldText field to add to the page.
in_locationText field location in points relative to bottom left of the page. All fields in the location will be used.
Returns
A reference to this PageKit.

◆ SetTextFields()

HPS.Publish.PageKit HPS.Publish.PageKit.SetTextFields ( HPS.Publish.TextFieldKit []  in_text_fields,
HPS.IntRectangle []  in_locations 
)
inline

Adds a list of text fields to the page. This will replace all text fields (if any) on the page. These correspond to values that will be passed to A3DPDFPageInsertTextField.

Parameters
in_text_fieldsText fields to add to the page.
in_locationsText field locations in points relative to bottom left of the page. All fields in the locations will be used.
Returns
A reference to this PageKit.

◆ SetTextValueByField()

HPS.Publish.PageKit HPS.Publish.PageKit.SetTextValueByField ( string  in_field,
string  in_value 
)
inline

Sets a text value on the given form field. If there is an existing text value on the given form field, it will get overwritten. This corresponds to the value that will be passed to A3DPDFPageFieldTextSetValue. This will only have an effect if the page has a template file.

Parameters
in_fieldUTF8-encoded form field name for the text value.
in_valueUTF8-encoded text value to be set on the given form field.
Returns
A reference to this PageKit.

◆ SetTextValuesByField()

HPS.Publish.PageKit HPS.Publish.PageKit.SetTextValuesByField ( string []  in_fields,
string []  in_values 
)
inline

Sets text values on the given form fields. If there is an existing text value on a given form field, it will get overwritten. These correspond to values that will be passed to A3DPDFPageFieldTextSetValue. This will only have an effect if the page has a template file.

Parameters
in_fieldsThe form field names for the text values.
in_valuesThe text values to be set on the corresponding form fields.
Returns
A reference to this PageKit.

◆ SetVisibilitiesByField()

HPS.Publish.PageKit HPS.Publish.PageKit.SetVisibilitiesByField ( string []  in_fields,
bool []  in_states 
)
inline

Sets whether the objects at the given form fields should be visible. If there is an existing visibility on a given form field, it will get overwritten. These correspond to values that will be passed to A3DPDFPageFieldSetVisibility. This will only have an effect if the page has a template file.

Parameters
in_fieldsThe form field names on which to set visibility.
in_statesWhether the objects at the at the corresponding form fields should be visible.
Returns
A reference to this PageKit.

◆ SetVisibilityByField()

HPS.Publish.PageKit HPS.Publish.PageKit.SetVisibilityByField ( string  in_field,
bool  in_state 
)
inline

Sets whether the object at the given form field should be visible. If there is an existing visibility on the given form field, it will get overwritten. This corresponds to the value that will be passed to A3DPDFPageFieldSetVisibility. This will only have an effect if the page has a template file.

Parameters
in_fieldUTF8-encoded form field name on which to set visibility.
in_stateWhether the object at the at the given form field should be visible.
Returns
A reference to this PageKit.

◆ Show()

void HPS.Publish.PageKit.Show ( out HPS.Publish.PageKit  out_kit)
inline

Copies this PageKit into the given PageKit.

Parameters
out_kitThe PageKit to populate with the contents of this PageKit.

◆ ShowAnnotations()

bool HPS.Publish.PageKit.ShowAnnotations ( out HPS.Publish.AnnotationKit []  out_annotations,
out HPS.IntRectangle []  out_locations 
)
inline

Shows the annotations on the page.

Parameters
out_annotationsAnnotations on the page.
out_locationsAnnotation locations on the page.
Returns
true if annotations were specified, false otherwise.

◆ ShowButtons()

bool HPS.Publish.PageKit.ShowButtons ( out HPS.Publish.ButtonKit []  out_buttons,
out HPS.IntRectangle []  out_locations 
)
inline

Shows the buttons on the page.

Parameters
out_buttonsButtons on the page.
out_locationsButton locations on the page.
Returns
true if buttons were specified, false otherwise.

◆ ShowCheckBoxes()

bool HPS.Publish.PageKit.ShowCheckBoxes ( out HPS.Publish.CheckBoxKit []  out_check_boxes,
out HPS.IntRectangle []  out_locations 
)
inline

Shows the check boxes on the page.

Parameters
out_check_boxesCheck boxes on the page.
out_locationsCheck box locations on the page.
Returns
true if check boxes were specified, false otherwise.

◆ ShowDropDownLists()

bool HPS.Publish.PageKit.ShowDropDownLists ( out HPS.Publish.DropDownListKit []  out_drop_down_lists,
out HPS.IntRectangle []  out_locations 
)
inline

Shows the drop down lists on the page.

Parameters
out_drop_down_listsDrop down lists on the page.
out_locationsDrop drown list locations on the page.
Returns
true if drop down lists were specified, false otherwise.

◆ ShowFormat()

bool HPS.Publish.PageKit.ShowFormat ( out HPS.Publish.Page.Format  out_format)
inline

Shows the format of the page.

Parameters
out_formatFormat of the page.
Returns
true if a format was specified, false otherwise.

◆ ShowImages()

bool HPS.Publish.PageKit.ShowImages ( out HPS.Publish.ImageKit []  out_images,
out HPS.IntRectangle []  out_locations 
)
inline

Shows the images on the page.

Parameters
out_imagesImages on the page.
out_locationsImage locations on the page.
Returns
true if images were specified, false otherwise.

◆ ShowLinks()

bool HPS.Publish.PageKit.ShowLinks ( out HPS.Publish.LinkKit []  out_links,
out HPS.IntRectangle []  out_locations 
)
inline

Shows the links on the page.

Parameters
out_linksLinks on the page.
out_locationsLink locations on the page.
Returns
true if links were specified, false otherwise.

◆ ShowListBoxes()

bool HPS.Publish.PageKit.ShowListBoxes ( out HPS.Publish.ListBoxKit []  out_list_boxes,
out HPS.IntRectangle []  out_locations 
)
inline

Shows the list boxes on the page.

Parameters
out_list_boxesList boxes on the page.
out_locationsList boxes locations on the page.
Returns
true if list boxes were specified, false otherwise.

◆ ShowOrientation()

bool HPS.Publish.PageKit.ShowOrientation ( out HPS.Publish.Page.Orientation  out_orientation)
inline

Shows the orientation of the page.

Parameters
out_orientationOrientation of the page.
Returns
true if an orientation was specified, false otherwise.

◆ ShowRadioButtons()

bool HPS.Publish.PageKit.ShowRadioButtons ( out HPS.Publish.RadioButtonKit []  out_radio_buttons,
out HPS.IntRectangle []  out_locations 
)
inline

Shows the radio buttons on the page.

Parameters
out_radio_buttonsRadio buttons on the page.
out_locationsRadio buttons locations on the page.
Returns
true if radio buttons were specified, false otherwise.

◆ ShowSignatureFields()

bool HPS.Publish.PageKit.ShowSignatureFields ( out HPS.Publish.SignatureFieldKit []  out_signature_fields,
out HPS.IntRectangle []  out_locations 
)
inline

Shows the signature fields on the page.

Parameters
out_signature_fieldsSignature fields on the page.
out_locationsSignature field locations on the page.
Returns
true if signature fields were specified, false otherwise.

◆ ShowSlideTables()

bool HPS.Publish.PageKit.ShowSlideTables ( out HPS.Publish.SlideTableKit []  out_slide_tables,
out HPS.IntRectangle []  out_locations 
)
inline

Shows the slide tables on the page.

Parameters
out_slide_tablesSlide tables on the page.
out_locationsSlide table locations on the page.
Returns
true if slide tables were specified, false otherwise.

◆ ShowTables()

bool HPS.Publish.PageKit.ShowTables ( out HPS.Publish.TableKit []  out_tables,
out HPS.IntRectangle []  out_locations 
)
inline

Shows the tables on the page.

Parameters
out_tablesTables on the page.
out_locationsTable locations on the page.
Returns
true if tables were specified, false otherwise.

◆ ShowTemplateFile()

bool HPS.Publish.PageKit.ShowTemplateFile ( out string  out_filename)
inline

Shows the template file.

Parameters
out_filenameThe filename for the PDF file to act as a template.
Returns
true if a template file was specified, false otherwise.

◆ ShowText()

bool HPS.Publish.PageKit.ShowText ( out HPS.Publish.TextKit []  out_text,
out HPS.IntRectangle []  out_locations 
)
inline

Shows the text on the page.

Parameters
out_textText on the page.
out_locationsText locations on the page.
Returns
true if text strings were specified, false otherwise.

◆ ShowTextFields()

bool HPS.Publish.PageKit.ShowTextFields ( out HPS.Publish.TextFieldKit []  out_text_fields,
out HPS.IntRectangle []  out_locations 
)
inline

Shows the text fields on the page.

Parameters
out_text_fieldsText fields on the page.
out_locationsText field locations on the page.
Returns
true if text fields were specified, false otherwise.

◆ UnsetAnnotation()

HPS.Publish.PageKit HPS.Publish.PageKit.UnsetAnnotation ( ulong  in_index)
inline

Removes the annotation at the given index from the page.

Parameters
in_indexIndex of the annotation to remove from the page.
Returns
A reference to this PageKit.

◆ UnsetAnnotationByField()

HPS.Publish.PageKit HPS.Publish.PageKit.UnsetAnnotationByField ( string  in_field)
inline

Removes the annotation at the given form field from the page.

Parameters
in_fieldUTF8-encoded form field name with the annotation to be removed.
Returns
A reference to this PageKit.

◆ UnsetAnnotations() [1/2]

HPS.Publish.PageKit HPS.Publish.PageKit.UnsetAnnotations ( ulong []  in_indices)
inline

Removes the annotations at the given indices from the page.

Parameters
in_indicesIndices of the annotations to remove from the page.
Returns
A reference to this PageKit.

◆ UnsetAnnotations() [2/2]

HPS.Publish.PageKit HPS.Publish.PageKit.UnsetAnnotations ( )
inline

Removes all annotations from the page.

Returns
A reference to this PageKit.

◆ UnsetAnnotationsByField() [1/2]

HPS.Publish.PageKit HPS.Publish.PageKit.UnsetAnnotationsByField ( string []  in_fields)
inline

Removes the annotations at the given form fields from the page.

Parameters
in_fieldsForm field names with the annotations to be removed.
Returns
A reference to this PageKit.

◆ UnsetAnnotationsByField() [2/2]

HPS.Publish.PageKit HPS.Publish.PageKit.UnsetAnnotationsByField ( )
inline

Removes all annotation form fields from the page.

Returns
A reference to this PageKit.

◆ UnsetButton()

HPS.Publish.PageKit HPS.Publish.PageKit.UnsetButton ( ulong  in_index)
inline

Removes the button at the given index from the page.

Parameters
in_indexIndex of the button to remove from the page.
Returns
A reference to this PageKit.

◆ UnsetButtonIconByField()

HPS.Publish.PageKit HPS.Publish.PageKit.UnsetButtonIconByField ( string  in_field)
inline

Removes the image on the icon at the given form field from the page.

Parameters
in_fieldUTF8-encoded form field name of the icon with the image to be removed.
Returns
A reference to this PageKit.

◆ UnsetButtonIconsByField() [1/2]

HPS.Publish.PageKit HPS.Publish.PageKit.UnsetButtonIconsByField ( string []  in_fields)
inline

Removes the images on the icons at the given form fields from the page.

Parameters
in_fieldsForm field names of icons with the images to be removed.
Returns
A reference to this PageKit.

◆ UnsetButtonIconsByField() [2/2]

HPS.Publish.PageKit HPS.Publish.PageKit.UnsetButtonIconsByField ( )
inline

Removes all button icon form fields from the page.

Returns
A reference to this PageKit.

◆ UnsetButtonLabelByField()

HPS.Publish.PageKit HPS.Publish.PageKit.UnsetButtonLabelByField ( string  in_field)
inline

Removes the label at the given form field from the page.

Parameters
in_fieldUTF8-encoded form field name of the label to be removed.
Returns
A reference to this PageKit.

◆ UnsetButtonLabelsByField() [1/2]

HPS.Publish.PageKit HPS.Publish.PageKit.UnsetButtonLabelsByField ( string []  in_fields)
inline

Removes the labels at the given form fields from the page.

Parameters
in_fieldsForm field names of the labels to be removed.
Returns
A reference to this PageKit.

◆ UnsetButtonLabelsByField() [2/2]

HPS.Publish.PageKit HPS.Publish.PageKit.UnsetButtonLabelsByField ( )
inline

Removes all button label form fields from the page.

Returns
A reference to this PageKit.

◆ UnsetButtons() [1/2]

HPS.Publish.PageKit HPS.Publish.PageKit.UnsetButtons ( ulong []  in_indices)
inline

Removes the buttons at the given indices from the page.

Parameters
in_indicesIndices of the buttons to remove from the page.
Returns
A reference to this PageKit.

◆ UnsetButtons() [2/2]

HPS.Publish.PageKit HPS.Publish.PageKit.UnsetButtons ( )
inline

Removes all buttons from the page.

Returns
A reference to this PageKit.

◆ UnsetCheckBox()

HPS.Publish.PageKit HPS.Publish.PageKit.UnsetCheckBox ( ulong  in_index)
inline

Removes the check box at the given index from the page.

Parameters
in_indexIndex of the check box to remove from the page.
Returns
A reference to this PageKit.

◆ UnsetCheckBoxes() [1/2]

HPS.Publish.PageKit HPS.Publish.PageKit.UnsetCheckBoxes ( ulong []  in_indices)
inline

Removes the check box at the given indices from the page.

Parameters
in_indicesIndices of the check box to remove from the page.
Returns
A reference to this PageKit.

◆ UnsetCheckBoxes() [2/2]

HPS.Publish.PageKit HPS.Publish.PageKit.UnsetCheckBoxes ( )
inline

Removes all check boxes from the page.

Returns
A reference to this PageKit.

◆ UnsetDropDownList()

HPS.Publish.PageKit HPS.Publish.PageKit.UnsetDropDownList ( ulong  in_index)
inline

Removes the drop down list at the given index from the page.

Parameters
in_indexIndex of the drop down list to remove from the page.
Returns
A reference to this PageKit.

◆ UnsetDropDownLists() [1/2]

HPS.Publish.PageKit HPS.Publish.PageKit.UnsetDropDownLists ( ulong []  in_indices)
inline

Removes the drop down list at the given indices from the page.

Parameters
in_indicesIndices of the drop down list to remove from the page.
Returns
A reference to this PageKit.

◆ UnsetDropDownLists() [2/2]

HPS.Publish.PageKit HPS.Publish.PageKit.UnsetDropDownLists ( )
inline

Removes all drop down lists from the page.

Returns
A reference to this PageKit.

◆ UnsetEverything()

HPS.Publish.PageKit HPS.Publish.PageKit.UnsetEverything ( )
inline

Removes all data from the page.

Returns
A reference to this PageKit.

◆ UnsetFormat()

HPS.Publish.PageKit HPS.Publish.PageKit.UnsetFormat ( )
inline

Removes the format from the page.

Returns
A reference to this PageKit.

◆ UnsetImage()

HPS.Publish.PageKit HPS.Publish.PageKit.UnsetImage ( ulong  in_index)
inline

Removes the image at the given index from the page.

Parameters
in_indexIndex of the image to remove from the page.
Returns
A reference to this PageKit.

◆ UnsetImages() [1/2]

HPS.Publish.PageKit HPS.Publish.PageKit.UnsetImages ( ulong []  in_indices)
inline

Removes the images at the given indices from the page.

Parameters
in_indicesIndices of the images to remove from the page.
Returns
A reference to this PageKit.

◆ UnsetImages() [2/2]

HPS.Publish.PageKit HPS.Publish.PageKit.UnsetImages ( )
inline

Removes all images from the page.

Returns
A reference to this PageKit.

◆ UnsetJavaScriptActionByField()

HPS.Publish.PageKit HPS.Publish.PageKit.UnsetJavaScriptActionByField ( string  in_field)
inline

Removes the JavaScript action at the given form field from the page.

Parameters
in_fieldUTF8-encoded form field name of the action to be removed.
Returns
A reference to this PageKit.

◆ UnsetJavaScriptActionsByField() [1/2]

HPS.Publish.PageKit HPS.Publish.PageKit.UnsetJavaScriptActionsByField ( string []  in_fields)
inline

Removes the JavaScript actions at the given form fields from the page.

Parameters
in_fieldsForm field names of the actions to be removed.
Returns
A reference to this PageKit.

◆ UnsetJavaScriptActionsByField() [2/2]

HPS.Publish.PageKit HPS.Publish.PageKit.UnsetJavaScriptActionsByField ( )
inline

Removes all JavaScript action form fields from the page.

Returns
A reference to this PageKit.

◆ UnsetLink()

HPS.Publish.PageKit HPS.Publish.PageKit.UnsetLink ( ulong  in_index)
inline

Removes the link at the given index from the page.

Parameters
in_indexIndex of the link to remove from the page.
Returns
A reference to this PageKit.

◆ UnsetLinks() [1/2]

HPS.Publish.PageKit HPS.Publish.PageKit.UnsetLinks ( ulong []  in_indices)
inline

Removes the links at the given indices from the page.

Parameters
in_indicesIndices of the links to remove from the page.
Returns
A reference to this PageKit.

◆ UnsetLinks() [2/2]

HPS.Publish.PageKit HPS.Publish.PageKit.UnsetLinks ( )
inline

Removes all links from the page.

Returns
A reference to this PageKit.

◆ UnsetListBox()

HPS.Publish.PageKit HPS.Publish.PageKit.UnsetListBox ( ulong  in_index)
inline

Removes the list box at the given index from the page.

Parameters
in_indexIndex of the list box to remove from the page.
Returns
A reference to this PageKit.

◆ UnsetListBoxes() [1/2]

HPS.Publish.PageKit HPS.Publish.PageKit.UnsetListBoxes ( ulong []  in_indices)
inline

Removes the list box at the given indices from the page.

Parameters
in_indicesIndices of the list box to remove from the page.
Returns
A reference to this PageKit.

◆ UnsetListBoxes() [2/2]

HPS.Publish.PageKit HPS.Publish.PageKit.UnsetListBoxes ( )
inline

Removes all list boxes from the page.

Returns
A reference to this PageKit.

◆ UnsetListItemByField()

HPS.Publish.PageKit HPS.Publish.PageKit.UnsetListItemByField ( string  in_field,
ulong  in_index 
)
inline

Removes the item at the given index from the list at the given form field from the page.

Parameters
in_fieldUTF8-encoded form field name of the list with the item to be removed.
in_indexIndex of the item in the list at the given form field to be removed.
Returns
A reference to this PageKit.

◆ UnsetListItemsByField() [1/4]

HPS.Publish.PageKit HPS.Publish.PageKit.UnsetListItemsByField ( string  in_field,
ulong []  in_indices 
)
inline

Removes the items at the given indices from the list at the given form field from the page.

Parameters
in_fieldUTF8-encoded form field name of the list with the items to be removed.
in_indicesIndices of the items in the list at the form field to be removed.
Returns
A reference to this PageKit.

◆ UnsetListItemsByField() [2/4]

HPS.Publish.PageKit HPS.Publish.PageKit.UnsetListItemsByField ( string  in_field)
inline

Removes all items from the list at the given form field from the page.

Parameters
in_fieldUTF8-encoded form field name of the list with the items to be removed.
Returns
A reference to this PageKit.

◆ UnsetListItemsByField() [3/4]

HPS.Publish.PageKit HPS.Publish.PageKit.UnsetListItemsByField ( string []  in_fields)
inline

Removes all items from the lists at the given form fields from the page.

Parameters
in_fieldsForm field names of the lists with the items to be removed.
Returns
A reference to this PageKit.

◆ UnsetListItemsByField() [4/4]

HPS.Publish.PageKit HPS.Publish.PageKit.UnsetListItemsByField ( )
inline

Removes all list item form fields from the page.

Returns
A reference to this PageKit.

◆ UnsetOrientation()

HPS.Publish.PageKit HPS.Publish.PageKit.UnsetOrientation ( )
inline

Removes the orientation from the page.

Returns
A reference to this PageKit.

◆ UnsetRadioButton()

HPS.Publish.PageKit HPS.Publish.PageKit.UnsetRadioButton ( ulong  in_index)
inline

Removes the radio button at the given index from the page.

Parameters
in_indexIndex of the radio button to remove from the page.
Returns
A reference to this PageKit.

◆ UnsetRadioButtons() [1/2]

HPS.Publish.PageKit HPS.Publish.PageKit.UnsetRadioButtons ( ulong []  in_indices)
inline

Removes the radio button at the given indices from the page.

Parameters
in_indicesIndices of the radio button to remove from the page.
Returns
A reference to this PageKit.

◆ UnsetRadioButtons() [2/2]

HPS.Publish.PageKit HPS.Publish.PageKit.UnsetRadioButtons ( )
inline

Removes all radio buttons from the page.

Returns
A reference to this PageKit.

◆ UnsetSignatureField()

HPS.Publish.PageKit HPS.Publish.PageKit.UnsetSignatureField ( ulong  in_index)
inline

Removes the signature field at the given index from the page.

Parameters
in_indexIndex of the signature field to remove from the page.
Returns
A reference to this PageKit.

◆ UnsetSignatureFields() [1/2]

HPS.Publish.PageKit HPS.Publish.PageKit.UnsetSignatureFields ( ulong []  in_indices)
inline

Removes the signature field at the given indices from the page.

Parameters
in_indicesIndices of the signature field to remove from the page.
Returns
A reference to this PageKit.

◆ UnsetSignatureFields() [2/2]

HPS.Publish.PageKit HPS.Publish.PageKit.UnsetSignatureFields ( )
inline

Removes all signature fields from the page.

Returns
A reference to this PageKit.

◆ UnsetSlideTable()

HPS.Publish.PageKit HPS.Publish.PageKit.UnsetSlideTable ( ulong  in_index)
inline

Removes the slide table at the given index from the page.

Parameters
in_indexIndex of the slide table to remove from the page.
Returns
A reference to this PageKit.

◆ UnsetSlideTables() [1/2]

HPS.Publish.PageKit HPS.Publish.PageKit.UnsetSlideTables ( ulong []  in_indices)
inline

Removes the slide tables at the given indices from the page.

Parameters
in_indicesIndices of the slide tables to remove from the page.
Returns
A reference to this PageKit.

◆ UnsetSlideTables() [2/2]

HPS.Publish.PageKit HPS.Publish.PageKit.UnsetSlideTables ( )
inline

Removes all slide tables from the page.

Returns
A reference to this PageKit.

◆ UnsetTable()

HPS.Publish.PageKit HPS.Publish.PageKit.UnsetTable ( ulong  in_index)
inline

Removes the table at the given index from the page.

Parameters
in_indexIndex of the table to remove from the page.
Returns
A reference to this PageKit.

◆ UnsetTables() [1/2]

HPS.Publish.PageKit HPS.Publish.PageKit.UnsetTables ( ulong []  in_indices)
inline

Removes the tables at the given indices from the page.

Parameters
in_indicesIndices of the tables to remove from the page.
Returns
A reference to this PageKit.

◆ UnsetTables() [2/2]

HPS.Publish.PageKit HPS.Publish.PageKit.UnsetTables ( )
inline

Removes all tables from the page.

Returns
A reference to this PageKit.

◆ UnsetTemplateFile()

HPS.Publish.PageKit HPS.Publish.PageKit.UnsetTemplateFile ( )
inline

Removes the template file from the page.

Returns
A reference to this PageKit.

◆ UnsetText() [1/3]

HPS.Publish.PageKit HPS.Publish.PageKit.UnsetText ( ulong  in_index)
inline

Removes the text at the given index from the page.

Parameters
in_indexIndex of the text to remove from the page.
Returns
A reference to this PageKit.

◆ UnsetText() [2/3]

HPS.Publish.PageKit HPS.Publish.PageKit.UnsetText ( ulong []  in_indices)
inline

Removes the text at the given indices from the page.

Parameters
in_indicesIndices of the text to remove from the page.
Returns
A reference to this PageKit.

◆ UnsetText() [3/3]

HPS.Publish.PageKit HPS.Publish.PageKit.UnsetText ( )
inline

Removes all text from the page.

Returns
A reference to this PageKit.

◆ UnsetTextField()

HPS.Publish.PageKit HPS.Publish.PageKit.UnsetTextField ( ulong  in_index)
inline

Removes the text field at the given index from the page.

Parameters
in_indexIndex of the text field to remove from the page.
Returns
A reference to this PageKit.

◆ UnsetTextFields() [1/2]

HPS.Publish.PageKit HPS.Publish.PageKit.UnsetTextFields ( ulong []  in_indices)
inline

Removes the text fields at the given indices from the page.

Parameters
in_indicesIndices of the text fields to remove from the page.
Returns
A reference to this PageKit.

◆ UnsetTextFields() [2/2]

HPS.Publish.PageKit HPS.Publish.PageKit.UnsetTextFields ( )
inline

Removes all text fields from the page.

Returns
A reference to this PageKit.

◆ UnsetTextValueByField()

HPS.Publish.PageKit HPS.Publish.PageKit.UnsetTextValueByField ( string  in_field)
inline

Removes the text value at the given form field from the page.

Parameters
in_fieldUTF8-encoded form field name with the text value to be removed.
Returns
A reference to this PageKit.

◆ UnsetTextValuesByField() [1/2]

HPS.Publish.PageKit HPS.Publish.PageKit.UnsetTextValuesByField ( string []  in_fields)
inline

Removes the text values at the given form fields from the page.

Parameters
in_fieldsForm field names with the text values to be removed.
Returns
A reference to this PageKit.

◆ UnsetTextValuesByField() [2/2]

HPS.Publish.PageKit HPS.Publish.PageKit.UnsetTextValuesByField ( )
inline

Removes all text value form fields from the page.

Returns
A reference to this PageKit.

◆ UnsetVisibilitiesByField() [1/2]

HPS.Publish.PageKit HPS.Publish.PageKit.UnsetVisibilitiesByField ( string []  in_fields)
inline

Removes the visibility settings at the given form fields from the page.

Parameters
in_fieldsForm field names with the visibility settings to be removed.
Returns
A reference to this PageKit.

◆ UnsetVisibilitiesByField() [2/2]

HPS.Publish.PageKit HPS.Publish.PageKit.UnsetVisibilitiesByField ( )
inline

Removes all visibility settings on form fields from the page.

Returns
A reference to this PageKit.

◆ UnsetVisibilityByField()

HPS.Publish.PageKit HPS.Publish.PageKit.UnsetVisibilityByField ( string  in_field)
inline

Removes the visibility setting at the given form field from the page.

Parameters
in_fieldUTF8-encoded form field name with the visibility setting to be removed.
Returns
A reference to this PageKit.

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