< Home

< Table of Contents

REFERENCE MANUAL

HPS.Publish.PageControl Class Reference

The PageControl class is a smart pointer to a page within a Publish PDF document. More...

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

Public Member Functions

HPS.Publish.PageControl AddAnnotation (HPS.Publish.AnnotationKit in_annotation, HPS.IntRectangle in_location)
 Adds an annotation to the page. More...
 
HPS.Publish.PageControl AddAnnotations (HPS.Publish.AnnotationKit[] in_annotations, HPS.IntRectangle[] in_locations)
 Adds a list of annotations to the page. More...
 
HPS.Publish.PageControl AddButton (HPS.Publish.ButtonKit in_button, HPS.IntRectangle in_location)
 Adds a button to the page. More...
 
HPS.Publish.PageControl AddButtons (HPS.Publish.ButtonKit[] in_buttons, HPS.IntRectangle[] in_locations)
 Adds a list of buttons to the page. More...
 
HPS.Publish.PageControl AddCheckBox (HPS.Publish.CheckBoxKit in_check_box, HPS.IntRectangle in_location)
 Adds a check box to the page. More...
 
HPS.Publish.PageControl AddCheckBoxes (HPS.Publish.CheckBoxKit[] in_check_boxes, HPS.IntRectangle[] in_locations)
 Adds a list of check boxes to the page. More...
 
HPS.Publish.PageControl AddDropDownList (HPS.Publish.DropDownListKit in_drop_down_list, HPS.IntRectangle in_location)
 Adds a drop down list to the page. More...
 
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. More...
 
HPS.Publish.PageControl AddImage (HPS.Publish.ImageKit in_image, HPS.IntRectangle in_location)
 Adds an image to the page. More...
 
HPS.Publish.PageControl AddImages (HPS.Publish.ImageKit[] in_images, HPS.IntRectangle[] in_locations)
 Adds a list of images to the page. More...
 
HPS.Publish.PageControl AddLink (HPS.Publish.LinkKit in_link, HPS.IntRectangle in_location)
 Adds a link to the page. More...
 
HPS.Publish.PageControl AddLinks (HPS.Publish.LinkKit[] in_links, HPS.IntRectangle[] in_locations)
 Adds a list of links to the page. More...
 
HPS.Publish.PageControl AddListBox (HPS.Publish.ListBoxKit in_list_box, HPS.IntRectangle in_location)
 Adds a list box to the page. More...
 
HPS.Publish.PageControl AddListBoxes (HPS.Publish.ListBoxKit[] in_list_boxes, HPS.IntRectangle[] in_locations)
 Adds a list of list boxes to the page. More...
 
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. More...
 
HPS.Publish.PageControl AddListItemsByField (string in_field, string[] in_values, string[] in_export_values)
 Adds items to the list at the given form field. More...
 
HPS.Publish.PageControl AddRadioButton (HPS.Publish.RadioButtonKit in_radio_button, HPS.IntRectangle in_location)
 Adds a radio button to the page. More...
 
HPS.Publish.PageControl AddRadioButtons (HPS.Publish.RadioButtonKit[] in_radio_buttons, HPS.IntRectangle[] in_locations)
 Adds a list of radio buttons to the page. More...
 
HPS.Publish.PageControl AddSignatureField (HPS.Publish.SignatureFieldKit in_signature_field, HPS.IntRectangle in_location)
 Adds a signature field to the page. More...
 
HPS.Publish.PageControl AddSignatureFields (HPS.Publish.SignatureFieldKit[] in_signature_fields, HPS.IntRectangle[] in_locations)
 Adds a list of signature fields to the page. More...
 
HPS.Publish.PageControl AddSlideTable (HPS.Publish.SlideTableKit in_slide_table, HPS.IntRectangle in_location)
 Adds a slide table to the page. More...
 
HPS.Publish.PageControl AddSlideTables (HPS.Publish.SlideTableKit[] in_slide_tables, HPS.IntRectangle[] in_locations)
 Adds a list of slide tables to the page. More...
 
