HPS::Publish::PageKit

class HPS::Publish::PageKit : public HPS::SprocketKit

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.

Public Functions

PageKit &AddAnnotation(AnnotationKit const &in_annotation, IntRectangle const &in_location)

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_annotation – Annotation to add to the page.
in_location – Annotation location in points relative to bottom left of the page. All fields in the location will be used.

Returns

A reference to this PageKit.

PageKit &AddAnnotations(AnnotationKitArray const &in_annotations, IntRectangleArray const &in_locations)

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_annotations – Annotations to add to the page.
in_locations – Annotation locations in points relative to bottom left of the page.

Returns

A reference to this PageKit.

PageKit &AddAnnotations(size_t in_count, AnnotationKit const in_annotations[], IntRectangle const in_locations[])

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_count – Size of the following arrays.
in_annotations – Annotations to add to the page.
in_locations – Annotation locations in points relative to bottom left of the page.

Returns

A reference to this PageKit.

PageKit &AddButton(ButtonKit const &in_button, IntRectangle const &in_location)

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_button – Button to add to the page.
in_location – Button location in points relative to bottom left of the page. All fields in the location will be used.

Returns

A reference to this PageKit.

PageKit &AddButtons(ButtonKitArray const &in_buttons, IntRectangleArray const &in_locations)

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_buttons – Buttons to add to the page.
in_locations – Button locations in points relative to bottom left of the page. All fields in the locations will be used.

Returns

A reference to this PageKit.

PageKit &AddButtons(size_t in_count, ButtonKit const in_buttons[], IntRectangle const in_locations[])

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_count – Size of the following arrays.
in_buttons – Buttons to add to the page.
in_locations – Button locations in points relative to bottom left of the page. All fields in the locations will be used.

Returns

A reference to this PageKit.

PageKit &AddCheckBox(CheckBoxKit const &in_checkbox, IntRectangle const &in_location)

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_checkbox – Check Box to add to the page.
in_location – Check 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.

PageKit &AddCheckBoxes(CheckBoxKitArray const &in_checkbox, IntRectangleArray const &in_locations)

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_checkbox – Check Box to add to the page.
in_locations – Check 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.

PageKit &AddCheckBoxes(size_t in_count, CheckBoxKit const in_checkbox[], IntRectangle const in_locations[])

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_count – Size of the following arrays.
in_checkbox – Check Box to add to the page.
in_locations – Check 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.

PageKit &AddDropDownList(DropDownListKit const &in_drop_down_list, IntRectangle const &in_location)

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_list – Drop Down List to add to the page.
in_location – Drop 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.

PageKit &AddDropDownLists(DropDownListKitArray const &in_drop_down_list, IntRectangleArray const &in_locations)

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_list – Drop Down List to add to the page.
in_locations – Drop 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.

PageKit &AddDropDownLists(size_t in_count, DropDownListKit const in_drop_down_list[], IntRectangle const in_locations[])

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_count – Size of the following arrays.
in_drop_down_list – Drop Down List to add to the page.
in_locations – Drop 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.

PageKit &AddImage(ImageKit const &in_image, IntRectangle const &in_location)

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_image – Image to add to the page.
in_location – Image 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.

PageKit &AddImages(ImageKitArray const &in_images, IntRectangleArray const &in_locations)

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_images – Images to add to the page.
in_locations – Image 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.

PageKit &AddImages(size_t in_count, ImageKit const in_images[], IntRectangle const in_locations[])

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_count – Size of the following arrays.
in_images – Images to add to the page.
in_locations – Image 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.

PageKit &AddLink(LinkKit const &in_link, IntRectangle const &in_location)

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_link – Link to add to the page.
in_location – Link location in points relative to bottom left of the page. All fields in the location will be used.

Returns

A reference to this PageKit.

PageKit &AddLinks(LinkKitArray const &in_links, IntRectangleArray const &in_locations)

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_links – Links to add to the page.
in_locations – Link locations in points relative to bottom left of the page. All fields in the locations will be used.

Returns

A reference to this PageKit.

PageKit &AddLinks(size_t in_count, LinkKit const in_links[], IntRectangle const in_locations[])

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_count – Size of the following arrays.
in_links – Links to add to the page.
in_locations – Link locations in points relative to bottom left of the page. All fields in the locations will be used.

Returns

A reference to this PageKit.

PageKit &AddListBox(ListBoxKit const &in_list_box, IntRectangle const &in_location)

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_box – List Box to add to the page.
in_location – List 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.

PageKit &AddListBoxes(ListBoxKitArray const &in_list_box, IntRectangleArray const &in_locations)

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_box – List Box to add to the page.
in_locations – List 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.

PageKit &AddListBoxes(size_t in_count, ListBoxKit const in_list_box[], IntRectangle const in_locations[])

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_count – Size of the following arrays.
in_list_box – List Box to add to the page.
in_locations – List 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.

PageKit &AddListItemByField(char const *in_field, char const *in_value, char const *in_export_value)

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_field – UTF8-encoded form field name for the list.
in_value – UTF8-encoded value for the item to be added to the list at the given form field.
in_export_value – UTF8-encoded export value for the item to be added to the list at the given form field.

Returns

A reference to this PageKit.

PageKit &AddListItemsByField(char const *in_field, size_t in_count, UTF8 const in_values[], UTF8 const in_export_values[])

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_field – UTF8-encoded form field name for the list.
in_count – Size of the following arrays.
in_values – The values for the items to be added to the list at the given form field.
in_export_values – The export values for the items to be added to the list at the given form field.

Returns

A reference to this PageKit.

PageKit &AddListItemsByField(char const *in_field, UTF8Array const &in_values, UTF8Array const &in_export_values)

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_field – UTF8-encoded form field name for the list.
in_values – The values for the items to be added to the list at the given form field.
in_export_values – The export values for the items to be added to the list at the given form field.

Returns

A reference to this PageKit.

PageKit &AddRadioButton(RadioButtonKit const &in_radio_button, IntRectangle const &in_location)

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_button – Radio button to add to the page.
in_location – Button location in points relative to bottom left of the page. All fields in the location will be used.

