HPS.Publish.PageControl Class Reference
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)
 
HPS.Publish.PageControl AddAnnotations (HPS.Publish.AnnotationKit[] in_annotations, HPS.IntRectangle[] in_locations)
 
HPS.Publish.PageControl AddButton (HPS.Publish.ButtonKit in_button, HPS.IntRectangle in_location)
 
HPS.Publish.PageControl AddButtons (HPS.Publish.ButtonKit[] in_buttons, HPS.IntRectangle[] in_locations)
 
HPS.Publish.PageControl AddCheckBox (HPS.Publish.CheckBoxKit in_check_box, HPS.IntRectangle in_location)
 
HPS.Publish.PageControl AddCheckBoxes (HPS.Publish.CheckBoxKit[] in_check_boxes, HPS.IntRectangle[] in_locations)
 
HPS.Publish.PageControl AddDropDownList (HPS.Publish.DropDownListKit in_drop_down_list, HPS.IntRectangle in_location)
 
HPS.Publish.PageControl AddDropDownLists (HPS.Publish.DropDownListKit[] in_drop_down_lists, HPS.IntRectangle[] in_locations)
 
HPS.Publish.PageControl AddImage (HPS.Publish.ImageKit in_image, HPS.IntRectangle in_location)
 
HPS.Publish.PageControl AddImages (HPS.Publish.ImageKit[] in_images, HPS.IntRectangle[] in_locations)
 
HPS.Publish.PageControl AddLink (HPS.Publish.LinkKit in_link, HPS.IntRectangle in_location)
 
HPS.Publish.PageControl AddLinks (HPS.Publish.LinkKit[] in_links, HPS.IntRectangle[] in_locations)
 
HPS.Publish.PageControl AddListBox (HPS.Publish.ListBoxKit in_list_box, HPS.IntRectangle in_location)
 
HPS.Publish.PageControl AddListBoxes (HPS.Publish.ListBoxKit[] in_list_boxes, HPS.IntRectangle[] in_locations)
 
HPS.Publish.PageControl AddListItemByField (string in_field, string in_value, string in_export_value)
 
HPS.Publish.PageControl AddListItemsByField (string in_field, string[] in_values, string[] in_export_values)
 
HPS.Publish.PageControl AddRadioButton (HPS.Publish.RadioButtonKit in_radio_button, HPS.IntRectangle in_location)
 
HPS.Publish.PageControl AddRadioButtons (HPS.Publish.RadioButtonKit[] in_radio_buttons, HPS.IntRectangle[] in_locations)
 
HPS.Publish.PageControl AddSignatureField (HPS.Publish.SignatureFieldKit in_signature_field, HPS.IntRectangle in_location)
 
HPS.Publish.PageControl AddSignatureFields (HPS.Publish.SignatureFieldKit[] in_signature_fields, HPS.IntRectangle[] in_locations)
 
HPS.Publish.PageControl AddSlideTable (HPS.Publish.SlideTableKit in_slide_table, HPS.IntRectangle in_location)
 
HPS.Publish.PageControl AddSlideTables (HPS.Publish.SlideTableKit[] in_slide_tables, HPS.IntRectangle[] in_locations)
 
HPS.Publish.PageControl AddTable (HPS.Publish.TableKit in_table, HPS.IntRectangle in_location)
 
HPS.Publish.PageControl AddTables (HPS.Publish.TableKit[] in_tables, HPS.IntRectangle[] in_locations)
 
HPS.Publish.PageControl AddText (HPS.Publish.TextKit in_text, HPS.IntRectangle in_location)
 
HPS.Publish.PageControl AddText (HPS.Publish.TextKit[] in_text, HPS.IntRectangle[] in_locations)
 
HPS.Publish.PageControl AddTextField (HPS.Publish.TextFieldKit in_text_field, HPS.IntRectangle in_location)
 
HPS.Publish.PageControl AddTextFields (HPS.Publish.TextFieldKit[] in_text_fields, HPS.IntRectangle[] in_locations)
 
override void Dispose ()
 
override HPS.Type ObjectType ()
 
 PageControl ()
 
 PageControl (HPS.Publish.PageControl in_that)
 
HPS.Publish.PageControl SetAnnotationByField (string in_field, HPS.Publish.AnnotationKit in_annotation)
 
HPS.Publish.PageControl SetAnnotationsByField (string[] in_fields, HPS.Publish.AnnotationKit[] in_annotations)
 
HPS.Publish.PageControl SetButtonIconByField (string in_field, HPS.Publish.ImageKit in_image)
 
HPS.Publish.PageControl SetButtonIconsByField (string[] in_fields, HPS.Publish.ImageKit[] in_images)
 
HPS.Publish.PageControl SetButtonLabelByField (string in_field, string in_label)
 
HPS.Publish.PageControl SetButtonLabelsByField (string[] in_fields, string[] in_labels)
 
HPS.Publish.PageControl SetJavaScriptActionByField (string in_field, string in_source, HPS.Publish.Source.Type in_type)
 
HPS.Publish.PageControl SetJavaScriptActionByField (string in_field, string in_source)
 
HPS.Publish.PageControl SetJavaScriptActionsByField (string[] in_fields, string[] in_sources, HPS.Publish.Source.Type[] in_types)
 
HPS.Publish.PageControl SetTextValueByField (string in_field, string in_value)
 
HPS.Publish.PageControl SetTextValuesByField (string[] in_fields, string[] in_values)
 
HPS.Publish.PageControl SetVisibilitiesByField (string[] in_fields, bool[] in_states)
 
HPS.Publish.PageControl SetVisibilityByField (string in_field, bool in_state)
 