HPS.Publish.PageControl AddTable (HPS.Publish.TableKit in_table, HPS.IntRectangle in_location)
 Adds a table to the page. More...
 
HPS.Publish.PageControl AddTables (HPS.Publish.TableKit[] in_tables, HPS.IntRectangle[] in_locations)
 Adds a list of tables to the page. More...
 
HPS.Publish.PageControl AddText (HPS.Publish.TextKit in_text, HPS.IntRectangle in_location)
 Adds a text string to the page. More...
 
HPS.Publish.PageControl AddText (HPS.Publish.TextKit[] in_text, HPS.IntRectangle[] in_locations)
 Adds text strings to the page. More...
 
HPS.Publish.PageControl AddTextField (HPS.Publish.TextFieldKit in_text_field, HPS.IntRectangle in_location)
 Adds a text field to the page. More...
 
HPS.Publish.PageControl AddTextFields (HPS.Publish.TextFieldKit[] in_text_fields, HPS.IntRectangle[] in_locations)
 Adds a list of text fields to the page. More...
 
override void Dispose ()
 
override HPS.Type ObjectType ()
 This function returns the type the object, as declared. More...
 
 PageControl ()
 The default constructor creates an uninitialized PageControl object. More...
 
 PageControl (HPS.Publish.PageControl in_that)
 The copy constructor creates a PageControl object that shares the underlying smart-pointer of the source PageControl. More...
 
HPS.Publish.PageControl SetAnnotationByField (string in_field, HPS.Publish.AnnotationKit in_annotation)
 Sets an annotation on the given form field. More...
 
HPS.Publish.PageControl SetAnnotationsByField (string[] in_fields, HPS.Publish.AnnotationKit[] in_annotations)
 Sets annotations on the given form fields. More...
 
HPS.Publish.PageControl SetButtonIconByField (string in_field, HPS.Publish.ImageKit in_image)
 Sets an image on the icon at the given form field. More...
 
HPS.Publish.PageControl SetButtonIconsByField (string[] in_fields, HPS.Publish.ImageKit[] in_images)
 Sets images on the icons at the given form fields. More...
 
HPS.Publish.PageControl SetButtonLabelByField (string in_field, string in_label)
 Sets a label on the given form field. More...
 
HPS.Publish.PageControl SetButtonLabelsByField (string[] in_fields, string[] in_labels)
 Sets labels on the given form fields. More...
 
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. More...
 
HPS.Publish.PageControl SetJavaScriptActionByField (string in_field, string in_source)
 Sets a JavaScript source or file on the given form field. More...
 
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. More...
 
HPS.Publish.PageControl SetTextValueByField (string in_field, string in_value)
 Sets a text value on the given form field. More...
 
HPS.Publish.PageControl SetTextValuesByField (string[] in_fields, string[] in_values)
 Sets text values on the given form fields. More...
 
HPS.Publish.PageControl SetVisibilitiesByField (string[] in_fields, bool[] in_states)
 Sets whether the objects at the given form fields should be visible. More...
 
HPS.Publish.PageControl SetVisibilityByField (string in_field, bool in_state)
 Sets whether the object at the given form field should be visible. More...
 
bool ShowFields (out string[] out_names, out HPS.IntRectangle[] out_locations, out HPS.Publish.Field.Type[] out_types)
 Shows the PDF form fields on the page associated with this PageControl. More...
 
- Public Member Functions inherited from HPS.Sprocket
 Sprocket (HPS.Sprocket in_that)
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 Indicates whether this object has any values set on it. More...
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 Returns an identifier that can be used to identify which instance of a class an object is. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
 Object (HPS.Object in_that)
 The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More...
 
virtual void Reset ()
 Resets this object to its initial, uninitialized state. More...
 
HPS.Type Type ()
 This function returns the true type of the underlying object. More...
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Public Types inherited from HPS.Sprocket
enum  UpdateType { Synchronous = 0, Asynchronous = 1 }
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 
- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 
HandleRef scptr
 

Detailed Description

The PageControl class is a smart pointer to a page within a Publish PDF document.

It allows direct interaction with a PDF page.