Returns

A reference to this PageKit.

PageKit &AddRadioButtons(RadioButtonKitArray const &in_radio_buttons, IntRectangleArray const &in_locations)

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_buttons – Radio buttons to add to the page.
in_locations – Button locations in points relative to bottom left of the page. All fields in the locations will be used.

Returns

A reference to this PageKit.

PageKit &AddRadioButtons(size_t in_count, RadioButtonKit const in_radio_buttons[], IntRectangle const in_locations[])

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_count – Size of the following arrays.
in_radio_buttons – Radio buttons to add to the page.
in_locations – Button locations in points relative to bottom left of the page. All fields in the locations will be used.

Returns

A reference to this PageKit.

PageKit &AddSignatureField(SignatureFieldKit const &in_signature_field, IntRectangle const &in_location)

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_field – Signature Field to add to the page.
in_location – Signature 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.

PageKit &AddSignatureFields(SignatureFieldKitArray const &in_signature_field, IntRectangleArray const &in_locations)

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_field – Signature Field to add to the page.
in_locations – Signature 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.

PageKit &AddSignatureFields(size_t in_count, SignatureFieldKit const in_signature_field[], IntRectangle const in_locations[])

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_count – Size of the following arrays.
in_signature_field – Signature Field to add to the page.
in_locations – Signature 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.

PageKit &AddSlideTable(SlideTableKit const &in_slide_table, IntRectangle const &in_location)

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_table – Slide table to add to the page.
in_location – Slide 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.

PageKit &AddSlideTables(size_t in_count, SlideTableKit const in_slide_tables[], IntRectangle const in_locations[])

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_count – Size of the following arrays.
in_slide_tables – Slide tables to add to the page.
in_locations – Slide 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.

PageKit &AddSlideTables(SlideTableKitArray const &in_slide_tables, IntRectangleArray const &in_locations)

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_tables – Slide tables to add to the page.
in_locations – Slide 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.

PageKit &AddTable(TableKit const &in_table, IntRectangle const &in_location)

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_table – Table to add to the page.
in_location – 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.

PageKit &AddTables(size_t in_count, TableKit const in_tables[], IntRectangle const in_locations[])

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_count – Size of the following arrays.
in_tables – Tables to add to the page.
in_locations – 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.

PageKit &AddTables(TableKitArray const &in_tables, IntRectangleArray const &in_locations)

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_tables – Tables to add to the page.
in_locations – 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.

PageKit &AddText(size_t in_count, TextKit const in_text[], IntRectangle const in_locations[])

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_count – Size of the following arrays.
in_text – Text to add to the page.
in_locations – Text 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.

PageKit &AddText(TextKit const &in_text, IntRectangle const &in_location)

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_text – Text to add to the page.
in_location – Text 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.

PageKit &AddText(TextKitArray const &in_text, IntRectangleArray const &in_locations)

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_text – Text to add to the page.
in_locations – Text 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.

PageKit &AddTextField(TextFieldKit const &in_text_field, IntRectangle const &in_location)

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_field – Text field to add to the page.
in_location – Text 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.

PageKit &AddTextFields(size_t in_count, TextFieldKit const in_text_fields[], IntRectangle const in_locations[])

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_count – Size of the following arrays.
in_text_fields – Text fields to add to the page.
in_locations – Text 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.

PageKit &AddTextFields(TextFieldKitArray const &in_text_fields, IntRectangleArray const &in_locations)

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_fields – Text fields to add to the page.
in_locations – Text 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.

virtual bool Empty() const

Indicates whether this PageKit has any values set on it.

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

bool Equals(PageKit const &in_kit) const

Check if the source PageKit is equivalent to this PageKit.

Parameters: in_kit – The source PageKit to compare to this PageKit.
Returns: true if the objects are equivalent, false otherwise.

inline virtual HPS::Type ObjectType() const

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.

bool operator!=(PageKit const &in_kit) const

Check if the source PageKit is not equivalent to this PageKit.

Parameters: in_kit – The source PageKit to compare to this PageKit.
Returns: true if the objects are not equivalent, false otherwise.

PageKit &operator=(PageKit &&in_kit)

The move assignment operator transfers the underlying object of the rvalue reference to this PageKit.

Parameters: in_kit – An rvalue reference to a PageKit to take the underlying object from.
Returns: A reference to this PageKit.

PageKit &operator=(PageKit const &in_kit)

Copies the source PageKit into this PageKit.

Parameters: in_kit – The source PageKit to copy.
Returns: A reference to this PageKit.

bool operator==(PageKit const &in_kit) const

Check if the source PageKit is equivalent to this PageKit.

Parameters: in_kit – The source PageKit to compare to this PageKit.
Returns: true if the objects are equivalent, false otherwise.

PageKit(): The default constructor creates an empty PageKit object.

PageKit(char const *in_filename)

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

Parameters: in_filename – UTF8-encoded filename for the PDF file to act as a template.

PageKit(Page::Format in_format, Page::Orientation in_orientation)

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

Parameters

in_format – Format of the page.
in_orientation – Orientation of the page.

PageKit(PageKit &&in_kit)

The move constructor creates a PageKit by transferring the underlying object of the rvalue reference to this PageKit.

Parameters: in_kit – An rvalue reference to a PageKit to take the underlying object from.

PageKit(PageKit const &in_kit)

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

Parameters: in_kit – The source PageKit to copy.

void Set(PageKit const &in_kit)

Copies the source PageKit into this PageKit.

Parameters: in_kit – The source PageKit to copy.

PageKit &SetAnnotation(AnnotationKit const &in_annotation, IntRectangle const &in_location)

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_annotation – Annotation to add to the page.
in_location – Annotation location in points relative to bottom left of the page. All fields in the location will be used.

Returns

A reference to this PageKit.

PageKit &SetAnnotationByField(char const *in_field, AnnotationKit const &in_annotation)

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_field – UTF8-encoded form field name for the annotation.
in_annotation – The annotation to be set on the given form field.

Returns

A reference to this PageKit.