bool ShowFields (out string[] out_names, out HPS.IntRectangle[] out_locations, out HPS.Publish.Field.Type[] out_types)
 
- Public Member Functions inherited from HPS.Sprocket
Sprocket (HPS.Sprocket in_that)
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
Object (HPS.Object that)
 
virtual void Reset ()
 
virtual HPS.Type Type ()
 

Protected Member Functions

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

Additional Inherited Members

- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 
- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

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

◆ PageControl() [1/2]

HPS.Publish.PageControl.PageControl ( )
inline

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

◆ PageControl() [2/2]

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

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

Parameters
in_thatThe source PageControl to copy.

Member Function Documentation

◆ AddAnnotation()

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

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

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

◆ AddAnnotations()

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

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

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

◆ AddButton()

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

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

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

◆ AddButtons()

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

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

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

◆ AddCheckBox()

HPS.Publish.PageControl HPS.Publish.PageControl.AddCheckBox ( HPS.Publish.CheckBoxKit  in_check_box,
HPS.IntRectangle  in_location 
)
inline

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

Parameters
in_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.

◆ AddCheckBoxes()

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

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.

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

◆ AddDropDownList()

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

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

Parameters
in_drop_down_listDrop down list to add to the page.
in_locationDrop down list location in points relative to bottom left of the page. All fields in the location will be used.
Returns
A reference to this PageControl.

◆ AddDropDownLists()

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

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.

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

◆ AddImage()

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

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

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

◆ AddImages()

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

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

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

◆ AddLink()

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

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

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

◆ AddLinks()

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

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

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

◆ AddListBox()

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

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

Parameters
in_list_boxList box to add to the page.
in_locationList box location in points relative to bottom left of the page. All fields in the location will be used.
Returns
A reference to this PageControl.

◆ AddListBoxes()

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

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.

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

◆ AddListItemByField()

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

Adds an item to the list at the given form field. The item to will be appended to any existing items in the list at the given form field. This corresponds to the value that will be passed to A3DPDFPageFieldListAddItem. This will only have an effect if the 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.

◆ AddListItemsByField()

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

Adds items to the list at the given form field. The items to will be appended to any existing items in the list at the given form field. These correspond to values that will be passed to A3DPDFPageFieldListAddItem. This will only have an effect if the 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_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.

◆ AddRadioButton()

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

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

Parameters
in_radio_buttonRadio button to add to the page.
in_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.

◆ AddRadioButtons()

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

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.

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

◆ AddSignatureField()

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

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

Parameters
in_signature_fieldSignature field to add to the page.
in_locationSignature field location in points relative to bottom left of the page. All fields in the location will be used.
Returns
A reference to this PageControl.

◆ AddSignatureFields()

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

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.

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

◆ AddSlideTable()

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

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

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

◆ AddSlideTables()

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

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

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

◆ AddTable()

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

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

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

◆ AddTables()

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

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

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

◆ AddText() [1/2]

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

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

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

◆ AddText() [2/2]

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

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

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

◆ AddTextField()

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

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

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

◆ AddTextFields()

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

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

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

◆ ObjectType()

override HPS.Type HPS.Publish.PageControl.ObjectType ( )
inlinevirtual

This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).

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

Reimplemented from HPS.Object.

◆ SetAnnotationByField()

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

Sets an annotation on the given form field. If there is an existing annotation on the given form field, it will get overwritten. This corresponds to the value that will be passed to A3DPDFPageFieldSet3DAnnot. This will only have an effect if the 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.

◆ SetAnnotationsByField()

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

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

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

◆ SetButtonIconByField()

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

Sets an image on the icon at the given form field. If there is an existing image on an icon at the given form field, it will get overwritten. This corresponds to the value that will be passed to A3DPDFPageFieldButtonSetIcon. This will only have an effect if the 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.

◆ SetButtonIconsByField()

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

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

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

◆ SetButtonLabelByField()

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

Sets a label on the given form field. If there is an existing label on the given form field, it will get overwritten. This corresponds to the value that will be passed to A3DPDFPageFieldButtonSetLabel. This will only have an effect if the 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.

◆ SetButtonLabelsByField()

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

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

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

◆ SetJavaScriptActionByField() [1/2]

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

Sets a JavaScript source or file on the given form field. If there is any existing JavaScript source or file at the given form field, it will be overwritten. This corresponds to the value that will be passed to A3DPDFPageFieldSetActionJavascriptFromString or A3DPDFPageFieldSetActionJavascriptFromFile. This will only have an effect if the 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 Source.Type.Code.
Returns
A reference to this PageControl.

◆ SetJavaScriptActionByField() [2/2]

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

Sets a JavaScript source or file on the given form field. If there is any existing JavaScript source or file at the given form field, it will be overwritten. This corresponds to the value that will be passed to A3DPDFPageFieldSetActionJavascriptFromString or A3DPDFPageFieldSetActionJavascriptFromFile. This will only have an effect if the 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.

◆ SetJavaScriptActionsByField()

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

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

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

◆ SetTextValueByField()

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

Sets a text value on the given form field. If there is an existing text value on the given form field, it will get overwritten. This corresponds to the value that will be passed to A3DPDFPageFieldTextSetValue. This will only have an effect if the 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.

◆ SetTextValuesByField()

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

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

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

◆ SetVisibilitiesByField()

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

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

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

◆ SetVisibilityByField()

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

Sets whether the object at the given form field should be visible. If there is an existing visibility on the given form field, it will get overwritten. This corresponds to the value that will be passed to A3DPDFPageFieldSetVisibility. This will only have an effect if the 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.

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