Constructor & Destructor Documentation

HPS.Publish.PageControl.PageControl ( )

The default constructor creates an uninitialized PageControl object.

The Type() function will return Type::None.

HPS.Publish.PageControl.PageControl ( HPS.Publish.PageControl  in_that)

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

Parameters
in_thatThe source <ref refid="class_h_p_s_1_1_publish_1_1_page_control" kindref="compound">PageControl</ref> to copy.

Member Function Documentation

HPS.Publish.PageControl 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 <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/group__a3d__publish__page__module.html#ga7dfdb3dab2c487594a96cdba21f8295f">A3DPDFPageInsert3DAnnot</ulink>.

Parameters
in_annotation<ref refid="class_h_p_s_1_1_publish_1_1_annotation" kindref="compound">Annotation</ref> to add to the page.
in_location<ref refid="class_h_p_s_1_1_publish_1_1_annotation" kindref="compound">Annotation</ref> location in points relative to bottom left of the page. All fields in the location will be used.
Returns
A reference to this PageControl.
HPS.Publish.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 <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/group__a3d__publish__page__module.html#ga7dfdb3dab2c487594a96cdba21f8295f">A3DPDFPageInsert3DAnnot</ulink>.

Parameters
in_countSize of the following arrays.
in_annotationsAnnotations to add to the page.
in_locations<ref refid="class_h_p_s_1_1_publish_1_1_annotation" kindref="compound">Annotation</ref> locations in points relative to bottom left of the page.
Returns
A reference to this PageControl.
HPS.Publish.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 <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/group__a3d__publish__page__module.html#ga1727c2d83b817942b2a9a9759c7aa7c1">A3DPDFPageInsertButton</ulink>.

Parameters
in_buttonButton to add to the page.
in_locationButton location in points relative to bottom left of the page. All fields in the location will be used.
Returns
A reference to this PageControl.
HPS.Publish.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 <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/group__a3d__publish__page__module.html#ga1727c2d83b817942b2a9a9759c7aa7c1">A3DPDFPageInsertButton</ulink>.

Parameters
in_countSize of the following arrays.
in_buttonsButtons to add to the page.
in_locationsButton locations in points relative to bottom left of the page. All fields in the locations will be used.
Returns
A reference to this PageControl.
HPS.Publish.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 <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/group__a3d__publish__page__module.html#ga1727c2d83b817942b2a9a9759c7aa7c1">A3DPDFPageInsertCheckBox</ulink>.

Parameters
in_check_boxCheck box to add to the page.
in_locationCheck box location in points relative to bottom left of the page. All fields in the location will be used.
Returns
A reference to this PageControl.
HPS.Publish.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 <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/group__a3d__publish__page__module.html#ga1727c2d83b817942b2a9a9759c7aa7c1">A3DPDFPageInsertCheckBox</ulink>.

Parameters
in_countSize of the following arrays.
in_check_boxesCheck boxes to add to the page.
in_locationsCheck box locations in points relative to bottom left of the page. All fields in the locations will be used.
Returns
A reference to this PageControl.
HPS.Publish.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 <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/group__a3d__publish__page__module.html#ga1727c2d83b817942b2a9a9759c7aa7c1">A3DPDFPageInsertDropDownList</ulink>.

Parameters
in_drop_down_listDrop down list to add to the page.
in_locationDrop down list location in points relative to bottom left of the page. All fields in the location will be used.
Returns
A reference to this PageControl.
HPS.Publish.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 <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/group__a3d__publish__page__module.html#ga1727c2d83b817942b2a9a9759c7aa7c1">A3DPDFPageInsertDropDownList</ulink>.

Parameters
in_countSize of the following arrays.
in_drop_down_listsDrop down lists to add to the page.
in_locationsDrop down list locations in points relative to bottom left of the page. All fields in the locations will be used.
Returns
A reference to this PageControl.
HPS.Publish.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 <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/group__a3d__publish__page__module.html#ga4a0580850d8442f86b2af8856c02654a">A3DPDFPageInsertImage</ulink>.