PageKit &SetAnnotations(AnnotationKitArray const &in_annotations, IntRectangleArray const &in_locations)

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_annotations – Annotations to add to the page.
in_locations – Annotation locations in points relative to bottom left of the page. All fields in the locations will be used.

Returns

A reference to this PageKit.

PageKit &SetAnnotations(size_t in_count, AnnotationKit const in_annotations[], IntRectangle const in_locations[])

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_count – Size of the following arrays.
in_annotations – Annotations to add to the page.
in_locations – Annotation locations in points relative to bottom left of the page. All fields in the locations will be used.

Returns

A reference to this PageKit.

PageKit &SetAnnotationsByField(size_t in_count, UTF8 const in_fields[], AnnotationKit const in_annotations[])

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_count – Size of the following arrays.
in_fields – The form field names for the annotations.
in_annotations – The annotations to be set on the corresponding form fields.

Returns

A reference to this PageKit.

PageKit &SetAnnotationsByField(UTF8Array const &in_fields, AnnotationKitArray const &in_annotations)

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_fields – The form field names for the annotations.
in_annotations – The annotations to be set on the corresponding form fields.

Returns

A reference to this PageKit.

PageKit &SetButton(ButtonKit const &in_button, IntRectangle const &in_location)

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_button – Button to add to the page.
in_location – Button location in points relative to bottom left of the page. All fields in the location will be used.

Returns

A reference to this PageKit.

PageKit &SetButtonIconByField(char const *in_field, ImageKit const &in_image)

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_field – UTF8-encoded form field name for the icon.
in_image – The image to be set on the icon at the given form field.

Returns

A reference to this PageKit.

PageKit &SetButtonIconsByField(size_t in_count, UTF8 const in_fields[], ImageKit const in_images[])

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_count – Size of the following arrays.
in_fields – The form field names for the icons.
in_images – The images to be set on the icons at the corresponding form fields.

Returns

A reference to this PageKit.

PageKit &SetButtonIconsByField(UTF8Array const &in_fields, ImageKitArray const &in_images)

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_fields – The form field names for the icons.
in_images – The images to be set on the icons at the corresponding form fields.

Returns

A reference to this PageKit.

PageKit &SetButtonLabelByField(char const *in_field, char const *in_label)

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_field – UTF8-encoded form field name for the label.
in_label – UTF8-encoded label to be set on the given form field.

Returns

A reference to this PageKit.

PageKit &SetButtonLabelsByField(size_t in_count, UTF8 const in_fields[], UTF8 const in_labels[])

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_count – Size of the following arrays.
in_fields – The form field names for the labels.
in_labels – The labels to be set on the corresponding form fields.

Returns

A reference to this PageKit.

PageKit &SetButtonLabelsByField(UTF8Array const &in_fields, UTF8Array const &in_labels)

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_fields – The form field names for the labels.
in_labels – The labels to be set on the corresponding form fields.

Returns

A reference to this PageKit.

PageKit &SetButtons(ButtonKitArray const &in_buttons, IntRectangleArray const &in_locations)

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_buttons – Buttons to add to the page.
in_locations – Button locations in points relative to bottom left of the page. All fields in the locations will be used.

Returns

A reference to this PageKit.

PageKit &SetButtons(size_t in_count, ButtonKit const in_buttons[], IntRectangle const in_locations[])

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_count – Size of the following arrays.
in_buttons – Buttons to add to the page.
in_locations – Button locations in points relative to bottom left of the page. All fields in the locations will be used.

Returns

A reference to this PageKit.

PageKit &SetCheckBox(CheckBoxKit const &in_checkbox, IntRectangle const &in_location)

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_checkbox – Check Box to add to the page.
in_location – Check 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.

PageKit &SetCheckBoxes(CheckBoxKitArray const &in_checkbox, IntRectangleArray const &in_locations)

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_checkbox – Check Box to add to the page.
in_locations – Check 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.

PageKit &SetCheckBoxes(size_t in_count, CheckBoxKit const in_checkbox[], IntRectangle const in_locations[])

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_count – Size of the following arrays.
in_checkbox – Check Box to add to the page.
in_locations – Check 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.

PageKit &SetDropDownList(DropDownListKit const &in_drop_down_list, IntRectangle const &in_location)

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_list – Drop Down List to add to the page.
in_location – Drop 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.

PageKit &SetDropDownLists(DropDownListKitArray const &in_drop_down_list, IntRectangleArray const &in_locations)

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_list – Drop Down List to add to the page.
in_locations – Drop 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.

PageKit &SetDropDownLists(size_t in_count, DropDownListKit const in_drop_down_list[], IntRectangle const in_locations[])

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_count – Size of the following arrays.
in_drop_down_list – Drop Down List to add to the page.
in_locations – Drop 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.

PageKit &SetFormat(Page::Format in_format)

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_format – Format of the page.
Returns: A reference to this PageKit.

PageKit &SetImage(ImageKit const &in_image, IntRectangle const &in_location)

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_image – Image to add to the page.
in_location – Image 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.

PageKit &SetImages(ImageKitArray const &in_images, IntRectangleArray const &in_locations)

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_images – Images to add to the page.
in_locations – Image 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.

PageKit &SetImages(size_t in_count, ImageKit const in_images[], IntRectangle const in_locations[])

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_count – Size of the following arrays.
in_images – Images to add to the page.
in_locations – Image 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.

PageKit &SetJavaScriptActionByField(char const *in_field, char const *in_source, Source::Type in_type = Source::Type::Code)

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_field – UTF8-encoded form field name for the JavaScript action.
in_source – UTF8-encoded JavaScript source or file (depending on the following argument) to be set on the given form field.
in_type – The type of the preceding argument. Defaults to Source::Type::Code.

Returns

A reference to this PageKit.

PageKit &SetJavaScriptActionsByField(size_t in_count, UTF8 const in_fields[], UTF8 const in_sources[], Source::Type const in_types[])

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_count – Size of the following arrays.
in_fields – The form field names for the JavaScript actions.
in_sources – The JavaScript sources and/or files (depending on the corresponding entry in the following argument) to be set on the corresponding form fields.
in_types – The types for each item in the preceding argument array.

Returns

A reference to this PageKit.

