HPS.Publish.PageControl

class HPS.Publish.PageControl : public HPS.Sprocket

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

Public Functions

HPS.Publish.PageControl AddAnnotation (HPS.Publish.AnnotationKit in_annotation, HPS.IntRectangle 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.

Param in_annotation

Annotation to add to the page.

Param in_location

Annotation location in points relative to bottom left of the page. All fields in the location will be used.

Return

A reference to this PageControl.

HPS.Publish.PageControl AddAnnotations (HPS.Publish.AnnotationKit[] in_annotations, HPS.IntRectangle[] 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.

Param in_annotations

Annotations to add to the page.

Param in_locations

Annotation locations in points relative to bottom left of the page.

Return

A reference to this PageControl.

HPS.Publish.PageControl AddButton (HPS.Publish.ButtonKit in_button, HPS.IntRectangle 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.

Param in_button

Button to add to the page.

Param in_location

Button location in points relative to bottom left of the page. All fields in the location will be used.

Return

A reference to this PageControl.

HPS.Publish.PageControl AddButtons (HPS.Publish.ButtonKit[] in_buttons, HPS.IntRectangle[] 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.

Param in_buttons

Buttons to add to the page.

Param in_locations

Button locations in points relative to bottom left of the page. All fields in the locations will be used.

Return

A reference to this PageControl.

HPS.Publish.PageControl AddCheckBox (HPS.Publish.CheckBoxKit in_check_box, HPS.IntRectangle 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.

Param in_check_box

Check box to add to the page.

Param in_location

Check box location in points relative to bottom left of the page. All fields in the location will be used.

Return

A reference to this PageControl.

HPS.Publish.PageControl AddCheckBoxes (HPS.Publish.CheckBoxKit[] in_check_boxes, HPS.IntRectangle[] in_locations)

Adds a list of 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.

Param in_check_boxes

Check boxes to add to the page.

Param in_locations

Check box locations in points relative to bottom left of the page. All fields in the locations will be used.

Return

A reference to this PageControl.

HPS.Publish.PageControl AddDropDownList (HPS.Publish.DropDownListKit in_drop_down_list, HPS.IntRectangle 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.

Param in_drop_down_list

Drop down list to add to the page.

Param in_location

Drop down list location in points relative to bottom left of the page. All fields in the location will be used.

Return

A reference to this PageControl.

HPS.Publish.PageControl AddDropDownLists (HPS.Publish.DropDownListKit[] in_drop_down_lists, HPS.IntRectangle[] in_locations)

Adds a list of 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.

Param in_drop_down_lists

Drop down lists to add to the page.

Param in_locations

Drop down list locations in points relative to bottom left of the page. All fields in the locations will be used.

Return

A reference to this PageControl.

HPS.Publish.PageControl AddImage (HPS.Publish.ImageKit in_image, HPS.IntRectangle 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.

Param in_image

Image to add to the page.

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

Return

A reference to this PageControl.

HPS.Publish.PageControl AddImages (HPS.Publish.ImageKit[] in_images, HPS.IntRectangle[] 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.

Param in_images

Images to add to the page.

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

Return

A reference to this PageControl.

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.

Param in_link

Link to add to the page.

Param in_location

Link location in points relative to bottom left of the page. All fields in the location will be used.

Return

A reference to this PageControl.

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.

Param in_links

Links to add to the page.

Param in_locations

Link locations in points relative to bottom left of the page. All fields in the locations will be used.

Return

A reference to this PageControl.

HPS.Publish.PageControl AddListBox (HPS.Publish.ListBoxKit in_list_box, HPS.IntRectangle 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.

Param in_list_box

List box to add to the page.

Param in_location

List box location in points relative to bottom left of the page. All fields in the location will be used.

Return

A reference to this PageControl.

HPS.Publish.PageControl AddListBoxes (HPS.Publish.ListBoxKit[] in_list_boxes, HPS.IntRectangle[] in_locations)

Adds a list of 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.

Param in_list_boxes

List boxes to add to the page.

Param in_locations

List box locations in points relative to bottom left of the page. All fields in the locations will be used.

Return

A reference to this PageControl.

HPS.Publish.PageControl AddListItemByField (string in_field, string in_value, string 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 underlying page has a form field with the given name and is of the appropriate type.

Param in_field

UTF8-encoded form field name for the list.

Param in_value

UTF8-encoded value for the item to be added to the list at the given form field.

Param in_export_value

UTF8-encoded export value for the item to be added to the list at the given form field.

Return

A reference to this PageControl.

HPS.Publish.PageControl AddListItemsByField (string in_field, string[] in_values, string[] 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 underlying page has a form field with the given name and is of the appropriate type.

Param in_field

UTF8-encoded form field name for the list.

Param in_values

The values for the items to be added to the list at the given form field.

Param in_export_values

The export values for the items to be added to the list at the given form field.

Return

A reference to this PageControl.

HPS.Publish.PageControl AddRadioButton (HPS.Publish.RadioButtonKit in_radio_button, HPS.IntRectangle 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.

Param in_radio_button

Radio button to add to the page.

Param in_location

Radio button location in points relative to bottom left of the page. All fields in the location will be used.

Return

A reference to this PageControl.

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

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

Param in_radio_buttons

Radio buttons to add to the page.

Param in_locations

Radio button locations in points relative to bottom left of the page. All fields in the locations will be used.

Return

A reference to this PageControl.

HPS.Publish.PageControl AddSignatureField (HPS.Publish.SignatureFieldKit in_signature_field, HPS.IntRectangle 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.

Param in_signature_field

Signature field to add to the page.

Param in_location

Signature field location in points relative to bottom left of the page. All fields in the location will be used.

Return

A reference to this PageControl.

HPS.Publish.PageControl AddSignatureFields (HPS.Publish.SignatureFieldKit[] in_signature_fields, HPS.IntRectangle[] in_locations)

Adds a list of 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.

Param in_signature_fields

Signature fields to add to the page.

Param in_locations

Signature field locations in points relative to bottom left of the page. All fields in the locations will be used.

Return

A reference to this PageControl.

HPS.Publish.PageControl AddSlideTable (HPS.Publish.SlideTableKit in_slide_table, HPS.IntRectangle 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.

Param in_slide_table

Slide table to add to the page.

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

Return

A reference to this PageControl.

HPS.Publish.PageControl AddSlideTables (HPS.Publish.SlideTableKit[] in_slide_tables, HPS.IntRectangle[] 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.

Param in_slide_tables

Slide tables to add to the page.

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

Return

A reference to this PageControl.

HPS.Publish.PageControl AddTable (HPS.Publish.TableKit in_table, HPS.IntRectangle 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.

Param in_table

Table to add to the page.

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

Return

A reference to this PageControl.

HPS.Publish.PageControl AddTables (HPS.Publish.TableKit[] in_tables, HPS.IntRectangle[] 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.

Param in_tables

Tables to add to the page.

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

Return

A reference to this PageControl.

HPS.Publish.PageControl AddText (HPS.Publish.TextKit in_text, HPS.IntRectangle 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.

Param in_text

Text to add to the page.

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

Return

A reference to this PageControl.

HPS.Publish.PageControl AddText (HPS.Publish.TextKit[] in_text, HPS.IntRectangle[] 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.

Param in_text

Text to add to the page.

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

Return

A reference to this PageControl.

HPS.Publish.PageControl AddTextField (HPS.Publish.TextFieldKit in_text_field, HPS.IntRectangle 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.

Param in_text_field

Text field to add to the page.

Param in_location

Text field location in points relative to bottom left of the page. All fields in the location will be used.

Return

A reference to this PageControl.

HPS.Publish.PageControl AddTextFields (HPS.Publish.TextFieldKit[] in_text_fields, HPS.IntRectangle[] 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.

Param in_text_fields

Text fields to add to the page.

Param in_locations

Text field locations in points relative to bottom left of the page. All fields in the locations will be used.

Return

A reference to this PageControl.

override HPS.Type ObjectType ()

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

Return

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

PageControl ()

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

PageControl (HPS.Publish.PageControl in_that)

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

Param in_that

The source PageControl to copy.

HPS.Publish.PageControl SetAnnotationByField (string in_field, HPS.Publish.AnnotationKit 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 underlying page has a form field with the given name and is of the appropriate type.

Param in_field

UTF8-encoded form field name for the annotation.

Param in_annotation

The annotation to be set on the given form field.

Return

A reference to this PageControl.

HPS.Publish.PageControl SetAnnotationsByField (string[] in_fields, HPS.Publish.AnnotationKit[] 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 underlying page has a form field with the given name and is of the appropriate type.

Param in_fields

The form field names for the annotations.

Param in_annotations

The annotations to be set on the corresponding form fields.

Return

A reference to this PageControl.

HPS.Publish.PageControl SetButtonIconByField (string in_field, HPS.Publish.ImageKit 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 underlying page has a form field with the given name and is of the appropriate type.

Param in_field

UTF8-encoded form field name for the icon.

Param in_image

The image to be set on the icon at the given form field.

Return

A reference to this PageControl.

HPS.Publish.PageControl SetButtonIconsByField (string[] in_fields, HPS.Publish.ImageKit[] 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 underlying page has a form field with the given name and is of the appropriate type.

Param in_fields

The form field names for the icons.

Param in_images

The images to be set on the icons at the corresponding form fields.

Return

A reference to this PageControl.

HPS.Publish.PageControl SetButtonLabelByField (string in_field, string 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 underlying page has a form field with the given name and is of the appropriate type.

Param in_field

UTF8-encoded form field name for the label.

Param in_label

UTF8-encoded label to be set on the given form field.

Return

A reference to this PageControl.

HPS.Publish.PageControl SetButtonLabelsByField (string[] in_fields, string[] 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 underlying page has a form field with the given name and is of the appropriate type.

Param in_fields

The form field names for the labels.

Param in_labels

The labels to be set on the corresponding form fields.

Return

A reference to this PageControl.

HPS.Publish.PageControl SetJavaScriptActionByField (string in_field, string in_source)

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 underlying page has a form field with the given name and is of the appropriate type.

Param in_field

UTF8-encoded form field name for the JavaScript action.

Param in_source

UTF8-encoded JavaScript source or file (depending on the following argument) to be set on the given form field.

Return

A reference to this PageControl.

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

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 underlying page has a form field with the given name and is of the appropriate type.

Param in_field

UTF8-encoded form field name for the JavaScript action.

Param in_source

UTF8-encoded JavaScript source or file (depending on the following argument) to be set on the given form field.

Param in_type

The type of the preceding argument. Defaults to Source.Type.Code.

Return

A reference to this PageControl.

HPS.Publish.PageControl SetJavaScriptActionsByField (string[] in_fields, string[] in_sources, HPS.Publish.Source.Type[] 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 underlying page has a form field with the given name and is of the appropriate type.

Param in_fields

The form field names for the JavaScript actions.

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

Param in_types

The types for each item in the preceding argument array.

Return

A reference to this PageControl.

HPS.Publish.PageControl SetTextValueByField (string in_field, string 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 underlying page has a form field with the given name and is of the appropriate type.

Param in_field

UTF8-encoded form field name for the text value.

Param in_value

UTF8-encoded text value to be set on the given form field.

Return

A reference to this PageControl.

HPS.Publish.PageControl SetTextValuesByField (string[] in_fields, string[] 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 underlying page has a form field with the given name and is of the appropriate type.

Param in_fields

The form field names for the text values.

Param in_values

The text values to be set on the corresponding form fields.

Return

A reference to this PageControl.

HPS.Publish.PageControl SetVisibilitiesByField (string[] in_fields, bool[] 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 underlying page has a form field with the given name and is of the appropriate type.

Param in_fields

The form field names on which to set visibility.

Param in_states

Whether the objects at the at the corresponding form fields should be visible.

Return

A reference to this PageControl.

HPS.Publish.PageControl SetVisibilityByField (string 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 underlying page has a form field with the given name and is of the appropriate type.

Param in_field

UTF8-encoded form field name on which to set visibility.

Param in_state

Whether the object at the at the given form field should be visible.

Return

A reference to this PageControl.