Parameters
in_image<ref refid="class_h_p_s_1_1_publish_1_1_image" kindref="compound">Image</ref> to add to the page.
in_location<ref refid="class_h_p_s_1_1_publish_1_1_image" kindref="compound">Image</ref> 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 PageControl.
HPS.Publish.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 <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/group__a3d__publish__page__module.html#ga4a0580850d8442f86b2af8856c02654a">A3DPDFPageInsertImage</ulink>.

Parameters
in_countSize of the following arrays.
in_imagesImages to add to the page.
in_locations<ref refid="class_h_p_s_1_1_publish_1_1_image" kindref="compound">Image</ref> 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 PageControl.
HPS.Publish.PageControl HPS.Publish.PageControl.AddLink ( HPS.Publish.LinkKit  in_link,
HPS.IntRectangle  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 <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/group__a3d__publish__page__module.html#ga1822ea723295e01b53e222864b8efd31">A3DPDFPageInsertLink</ulink>.

Parameters
in_linkLink to add to the page.
in_locationLink location in points relative to bottom left of the page. All fields in the location will be used.
Returns
A reference to this PageControl.
HPS.Publish.PageControl HPS.Publish.PageControl.AddLinks ( HPS.Publish.LinkKit[]  in_links,
HPS.IntRectangle[]  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 <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/group__a3d__publish__page__module.html#ga1822ea723295e01b53e222864b8efd31">A3DPDFPageInsertLink</ulink>.

Parameters
in_countSize of the following arrays.
in_linksLinks to add to the page.
in_locationsLink locations in points relative to bottom left of the page. All fields in the locations will be used.
Returns
A reference to this PageControl.
HPS.Publish.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 <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/group__a3d__publish__page__module.html#ga1727c2d83b817942b2a9a9759c7aa7c1">A3DPDFPageInsertListBox</ulink>.

Parameters
in_list_boxList box to add to the page.
in_locationList box location in points relative to bottom left of the page. All fields in the location will be used.
Returns
A reference to this PageControl.
HPS.Publish.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 <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/group__a3d__publish__page__module.html#ga1727c2d83b817942b2a9a9759c7aa7c1">A3DPDFPageInsertListBox</ulink>.

Parameters
in_countSize of the following arrays.
in_list_boxesList boxes to add to the page.
in_locationsList box locations in points relative to bottom left of the page. All fields in the locations will be used.
Returns
A reference to this PageControl.
HPS.Publish.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 <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/group__a3d__publish__page__module.html#gae268fe9055181033df8eb554bf6d9ae6">A3DPDFPageFieldListAddItem</ulink>. This will only have an effect if the underlying page has a form field with the given name and is of the appropriate type.

Parameters
in_fieldUTF8-encoded form field name for the list.
in_valueUTF8-encoded value for the item to be added to the list at the given form field.
in_export_valueUTF8-encoded export value for the item to be added to the list at the given form field.
Returns
A reference to this PageControl.
HPS.Publish.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 <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/group__a3d__publish__page__module.html#gae268fe9055181033df8eb554bf6d9ae6">A3DPDFPageFieldListAddItem</ulink>. This will only have an effect if the underlying page has a form field with the given name and is of the appropriate type.

Parameters
in_fieldUTF8-encoded form field name for the list.
in_countSize of the following arrays.
in_valuesThe values for the items to be added to the list at the given form field.
in_export_valuesThe export values for the items to be added to the list at the given form field.
Returns
A reference to this PageControl.
HPS.Publish.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 <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/group__a3d__publish__page__module.html#ga1727c2d83b817942b2a9a9759c7aa7c1">A3DPDFPageInsertRadioButton</ulink>.

Parameters
in_radio_buttonRadio button to add to the page.
in_locationRadio button location in points relative to bottom left of the page. All fields in the location will be used.
Returns
A reference to this PageControl.
HPS.Publish.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 <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/group__a3d__publish__page__module.html#ga1727c2d83b817942b2a9a9759c7aa7c1">A3DPDFPageInsertRadioButton</ulink>.

Parameters
in_countSize of the following arrays.
in_radio_buttonsRadio buttons to add to the page.
in_locationsRadio button locations in points relative to bottom left of the page. All fields in the locations will be used.
Returns
A reference to this PageControl.
HPS.Publish.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 <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/group__a3d__publish__page__module.html#ga1727c2d83b817942b2a9a9759c7aa7c1">A3DPDFPageInsertSignatureField</ulink>.

Parameters
in_signature_fieldSignature field to add to the page.
in_locationSignature field location in points relative to bottom left of the page. All fields in the location will be used.
Returns
A reference to this PageControl.
HPS.Publish.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 <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/group__a3d__publish__page__module.html#ga1727c2d83b817942b2a9a9759c7aa7c1">A3DPDFPageInsertSignatureField</ulink>.

Parameters
in_countSize of the following arrays.
in_signature_fieldsSignature fields to add to the page.
in_locationsSignature field locations in points relative to bottom left of the page. All fields in the locations will be used.
Returns
A reference to this PageControl.
HPS.Publish.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 <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/group__a3d__publish__document__module.html#gad3131986068fd4ef196d26f841093b6c">A3DPDFDefineSlideTable</ulink>.

Parameters
in_slide_tableSlide table to add to the page.
in_locationSlide table location in points relative to upper left of the page. Only the left and top fields in the location will be used.
Returns
A reference to this PageControl.
HPS.Publish.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 <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/group__a3d__publish__document__module.html#gad3131986068fd4ef196d26f841093b6c">A3DPDFDefineSlideTable</ulink>.

Parameters
in_countSize of the following arrays.
in_slide_tablesSlide tables to add to the page.
in_locationsSlide table locations in points relative to upper left of the page. Only the left and top fields in the locations will be used.
Returns
A reference to this PageControl.
HPS.Publish.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 <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/group__a3d__publish__page__module.html#gae924b1a89f5cfa5cdbe2913480597b21">A3DPDFPageInsertTable</ulink>.

Parameters
in_tableTable to add to the page.
in_locationTable location in points relative to upper left of the page. Only the left and top fields in the location will be used.
Returns
A reference to this PageControl.
HPS.Publish.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 <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/group__a3d__publish__page__module.html#gae924b1a89f5cfa5cdbe2913480597b21">A3DPDFPageInsertTable</ulink>.

Parameters
in_countSize of the following arrays.
in_tablesTables to add to the page.
in_locationsTable locations in points relative to upper left of the page. Only the left and top fields in the locations will be used.
Returns
A reference to this PageControl.
HPS.Publish.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 <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/group__a3d__publish__page__module.html#gafd4ece4c88ce91b60228a4e72988b1ff">A3DPDFPageInsertText</ulink>.

Parameters
in_text<ref refid="class_h_p_s_1_1_publish_1_1_text" kindref="compound">Text</ref> to add to the page.
in_location<ref refid="class_h_p_s_1_1_publish_1_1_text" kindref="compound">Text</ref> 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 PageControl.
HPS.Publish.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 <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/group__a3d__publish__page__module.html#gafd4ece4c88ce91b60228a4e72988b1ff">A3DPDFPageInsertText</ulink>.

Parameters
in_countSize of the following arrays.
in_text<ref refid="class_h_p_s_1_1_publish_1_1_text" kindref="compound">Text</ref> to add to the page.
in_locations<ref refid="class_h_p_s_1_1_publish_1_1_text" kindref="compound">Text</ref> 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 PageControl.
HPS.Publish.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 <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/group__a3d__publish__page__module.html#ga04003d7a34557c95e84c462525ef1728">A3DPDFPageInsertTextField</ulink>.

Parameters
in_text_field<ref refid="class_h_p_s_1_1_publish_1_1_text" kindref="compound">Text</ref> field to add to the page.
in_location<ref refid="class_h_p_s_1_1_publish_1_1_text" kindref="compound">Text</ref> field location in points relative to bottom left of the page. All fields in the location will be used.
Returns
A reference to this PageControl.
HPS.Publish.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 <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/group__a3d__publish__page__module.html#ga04003d7a34557c95e84c462525ef1728">A3DPDFPageInsertTextField</ulink>.

Parameters
in_countSize of the following arrays.
in_text_fields<ref refid="class_h_p_s_1_1_publish_1_1_text" kindref="compound">Text</ref> fields to add to the page.
in_locations<ref refid="class_h_p_s_1_1_publish_1_1_text" kindref="compound">Text</ref> field locations in points relative to bottom left of the page. All fields in the locations will be used.
Returns
A reference to this PageControl.
override HPS.Type HPS.Publish.PageControl.ObjectType ( )
virtual

This function returns the type the object, as declared.

This does not necessarily give the true type of the underlying object.

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

Reimplemented from HPS.Object.

HPS.Publish.PageControl 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 <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/group__a3d__publish__page__module.html#gadf6f14b2368a856f31169dc03e0c501e">A3DPDFPageFieldSet3DAnnot</ulink>. This will only have an effect if the underlying page has a form field with the given name and is of the appropriate type.

Parameters
in_fieldUTF8-encoded form field name for the annotation.
in_annotationThe annotation to be set on the given form field.
Returns
A reference to this PageControl.
HPS.Publish.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 <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/group__a3d__publish__page__module.html#gadf6f14b2368a856f31169dc03e0c501e">A3DPDFPageFieldSet3DAnnot</ulink>. This will only have an effect if the underlying page has a form field with the given name and is of the appropriate type.

Parameters
in_countSize of the following arrays.
in_fieldsThe form field names for the annotations.
in_annotationsThe annotations to be set on the corresponding form fields.
Returns
A reference to this PageControl.
HPS.Publish.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 <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/group__a3d__publish__page__module.html#ga6051e30d012d9dd265fe8eb3a01f317f">A3DPDFPageFieldButtonSetIcon</ulink>. This will only have an effect if the underlying page has a form field with the given name and is of the appropriate type.

Parameters
in_fieldUTF8-encoded form field name for the icon.
in_imageThe image to be set on the icon at the given form field.
Returns
A reference to this PageControl.
HPS.Publish.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 <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/group__a3d__publish__page__module.html#ga6051e30d012d9dd265fe8eb3a01f317f">A3DPDFPageFieldButtonSetIcon</ulink>. This will only have an effect if the underlying page has a form field with the given name and is of the appropriate type.

Parameters
in_countSize of the following arrays.
in_fieldsThe form field names for the icons.
in_imagesThe images to be set on the icons at the corresponding form fields.
Returns
A reference to this PageControl.
HPS.Publish.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 <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/group__a3d__publish__page__module.html#gae268fe9055181033df8eb554bf6d9ae6">A3DPDFPageFieldButtonSetLabel</ulink>. This will only have an effect if the underlying page has a form field with the given name and is of the appropriate type.

Parameters
in_fieldUTF8-encoded form field name for the label.
in_labelUTF8-encoded label to be set on the given form field.
Returns
A reference to this PageControl.
HPS.Publish.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 <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/group__a3d__publish__page__module.html#gae268fe9055181033df8eb554bf6d9ae6">A3DPDFPageFieldButtonSetLabel</ulink>. This will only have an effect if the underlying page has a form field with the given name and is of the appropriate type.

Parameters
in_countSize of the following arrays.
in_fieldsThe form field names for the labels.
in_labelsThe labels to be set on the corresponding form fields.
Returns
A reference to this PageControl.
HPS.Publish.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 <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/group__a3d__publish__page__module.html#gac02217c03ab6cc02581362eab77c12f6">A3DPDFPageFieldSetActionJavascriptFromString</ulink> or <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/group__a3d__publish__page__module.html#gacf5655c5eb503b4c0fa6f719699a90ee">A3DPDFPageFieldSetActionJavascriptFromFile</ulink>. This will only have an effect if the underlying page has a form field with the given name and is of the appropriate type.

Parameters
in_fieldUTF8-encoded form field name for the JavaScript action.
in_sourceUTF8-encoded JavaScript source or file (depending on the following argument) to be set on the given form field.
in_typeThe type of the preceding argument. Defaults to <ref refid="class_h_p_s_1_1_publish_1_1_source_1a5e72b242e24c67a4d9d777bce395bb92aca0dbad92a874b2f69b549293387925e" kindref="member">Source::Type::Code</ref>.
Returns
A reference to this PageControl.
HPS.Publish.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 <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/group__a3d__publish__page__module.html#gac02217c03ab6cc02581362eab77c12f6">A3DPDFPageFieldSetActionJavascriptFromString</ulink> or <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/group__a3d__publish__page__module.html#gacf5655c5eb503b4c0fa6f719699a90ee">A3DPDFPageFieldSetActionJavascriptFromFile</ulink>. This will only have an effect if the underlying page has a form field with the given name and is of the appropriate type.

Parameters
in_fieldUTF8-encoded form field name for the JavaScript action.
in_sourceUTF8-encoded JavaScript source or file (depending on the following argument) to be set on the given form field.
Returns
A reference to this PageControl.
HPS.Publish.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 <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/group__a3d__publish__page__module.html#gac02217c03ab6cc02581362eab77c12f6">A3DPDFPageFieldSetActionJavascriptFromString</ulink> or <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/group__a3d__publish__page__module.html#gacf5655c5eb503b4c0fa6f719699a90ee">A3DPDFPageFieldSetActionJavascriptFromFile</ulink>. This will only have an effect if the underlying page has a form field with the given name and is of the appropriate type.

Parameters
in_countSize of the following arrays.
in_fieldsThe form field names for the JavaScript actions.
in_sourcesThe JavaScript sources and/or files (depending on the corresponding entry in the following argument) to be set on the corresponding form fields.
in_typesThe types for each item in the preceding argument array.
Returns
A reference to this PageControl.
HPS.Publish.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 <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/group__a3d__publish__page__module.html#ga8f171e2004b51ae1ebcec2eceb773b00">A3DPDFPageFieldTextSetValue</ulink>. This will only have an effect if the underlying page has a form field with the given name and is of the appropriate type.

Parameters
in_fieldUTF8-encoded form field name for the text value.
in_valueUTF8-encoded text value to be set on the given form field.
Returns
A reference to this PageControl.
HPS.Publish.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 <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/group__a3d__publish__page__module.html#ga8f171e2004b51ae1ebcec2eceb773b00">A3DPDFPageFieldTextSetValue</ulink>. This will only have an effect if the underlying page has a form field with the given name and is of the appropriate type.

Parameters
in_countSize of the following arrays.
in_fieldsThe form field names for the text values.
in_valuesThe text values to be set on the corresponding form fields.
Returns
A reference to this PageControl.
HPS.Publish.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 <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/group__a3d__publish__page__module.html#gacdabb9f6e7fc6a887de9516148549b8d">A3DPDFPageFieldSetVisibility</ulink>. This will only have an effect if the underlying page has a form field with the given name and is of the appropriate type.

Parameters
in_countSize of the following arrays.
in_fieldsThe form field names on which to set visibility.
in_statesWhether the objects at the at the corresponding form fields should be visible.
Returns
A reference to this PageControl.
HPS.Publish.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 <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/group__a3d__publish__page__module.html#gacdabb9f6e7fc6a887de9516148549b8d">A3DPDFPageFieldSetVisibility</ulink>. This will only have an effect if the underlying page has a form field with the given name and is of the appropriate type.

Parameters
in_fieldUTF8-encoded form field name on which to set visibility.
in_stateWhether the object at the at the given form field should be visible.
Returns
A reference to this PageControl.
bool HPS.Publish.PageControl.ShowFields ( out string[]  out_names,
out HPS.IntRectangle[]  out_locations,
out HPS.Publish.Field.Type[]  out_types 
)

Shows the PDF form fields on the page associated with this PageControl.

Parameters
out_namesThe names of the PDF form fields on the associated page.
out_locationsThe locations of the PDF form fields on the associated page.
out_typesThe types of the PDF form fields on the associated page.
Returns
true if there are any PDF form fields on the associated page, false otherwise.

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