PageKit &SetJavaScriptActionsByField(UTF8Array const &in_fields, UTF8Array const &in_sources, SourceTypeArray const &in_types)

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_fields – The form field names for the JavaScript actions.
in_sources – The JavaScript sources and/or files (depending on the corresponding entry in the following argument) to be set on the corresponding form fields.
in_types – The types for each item in the preceding argument array.

Returns

A reference to this PageKit.

PageKit &SetLink(LinkKit const &in_link, IntRectangle const &in_location)

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_link – Link to add to the page.
in_location – Link location in points relative to bottom left of the page. All fields in the location will be used.

Returns

A reference to this PageKit.

PageKit &SetLinks(LinkKitArray const &in_links, IntRectangleArray const &in_locations)

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_links – Links to add to the page.
in_locations – Link locations in points relative to bottom left of the page. All fields in the locations will be used.

Returns

A reference to this PageKit.

PageKit &SetLinks(size_t in_count, LinkKit const in_links[], IntRectangle const in_locations[])

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_count – Size of the following arrays.
in_links – Links to add to the page.
in_locations – Link locations in points relative to bottom left of the page. All fields in the locations will be used.

Returns

A reference to this PageKit.

PageKit &SetListBox(ListBoxKit const &in_list_box, IntRectangle const &in_location)

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_box – List Box to add to the page.
in_location – List 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.

PageKit &SetListBoxes(ListBoxKitArray const &in_list_box, IntRectangleArray const &in_locations)

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_box – List Box to add to the page.
in_locations – List 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.

PageKit &SetListBoxes(size_t in_count, ListBoxKit const in_list_box[], IntRectangle const in_locations[])

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_count – Size of the following arrays.
in_list_box – List Box to add to the page.
in_locations – List 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.

PageKit &SetListItemByField(char const *in_field, char const *in_value, char const *in_export_value)

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_field – UTF8-encoded form field name for the list.
in_value – UTF8-encoded value for the item to be added to the list at the given form field.
in_export_value – UTF8-encoded export value for the item to be added to the list at the given form field.

Returns

A reference to this PageKit.

PageKit &SetListItemsByField(char const *in_field, size_t in_count, UTF8 const in_values[], UTF8 const in_export_values[])

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_field – UTF8-encoded form field name for the list.
in_count – Size of the following arrays.
in_values – The values for the items to be added to the list at the given form field.
in_export_values – The export values for the items to be added to the list at the given form field.

Returns

A reference to this PageKit.

PageKit &SetListItemsByField(char const *in_field, UTF8Array const &in_values, UTF8Array const &in_export_values)

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_field – UTF8-encoded form field name for the list.
in_values – The values for the items to be added to the list at the given form field.
in_export_values – The export values for the items to be added to the list at the given form field.

Returns

A reference to this PageKit.

PageKit &SetOrientation(Page::Orientation in_orientation)

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_orientation – Orientation of the page.
Returns: A reference to this PageKit.

PageKit &SetRadioButton(RadioButtonKit const &in_radio_button, IntRectangle const &in_location)

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_button – Radio button to add to the page.
in_location – Button location in points relative to bottom left of the page. All fields in the location will be used.

Returns

A reference to this PageKit.

PageKit &SetRadioButtons(RadioButtonKitArray const &in_radio_buttons, IntRectangleArray const &in_locations)

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_buttons – Radio buttons to add to the page.
in_locations – Button locations in points relative to bottom left of the page. All fields in the locations will be used.

Returns

A reference to this PageKit.

PageKit &SetRadioButtons(size_t in_count, RadioButtonKit const in_radio_buttons[], IntRectangle const in_locations[])

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_count – Size of the following arrays.
in_radio_buttons – Radio buttons to add to the page.
in_locations – Button locations in points relative to bottom left of the page. All fields in the locations will be used.

Returns

A reference to this PageKit.

PageKit &SetSignatureField(SignatureFieldKit const &in_signature_field, IntRectangle const &in_location)

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_field – Signature Field to add to the page.
in_location – Signature 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.

PageKit &SetSignatureFields(SignatureFieldKitArray const &in_signature_field, IntRectangleArray const &in_locations)

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_field – Signature Field to add to the page.
in_locations – Signature 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.

PageKit &SetSignatureFields(size_t in_count, SignatureFieldKit const in_signature_field[], IntRectangle const in_locations[])

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_count – Size of the following arrays.
in_signature_field – Signature Field to add to the page.
in_locations – Signature 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.

PageKit &SetSlideTable(SlideTableKit const &in_slide_table, IntRectangle const &in_location)

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_table – Slide table to add to the page.
in_location – Slide 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.

PageKit &SetSlideTables(size_t in_count, SlideTableKit const in_slide_tables[], IntRectangle const in_locations[])

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_count – Size of the following arrays.
in_slide_tables – Slide tables to add to the page.
in_locations – Slide 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.

PageKit &SetSlideTables(SlideTableKitArray const &in_slide_tables, IntRectangleArray const &in_locations)

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_tables – Slide tables to add to the page.
in_locations – Slide 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.

PageKit &SetTable(TableKit const &in_table, IntRectangle const &in_location)

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_table – Table to add to the page.
in_location – 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.

PageKit &SetTables(size_t in_count, TableKit const in_tables[], IntRectangle const in_locations[])

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_count – Size of the following arrays.
in_tables – Tables to add to the page.
in_locations – 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.

PageKit &SetTables(TableKitArray const &in_tables, IntRectangleArray const &in_locations)

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_tables – Tables to add to the page.
in_locations – 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.

PageKit &SetTemplateFile(char const *in_filename)

Sets the PDF file which will act as a template.

Parameters: in_filename – UTF8-encoded filename for the PDF file to act as a template.
Returns: A reference to this PageKit.

PageKit &SetText(size_t in_count, TextKit const in_text[], IntRectangle const in_locations[])

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_count – Size of the following arrays.
in_text – Text to add to the page.
in_locations – Text 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.

PageKit &SetText(TextKit const &in_text, IntRectangle const &in_location)

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_text – Text to add to the page.
in_location – Text 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.

