The PageKit class is a user space object. It acts as the container for all data that can be on a page in a Publish PDF. More...

Public Member Functions | |
HPS.Publish.PageKit | 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/publish/latest/build/api_ref/group__a3d__publish__page__module.html#ga7dfdb3dab2c487594a96cdba21f8295f">A3DPDFPageInsert3DAnnot</ulink>. More... | |
HPS.Publish.PageKit | 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/publish/latest/build/api_ref/group__a3d__publish__page__module.html#ga7dfdb3dab2c487594a96cdba21f8295f">A3DPDFPageInsert3DAnnot</ulink>. More... | |
HPS.Publish.PageKit | 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/publish/latest/build/api_ref/group__a3d__publish__page__module.html#ga1727c2d83b817942b2a9a9759c7aa7c1">A3DPDFPageInsertButton</ulink>. More... | |
HPS.Publish.PageKit | 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/publish/latest/build/api_ref/group__a3d__publish__page__module.html#ga1727c2d83b817942b2a9a9759c7aa7c1">A3DPDFPageInsertButton</ulink>. More... | |
HPS.Publish.PageKit | AddCheckBox (HPS.Publish.CheckBoxKit in_checkbox, 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/publish/latest/build/api_ref/group__a3d__publish__page__module.html#ga7433812feb725392327a6266e38d85a4">A3DPDFPageInsertCheckBox</ulink>. More... | |
HPS.Publish.PageKit | AddCheckBoxes (HPS.Publish.CheckBoxKit[] in_checkbox, HPS.IntRectangle[] in_locations) |
Adds check boxes to the page. This will not replace any check boxes on the page. These correspond to values that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#ga7433812feb725392327a6266e38d85a4">A3DPDFPageInsertCheckBox</ulink>. More... | |
HPS.Publish.PageKit | 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/publish/latest/build/api_ref/group__a3d__publish__page__module.html#gab9b0df08811a3e7005540ad1114ad818">A3DPDFPageInsertDropDownList</ulink>. More... | |
HPS.Publish.PageKit | AddDropDownLists (HPS.Publish.DropDownListKit[] in_drop_down_list, HPS.IntRectangle[] in_locations) |
Adds drop down lists to the page. This will not replace any drop down lists on the page. These correspond to values that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#gab9b0df08811a3e7005540ad1114ad818">A3DPDFPageInsertDropDownList</ulink>. More... | |
HPS.Publish.PageKit | 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/publish/latest/build/api_ref/group__a3d__publish__page__module.html#ga4a0580850d8442f86b2af8856c02654a">A3DPDFPageInsertImage</ulink>. More... | |
HPS.Publish.PageKit | 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/publish/latest/build/api_ref/group__a3d__publish__page__module.html#ga4a0580850d8442f86b2af8856c02654a">A3DPDFPageInsertImage</ulink>. More... | |
HPS.Publish.PageKit | 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/publish/latest/build/api_ref/group__a3d__publish__page__module.html#ga1822ea723295e01b53e222864b8efd31">A3DPDFPageInsertLink</ulink>. More... | |
HPS.Publish.PageKit | 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/publish/latest/build/api_ref/group__a3d__publish__page__module.html#ga1822ea723295e01b53e222864b8efd31">A3DPDFPageInsertLink</ulink>. More... | |
HPS.Publish.PageKit | 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/publish/latest/build/api_ref/group__a3d__publish__page__module.html#ga2f971ef3bf91640243af5beb32d79ad2">A3DPDFPageInsertListBox</ulink>. More... | |
HPS.Publish.PageKit | AddListBoxes (HPS.Publish.ListBoxKit[] in_list_box, HPS.IntRectangle[] in_locations) |
Adds list boxes to the page. This will not replace any list boxes on the page. These correspond to values that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#ga2f971ef3bf91640243af5beb32d79ad2">A3DPDFPageInsertListBox</ulink>. More... | |
HPS.Publish.PageKit | 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/publish/latest/build/api_ref/group__a3d__publish__page__module.html#gae268fe9055181033df8eb554bf6d9ae6">A3DPDFPageFieldListAddItem</ulink>. This will only have an effect if the page has a template file. More... | |
HPS.Publish.PageKit | 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/publish/latest/build/api_ref/group__a3d__publish__page__module.html#gae268fe9055181033df8eb554bf6d9ae6">A3DPDFPageFieldListAddItem</ulink>. This will only have an effect if the page has a template file. More... | |
HPS.Publish.PageKit | 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/publish/latest/build/api_ref/group__a3d__publish__page__module.html#gac24f87cbf1a247c8516ebfa6f7cf7f89">A3DPDFPageInsertRadioButton</ulink>. More... | |
HPS.Publish.PageKit | AddRadioButtons (HPS.Publish.RadioButtonKit[] in_radio_buttons, HPS.IntRectangle[] in_locations) |
Adds a list of buttons to the page. This will not replace any radio buttons on the page. These correspond to values that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#gac24f87cbf1a247c8516ebfa6f7cf7f89">A3DPDFPageInsertRadioButton</ulink>. More... | |
HPS.Publish.PageKit | 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/publish/latest/build/api_ref/group__a3d__publish__page__module.html#ga3f2f1980667a3a840923320736264203">A3DPDFPageInsertSignatureField</ulink>. More... | |
HPS.Publish.PageKit | AddSignatureFields (HPS.Publish.SignatureFieldKit[] in_signature_field, HPS.IntRectangle[] in_locations) |
Adds signature fields to the page. This will not replace any signature fields on the page. These correspond to values that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#ga3f2f1980667a3a840923320736264203">A3DPDFPageInsertSignatureField</ulink>. More... | |
HPS.Publish.PageKit | 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/publish/latest/build/api_ref/group__a3d__publish__document__module.html#gad3131986068fd4ef196d26f841093b6c">A3DPDFDefineSlideTable</ulink>. More... | |
HPS.Publish.PageKit | 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/publish/latest/build/api_ref/group__a3d__publish__document__module.html#gad3131986068fd4ef196d26f841093b6c">A3DPDFDefineSlideTable</ulink>. More... | |
HPS.Publish.PageKit | 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/publish/latest/build/api_ref/group__a3d__publish__page__module.html#gae924b1a89f5cfa5cdbe2913480597b21">A3DPDFPageInsertTable</ulink>. More... | |
HPS.Publish.PageKit | 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/publish/latest/build/api_ref/group__a3d__publish__page__module.html#gae924b1a89f5cfa5cdbe2913480597b21">A3DPDFPageInsertTable</ulink>. More... | |
HPS.Publish.PageKit | 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/publish/latest/build/api_ref/group__a3d__publish__page__module.html#gafd4ece4c88ce91b60228a4e72988b1ff">A3DPDFPageInsertText</ulink>. More... | |
HPS.Publish.PageKit | 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/publish/latest/build/api_ref/group__a3d__publish__page__module.html#gafd4ece4c88ce91b60228a4e72988b1ff">A3DPDFPageInsertText</ulink>. More... | |
HPS.Publish.PageKit | 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/publish/latest/build/api_ref/group__a3d__publish__page__module.html#ga04003d7a34557c95e84c462525ef1728">A3DPDFPageInsertTextField</ulink>. More... | |
HPS.Publish.PageKit | 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/publish/latest/build/api_ref/group__a3d__publish__page__module.html#ga04003d7a34557c95e84c462525ef1728">A3DPDFPageInsertTextField</ulink>. More... | |
override void | Dispose () |
override bool | Empty () |
Indicates whether this PageKit has any values set on it. More... | |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.Publish.PageKit in_kit) |
Check if the source PageKit is equivalent to this PageKit. More... | |
override int | GetHashCode () |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object. More... | |
PageKit () | |
The default constructor creates an empty PageKit object. More... | |
PageKit (HPS.Publish.Page.Format in_format, HPS.Publish.Page.Orientation in_orientation) | |
This constructor creates a PageKit with the given format and orientation. More... | |
PageKit (string in_filename) | |
This constructor creates a PageKit from the given PDF template file. More... | |
PageKit (HPS.Publish.PageKit in_kit) | |
The copy constructor creates a new PageKit object that contains the same settings as the source PageKit. More... | |
void | Set (HPS.Publish.PageKit in_kit) |
Copies the source PageKit into this PageKit. More... | |
HPS.Publish.PageKit | SetAnnotation (HPS.Publish.AnnotationKit in_annotation, HPS.IntRectangle in_location) |
Adds an annotation to the page. This will replace all annotations (if any) on the page. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#ga7dfdb3dab2c487594a96cdba21f8295f">A3DPDFPageInsert3DAnnot</ulink>. More... | |
HPS.Publish.PageKit | 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/publish/latest/build/api_ref/group__a3d__publish__page__module.html#gadf6f14b2368a856f31169dc03e0c501e">A3DPDFPageFieldSet3DAnnot</ulink>. This will only have an effect if the page has a template file. More... | |
HPS.Publish.PageKit | SetAnnotations (HPS.Publish.AnnotationKit[] in_annotations, HPS.IntRectangle[] in_locations) |
Adds a list of annotations to the page. This will replace all annotations (if any) on the page. These correspond to the values that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#ga7dfdb3dab2c487594a96cdba21f8295f">A3DPDFPageInsert3DAnnot</ulink>. More... | |
HPS.Publish.PageKit | 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/publish/latest/build/api_ref/group__a3d__publish__page__module.html#gadf6f14b2368a856f31169dc03e0c501e">A3DPDFPageFieldSet3DAnnot</ulink>. This will only have an effect if the page has a template file. More... | |
HPS.Publish.PageKit | SetButton (HPS.Publish.ButtonKit in_button, HPS.IntRectangle in_location) |
Adds a button to the page. This will replace all buttons (if any) on the page. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#ga1727c2d83b817942b2a9a9759c7aa7c1">A3DPDFPageInsertButton</ulink>. More... | |
HPS.Publish.PageKit | 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/publish/latest/build/api_ref/group__a3d__publish__page__module.html#ga6051e30d012d9dd265fe8eb3a01f317f">A3DPDFPageFieldButtonSetIcon</ulink>. This will only have an effect if the page has a template file. More... | |
HPS.Publish.PageKit | 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/publish/latest/build/api_ref/group__a3d__publish__page__module.html#ga6051e30d012d9dd265fe8eb3a01f317f">A3DPDFPageFieldButtonSetIcon</ulink>. This will only have an effect if the page has a template file. More... | |
HPS.Publish.PageKit | 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/publish/latest/build/api_ref/group__a3d__publish__page__module.html#gae268fe9055181033df8eb554bf6d9ae6">A3DPDFPageFieldButtonSetLabel</ulink>. This will only have an effect if the page has a template file. More... | |
HPS.Publish.PageKit | 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/publish/latest/build/api_ref/group__a3d__publish__page__module.html#gae268fe9055181033df8eb554bf6d9ae6">A3DPDFPageFieldButtonSetLabel</ulink>. This will only have an effect if the page has a template file. More... | |
HPS.Publish.PageKit | SetButtons (HPS.Publish.ButtonKit[] in_buttons, HPS.IntRectangle[] in_locations) |
Adds a list of buttons to the page. This will replace all buttons (if any) on the page. These correspond to values that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#ga1727c2d83b817942b2a9a9759c7aa7c1">A3DPDFPageInsertButton</ulink>. More... | |
HPS.Publish.PageKit | SetCheckBox (HPS.Publish.CheckBoxKit in_checkbox, HPS.IntRectangle in_location) |
Adds a check box to the page. This will replace all check box (if any) on the page. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#ga7433812feb725392327a6266e38d85a4">A3DPDFPageInsertCheckBox</ulink>. More... | |
HPS.Publish.PageKit | SetCheckBoxes (HPS.Publish.CheckBoxKit[] in_checkbox, HPS.IntRectangle[] in_locations) |
Adds check boxes to the page. This will replace all check boxes (if any) on the page. These correspond to values that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#ga7433812feb725392327a6266e38d85a4">A3DPDFPageInsertCheckBox</ulink>. More... | |
HPS.Publish.PageKit | SetDropDownList (HPS.Publish.DropDownListKit in_drop_down_list, HPS.IntRectangle in_location) |
Adds a drop down list to the page. This will replace all drop down list (if any) on the page. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#gab9b0df08811a3e7005540ad1114ad818">A3DPDFPageInsertDropDownList</ulink>. More... | |
HPS.Publish.PageKit | SetDropDownLists (HPS.Publish.DropDownListKit[] in_drop_down_list, HPS.IntRectangle[] in_locations) |
Adds drop down lists to the page. This will replace all drop down lists (if any) on the page. These correspond to values that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#gab9b0df08811a3e7005540ad1114ad818">A3DPDFPageInsertDropDownList</ulink>. More... | |
HPS.Publish.PageKit | SetFormat (HPS.Publish.Page.Format in_format) |
Sets the format of the page. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/struct_a3_d_p_d_f_page_data.html#a365806d4aaa8d9fd2c24ab1335dbc549">A3DPDFPageData::m_ePageSize</ulink>. This has no effect if this page has a template file. More... | |
HPS.Publish.PageKit | SetImage (HPS.Publish.ImageKit in_image, HPS.IntRectangle in_location) |
Adds an image to the page. This will replace all images (if any) on the page. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#ga4a0580850d8442f86b2af8856c02654a">A3DPDFPageInsertImage</ulink>. More... | |
HPS.Publish.PageKit | SetImages (HPS.Publish.ImageKit[] in_images, HPS.IntRectangle[] in_locations) |
Adds a list of images to the page. This will replace all images (if any) on the page. These correspond to values that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#ga4a0580850d8442f86b2af8856c02654a">A3DPDFPageInsertImage</ulink>. More... | |
HPS.Publish.PageKit | 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/publish/latest/build/api_ref/group__a3d__publish__page__module.html#gac02217c03ab6cc02581362eab77c12f6">A3DPDFPageFieldSetActionJavascriptFromString</ulink> or <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#gacf5655c5eb503b4c0fa6f719699a90ee">A3DPDFPageFieldSetActionJavascriptFromFile</ulink>. This will only have an effect if the page has a template file. More... | |
HPS.Publish.PageKit | 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/publish/latest/build/api_ref/group__a3d__publish__page__module.html#gac02217c03ab6cc02581362eab77c12f6">A3DPDFPageFieldSetActionJavascriptFromString</ulink> or <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#gacf5655c5eb503b4c0fa6f719699a90ee">A3DPDFPageFieldSetActionJavascriptFromFile</ulink>. This will only have an effect if the page has a template file. More... | |
HPS.Publish.PageKit | 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/publish/latest/build/api_ref/group__a3d__publish__page__module.html#gac02217c03ab6cc02581362eab77c12f6">A3DPDFPageFieldSetActionJavascriptFromString</ulink> or <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#gacf5655c5eb503b4c0fa6f719699a90ee">A3DPDFPageFieldSetActionJavascriptFromFile</ulink>. This will only have an effect if the page has a template file. More... | |
HPS.Publish.PageKit | SetLink (HPS.Publish.LinkKit in_link, HPS.IntRectangle in_location) |
Adds a link to the page. This will replace all links (if any) on the page. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#ga1822ea723295e01b53e222864b8efd31">A3DPDFPageInsertLink</ulink>. More... | |
HPS.Publish.PageKit | SetLinks (HPS.Publish.LinkKit[] in_links, HPS.IntRectangle[] in_locations) |
Adds a list of links to the page. This will replace all links (if any) on the page. These correspond to values that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#ga1822ea723295e01b53e222864b8efd31">A3DPDFPageInsertLink</ulink>. More... | |
HPS.Publish.PageKit | SetListBox (HPS.Publish.ListBoxKit in_list_box, HPS.IntRectangle in_location) |
Adds a list box to the page. This will replace all list box (if any) on the page. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#ga2f971ef3bf91640243af5beb32d79ad2">A3DPDFPageInsertListBox</ulink>. More... | |
HPS.Publish.PageKit | SetListBoxes (HPS.Publish.ListBoxKit[] in_list_box, HPS.IntRectangle[] in_locations) |
Adds list boxes to the page. This will replace all list boxes (if any) on the page. These correspond to values that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#ga2f971ef3bf91640243af5beb32d79ad2">A3DPDFPageInsertListBox</ulink>. More... | |
HPS.Publish.PageKit | SetListItemByField (string in_field, string in_value, string in_export_value) |
Adds an item to the list at the given form field. If there are any existing items in the list at the given form field, they will be overwritten. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#gae268fe9055181033df8eb554bf6d9ae6">A3DPDFPageFieldListAddItem</ulink>. This will only have an effect if the page has a template file. More... | |
HPS.Publish.PageKit | SetListItemsByField (string in_field, string[] in_values, string[] in_export_values) |
Adds items to the list at the given form field. If there are any existing items in the list at the given form field, they will be overwritten. These correspond to values that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#gae268fe9055181033df8eb554bf6d9ae6">A3DPDFPageFieldListAddItem</ulink>. This will only have an effect if the page has a template file. More... | |
HPS.Publish.PageKit | SetOrientation (HPS.Publish.Page.Orientation in_orientation) |
Sets the orientation of the page. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/struct_a3_d_p_d_f_page_data.html#a5df6f02cb70127783ed0b1d5869bc99d">A3DPDFPageData::m_ePageOrientation</ulink>. This has no effect if this page has a template file. More... | |
HPS.Publish.PageKit | SetRadioButton (HPS.Publish.RadioButtonKit in_radio_button, HPS.IntRectangle in_location) |
Adds a radio button to the page. This will replace all radio buttons (if any) on the page. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#gac24f87cbf1a247c8516ebfa6f7cf7f89">A3DPDFPageInsertRadioButton</ulink>. More... | |
HPS.Publish.PageKit | SetRadioButtons (HPS.Publish.RadioButtonKit[] in_radio_buttons, HPS.IntRectangle[] in_locations) |
Adds a list of buttons to the page. This will replace all radio buttons (if any) on the page. These correspond to values that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#gac24f87cbf1a247c8516ebfa6f7cf7f89">A3DPDFPageInsertRadioButton</ulink>. More... | |
HPS.Publish.PageKit | SetSignatureField (HPS.Publish.SignatureFieldKit in_signature_field, HPS.IntRectangle in_location) |
Adds a signature field to the page. This will replace all signature field (if any) on the page. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#ga3f2f1980667a3a840923320736264203">A3DPDFPageInsertSignatureField</ulink>. More... | |
HPS.Publish.PageKit | SetSignatureFields (HPS.Publish.SignatureFieldKit[] in_signature_field, HPS.IntRectangle[] in_locations) |
Adds signature fields to the page. This will replace all signature fields (if any) on the page. These correspond to values that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#ga3f2f1980667a3a840923320736264203">A3DPDFPageInsertSignatureField</ulink>. More... | |
HPS.Publish.PageKit | SetSlideTable (HPS.Publish.SlideTableKit in_slide_table, HPS.IntRectangle in_location) |
Adds a slide table to the page. This will replace all slide tables (if any) on the page. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__document__module.html#gad3131986068fd4ef196d26f841093b6c">A3DPDFDefineSlideTable</ulink>. More... | |
HPS.Publish.PageKit | SetSlideTables (HPS.Publish.SlideTableKit[] in_slide_tables, HPS.IntRectangle[] in_locations) |
Adds a list of slide tables to the page. This will replace all slide tables (if any) on the page. These correspond to values that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__document__module.html#gad3131986068fd4ef196d26f841093b6c">A3DPDFDefineSlideTable</ulink>. More... | |
HPS.Publish.PageKit | SetTable (HPS.Publish.TableKit in_table, HPS.IntRectangle in_location) |
Adds a table to the page. This will replace all tables (if any) on the page. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#gae924b1a89f5cfa5cdbe2913480597b21">A3DPDFPageInsertTable</ulink>. More... | |
HPS.Publish.PageKit | SetTables (HPS.Publish.TableKit[] in_tables, HPS.IntRectangle[] in_locations) |
Adds a list of tables to the page. This will replace all tables (if any) on the page. These correspond to values that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#gae924b1a89f5cfa5cdbe2913480597b21">A3DPDFPageInsertTable</ulink>. More... | |
HPS.Publish.PageKit | SetTemplateFile (string in_filename) |
Sets the PDF file which will act as a template. More... | |
HPS.Publish.PageKit | SetText (HPS.Publish.TextKit in_text, HPS.IntRectangle in_location) |
Adds a text string to the page. This will replace all text (if any) on the page. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#gafd4ece4c88ce91b60228a4e72988b1ff">A3DPDFPageInsertText</ulink>. More... | |
HPS.Publish.PageKit | SetText (HPS.Publish.TextKit[] in_text, HPS.IntRectangle[] in_locations) |
Adds text strings to the page. This will replace all text (if any) on the page. These correspond to values that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#gafd4ece4c88ce91b60228a4e72988b1ff">A3DPDFPageInsertText</ulink>. More... | |
HPS.Publish.PageKit | SetTextField (HPS.Publish.TextFieldKit in_text_field, HPS.IntRectangle in_location) |
Adds a text field to the page. This will replace all text fields (if any) on the page. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#ga04003d7a34557c95e84c462525ef1728">A3DPDFPageInsertTextField</ulink>. More... | |
HPS.Publish.PageKit | SetTextFields (HPS.Publish.TextFieldKit[] in_text_fields, HPS.IntRectangle[] in_locations) |
Adds a list of text fields to the page. This will replace all text fields (if any) on the page. These correspond to values that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#ga04003d7a34557c95e84c462525ef1728">A3DPDFPageInsertTextField</ulink>. More... | |
HPS.Publish.PageKit | 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/publish/latest/build/api_ref/group__a3d__publish__page__module.html#ga8f171e2004b51ae1ebcec2eceb773b00">A3DPDFPageFieldTextSetValue</ulink>. This will only have an effect if the page has a template file. More... | |
HPS.Publish.PageKit | 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/publish/latest/build/api_ref/group__a3d__publish__page__module.html#ga8f171e2004b51ae1ebcec2eceb773b00">A3DPDFPageFieldTextSetValue</ulink>. This will only have an effect if the page has a template file. More... | |
HPS.Publish.PageKit | 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/publish/latest/build/api_ref/group__a3d__publish__page__module.html#gacdabb9f6e7fc6a887de9516148549b8d">A3DPDFPageFieldSetVisibility</ulink>. This will only have an effect if the page has a template file. More... | |
HPS.Publish.PageKit | 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/publish/latest/build/api_ref/group__a3d__publish__page__module.html#gacdabb9f6e7fc6a887de9516148549b8d">A3DPDFPageFieldSetVisibility</ulink>. This will only have an effect if the page has a template file. More... | |
void | Show (out HPS.Publish.PageKit out_kit) |
Copies this PageKit into the given PageKit. More... | |
bool | ShowAnnotations (out HPS.Publish.AnnotationKit[] out_annotations, out HPS.IntRectangle[] out_locations) |
Shows the annotations on the page. More... | |
bool | ShowAnnotationsByField (out string[] out_fields, out HPS.Publish.AnnotationKit[] out_annotations) |
Shows the annotations on form fields on the page. More... | |
bool | ShowButtonIconsByField (out string[] out_fields, out HPS.Publish.ImageKit[] out_images) |
Shows the images on icons on form fields on the page. More... | |
bool | ShowButtonLabelsByField (out string[] out_fields, out string[] out_labels) |
Shows the labels on form fields on the page. More... | |
bool | ShowButtons (out HPS.Publish.ButtonKit[] out_buttons, out HPS.IntRectangle[] out_locations) |
Shows the buttons on the page. More... | |
bool | ShowCheckBoxes (out HPS.Publish.CheckBoxKit[] out_check_boxes, out HPS.IntRectangle[] out_locations) |
Shows the check boxes on the page. More... | |
bool | ShowDropDownLists (out HPS.Publish.DropDownListKit[] out_drop_down_lists, out HPS.IntRectangle[] out_locations) |
Shows the drop down lists on the page. More... | |
bool | ShowFormat (out HPS.Publish.Page.Format out_format) |
Shows the format of the page. More... | |
bool | ShowImages (out HPS.Publish.ImageKit[] out_images, out HPS.IntRectangle[] out_locations) |
Shows the images on the page. More... | |
bool | ShowJavaScriptActionsByField (out string[] out_fields, out string[] out_sources, out HPS.Publish.Source.Type[] out_types) |
Shows the JavaScript actions on form fields on the page. More... | |
bool | ShowLinks (out HPS.Publish.LinkKit[] out_links, out HPS.IntRectangle[] out_locations) |
Shows the links on the page. More... | |
bool | ShowListBoxes (out HPS.Publish.ListBoxKit[] out_list_boxes, out HPS.IntRectangle[] out_locations) |
Shows the list boxes on the page. More... | |
bool | ShowListItemFields (out string[] out_fields) |
Shows the list item form fields on the page. More... | |
bool | ShowListItemsByField (string in_field, out string[] out_values, out string[] out_export_values) |
Shows the items in the list on the given field on the page. More... | |
bool | ShowOrientation (out HPS.Publish.Page.Orientation out_orientation) |
Shows the orientation of the page. More... | |
bool | ShowRadioButtons (out HPS.Publish.RadioButtonKit[] out_radio_buttons, out HPS.IntRectangle[] out_locations) |
Shows the radio buttons on the page. More... | |
bool | ShowSignatureFields (out HPS.Publish.SignatureFieldKit[] out_signature_fields, out HPS.IntRectangle[] out_locations) |
Shows the signature fields on the page. More... | |
bool | ShowSlideTables (out HPS.Publish.SlideTableKit[] out_slide_tables, out HPS.IntRectangle[] out_locations) |
Shows the slide tables on the page. More... | |
bool | ShowTables (out HPS.Publish.TableKit[] out_tables, out HPS.IntRectangle[] out_locations) |
Shows the tables on the page. More... | |
bool | ShowTemplateFile (out string out_filename) |
Shows the template file. More... | |
bool | ShowText (out HPS.Publish.TextKit[] out_text, out HPS.IntRectangle[] out_locations) |
Shows the text on the page. More... | |
bool | ShowTextFields (out HPS.Publish.TextFieldKit[] out_text_fields, out HPS.IntRectangle[] out_locations) |
Shows the text fields on the page. More... | |
bool | ShowTextValuesByField (out string[] out_fields, out string[] out_values) |
Shows the text values on form fields on the page. More... | |
bool | ShowVisibilitiesByField (out string[] out_fields, out bool[] out_states) |
Shows the visibility settings on form fields on the page. More... | |
HPS.Publish.PageKit | UnsetAnnotation (ulong in_index) |
Removes the annotation at the given index from the page. More... | |
HPS.Publish.PageKit | UnsetAnnotationByField (string in_field) |
Removes the annotation at the given form field from the page. More... | |
HPS.Publish.PageKit | UnsetAnnotations (ulong[] in_indices) |
Removes the annotations at the given indices from the page. More... | |
HPS.Publish.PageKit | UnsetAnnotations () |
Removes all annotations from the page. More... | |
HPS.Publish.PageKit | UnsetAnnotationsByField (string[] in_fields) |
Removes the annotations at the given form fields from the page. More... | |
HPS.Publish.PageKit | UnsetAnnotationsByField () |
Removes all annotation form fields from the page. More... | |
HPS.Publish.PageKit | UnsetButton (ulong in_index) |
Removes the button at the given index from the page. More... | |
HPS.Publish.PageKit | UnsetButtonIconByField (string in_field) |
Removes the image on the icon at the given form field from the page. More... | |
HPS.Publish.PageKit | UnsetButtonIconsByField (string[] in_fields) |
Removes the images on the icons at the given form fields from the page. More... | |
HPS.Publish.PageKit | UnsetButtonIconsByField () |
Removes all button icon form fields from the page. More... | |
HPS.Publish.PageKit | UnsetButtonLabelByField (string in_field) |
Removes the label at the given form field from the page. More... | |
HPS.Publish.PageKit | UnsetButtonLabelsByField (string[] in_fields) |
Removes the labels at the given form fields from the page. More... | |
HPS.Publish.PageKit | UnsetButtonLabelsByField () |
Removes all button label form fields from the page. More... | |
HPS.Publish.PageKit | UnsetButtons (ulong[] in_indices) |
Removes the buttons at the given indices from the page. More... | |
HPS.Publish.PageKit | UnsetButtons () |
Removes all buttons from the page. More... | |
HPS.Publish.PageKit | UnsetCheckBox (ulong in_index) |
Removes the check box at the given index from the page. More... | |
HPS.Publish.PageKit | UnsetCheckBoxes (ulong[] in_indices) |
Removes the check box at the given indices from the page. More... | |
HPS.Publish.PageKit | UnsetCheckBoxes () |
Removes all check boxes from the page. More... | |
HPS.Publish.PageKit | UnsetDropDownList (ulong in_index) |
Removes the drop down list at the given index from the page. More... | |
HPS.Publish.PageKit | UnsetDropDownLists (ulong[] in_indices) |
Removes the drop down list at the given indices from the page. More... | |
HPS.Publish.PageKit | UnsetDropDownLists () |
Removes all drop down lists from the page. More... | |
HPS.Publish.PageKit | UnsetEverything () |
Removes all data from the page. More... | |
HPS.Publish.PageKit | UnsetFormat () |
Removes the format from the page. More... | |
HPS.Publish.PageKit | UnsetImage (ulong in_index) |
Removes the image at the given index from the page. More... | |
HPS.Publish.PageKit | UnsetImages (ulong[] in_indices) |
Removes the images at the given indices from the page. More... | |
HPS.Publish.PageKit | UnsetImages () |
Removes all images from the page. More... | |
HPS.Publish.PageKit | UnsetJavaScriptActionByField (string in_field) |
Removes the JavaScript action at the given form field from the page. More... | |
HPS.Publish.PageKit | UnsetJavaScriptActionsByField (string[] in_fields) |
Removes the JavaScript actions at the given form fields from the page. More... | |
HPS.Publish.PageKit | UnsetJavaScriptActionsByField () |
Removes all JavaScript action form fields from the page. More... | |
HPS.Publish.PageKit | UnsetLink (ulong in_index) |
Removes the link at the given index from the page. More... | |
HPS.Publish.PageKit | UnsetLinks (ulong[] in_indices) |
Removes the links at the given indices from the page. More... | |
HPS.Publish.PageKit | UnsetLinks () |
Removes all links from the page. More... | |
HPS.Publish.PageKit | UnsetListBox (ulong in_index) |
Removes the list box at the given index from the page. More... | |
HPS.Publish.PageKit | UnsetListBoxes (ulong[] in_indices) |
Removes the list box at the given indices from the page. More... | |
HPS.Publish.PageKit | UnsetListBoxes () |
Removes all list boxes from the page. More... | |
HPS.Publish.PageKit | UnsetListItemByField (string in_field, ulong in_index) |
Removes the item at the given index from the list at the given form field from the page. More... | |
HPS.Publish.PageKit | UnsetListItemsByField (string in_field, ulong[] in_indices) |
Removes the items at the given indices from the list at the given form field from the page. More... | |
HPS.Publish.PageKit | UnsetListItemsByField (string in_field) |
Removes all items from the list at the given form field from the page. More... | |
HPS.Publish.PageKit | UnsetListItemsByField (string[] in_fields) |
Removes all items from the lists at the given form fields from the page. More... | |
HPS.Publish.PageKit | UnsetListItemsByField () |
Removes all list item form fields from the page. More... | |
HPS.Publish.PageKit | UnsetOrientation () |
Removes the orientation from the page. More... | |
HPS.Publish.PageKit | UnsetRadioButton (ulong in_index) |
Removes the radio button at the given index from the page. More... | |
HPS.Publish.PageKit | UnsetRadioButtons (ulong[] in_indices) |
Removes the radio button at the given indices from the page. More... | |
HPS.Publish.PageKit | UnsetRadioButtons () |
Removes all radio buttons from the page. More... | |
HPS.Publish.PageKit | UnsetSignatureField (ulong in_index) |
Removes the signature field at the given index from the page. More... | |
HPS.Publish.PageKit | UnsetSignatureFields (ulong[] in_indices) |
Removes the signature field at the given indices from the page. More... | |
HPS.Publish.PageKit | UnsetSignatureFields () |
Removes all signature fields from the page. More... | |
HPS.Publish.PageKit | UnsetSlideTable (ulong in_index) |
Removes the slide table at the given index from the page. More... | |
HPS.Publish.PageKit | UnsetSlideTables (ulong[] in_indices) |
Removes the slide tables at the given indices from the page. More... | |
HPS.Publish.PageKit | UnsetSlideTables () |
Removes all slide tables from the page. More... | |
HPS.Publish.PageKit | UnsetTable (ulong in_index) |
Removes the table at the given index from the page. More... | |
HPS.Publish.PageKit | UnsetTables (ulong[] in_indices) |
Removes the tables at the given indices from the page. More... | |
HPS.Publish.PageKit | UnsetTables () |
Removes all tables from the page. More... | |
HPS.Publish.PageKit | UnsetTemplateFile () |
Removes the template file from the page. More... | |
HPS.Publish.PageKit | UnsetText (ulong in_index) |
Removes the text at the given index from the page. More... | |
HPS.Publish.PageKit | UnsetText (ulong[] in_indices) |
Removes the text at the given indices from the page. More... | |
HPS.Publish.PageKit | UnsetText () |
Removes all text from the page. More... | |
HPS.Publish.PageKit | UnsetTextField (ulong in_index) |
Removes the text field at the given index from the page. More... | |
HPS.Publish.PageKit | UnsetTextFields (ulong[] in_indices) |
Removes the text fields at the given indices from the page. More... | |
HPS.Publish.PageKit | UnsetTextFields () |
Removes all text fields from the page. More... | |
HPS.Publish.PageKit | UnsetTextValueByField (string in_field) |
Removes the text value at the given form field from the page. More... | |
HPS.Publish.PageKit | UnsetTextValuesByField (string[] in_fields) |
Removes the text values at the given form fields from the page. More... | |
HPS.Publish.PageKit | UnsetTextValuesByField () |
Removes all text value form fields from the page. More... | |
HPS.Publish.PageKit | UnsetVisibilitiesByField (string[] in_fields) |
Removes the visibility settings at the given form fields from the page. More... | |
HPS.Publish.PageKit | UnsetVisibilitiesByField () |
Removes all visibility settings on form fields from the page. More... | |
HPS.Publish.PageKit | UnsetVisibilityByField (string in_field) |
Removes the visibility setting at the given form field from the page. More... | |
![]() | |
Sprocket (HPS.Sprocket in_that) | |
![]() | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns an identifier that can be used to identify which instance of a class an object is. Different keys and controls will return the same value if they are backed by the same database resource. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object that) | |
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. This function is useful for finding the type of smart pointer objects that have been cast to more generic types. More... | |
Static Public Member Functions | |
static HPS.Publish.PageKit | GetDefault () |
Creates a PageKit which contains the default settings. The returned object will not necessarily have values for every setting, but it will have them where it is reasonable to have a default. These values will be used for export unless a setting is overridden by the PageKit passed to File::Export. More... | |
static bool | operator!= (HPS.Publish.PageKit a, HPS.Publish.PageKit b) |
static bool | operator== (HPS.Publish.PageKit a, HPS.Publish.PageKit b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
Detailed Description
The PageKit class is a user space object. It acts as the container for all data that can be on a page in a Publish PDF.
Constructor & Destructor Documentation
|
inline |
The default constructor creates an empty PageKit object.
|
inline |
This constructor creates a PageKit with the given format and orientation.
- Parameters
-
in_format Format of the page. in_orientation Orientation of the page.
|
inline |
This constructor creates a PageKit from the given PDF template file.
- Parameters
-
in_filename UTF8-encoded filename for the PDF file to act as a template.
|
inline |
Member Function Documentation
|
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 <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#ga7dfdb3dab2c487594a96cdba21f8295f">A3DPDFPageInsert3DAnnot</ulink>.
- Parameters
-
in_annotation Annotation to add to the page. in_location Annotation location in points relative to bottom left of the page. All fields in the location will be used.
- Returns
- A reference to this PageKit.
|
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 <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#ga7dfdb3dab2c487594a96cdba21f8295f">A3DPDFPageInsert3DAnnot</ulink>.
- Parameters
-
in_annotations Annotations to add to the page. in_locations Annotation locations in points relative to bottom left of the page.
- Returns
- A reference to this PageKit.
|
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 <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#ga1727c2d83b817942b2a9a9759c7aa7c1">A3DPDFPageInsertButton</ulink>.
- Parameters
-
in_button Button to add to the page. in_location Button location in points relative to bottom left of the page. All fields in the location will be used.
- Returns
- A reference to this PageKit.
|
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 <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#ga1727c2d83b817942b2a9a9759c7aa7c1">A3DPDFPageInsertButton</ulink>.
- Parameters
-
in_buttons Buttons to add to the page. in_locations Button locations in points relative to bottom left of the page. All fields in the locations will be used.
- Returns
- A reference to this PageKit.
|
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 <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#ga7433812feb725392327a6266e38d85a4">A3DPDFPageInsertCheckBox</ulink>.
- Parameters
-
in_checkbox Check Box to add to the page. in_location Check Box location in points relative to bottom left of the page. Only the left and bottom fields in the location will be used.
- Returns
- A reference to this PageKit.
|
inline |
Adds check boxes to the page. This will not replace any check boxes on the page. These correspond to values that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#ga7433812feb725392327a6266e38d85a4">A3DPDFPageInsertCheckBox</ulink>.
- Parameters
-
in_checkbox Check Box to add to the page. in_locations Check Box locations in points relative to bottom left of the page. Only the left and bottom fields in the locations will be used.
- Returns
- A reference to this PageKit.
|
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 <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#gab9b0df08811a3e7005540ad1114ad818">A3DPDFPageInsertDropDownList</ulink>.
- Parameters
-
in_drop_down_list Drop Down List to add to the page. in_location Drop Down List location in points relative to bottom left of the page. Only the left and bottom fields in the location will be used.
- Returns
- A reference to this PageKit.
|
inline |
Adds drop down lists to the page. This will not replace any drop down lists on the page. These correspond to values that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#gab9b0df08811a3e7005540ad1114ad818">A3DPDFPageInsertDropDownList</ulink>.
- Parameters
-
in_drop_down_list Drop Down List to add to the page. in_locations Drop Down List locations in points relative to bottom left of the page. Only the left and bottom fields in the locations will be used.
- Returns
- A reference to this PageKit.
|
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 <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#ga4a0580850d8442f86b2af8856c02654a">A3DPDFPageInsertImage</ulink>.
- Parameters
-
in_image Image to add to the page. in_location Image location in points relative to bottom left of the page. Only the left and bottom fields in the location will be used.
- Returns
- A reference to this PageKit.
|
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 <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#ga4a0580850d8442f86b2af8856c02654a">A3DPDFPageInsertImage</ulink>.
- Parameters
-
in_images Images to add to the page. in_locations Image locations in points relative to bottom left of the page. Only the left and bottom fields in the locations will be used.
- Returns
- A reference to this PageKit.
|
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 <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#ga1822ea723295e01b53e222864b8efd31">A3DPDFPageInsertLink</ulink>.
- Parameters
-
in_link Link to add to the page. in_location Link location in points relative to bottom left of the page. All fields in the location will be used.
- Returns
- A reference to this PageKit.
|
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 <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#ga1822ea723295e01b53e222864b8efd31">A3DPDFPageInsertLink</ulink>.
- Parameters
-
in_links Links to add to the page. in_locations Link locations in points relative to bottom left of the page. All fields in the locations will be used.
- Returns
- A reference to this PageKit.
|
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 <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#ga2f971ef3bf91640243af5beb32d79ad2">A3DPDFPageInsertListBox</ulink>.
- Parameters
-
in_list_box List Box to add to the page. in_location List Box location in points relative to bottom left of the page. Only the left and bottom fields in the location will be used.
- Returns
- A reference to this PageKit.
|
inline |
Adds list boxes to the page. This will not replace any list boxes on the page. These correspond to values that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#ga2f971ef3bf91640243af5beb32d79ad2">A3DPDFPageInsertListBox</ulink>.
- Parameters
-
in_list_box List Box to add to the page. in_locations List Box locations in points relative to bottom left of the page. Only the left and bottom fields in the locations will be used.
- Returns
- A reference to this PageKit.
|
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 <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#gae268fe9055181033df8eb554bf6d9ae6">A3DPDFPageFieldListAddItem</ulink>. This will only have an effect if the page has a template file.
- Parameters
-
in_field UTF8-encoded form field name for the list. in_value UTF8-encoded value for the item to be added to the list at the given form field. in_export_value UTF8-encoded export value for the item to be added to the list at the given form field.
- Returns
- A reference to this PageKit.
|
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 <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#gae268fe9055181033df8eb554bf6d9ae6">A3DPDFPageFieldListAddItem</ulink>. This will only have an effect if the page has a template file.
- Parameters
-
in_field UTF8-encoded form field name for the list. in_values The values for the items to be added to the list at the given form field. in_export_values The export values for the items to be added to the list at the given form field.
- Returns
- A reference to this PageKit.
|
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 <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#gac24f87cbf1a247c8516ebfa6f7cf7f89">A3DPDFPageInsertRadioButton</ulink>.
- Parameters
-
in_radio_button Radio button to add to the page. in_location Button location in points relative to bottom left of the page. All fields in the location will be used.
- Returns
- A reference to this PageKit.
|
inline |
Adds a list of buttons to the page. This will not replace any radio buttons on the page. These correspond to values that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#gac24f87cbf1a247c8516ebfa6f7cf7f89">A3DPDFPageInsertRadioButton</ulink>.
- Parameters
-
in_radio_buttons Radio buttons to add to the page. in_locations Button locations in points relative to bottom left of the page. All fields in the locations will be used.
- Returns
- A reference to this PageKit.
|
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 <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#ga3f2f1980667a3a840923320736264203">A3DPDFPageInsertSignatureField</ulink>.
- Parameters
-
in_signature_field Signature Field to add to the page. in_location Signature Field location in points relative to bottom left of the page. Only the left and bottom fields in the location will be used.
- Returns
- A reference to this PageKit.
|
inline |
Adds signature fields to the page. This will not replace any signature fields on the page. These correspond to values that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#ga3f2f1980667a3a840923320736264203">A3DPDFPageInsertSignatureField</ulink>.
- Parameters
-
in_signature_field Signature Field to add to the page. in_locations Signature Field locations in points relative to bottom left of the page. Only the left and bottom fields in the locations will be used.
- Returns
- A reference to this PageKit.
|
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 <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__document__module.html#gad3131986068fd4ef196d26f841093b6c">A3DPDFDefineSlideTable</ulink>.
- Parameters
-
in_slide_table Slide table to add to the page. in_location Slide table location in points relative to upper left of the page. Only the left and top fields in the location will be used.
- Returns
- A reference to this PageKit.
|
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 <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__document__module.html#gad3131986068fd4ef196d26f841093b6c">A3DPDFDefineSlideTable</ulink>.
- Parameters
-
in_slide_tables Slide tables to add to the page. in_locations Slide table locations in points relative to upper left of the page. Only the left and top fields in the locations will be used.
- Returns
- A reference to this PageKit.
|
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 <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#gae924b1a89f5cfa5cdbe2913480597b21">A3DPDFPageInsertTable</ulink>.
- Parameters
-
in_table Table to add to the page. in_location Table location in points relative to upper left of the page. Only the left and top fields in the location will be used.
- Returns
- A reference to this PageKit.
|
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 <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#gae924b1a89f5cfa5cdbe2913480597b21">A3DPDFPageInsertTable</ulink>.
- Parameters
-
in_tables Tables to add to the page. in_locations Table locations in points relative to upper left of the page. Only the left and top fields in the locations will be used.
- Returns
- A reference to this PageKit.
|
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 <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#gafd4ece4c88ce91b60228a4e72988b1ff">A3DPDFPageInsertText</ulink>.
- Parameters
-
in_text Text to add to the page. in_location Text location in points relative to bottom left of the page. Only the left and bottom fields in the location will be used.
- Returns
- A reference to this PageKit.
|
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 <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#gafd4ece4c88ce91b60228a4e72988b1ff">A3DPDFPageInsertText</ulink>.
- Parameters
-
in_text Text to add to the page. in_locations Text locations in points relative to bottom left of the page. Only the left and bottom fields in the locations will be used.
- Returns
- A reference to this PageKit.
|
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 <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#ga04003d7a34557c95e84c462525ef1728">A3DPDFPageInsertTextField</ulink>.
- Parameters
-
in_text_field Text field to add to the page. in_location Text field location in points relative to bottom left of the page. All fields in the location will be used.
- Returns
- A reference to this PageKit.
|
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 <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#ga04003d7a34557c95e84c462525ef1728">A3DPDFPageInsertTextField</ulink>.
- Parameters
-
in_text_fields Text fields to add to the page. in_locations Text field locations in points relative to bottom left of the page. All fields in the locations will be used.
- Returns
- A reference to this PageKit.
|
inlinevirtual |
Indicates whether this PageKit has any values set on it.
- Returns
- true if no values are set on this PageKit, false otherwise.
Reimplemented from HPS.Object.
|
inline |
|
inlinestatic |
Creates a PageKit which contains the default settings. The returned object will not necessarily have values for every setting, but it will have them where it is reasonable to have a default. These values will be used for export unless a setting is overridden by the PageKit passed to File::Export.
- Returns
- A PageKit with the default settings.
|
inlinevirtual |
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.
|
inline |
|
inline |
Adds an annotation to the page. This will replace all annotations (if any) on the page. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#ga7dfdb3dab2c487594a96cdba21f8295f">A3DPDFPageInsert3DAnnot</ulink>.
- Parameters
-
in_annotation Annotation to add to the page. in_location Annotation location in points relative to bottom left of the page. All fields in the location will be used.
- Returns
- A reference to this PageKit.
|
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 <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#gadf6f14b2368a856f31169dc03e0c501e">A3DPDFPageFieldSet3DAnnot</ulink>. This will only have an effect if the page has a template file.
- Parameters
-
in_field UTF8-encoded form field name for the annotation. in_annotation The annotation to be set on the given form field.
- Returns
- A reference to this PageKit.
|
inline |
Adds a list of annotations to the page. This will replace all annotations (if any) on the page. These correspond to the values that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#ga7dfdb3dab2c487594a96cdba21f8295f">A3DPDFPageInsert3DAnnot</ulink>.
- Parameters
-
in_annotations Annotations to add to the page. in_locations Annotation locations in points relative to bottom left of the page. All fields in the locations will be used.
- Returns
- A reference to this PageKit.
|
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 <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#gadf6f14b2368a856f31169dc03e0c501e">A3DPDFPageFieldSet3DAnnot</ulink>. This will only have an effect if the page has a template file.
- Parameters
-
in_fields The form field names for the annotations. in_annotations The annotations to be set on the corresponding form fields.
- Returns
- A reference to this PageKit.
|
inline |
Adds a button to the page. This will replace all buttons (if any) on the page. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#ga1727c2d83b817942b2a9a9759c7aa7c1">A3DPDFPageInsertButton</ulink>.
- Parameters
-
in_button Button to add to the page. in_location Button location in points relative to bottom left of the page. All fields in the location will be used.
- Returns
- A reference to this PageKit.
|
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 <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#ga6051e30d012d9dd265fe8eb3a01f317f">A3DPDFPageFieldButtonSetIcon</ulink>. This will only have an effect if the page has a template file.
- Parameters
-
in_field UTF8-encoded form field name for the icon. in_image The image to be set on the icon at the given form field.
- Returns
- A reference to this PageKit.
|
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 <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#ga6051e30d012d9dd265fe8eb3a01f317f">A3DPDFPageFieldButtonSetIcon</ulink>. This will only have an effect if the page has a template file.
- Parameters
-
in_fields The form field names for the icons. in_images The images to be set on the icons at the corresponding form fields.
- Returns
- A reference to this PageKit.
|
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 <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#gae268fe9055181033df8eb554bf6d9ae6">A3DPDFPageFieldButtonSetLabel</ulink>. This will only have an effect if the page has a template file.
- Parameters
-
in_field UTF8-encoded form field name for the label. in_label UTF8-encoded label to be set on the given form field.
- Returns
- A reference to this PageKit.
|
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 <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#gae268fe9055181033df8eb554bf6d9ae6">A3DPDFPageFieldButtonSetLabel</ulink>. This will only have an effect if the page has a template file.
- Parameters
-
in_fields The form field names for the labels. in_labels The labels to be set on the corresponding form fields.
- Returns
- A reference to this PageKit.
|
inline |
Adds a list of buttons to the page. This will replace all buttons (if any) on the page. These correspond to values that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#ga1727c2d83b817942b2a9a9759c7aa7c1">A3DPDFPageInsertButton</ulink>.
- Parameters
-
in_buttons Buttons to add to the page. in_locations Button locations in points relative to bottom left of the page. All fields in the locations will be used.
- Returns
- A reference to this PageKit.
|
inline |
Adds a check box to the page. This will replace all check box (if any) on the page. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#ga7433812feb725392327a6266e38d85a4">A3DPDFPageInsertCheckBox</ulink>.
- Parameters
-
in_checkbox Check Box to add to the page. in_location Check Box location in points relative to bottom left of the page. Only the left and bottom fields in the location will be used.
- Returns
- A reference to this PageKit.
|
inline |
Adds check boxes to the page. This will replace all check boxes (if any) on the page. These correspond to values that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#ga7433812feb725392327a6266e38d85a4">A3DPDFPageInsertCheckBox</ulink>.
- Parameters
-
in_checkbox Check Box to add to the page. in_locations Check Box locations in points relative to bottom left of the page. Only the left and bottom fields in the locations will be used.
- Returns
- A reference to this PageKit.
|
inline |
Adds a drop down list to the page. This will replace all drop down list (if any) on the page. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#gab9b0df08811a3e7005540ad1114ad818">A3DPDFPageInsertDropDownList</ulink>.
- Parameters
-
in_drop_down_list Drop Down List to add to the page. in_location Drop Down List location in points relative to bottom left of the page. Only the left and bottom fields in the location will be used.
- Returns
- A reference to this PageKit.
|
inline |
Adds drop down lists to the page. This will replace all drop down lists (if any) on the page. These correspond to values that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#gab9b0df08811a3e7005540ad1114ad818">A3DPDFPageInsertDropDownList</ulink>.
- Parameters
-
in_drop_down_list Drop Down List to add to the page. in_locations Drop Down List locations in points relative to bottom left of the page. Only the left and bottom fields in the locations will be used.
- Returns
- A reference to this PageKit.
|
inline |
Sets the format of the page. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/struct_a3_d_p_d_f_page_data.html#a365806d4aaa8d9fd2c24ab1335dbc549">A3DPDFPageData::m_ePageSize</ulink>. This has no effect if this page has a template file.
- Parameters
-
in_format Format of the page.
- Returns
- A reference to this PageKit.
|
inline |
Adds an image to the page. This will replace all images (if any) on the page. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#ga4a0580850d8442f86b2af8856c02654a">A3DPDFPageInsertImage</ulink>.
- Parameters
-
in_image Image to add to the page. in_location Image location in points relative to bottom left of the page. Only the left and bottom fields in the location will be used.
- Returns
- A reference to this PageKit.
|
inline |
Adds a list of images to the page. This will replace all images (if any) on the page. These correspond to values that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#ga4a0580850d8442f86b2af8856c02654a">A3DPDFPageInsertImage</ulink>.
- Parameters
-
in_images Images to add to the page. in_locations Image locations in points relative to bottom left of the page. Only the left and bottom fields in the locations will be used.
- Returns
- A reference to this PageKit.
|
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 <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#gac02217c03ab6cc02581362eab77c12f6">A3DPDFPageFieldSetActionJavascriptFromString</ulink> or <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#gacf5655c5eb503b4c0fa6f719699a90ee">A3DPDFPageFieldSetActionJavascriptFromFile</ulink>. This will only have an effect if the page has a template file.
- Parameters
-
in_field UTF8-encoded form field name for the JavaScript action. in_source UTF8-encoded JavaScript source or file (depending on the following argument) to be set on the given form field. in_type The type of the preceding argument. Defaults to Source::Type::Code.
- Returns
- A reference to this PageKit.
|
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 <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#gac02217c03ab6cc02581362eab77c12f6">A3DPDFPageFieldSetActionJavascriptFromString</ulink> or <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#gacf5655c5eb503b4c0fa6f719699a90ee">A3DPDFPageFieldSetActionJavascriptFromFile</ulink>. This will only have an effect if the page has a template file.
- Parameters
-
in_field UTF8-encoded form field name for the JavaScript action. in_source UTF8-encoded JavaScript source or file (depending on the following argument) to be set on the given form field.
- Returns
- A reference to this PageKit.
|
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 <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#gac02217c03ab6cc02581362eab77c12f6">A3DPDFPageFieldSetActionJavascriptFromString</ulink> or <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#gacf5655c5eb503b4c0fa6f719699a90ee">A3DPDFPageFieldSetActionJavascriptFromFile</ulink>. This will only have an effect if the page has a template file.
- Parameters
-
in_fields The form field names for the JavaScript actions. in_sources The JavaScript sources and/or files (depending on the corresponding entry in the following argument) to be set on the corresponding form fields. in_types The types for each item in the preceding argument array.
- Returns
- A reference to this PageKit.
|
inline |
Adds a link to the page. This will replace all links (if any) on the page. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#ga1822ea723295e01b53e222864b8efd31">A3DPDFPageInsertLink</ulink>.
- Parameters
-
in_link Link to add to the page. in_location Link location in points relative to bottom left of the page. All fields in the location will be used.
- Returns
- A reference to this PageKit.
|
inline |
Adds a list of links to the page. This will replace all links (if any) on the page. These correspond to values that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#ga1822ea723295e01b53e222864b8efd31">A3DPDFPageInsertLink</ulink>.
- Parameters
-
in_links Links to add to the page. in_locations Link locations in points relative to bottom left of the page. All fields in the locations will be used.
- Returns
- A reference to this PageKit.
|
inline |
Adds a list box to the page. This will replace all list box (if any) on the page. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#ga2f971ef3bf91640243af5beb32d79ad2">A3DPDFPageInsertListBox</ulink>.
- Parameters
-
in_list_box List Box to add to the page. in_location List Box location in points relative to bottom left of the page. Only the left and bottom fields in the location will be used.
- Returns
- A reference to this PageKit.
|
inline |
Adds list boxes to the page. This will replace all list boxes (if any) on the page. These correspond to values that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#ga2f971ef3bf91640243af5beb32d79ad2">A3DPDFPageInsertListBox</ulink>.
- Parameters
-
in_list_box List Box to add to the page. in_locations List Box locations in points relative to bottom left of the page. Only the left and bottom fields in the locations will be used.
- Returns
- A reference to this PageKit.
|
inline |
Adds an item to the list at the given form field. If there are any existing items in the list at the given form field, they will be overwritten. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#gae268fe9055181033df8eb554bf6d9ae6">A3DPDFPageFieldListAddItem</ulink>. This will only have an effect if the page has a template file.
- Parameters
-
in_field UTF8-encoded form field name for the list. in_value UTF8-encoded value for the item to be added to the list at the given form field. in_export_value UTF8-encoded export value for the item to be added to the list at the given form field.
- Returns
- A reference to this PageKit.
|
inline |
Adds items to the list at the given form field. If there are any existing items in the list at the given form field, they will be overwritten. These correspond to values that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#gae268fe9055181033df8eb554bf6d9ae6">A3DPDFPageFieldListAddItem</ulink>. This will only have an effect if the page has a template file.
- Parameters
-
in_field UTF8-encoded form field name for the list. in_values The values for the items to be added to the list at the given form field. in_export_values The export values for the items to be added to the list at the given form field.
- Returns
- A reference to this PageKit.
|
inline |
Sets the orientation of the page. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/struct_a3_d_p_d_f_page_data.html#a5df6f02cb70127783ed0b1d5869bc99d">A3DPDFPageData::m_ePageOrientation</ulink>. This has no effect if this page has a template file.
- Parameters
-
in_orientation Orientation of the page.
- Returns
- A reference to this PageKit.
|
inline |
Adds a radio button to the page. This will replace all radio buttons (if any) on the page. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#gac24f87cbf1a247c8516ebfa6f7cf7f89">A3DPDFPageInsertRadioButton</ulink>.
- Parameters
-
in_radio_button Radio button to add to the page. in_location Button location in points relative to bottom left of the page. All fields in the location will be used.
- Returns
- A reference to this PageKit.
|
inline |
Adds a list of buttons to the page. This will replace all radio buttons (if any) on the page. These correspond to values that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#gac24f87cbf1a247c8516ebfa6f7cf7f89">A3DPDFPageInsertRadioButton</ulink>.
- Parameters
-
in_radio_buttons Radio buttons to add to the page. in_locations Button locations in points relative to bottom left of the page. All fields in the locations will be used.
- Returns
- A reference to this PageKit.
|
inline |
Adds a signature field to the page. This will replace all signature field (if any) on the page. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#ga3f2f1980667a3a840923320736264203">A3DPDFPageInsertSignatureField</ulink>.
- Parameters
-
in_signature_field Signature Field to add to the page. in_location Signature Field location in points relative to bottom left of the page. Only the left and bottom fields in the location will be used.
- Returns
- A reference to this PageKit.
|
inline |
Adds signature fields to the page. This will replace all signature fields (if any) on the page. These correspond to values that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#ga3f2f1980667a3a840923320736264203">A3DPDFPageInsertSignatureField</ulink>.
- Parameters
-
in_signature_field Signature Field to add to the page. in_locations Signature Field locations in points relative to bottom left of the page. Only the left and bottom fields in the locations will be used.
- Returns
- A reference to this PageKit.
|
inline |
Adds a slide table to the page. This will replace all slide tables (if any) on the page. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__document__module.html#gad3131986068fd4ef196d26f841093b6c">A3DPDFDefineSlideTable</ulink>.
- Parameters
-
in_slide_table Slide table to add to the page. in_location Slide table location in points relative to upper left of the page. Only the left and top fields in the location will be used.
- Returns
- A reference to this PageKit.
|
inline |
Adds a list of slide tables to the page. This will replace all slide tables (if any) on the page. These correspond to values that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__document__module.html#gad3131986068fd4ef196d26f841093b6c">A3DPDFDefineSlideTable</ulink>.
- Parameters
-
in_slide_tables Slide tables to add to the page. in_locations Slide table locations in points relative to upper left of the page. Only the left and top fields in the locations will be used.
- Returns
- A reference to this PageKit.
|
inline |
Adds a table to the page. This will replace all tables (if any) on the page. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#gae924b1a89f5cfa5cdbe2913480597b21">A3DPDFPageInsertTable</ulink>.
- Parameters
-
in_table Table to add to the page. in_location Table location in points relative to upper left of the page. Only the left and top fields in the location will be used.
- Returns
- A reference to this PageKit.
|
inline |
Adds a list of tables to the page. This will replace all tables (if any) on the page. These correspond to values that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#gae924b1a89f5cfa5cdbe2913480597b21">A3DPDFPageInsertTable</ulink>.
- Parameters
-
in_tables Tables to add to the page. in_locations Table locations in points relative to upper left of the page. Only the left and top fields in the locations will be used.
- Returns
- A reference to this PageKit.
|
inline |
Sets the PDF file which will act as a template.
- Parameters
-
in_filename UTF8-encoded filename for the PDF file to act as a template.
- Returns
- A reference to this PageKit.
|
inline |
Adds a text string to the page. This will replace all text (if any) on the page. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#gafd4ece4c88ce91b60228a4e72988b1ff">A3DPDFPageInsertText</ulink>.
- Parameters
-
in_text Text to add to the page. in_location Text location in points relative to bottom left of the page. Only the left and bottom fields in the location will be used.
- Returns
- A reference to this PageKit.
|
inline |
Adds text strings to the page. This will replace all text (if any) on the page. These correspond to values that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#gafd4ece4c88ce91b60228a4e72988b1ff">A3DPDFPageInsertText</ulink>.
- Parameters
-
in_text Text to add to the page. in_locations Text locations in points relative to bottom left of the page. Only the left and bottom fields in the locations will be used.
- Returns
- A reference to this PageKit.
|
inline |
Adds a text field to the page. This will replace all text fields (if any) on the page. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#ga04003d7a34557c95e84c462525ef1728">A3DPDFPageInsertTextField</ulink>.
- Parameters
-
in_text_field Text field to add to the page. in_location Text field location in points relative to bottom left of the page. All fields in the location will be used.
- Returns
- A reference to this PageKit.
|
inline |
Adds a list of text fields to the page. This will replace all text fields (if any) on the page. These correspond to values that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#ga04003d7a34557c95e84c462525ef1728">A3DPDFPageInsertTextField</ulink>.
- Parameters
-
in_text_fields Text fields to add to the page. in_locations Text field locations in points relative to bottom left of the page. All fields in the locations will be used.
- Returns
- A reference to this PageKit.
|
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 <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#ga8f171e2004b51ae1ebcec2eceb773b00">A3DPDFPageFieldTextSetValue</ulink>. This will only have an effect if the page has a template file.
- Parameters
-
in_field UTF8-encoded form field name for the text value. in_value UTF8-encoded text value to be set on the given form field.
- Returns
- A reference to this PageKit.
|
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 <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#ga8f171e2004b51ae1ebcec2eceb773b00">A3DPDFPageFieldTextSetValue</ulink>. This will only have an effect if the page has a template file.
- Parameters
-
in_fields The form field names for the text values. in_values The text values to be set on the corresponding form fields.
- Returns
- A reference to this PageKit.
|
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 <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#gacdabb9f6e7fc6a887de9516148549b8d">A3DPDFPageFieldSetVisibility</ulink>. This will only have an effect if the page has a template file.
- Parameters
-
in_fields The form field names on which to set visibility. in_states Whether the objects at the at the corresponding form fields should be visible.
- Returns
- A reference to this PageKit.
|
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 <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#gacdabb9f6e7fc6a887de9516148549b8d">A3DPDFPageFieldSetVisibility</ulink>. This will only have an effect if the page has a template file.
- Parameters
-
in_field UTF8-encoded form field name on which to set visibility. in_state Whether the object at the at the given form field should be visible.
- Returns
- A reference to this PageKit.
|
inline |
|
inline |
Shows the annotations on the page.
- Parameters
-
out_annotations Annotations on the page. out_locations Annotation locations on the page.
- Returns
- true if annotations were specified, false otherwise.
|
inline |
Shows the annotations on form fields on the page.
- Parameters
-
out_fields The annotation form field names on the page. out_annotations The annotations on the corresponding form fields.
- Returns
- true if form field annotations were specified, false otherwise.
|
inline |
Shows the images on icons on form fields on the page.
- Parameters
-
out_fields The button icon form field names on the page. out_images The images on the icons at the corresponding form fields.
- Returns
- true if form field icons were specified, false otherwise.
|
inline |
Shows the labels on form fields on the page.
- Parameters
-
out_fields The button label form field names on the page. out_labels The labels on the corresponding form fields.
- Returns
- true if form field labels were specified, false otherwise.
|
inline |
Shows the buttons on the page.
- Parameters
-
out_buttons Buttons on the page. out_locations Button locations on the page.
- Returns
- true if buttons were specified, false otherwise.
|
inline |
Shows the check boxes on the page.
- Parameters
-
out_check_boxes Check boxes on the page. out_locations Check box locations on the page.
- Returns
- true if check boxes were specified, false otherwise.
|
inline |
Shows the drop down lists on the page.
- Parameters
-
out_drop_down_lists Drop down lists on the page. out_locations Drop drown list locations on the page.
- Returns
- true if drop down lists were specified, false otherwise.
|
inline |
Shows the format of the page.
- Parameters
-
out_format Format of the page.
- Returns
- true if a format was specified, false otherwise.
|
inline |
Shows the images on the page.
- Parameters
-
out_images Images on the page. out_locations Image locations on the page.
- Returns
- true if images were specified, false otherwise.
|
inline |
Shows the JavaScript actions on form fields on the page.
- Parameters
-
out_fields The form field names with JavaScript actions on the page. out_sources The JavaScript sources and/or files (depending on the corresponding entry in the following argument) on the corresponding form fields. out_types The types for each item in the preceding argument array.
- Returns
- true if form field JavaScript actions were specified, false otherwise.
|
inline |
Shows the links on the page.
- Parameters
-
out_links Links on the page. out_locations Link locations on the page.
- Returns
- true if links were specified, false otherwise.
|
inline |
Shows the list boxes on the page.
- Parameters
-
out_list_boxes List boxes on the page. out_locations List boxes locations on the page.
- Returns
- true if list boxes were specified, false otherwise.
|
inline |
Shows the list item form fields on the page.
- Parameters
-
out_fields The list form field names on the page.
- Returns
- true if any form field lists were specified, false otherwise.
|
inline |
Shows the items in the list on the given field on the page.
- Parameters
-
in_field UTF8-encoded form field name of the list with the items to be shown. out_values The values for the items in the list at the given form field. out_export_values The export values for the items in the list at the given form field.
- Returns
- true if list items on the given form field were specified, false otherwise.
|
inline |
Shows the orientation of the page.
- Parameters
-
out_orientation Orientation of the page.
- Returns
- true if an orientation was specified, false otherwise.
|
inline |
Shows the radio buttons on the page.
- Parameters
-
out_radio_buttons Radio buttons on the page. out_locations Radio buttons locations on the page.
- Returns
- true if radio buttons were specified, false otherwise.
|
inline |
Shows the signature fields on the page.
- Parameters
-
out_signature_fields Signature fields on the page. out_locations Signature field locations on the page.
- Returns
- true if signature fields were specified, false otherwise.
|
inline |
Shows the slide tables on the page.
- Parameters
-
out_slide_tables Slide tables on the page. out_locations Slide table locations on the page.
- Returns
- true if slide tables were specified, false otherwise.
|
inline |
Shows the tables on the page.
- Parameters
-
out_tables Tables on the page. out_locations Table locations on the page.
- Returns
- true if tables were specified, false otherwise.
|
inline |
Shows the template file.
- Parameters
-
out_filename The filename for the PDF file to act as a template.
- Returns
- true if a template file was specified, false otherwise.
|
inline |
|
inline |
|
inline |
Shows the text values on form fields on the page.
- Parameters
-
out_fields The form field names with the text values on the template. out_values The text values on the corresponding form fields.
- Returns
- true if form field text values were specified, false otherwise.
|
inline |
Shows the visibility settings on form fields on the page.
- Parameters
-
out_fields The form field names with visibility settings on the page. out_states Whether the objects at the at the corresponding form fields should be visible.
- Returns
- true if form field visibilities were specified, false otherwise.
|
inline |
Removes the annotation at the given index from the page.
- Parameters
-
in_index Index of the annotation to remove from the page.
- Returns
- A reference to this PageKit.
|
inline |
Removes the annotation at the given form field from the page.
- Parameters
-
in_field UTF8-encoded form field name with the annotation to be removed.
- Returns
- A reference to this PageKit.
|
inline |
Removes the annotations at the given indices from the page.
- Parameters
-
in_indices Indices of the annotations to remove from the page.
- Returns
- A reference to this PageKit.
|
inline |
Removes all annotations from the page.
- Returns
- A reference to this PageKit.
|
inline |
Removes the annotations at the given form fields from the page.
- Parameters
-
in_fields Form field names with the annotations to be removed.
- Returns
- A reference to this PageKit.
|
inline |
Removes all annotation form fields from the page.
- Returns
- A reference to this PageKit.
|
inline |
Removes the button at the given index from the page.
- Parameters
-
in_index Index of the button to remove from the page.
- Returns
- A reference to this PageKit.
|
inline |
Removes the image on the icon at the given form field from the page.
- Parameters
-
in_field UTF8-encoded form field name of the icon with the image to be removed.
- Returns
- A reference to this PageKit.
|
inline |
Removes the images on the icons at the given form fields from the page.
- Parameters
-
in_fields Form field names of icons with the images to be removed.
- Returns
- A reference to this PageKit.
|
inline |
Removes all button icon form fields from the page.
- Returns
- A reference to this PageKit.
|
inline |
Removes the label at the given form field from the page.
- Parameters
-
in_field UTF8-encoded form field name of the label to be removed.
- Returns
- A reference to this PageKit.
|
inline |
Removes the labels at the given form fields from the page.
- Parameters
-
in_fields Form field names of the labels to be removed.
- Returns
- A reference to this PageKit.
|
inline |
Removes all button label form fields from the page.
- Returns
- A reference to this PageKit.
|
inline |
Removes the buttons at the given indices from the page.
- Parameters
-
in_indices Indices of the buttons to remove from the page.
- Returns
- A reference to this PageKit.
|
inline |
Removes all buttons from the page.
- Returns
- A reference to this PageKit.
|
inline |
Removes the check box at the given index from the page.
- Parameters
-
in_index Index of the check box to remove from the page.
- Returns
- A reference to this PageKit.
|
inline |
Removes the check box at the given indices from the page.
- Parameters
-
in_indices Indices of the check box to remove from the page.
- Returns
- A reference to this PageKit.
|
inline |
Removes all check boxes from the page.
- Returns
- A reference to this PageKit.
|
inline |
Removes the drop down list at the given index from the page.
- Parameters
-
in_index Index of the drop down list to remove from the page.
- Returns
- A reference to this PageKit.
|
inline |
Removes the drop down list at the given indices from the page.
- Parameters
-
in_indices Indices of the drop down list to remove from the page.
- Returns
- A reference to this PageKit.
|
inline |
Removes all drop down lists from the page.
- Returns
- A reference to this PageKit.
|
inline |
Removes all data from the page.
- Returns
- A reference to this PageKit.
|
inline |
Removes the format from the page.
- Returns
- A reference to this PageKit.
|
inline |
Removes the image at the given index from the page.
- Parameters
-
in_index Index of the image to remove from the page.
- Returns
- A reference to this PageKit.
|
inline |
Removes the images at the given indices from the page.
- Parameters
-
in_indices Indices of the images to remove from the page.
- Returns
- A reference to this PageKit.
|
inline |
Removes all images from the page.
- Returns
- A reference to this PageKit.
|
inline |
Removes the JavaScript action at the given form field from the page.
- Parameters
-
in_field UTF8-encoded form field name of the action to be removed.
- Returns
- A reference to this PageKit.
|
inline |
Removes the JavaScript actions at the given form fields from the page.
- Parameters
-
in_fields Form field names of the actions to be removed.
- Returns
- A reference to this PageKit.
|
inline |
Removes all JavaScript action form fields from the page.
- Returns
- A reference to this PageKit.
|
inline |
Removes the link at the given index from the page.
- Parameters
-
in_index Index of the link to remove from the page.
- Returns
- A reference to this PageKit.
|
inline |
Removes the links at the given indices from the page.
- Parameters
-
in_indices Indices of the links to remove from the page.
- Returns
- A reference to this PageKit.
|
inline |
Removes all links from the page.
- Returns
- A reference to this PageKit.
|
inline |
Removes the list box at the given index from the page.
- Parameters
-
in_index Index of the list box to remove from the page.
- Returns
- A reference to this PageKit.
|
inline |
Removes the list box at the given indices from the page.
- Parameters
-
in_indices Indices of the list box to remove from the page.
- Returns
- A reference to this PageKit.
|
inline |
Removes all list boxes from the page.
- Returns
- A reference to this PageKit.
|
inline |
Removes the item at the given index from the list at the given form field from the page.
- Parameters
-
in_field UTF8-encoded form field name of the list with the item to be removed. in_index Index of the item in the list at the given form field to be removed.
- Returns
- A reference to this PageKit.
|
inline |
Removes the items at the given indices from the list at the given form field from the page.
- Parameters
-
in_field UTF8-encoded form field name of the list with the items to be removed. in_indices Indices of the items in the list at the form field to be removed.
- Returns
- A reference to this PageKit.
|
inline |
Removes all items from the list at the given form field from the page.
- Parameters
-
in_field UTF8-encoded form field name of the list with the items to be removed.
- Returns
- A reference to this PageKit.
|
inline |
Removes all items from the lists at the given form fields from the page.
- Parameters
-
in_fields Form field names of the lists with the items to be removed.
- Returns
- A reference to this PageKit.
|
inline |
Removes all list item form fields from the page.
- Returns
- A reference to this PageKit.
|
inline |
Removes the orientation from the page.
- Returns
- A reference to this PageKit.
|
inline |
Removes the radio button at the given index from the page.
- Parameters
-
in_index Index of the radio button to remove from the page.
- Returns
- A reference to this PageKit.
|
inline |
Removes the radio button at the given indices from the page.
- Parameters
-
in_indices Indices of the radio button to remove from the page.
- Returns
- A reference to this PageKit.
|
inline |
Removes all radio buttons from the page.
- Returns
- A reference to this PageKit.
|
inline |
Removes the signature field at the given index from the page.
- Parameters
-
in_index Index of the signature field to remove from the page.
- Returns
- A reference to this PageKit.
|
inline |
Removes the signature field at the given indices from the page.
- Parameters
-
in_indices Indices of the signature field to remove from the page.
- Returns
- A reference to this PageKit.
|
inline |
Removes all signature fields from the page.
- Returns
- A reference to this PageKit.
|
inline |
Removes the slide table at the given index from the page.
- Parameters
-
in_index Index of the slide table to remove from the page.
- Returns
- A reference to this PageKit.
|
inline |
Removes the slide tables at the given indices from the page.
- Parameters
-
in_indices Indices of the slide tables to remove from the page.
- Returns
- A reference to this PageKit.
|
inline |
Removes all slide tables from the page.
- Returns
- A reference to this PageKit.
|
inline |
Removes the table at the given index from the page.
- Parameters
-
in_index Index of the table to remove from the page.
- Returns
- A reference to this PageKit.
|
inline |
Removes the tables at the given indices from the page.
- Parameters
-
in_indices Indices of the tables to remove from the page.
- Returns
- A reference to this PageKit.
|
inline |
Removes all tables from the page.
- Returns
- A reference to this PageKit.
|
inline |
Removes the template file from the page.
- Returns
- A reference to this PageKit.
|
inline |
Removes the text at the given index from the page.
- Parameters
-
in_index Index of the text to remove from the page.
- Returns
- A reference to this PageKit.
|
inline |
Removes the text at the given indices from the page.
- Parameters
-
in_indices Indices of the text to remove from the page.
- Returns
- A reference to this PageKit.
|
inline |
Removes all text from the page.
- Returns
- A reference to this PageKit.
|
inline |
Removes the text field at the given index from the page.
- Parameters
-
in_index Index of the text field to remove from the page.
- Returns
- A reference to this PageKit.
|
inline |
Removes the text fields at the given indices from the page.
- Parameters
-
in_indices Indices of the text fields to remove from the page.
- Returns
- A reference to this PageKit.
|
inline |
Removes all text fields from the page.
- Returns
- A reference to this PageKit.
|
inline |
Removes the text value at the given form field from the page.
- Parameters
-
in_field UTF8-encoded form field name with the text value to be removed.
- Returns
- A reference to this PageKit.
|
inline |
Removes the text values at the given form fields from the page.
- Parameters
-
in_fields Form field names with the text values to be removed.
- Returns
- A reference to this PageKit.
|
inline |
Removes all text value form fields from the page.
- Returns
- A reference to this PageKit.
|
inline |
Removes the visibility settings at the given form fields from the page.
- Parameters
-
in_fields Form field names with the visibility settings to be removed.
- Returns
- A reference to this PageKit.
|
inline |
Removes all visibility settings on form fields from the page.
- Returns
- A reference to this PageKit.
|
inline |
Removes the visibility setting at the given form field from the page.
- Parameters
-
in_field UTF8-encoded form field name with the visibility setting to be removed.
- Returns
- A reference to this PageKit.
The documentation for this class was generated from the following file:
- internals/hps_sprk_publish/source/cs/HPS.Publish.cs