PageKit &SetText(TextKitArray const &in_text, IntRectangleArray const &in_locations)

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_text – Text to add to the page.
in_locations – Text 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.

PageKit &SetTextField(TextFieldKit const &in_text_field, IntRectangle const &in_location)

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_field – Text field to add to the page.
in_location – Text 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.

PageKit &SetTextFields(size_t in_count, TextFieldKit const in_text_fields[], IntRectangle const in_locations[])

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_count – Size of the following arrays.
in_text_fields – Text fields to add to the page.
in_locations – Text 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.

PageKit &SetTextFields(TextFieldKitArray const &in_text_fields, IntRectangleArray const &in_locations)

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_fields – Text fields to add to the page.
in_locations – Text 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.

PageKit &SetTextValueByField(char const *in_field, char const *in_value)

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_field – UTF8-encoded form field name for the text value.
in_value – UTF8-encoded text value to be set on the given form field.

Returns

A reference to this PageKit.

PageKit &SetTextValuesByField(size_t in_count, UTF8 const in_fields[], UTF8 const in_values[])

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_count – Size of the following arrays.
in_fields – The form field names for the text values.
in_values – The text values to be set on the corresponding form fields.

Returns

A reference to this PageKit.

PageKit &SetTextValuesByField(UTF8Array const &in_fields, UTF8Array const &in_values)

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_fields – The form field names for the text values.
in_values – The text values to be set on the corresponding form fields.

Returns

A reference to this PageKit.

PageKit &SetVisibilitiesByField(size_t in_count, UTF8 const in_fields[], bool const in_states[])

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_count – Size of the following arrays.
in_fields – The form field names on which to set visibility.
in_states – Whether the objects at the at the corresponding form fields should be visible.

Returns

A reference to this PageKit.

PageKit &SetVisibilitiesByField(UTF8Array const &in_fields, BoolArray const &in_states)

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_fields – The form field names on which to set visibility.
in_states – Whether the objects at the at the corresponding form fields should be visible.

Returns

A reference to this PageKit.

PageKit &SetVisibilityByField(char const *in_field, bool in_state)

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_field – UTF8-encoded form field name on which to set visibility.
in_state – Whether the object at the at the given form field should be visible.

Returns

A reference to this PageKit.

void Show(PageKit &out_kit) const

Copies this PageKit into the given PageKit.

Parameters: out_kit – The PageKit to populate with the contents of this PageKit.

bool ShowAnnotations(AnnotationKitArray &out_annotations, IntRectangleArray &out_locations) const

Shows the annotations on the page.

Parameters

out_annotations – Annotations on the page.
out_locations – Annotation locations on the page.

Returns

true if annotations were specified, false otherwise.

bool ShowAnnotationsByField(UTF8Array &out_fields, AnnotationKitArray &out_annotations) const

Shows the annotations on form fields on the page.

Parameters

out_fields – The annotation form field names on the page.
out_annotations – The annotations on the corresponding form fields.

Returns

true if form field annotations were specified, false otherwise.

bool ShowButtonIconsByField(UTF8Array &out_fields, ImageKitArray &out_images) const

Shows the images on icons on form fields on the page.

Parameters

out_fields – The button icon form field names on the page.
out_images – The images on the icons at the corresponding form fields.

Returns

true if form field icons were specified, false otherwise.

bool ShowButtonLabelsByField(UTF8Array &out_fields, UTF8Array &out_labels) const

Shows the labels on form fields on the page.

Parameters

out_fields – The button label form field names on the page.
out_labels – The labels on the corresponding form fields.

Returns

true if form field labels were specified, false otherwise.

bool ShowButtons(ButtonKitArray &out_buttons, IntRectangleArray &out_locations) const

Shows the buttons on the page.

Parameters

out_buttons – Buttons on the page.
out_locations – Button locations on the page.

Returns

true if buttons were specified, false otherwise.

bool ShowCheckBoxes(CheckBoxKitArray &out_check_boxes, IntRectangleArray &out_locations) const

Shows the check boxes on the page.

Parameters

out_check_boxes – Check boxes on the page.
out_locations – Check box locations on the page.

Returns

true if check boxes were specified, false otherwise.

bool ShowDropDownLists(DropDownListKitArray &out_drop_down_lists, IntRectangleArray &out_locations) const

Shows the drop down lists on the page.

Parameters

out_drop_down_lists – Drop down lists on the page.
out_locations – Drop drown list locations on the page.

Returns

true if drop down lists were specified, false otherwise.

bool ShowFormat(Page::Format &out_format) const

Shows the format of the page.

Parameters: out_format – Format of the page.
Returns: true if a format was specified, false otherwise.

bool ShowImages(ImageKitArray &out_images, IntRectangleArray &out_locations) const

Shows the images on the page.

Parameters

out_images – Images on the page.
out_locations – Image locations on the page.

Returns

true if images were specified, false otherwise.

bool ShowJavaScriptActionsByField(UTF8Array &out_fields, UTF8Array &out_sources, SourceTypeArray &out_types) const

Shows the JavaScript actions on form fields on the page.

Parameters

out_fields – The form field names with JavaScript actions on the page.
out_sources – The JavaScript sources and/or files (depending on the corresponding entry in the following argument) on the corresponding form fields.
out_types – The types for each item in the preceding argument array.

Returns

true if form field JavaScript actions were specified, false otherwise.

bool ShowLinks(LinkKitArray &out_links, IntRectangleArray &out_locations) const

Shows the links on the page.

Parameters

out_links – Links on the page.
out_locations – Link locations on the page.

Returns

true if links were specified, false otherwise.

bool ShowListBoxes(ListBoxKitArray &out_list_boxes, IntRectangleArray &out_locations) const

Shows the list boxes on the page.

Parameters

out_list_boxes – List boxes on the page.
out_locations – List boxes locations on the page.

Returns

true if list boxes were specified, false otherwise.

bool ShowListItemFields(UTF8Array &out_fields) const

Shows the list item form fields on the page.

Parameters: out_fields – The list form field names on the page.
Returns: true if any form field lists were specified, false otherwise.

bool ShowListItemsByField(char const *in_field, UTF8Array &out_values, UTF8Array &out_export_values) const

Shows the items in the list on the given field on the page.

Parameters

in_field – UTF8-encoded form field name of the list with the items to be shown.
out_values – The values for the items in the list at the given form field.
out_export_values – The export values for the items in the list at the given form field.

Returns

true if list items on the given form field were specified, false otherwise.

bool ShowOrientation(Page::Orientation &out_orientation) const

Shows the orientation of the page.

Parameters: out_orientation – Orientation of the page.
Returns: true if an orientation was specified, false otherwise.

bool ShowRadioButtons(RadioButtonKitArray &out_radio_buttons, IntRectangleArray &out_locations) const

Shows the radio buttons on the page.

Parameters

out_radio_buttons – Radio buttons on the page.
out_locations – Radio buttons locations on the page.

Returns

true if radio buttons were specified, false otherwise.

bool ShowSignatureFields(SignatureFieldKitArray &out_signature_fields, IntRectangleArray &out_locations) const

Shows the signature fields on the page.

Parameters

out_signature_fields – Signature fields on the page.
out_locations – Signature field locations on the page.

Returns

true if signature fields were specified, false otherwise.

bool ShowSlideTables(SlideTableKitArray &out_slide_tables, IntRectangleArray &out_locations) const

Shows the slide tables on the page.

Parameters

out_slide_tables – Slide tables on the page.
out_locations – Slide table locations on the page.

Returns

true if slide tables were specified, false otherwise.

bool ShowTables(TableKitArray &out_tables, IntRectangleArray &out_locations) const

Shows the tables on the page.

Parameters

out_tables – Tables on the page.
out_locations – Table locations on the page.

Returns

true if tables were specified, false otherwise.

bool ShowTemplateFile(UTF8 &out_filename) const

Shows the template file.

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

bool ShowText(TextKitArray &out_text, IntRectangleArray &out_locations) const

Shows the text on the page.

Parameters

out_text – Text on the page.
out_locations – Text locations on the page.

Returns

true if text strings were specified, false otherwise.

bool ShowTextFields(TextFieldKitArray &out_text_fields, IntRectangleArray &out_locations) const

Shows the text fields on the page.

Parameters

out_text_fields – Text fields on the page.
out_locations – Text field locations on the page.

Returns

true if text fields were specified, false otherwise.

bool ShowTextValuesByField(UTF8Array &out_fields, UTF8Array &out_values) const

Shows the text values on form fields on the page.

Parameters

out_fields – The form field names with the text values on the template.
out_values – The text values on the corresponding form fields.

Returns

true if form field text values were specified, false otherwise.

bool ShowVisibilitiesByField(UTF8Array &out_fields, BoolArray &out_states) const

Shows the visibility settings on form fields on the page.

Parameters

out_fields – The form field names with visibility settings on the page.
out_states – Whether the objects at the at the corresponding form fields should be visible.

Returns

true if form field visibilities were specified, false otherwise.

PageKit &UnsetAnnotation(size_t in_index)

Removes the annotation at the given index from the page.

Parameters: in_index – Index of the annotation to remove from the page.
Returns: A reference to this PageKit.

PageKit &UnsetAnnotationByField(char const *in_field)

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

Parameters: in_field – UTF8-encoded form field name with the annotation to be removed.
Returns: A reference to this PageKit.

PageKit &UnsetAnnotations()

Removes all annotations from the page.

Returns: A reference to this PageKit.

PageKit &UnsetAnnotations(size_t in_count, size_t const in_indices[])

Removes the annotations at the given indices from the page.

Parameters

in_count – Size of the following array.
in_indices – Indices of the annotations to remove from the page.

Returns

A reference to this PageKit.

PageKit &UnsetAnnotations(SizeTArray const &in_indices)

Removes the annotations at the given indices from the page.

Parameters: in_indices – Indices of the annotations to remove from the page.
Returns: A reference to this PageKit.

PageKit &UnsetAnnotationsByField()

Removes all annotation form fields from the page.

Returns: A reference to this PageKit.

PageKit &UnsetAnnotationsByField(size_t in_count, UTF8 const in_fields[])

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

Parameters

in_count – Size of the following array.
in_fields – Form field names with the annotations to be removed.

Returns

A reference to this PageKit.

PageKit &UnsetAnnotationsByField(UTF8Array const &in_fields)

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

Parameters: in_fields – Form field names with the annotations to be removed.
Returns: A reference to this PageKit.

PageKit &UnsetButton(size_t in_index)

Removes the button at the given index from the page.

Parameters: in_index – Index of the button to remove from the page.
Returns: A reference to this PageKit.

PageKit &UnsetButtonIconByField(char const *in_field)

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

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

PageKit &UnsetButtonIconsByField()

Removes all button icon form fields from the page.

Returns: A reference to this PageKit.

PageKit &UnsetButtonIconsByField(size_t in_count, UTF8 const in_fields[])

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

Parameters

in_count – Size of the following array.
in_fields – Form field names of icons with the images to be removed.

Returns

A reference to this PageKit.

PageKit &UnsetButtonIconsByField(UTF8Array const &in_fields)

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

Parameters: in_fields – Form field names of icons with the images to be removed.
Returns: A reference to this PageKit.

PageKit &UnsetButtonLabelByField(char const *in_field)

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

Parameters: in_field – UTF8-encoded form field name of the label to be removed.
Returns: A reference to this PageKit.

PageKit &UnsetButtonLabelsByField()

Removes all button label form fields from the page.

Returns: A reference to this PageKit.

PageKit &UnsetButtonLabelsByField(size_t in_count, UTF8 const in_fields[])

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

Parameters

in_count – Size of the following array.
in_fields – Form field names of the labels to be removed.

Returns

A reference to this PageKit.

PageKit &UnsetButtonLabelsByField(UTF8Array const &in_fields)

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

Parameters: in_fields – Form field names of the labels to be removed.
Returns: A reference to this PageKit.

PageKit &UnsetButtons()

Removes all buttons from the page.

Returns: A reference to this PageKit.

PageKit &UnsetButtons(size_t in_count, size_t const in_indices[])

Removes the buttons at the given indices from the page.

Parameters

in_count – Size of the following array.
in_indices – Indices of the buttons to remove from the page.

Returns

A reference to this PageKit.

PageKit &UnsetButtons(SizeTArray const &in_indices)

Removes the buttons at the given indices from the page.

Parameters: in_indices – Indices of the buttons to remove from the page.
Returns: A reference to this PageKit.

PageKit &UnsetCheckBox(size_t in_index)

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

Parameters: in_index – Index of the check box to remove from the page.
Returns: A reference to this PageKit.

PageKit &UnsetCheckBoxes()

Removes all check boxes from the page.

Returns: A reference to this PageKit.

PageKit &UnsetCheckBoxes(size_t in_count, size_t const in_indices[])

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

Parameters

in_count – Size of the following array.
in_indices – Indices of the check box to remove from the page.

Returns

A reference to this PageKit.

PageKit &UnsetCheckBoxes(SizeTArray const &in_indices)

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

Parameters: in_indices – Indices of the check box to remove from the page.
Returns: A reference to this PageKit.

PageKit &UnsetDropDownList(size_t in_index)

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

Parameters: in_index – Index of the drop down list to remove from the page.
Returns: A reference to this PageKit.

PageKit &UnsetDropDownLists()

Removes all drop down lists from the page.

Returns: A reference to this PageKit.

PageKit &UnsetDropDownLists(size_t in_count, size_t const in_indices[])

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

Parameters

in_count – Size of the following array.
in_indices – Indices of the drop down list to remove from the page.

Returns

A reference to this PageKit.

PageKit &UnsetDropDownLists(SizeTArray const &in_indices)

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

Parameters: in_indices – Indices of the drop down list to remove from the page.
Returns: A reference to this PageKit.

PageKit &UnsetEverything()

Removes all data from the page.

Returns: A reference to this PageKit.

PageKit &UnsetFormat()

Removes the format from the page.

Returns: A reference to this PageKit.

PageKit &UnsetImage(size_t in_index)

Removes the image at the given index from the page.

Parameters: in_index – Index of the image to remove from the page.
Returns: A reference to this PageKit.

PageKit &UnsetImages()

Removes all images from the page.

Returns: A reference to this PageKit.

PageKit &UnsetImages(size_t in_count, size_t const in_indices[])

Removes the images at the given indices from the page.

Parameters

in_count – Size of the following array.
in_indices – Indices of the images to remove from the page.

Returns

A reference to this PageKit.

PageKit &UnsetImages(SizeTArray const &in_indices)

Removes the images at the given indices from the page.

Parameters: in_indices – Indices of the images to remove from the page.
Returns: A reference to this PageKit.

PageKit &UnsetJavaScriptActionByField(char const *in_field)

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

Parameters: in_field – UTF8-encoded form field name of the action to be removed.
Returns: A reference to this PageKit.

PageKit &UnsetJavaScriptActionsByField()

Removes all JavaScript action form fields from the page.

Returns: A reference to this PageKit.

PageKit &UnsetJavaScriptActionsByField(size_t in_count, UTF8 const in_fields[])

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

Parameters

in_count – Size of the following array.
in_fields – Form field names of the actions to be removed.

Returns

A reference to this PageKit.

PageKit &UnsetJavaScriptActionsByField(UTF8Array const &in_fields)

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

Parameters: in_fields – Form field names of the actions to be removed.
Returns: A reference to this PageKit.

PageKit &UnsetLink(size_t in_index)

Removes the link at the given index from the page.

Parameters: in_index – Index of the link to remove from the page.
Returns: A reference to this PageKit.

PageKit &UnsetLinks()

Removes all links from the page.

Returns: A reference to this PageKit.

PageKit &UnsetLinks(size_t in_count, size_t const in_indices[])

Removes the links at the given indices from the page.

Parameters

in_count – Size of the following array.
in_indices – Indices of the links to remove from the page.

Returns

A reference to this PageKit.

PageKit &UnsetLinks(SizeTArray const &in_indices)

Removes the links at the given indices from the page.

Parameters: in_indices – Indices of the links to remove from the page.
Returns: A reference to this PageKit.

PageKit &UnsetListBox(size_t in_index)

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

Parameters: in_index – Index of the list box to remove from the page.
Returns: A reference to this PageKit.

PageKit &UnsetListBoxes()

Removes all list boxes from the page.

Returns: A reference to this PageKit.

PageKit &UnsetListBoxes(size_t in_count, size_t const in_indices[])

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

Parameters

in_count – Size of the following array.
in_indices – Indices of the list box to remove from the page.

Returns

A reference to this PageKit.

PageKit &UnsetListBoxes(SizeTArray const &in_indices)

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

Parameters: in_indices – Indices of the list box to remove from the page.
Returns: A reference to this PageKit.

PageKit &UnsetListItemByField(char const *in_field, size_t in_index)

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

Parameters

in_field – UTF8-encoded form field name of the list with the item to be removed.
in_index – Index of the item in the list at the given form field to be removed.

Returns

A reference to this PageKit.

PageKit &UnsetListItemsByField()

Removes all list item form fields from the page.

Returns: A reference to this PageKit.

PageKit &UnsetListItemsByField(char const *in_field)

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

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

PageKit &UnsetListItemsByField(char const *in_field, size_t in_count, size_t const in_indices[])

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

Parameters

in_field – UTF8-encoded form field name of the list with the items to be removed.
in_count – Size of the following array.
in_indices – Indices of the items in the list at the form field to be removed.

Returns

A reference to this PageKit.

PageKit &UnsetListItemsByField(char const *in_field, SizeTArray const &in_indices)

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

Parameters

in_field – UTF8-encoded form field name of the list with the items to be removed.
in_indices – Indices of the items in the list at the form field to be removed.

Returns

A reference to this PageKit.

PageKit &UnsetListItemsByField(size_t in_count, UTF8 const in_fields[])

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

Parameters

in_count – Size of the following array.
in_fields – Form field names of the lists with the items to be removed.

Returns

A reference to this PageKit.

PageKit &UnsetListItemsByField(UTF8Array const &in_fields)

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

Parameters: in_fields – Form field names of the lists with the items to be removed.
Returns: A reference to this PageKit.

PageKit &UnsetOrientation()

Removes the orientation from the page.

Returns: A reference to this PageKit.

PageKit &UnsetRadioButton(size_t in_index)

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

Parameters: in_index – Index of the radio button to remove from the page.
Returns: A reference to this PageKit.

PageKit &UnsetRadioButtons()

Removes all radio buttons from the page.

Returns: A reference to this PageKit.

PageKit &UnsetRadioButtons(size_t in_count, size_t const in_indices[])

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

Parameters

in_count – Size of the following array.
in_indices – Indices of the radio button to remove from the page.

Returns

A reference to this PageKit.

PageKit &UnsetRadioButtons(SizeTArray const &in_indices)

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

Parameters: in_indices – Indices of the radio button to remove from the page.
Returns: A reference to this PageKit.

PageKit &UnsetSignatureField(size_t in_index)

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

Parameters: in_index – Index of the signature field to remove from the page.
Returns: A reference to this PageKit.

PageKit &UnsetSignatureFields()

Removes all signature fields from the page.

Returns: A reference to this PageKit.

PageKit &UnsetSignatureFields(size_t in_count, size_t const in_indices[])

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

Parameters

in_count – Size of the following array.
in_indices – Indices of the signature field to remove from the page.

Returns

A reference to this PageKit.

PageKit &UnsetSignatureFields(SizeTArray const &in_indices)

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

Parameters: in_indices – Indices of the signature field to remove from the page.
Returns: A reference to this PageKit.

PageKit &UnsetSlideTable(size_t in_index)

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

Parameters: in_index – Index of the slide table to remove from the page.
Returns: A reference to this PageKit.

PageKit &UnsetSlideTables()

Removes all slide tables from the page.

Returns: A reference to this PageKit.

PageKit &UnsetSlideTables(size_t in_count, size_t const in_indices[])

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

Parameters

in_count – Size of the following array.
in_indices – Indices of the slide tables to remove from the page.

Returns

A reference to this PageKit.

PageKit &UnsetSlideTables(SizeTArray const &in_indices)

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

Parameters: in_indices – Indices of the slide tables to remove from the page.
Returns: A reference to this PageKit.

PageKit &UnsetTable(size_t in_index)

Removes the table at the given index from the page.

Parameters: in_index – Index of the table to remove from the page.
Returns: A reference to this PageKit.

PageKit &UnsetTables()

Removes all tables from the page.

Returns: A reference to this PageKit.

PageKit &UnsetTables(size_t in_count, size_t const in_indices[])

Removes the tables at the given indices from the page.

Parameters

in_count – Size of the following array.
in_indices – Indices of the tables to remove from the page.

Returns

A reference to this PageKit.

PageKit &UnsetTables(SizeTArray const &in_indices)

Removes the tables at the given indices from the page.

Parameters: in_indices – Indices of the tables to remove from the page.
Returns: A reference to this PageKit.

PageKit &UnsetTemplateFile()

Removes the template file from the page.

Returns: A reference to this PageKit.

PageKit &UnsetText()

Removes all text from the page.

Returns: A reference to this PageKit.

PageKit &UnsetText(size_t in_count, size_t const in_indices[])

Removes the text at the given indices from the page.

Parameters

in_count – Size of the following array.
in_indices – Indices of the text to remove from the page.

Returns

A reference to this PageKit.

PageKit &UnsetText(size_t in_index)

Removes the text at the given index from the page.

Parameters: in_index – Index of the text to remove from the page.
Returns: A reference to this PageKit.

PageKit &UnsetText(SizeTArray const &in_indices)

Removes the text at the given indices from the page.

Parameters: in_indices – Indices of the text to remove from the page.
Returns: A reference to this PageKit.

PageKit &UnsetTextField(size_t in_index)

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

Parameters: in_index – Index of the text field to remove from the page.
Returns: A reference to this PageKit.

PageKit &UnsetTextFields()

Removes all text fields from the page.

Returns: A reference to this PageKit.

PageKit &UnsetTextFields(size_t in_count, size_t const in_indices[])

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

Parameters

in_count – Size of the following array.
in_indices – Indices of the text fields to remove from the page.

Returns

A reference to this PageKit.

PageKit &UnsetTextFields(SizeTArray const &in_indices)

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

Parameters: in_indices – Indices of the text fields to remove from the page.
Returns: A reference to this PageKit.

PageKit &UnsetTextValueByField(char const *in_field)

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

Parameters: in_field – UTF8-encoded form field name with the text value to be removed.
Returns: A reference to this PageKit.

PageKit &UnsetTextValuesByField()

Removes all text value form fields from the page.

Returns: A reference to this PageKit.

PageKit &UnsetTextValuesByField(size_t in_count, UTF8 const in_fields[])

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

Parameters

in_count – Size of the following array.
in_fields – Form field names with the text values to be removed.

Returns

A reference to this PageKit.

PageKit &UnsetTextValuesByField(UTF8Array const &in_fields)

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

Parameters: in_fields – Form field names with the text values to be removed.
Returns: A reference to this PageKit.

PageKit &UnsetVisibilitiesByField()

Removes all visibility settings on form fields from the page.

Returns: A reference to this PageKit.

PageKit &UnsetVisibilitiesByField(size_t in_count, UTF8 const in_fields[])

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

Parameters

in_count – Size of the following array.
in_fields – Form field names with the visibility settings to be removed.

Returns

A reference to this PageKit.

PageKit &UnsetVisibilitiesByField(UTF8Array const &in_fields)

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

Parameters: in_fields – Form field names with the visibility settings to be removed.
Returns: A reference to this PageKit.

PageKit &UnsetVisibilityByField(char const *in_field)

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

Parameters: in_field – UTF8-encoded form field name with the visibility setting to be removed.
Returns: A reference to this PageKit.

virtual ~PageKit()

Public Static Functions

static PageKit GetDefault()

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.

Public Static Attributes

static const HPS::Type staticType = HPS::Type::PublishPageKit