Page functions. More...
Data Structures | |
| struct | A3DPDFFieldData |
| A3DPDF3DFieldData structure. More... | |
| struct | A3DPDFGraphicArcData |
| Structure that defines a graphic circle arc. More... | |
| struct | A3DPDFGraphicBezierCurveData |
| Structure that defines a graphic bezier curve. More... | |
| struct | A3DPDFGraphicCompositePathData |
| Structure that defines a graphic path. More... | |
| struct | A3DPDFGraphicLineData |
| Structure that defines a graphic line. More... | |
| struct | A3DPDFGraphicRectangleData |
| Structure that defines a graphic rectangle. More... | |
| struct | A3DPDFPageData |
| A3DPDFPageData structure. More... | |
| struct | A3DPDFPageData2 |
| A3DPDFPageData2 structure. More... | |
| struct | A3DPDFRectData |
| A3DPDFRectData structure: structure to define a rectangle placement in the PDF page. More... | |
| struct | A3DPDFRectDData |
| A3DPDFRectDData structure: structure to define a rectangle placement in the PDF page, in double precision. More... | |
Functions | |
| A3DStatus | A3DPDF3DAnnotSetActionJavascript (A3DPDFPage *pPage, A3DPDF3DAnnot *p3DAnnot, const A3DPDFEEventActionType eEventActionType, const A3DUTF8Char *pcJavascriptString) |
| Function to define a javaScript action to an event triggered on an annotation. The JavaScript is defined as a string. More... | |
| A3DStatus | A3DPDFButtonCreate (A3DPDFDocument *pDoc, const A3DPDFButtonData *pButtonData, A3DPDFButton **ppButton) |
| Function to create a button. More... | |
| A3DStatus | A3DPDFCheckBoxCreate (A3DPDFDocument *pDoc, const A3DPDFCheckBoxData *pCheckBoxData, A3DPDFCheckBox **ppCheckBox) |
| Function to create a CheckBox. More... | |
| A3DStatus | A3DPDFDigitalSignatureCreate (A3DPDFDocument *pDoc, const A3DPDFDigitalSignatureData *pDigitalSignatureData, A3DPDFDigitalSignature **ppDigitalSignature) |
| Function to create a DigitalSignature. More... | |
| A3DStatus | A3DPDFDocumentSetActionJavascript (A3DPDFDocument *pDoc, const A3DPDFEEventActionType eEventActionType, const A3DUTF8Char *pcJavascriptString) |
| Function to define a javaScript action to an event triggered on the document. The JavaScript is defined as a string. More... | |
| A3DStatus | A3DPDFDropDownListCreate (A3DPDFDocument *pDoc, const A3DPDFDropDownListData *pDropDownListData, A3DPDFDropDownList **ppDropDownList) |
| Function to create a DropDownList (combo box) More... | |
| A3DStatus | A3DPDFFieldGetInformation (A3DPDFField *pField, A3DPDFFieldData *pFieldData) |
| Function to retrieve useful information regarding a field of a document. More... | |
| A3DStatus | A3DPDFListBoxCreate (A3DPDFDocument *pDoc, const A3DPDFListBoxData *pListBoxData, A3DPDFListBox **ppListBox) |
| Function to create a ListBox. More... | |
| A3DStatus | A3DPDFPageDrawArc (A3DPDFPage *pPage, const A3DPDFGraphicArcData *pGraphicArcData) |
| Function to create a graphic circle arc. More... | |
| A3DStatus | A3DPDFPageDrawBezierCurve (A3DPDFPage *pPage, const A3DPDFGraphicBezierCurveData *pGraphicBezierCurveData) |
| Function to create a graphic bezier curve. More... | |
| A3DStatus | A3DPDFPageDrawCompositePath (A3DPDFPage *pPage, A3DPDFGraphicCompositePathData *pGraphicPathData) |
| Function to create a graphic composite path. More... | |
| A3DStatus | A3DPDFPageDrawLine (A3DPDFPage *pPage, const A3DPDFGraphicLineData *pGraphicLineData) |
| Function to create a graphic line. More... | |
| A3DStatus | A3DPDFPageDrawRectangle (A3DPDFPage *pPage, const A3DPDFGraphicRectangleData *pGraphicRectangleData) |
| Function to create a graphic line. More... | |
| A3DStatus | A3DPDFPageFieldButtonSetIcon (A3DPDFPage *pPage, const A3DUTF8Char *pcFieldName, const A3DPDFImage *pImage) |
| Function to set the icon of a button form field. More... | |
| A3DStatus | A3DPDFPageFieldButtonSetLabel (A3DPDFPage *pPage, const A3DUTF8Char *pcFieldName, const A3DUTF8Char *pcValue) |
| Function to set the label of a button form field. More... | |
| A3DStatus | A3DPDFPageFieldListAddItem (A3DPDFPage *pPage, const A3DUTF8Char *pcFieldName, const A3DUTF8Char *pcItemValue, const A3DUTF8Char *pcItemExportValue) |
| Function to add an item to a form field of type list. More... | |
| A3DStatus | A3DPDFPageFieldSet3DAnnot (A3DPDFPage *pPage, const A3DUTF8Char *pcFieldName, const A3DPDF3DAnnot *p3DAnnot) |
| Function to replace the form field specified with a 3D Annot object. More... | |
| A3DStatus | A3DPDFPageFieldSetActionJavascript (A3DPDFPage *pPage, const A3DUTF8Char *pcFieldName, const A3DPDFEEventActionType eEventActionType, const A3DUTF8Char *pcJavascriptString) |
| Function to attach JavaScript to a form field. The JavaScript is defined as a string. More... | |
| A3DStatus | A3DPDFPageFieldSetActionJavascriptFromFile (A3DPDFPage *pPage, const A3DUTF8Char *pcFieldName, const A3DUTF8Char *pcFileName) |
| This method was deprecated in HOOPS Publish 1.1. Use A3DPDFPageFieldSetActionJavascriptFromString instead. More... | |
| A3DStatus | A3DPDFPageFieldSetActionJavascriptFromString (A3DPDFPage *pPage, const A3DUTF8Char *pcFieldName, const A3DUTF8Char *pcJavascriptString) |
| Function to attach JavaScript to a form field. The JavaScript is defined as a string. More... | |
| A3DStatus | A3DPDFPageFieldSetVisibility (A3DPDFPage *pPage, const A3DUTF8Char *pcFieldName, const A3DBool bIsVisible) |
| Function to set the visibility of a form field. More... | |
| A3DStatus | A3DPDFPageFieldTextSetValue (A3DPDFPage *pPage, const A3DUTF8Char *pcFieldName, const A3DUTF8Char *pcValue) |
| Function to set the text of a text form field. More... | |
| A3DStatus | A3DPDFPageGetFields (A3DPDFPage *pPage, A3DInt32 *piNbFields, A3DPDFField ***pppFields) |
| Function to retrieve the fields of a PDF page. The fields supported are only form fields created with Acrobat. LiveCycle Designer fields (XFA) are not supported. More... | |
| A3DStatus | A3DPDFPageInsert3DAnnot (A3DPDFPage *pPage, const A3DPDF3DAnnot *p3DAnnot, const A3DPDFRectData *pRectData) |
| Function to insert a 3D Annot in a page. More... | |
| A3DStatus | A3DPDFPageInsertButton (A3DPDFPage *pPage, A3DPDFButton *pButton, const A3DPDFRectData *pRectData) |
| Function to insert a button in a page. More... | |
| A3DStatus | A3DPDFPageInsertButtonInTable (A3DPDFPage *pPage, A3DPDFTable *pTable, A3DPDFButton *pButton, A3DInt32 iRowIndex, A3DInt32 iColumnIndex) |
| Function to insert a button in a table. More... | |
| A3DStatus | A3DPDFPageInsertCheckBox (A3DPDFPage *pPage, A3DPDFCheckBox *pCheckBox, const A3DPDFRectData *pRectData) |
| Function to insert a CheckBox in a page. More... | |
| A3DStatus | A3DPDFPageInsertDigitalSignature (A3DPDFPage *pPage, A3DPDFDigitalSignature *pDigitalSignature, const A3DPDFRectData *pRectData) |
| Function to insert a DigitalSignature in a page. More... | |
| A3DStatus | A3DPDFPageInsertDropDownList (A3DPDFPage *pPage, A3DPDFDropDownList *pDropDownList, const A3DPDFRectData *pRectData) |
| Function to insert a DropDownList (combo box) in a page. More... | |
| A3DStatus | A3DPDFPageInsertImage (A3DPDFPage *pPage, A3DPDFImage *pImage, const A3DInt32 iPosLeft, const A3DInt32 iPosBottom) |
| Function to insert an image in a page. More... | |
| A3DStatus | A3DPDFPageInsertLink (A3DPDFPage *pPage, A3DPDFLink *pLink, const A3DPDFRectData *pRectData) |
| Function to insert a link in a page. More... | |
| A3DStatus | A3DPDFPageInsertLinkInTable (A3DPDFPage *pPage, A3DPDFTable *pTable, A3DPDFLink *pLink, A3DInt32 iRowIndex, A3DInt32 iColumnIndex) |
| Function to insert a link in a table. More... | |
| A3DStatus | A3DPDFPageInsertListBox (A3DPDFPage *pPage, A3DPDFListBox *pListBox, const A3DPDFRectData *pRectData) |
| Function to insert a ListBox in a page. More... | |
| A3DStatus | A3DPDFPageInsertRadioButton (A3DPDFPage *pPage, A3DPDFRadioButton *pRadioButton, const A3DPDFRectData *pRectData) |
| Function to insert a RadioButton in a page. More... | |
| A3DStatus | A3DPDFPageInsertTable (A3DPDFPage *pPage, A3DPDFTable *pTable, const A3DInt32 iPosLeft, const A3DInt32 iPosTop) |
| Function to insert a table in a page. More... | |
| A3DStatus | A3DPDFPageInsertText (A3DPDFPage *pPage, A3DPDFText *pText, const A3DInt32 iPosLeft, const A3DInt32 iPosBottom) |
| Function to insert a text in a page. More... | |
| A3DStatus | A3DPDFPageInsertTextField (A3DPDFPage *pPage, A3DPDFTextField *pTextField, const A3DPDFRectData *pRectData) |
| Function to insert a text field in a page. More... | |
| A3DStatus | A3DPDFPageInsertTextFieldInTable (A3DPDFPage *pPage, A3DPDFTable *pTable, A3DPDFTextField *pTextField, A3DInt32 iRowIndex, A3DInt32 iColumnIndex) |
| Function to insert a text field in a table. More... | |
| A3DStatus | A3DPDFPageInsertTextInTable (A3DPDFPage *pPage, A3DPDFTable *pTable, A3DPDFText *pText, A3DInt32 iRowIndex, A3DInt32 iColumnIndex) |
| Function to insert a text in a table. More... | |
| A3DStatus | A3DPDFPageRemoveTable (A3DPDFPage *pPage, A3DPDFTable *pTable) |
| Function to remove a table from a page. More... | |
| A3DStatus | A3DPDFPageSetActionJavascript (A3DPDFPage *pPage, const A3DPDFEEventActionType eEventActionType, const A3DUTF8Char *pcJavascriptString) |
| Function to define a javaScript action to an event triggered on the page. The JavaScript is defined as a string. More... | |
| A3DStatus | A3DPDFRadioButtonCreate (A3DPDFDocument *pDoc, const A3DPDFRadioButtonData *pRadioButtonData, A3DPDFRadioButton **ppRadioButton) |
| Function to create a RadioButton. More... | |
| A3DStatus | A3DPDFTextFieldCreate (A3DPDFDocument *pDoc, const A3DPDFTextFieldData *pTextFieldData, A3DPDFTextField **ppTextField) |
| Function to create a text field. More... | |
Detailed Description
Page functions.
This module describes the functions and structures that allow you to define a PDF Page in the document.
Enumeration Type Documentation
Set of events that can trigger the execution of an action.
The kA3DPDFEventPageOpened and kA3DPDFEventPageClosed event on an annotation object have a similar function in the page object. However, associating these triggers with annotations allows annotation objects to be self-contained. The kA3DPDFEventPageVisible and kA3DPDFEventPageInvisible types allow a distinction between pages that are open and pages that are visible. At any one time, while more than one page may be visible, depending on the page layout.
- Version
- 9.0
| enum A3DPDFEFieldType |
Field type.
- Version
- 6.0
| enum A3DPDFEFormField |
| enum A3DPDFEGraphicType |
Position of the label of the button relative to its icon.
- Version
- 7.2
Line style of the border of the button.
- Version
- 7.2
| enum A3DPDFEPageSize |
Page size of the PDF document.
- Version
- 4.1
| enum A3DPDFETextAlignment |
Function Documentation
| A3DStatus A3DPDF3DAnnotSetActionJavascript | ( | A3DPDFPage * | pPage, |
| A3DPDF3DAnnot * | p3DAnnot, | ||
| const A3DPDFEEventActionType | eEventActionType, | ||
| const A3DUTF8Char * | pcJavascriptString | ||
| ) |
Function to define a javaScript action to an event triggered on an annotation. The JavaScript is defined as a string.
The goal of this function is to define a JavaScript action to be launched on an event triggered on an annotation.
- Parameters
-
[in] pPage The Page object to work with. [in] p3DAnnot The 3D annot object to work with. [in] eEventActionType The action type. [in] pcJavascriptString The string which contains the JavaScript.
- Returns
- A3D_SUCCESS
- Version
- 9.0
| A3DStatus A3DPDFButtonCreate | ( | A3DPDFDocument * | pDoc, |
| const A3DPDFButtonData * | pButtonData, | ||
| A3DPDFButton ** | ppButton | ||
| ) |
Function to create a button.
The button is primarily created with this function, and it should be positioned on the page with the function A3DPDFPageInsertButton.
- Parameters
-
[in,out] pDoc The Document object to work with. [in] pButtonData The button parameters. The name is mandatory. [out] ppButton The button created.
- Returns
- A3D_SUCCESS
- Version
- 7.2
| A3DStatus A3DPDFCheckBoxCreate | ( | A3DPDFDocument * | pDoc, |
| const A3DPDFCheckBoxData * | pCheckBoxData, | ||
| A3DPDFCheckBox ** | ppCheckBox | ||
| ) |
Function to create a CheckBox.
The CheckBox is primarily created with this function, and it should be positionned on the page with the function A3DPDFPageInsertCheckBox.
- Parameters
-
[in,out] pDoc The Document object to work with. [in] pCheckBoxData The CheckBox parameters. The name is mandatory. [out] ppCheckBox The CheckBox created.
- Returns
- A3D_SUCCESS
- Version
- 8.0
| A3DStatus A3DPDFDigitalSignatureCreate | ( | A3DPDFDocument * | pDoc, |
| const A3DPDFDigitalSignatureData * | pDigitalSignatureData, | ||
| A3DPDFDigitalSignature ** | ppDigitalSignature | ||
| ) |
Function to create a DigitalSignature.
The DigitalSignature is primarily created with this function, and it should be positionned on the page with the function A3DPDFPageInsertDigitalSignature.
- Parameters
-
[in,out] pDoc The Document object to work with. [in] pDigitalSignatureData The DigitalSignature parameters. The name is mandatory. [out] ppDigitalSignature The DigitalSignature created.
- Returns
- A3D_SUCCESS
- Version
- 8.0
| A3DStatus A3DPDFDocumentSetActionJavascript | ( | A3DPDFDocument * | pDoc, |
| const A3DPDFEEventActionType | eEventActionType, | ||
| const A3DUTF8Char * | pcJavascriptString | ||
| ) |
Function to define a javaScript action to an event triggered on the document. The JavaScript is defined as a string.
The goal of this function is to define a JavaScript action to be launched on an event triggered on the document level.
- Parameters
-
[in] pDoc The Document object to work with. [in] eEventActionType The action type. Only kA3DPDFEventDocWillClose, kA3DPDFEventDocWillSave kA3DPDFEventDocDidSave kA3DPDFEventDocWillPrint and kA3DPDFEventDocDidPrint are relevant at document level. [in] pcJavascriptString The string which contains the JavaScript.
- Returns
- A3D_SUCCESS
- Version
- 9.0
| A3DStatus A3DPDFDropDownListCreate | ( | A3DPDFDocument * | pDoc, |
| const A3DPDFDropDownListData * | pDropDownListData, | ||
| A3DPDFDropDownList ** | ppDropDownList | ||
| ) |
Function to create a DropDownList (combo box)
The DropDownList is primarily created with this function, and it should be positionned on the page with the function A3DPDFPageInsertDropDownList. List items can be added using the function A3DPDFPageFieldListAddItem, after the call to A3DPDFPageInsertDropDownList.
- Parameters
-
[in,out] pDoc The Document object to work with. [in] pDropDownListData The DropDownList parameters. The name is mandatory. [out] ppDropDownList The DropDownList created.
- Returns
- A3D_SUCCESS
- Version
- 8.0
| A3DStatus A3DPDFFieldGetInformation | ( | A3DPDFField * | pField, |
| A3DPDFFieldData * | pFieldData | ||
| ) |
Function to retrieve useful information regarding a field of a document.
- Parameters
-
[in] pField The Field object to work with. [in,out] pFieldData Data structure completed by the function. Contains the attributes of the field.
- Version
- 6.0
| A3DStatus A3DPDFListBoxCreate | ( | A3DPDFDocument * | pDoc, |
| const A3DPDFListBoxData * | pListBoxData, | ||
| A3DPDFListBox ** | ppListBox | ||
| ) |
Function to create a ListBox.
The ListBox is primarily created with this function, and it should be positionned on the page with the function A3DPDFPageInsertListBox. List items can be added using the function A3DPDFPageFieldListAddItem, after the call to A3DPDFPageInsertListBox.
- Parameters
-
[in,out] pDoc The Document object to work with. [in] pListBoxData The ListBox parameters. The name is mandatory. [out] ppListBox The ListBox created.
- Returns
- A3D_SUCCESS
- Version
- 8.0
| A3DStatus A3DPDFPageDrawArc | ( | A3DPDFPage * | pPage, |
| const A3DPDFGraphicArcData * | pGraphicArcData | ||
| ) |
Function to create a graphic circle arc.
- Parameters
-
[in,out] pPage The page object to work with. [in] pGraphicArcData The Graphic arc parameters.
- Returns
- A3D_SUCCESS
- Version
- 9.1
| A3DStatus A3DPDFPageDrawBezierCurve | ( | A3DPDFPage * | pPage, |
| const A3DPDFGraphicBezierCurveData * | pGraphicBezierCurveData | ||
| ) |
Function to create a graphic bezier curve.
- Parameters
-
[in,out] pPage The page object to work with. [in] pGraphicBezierCurveData The Graphic Bezier curve parameters.
- Returns
- A3D_SUCCESS
- Version
- 9.1
| A3DStatus A3DPDFPageDrawCompositePath | ( | A3DPDFPage * | pPage, |
| A3DPDFGraphicCompositePathData * | pGraphicPathData | ||
| ) |
Function to create a graphic composite path.
- Parameters
-
[in,out] pPage The page object to work with. [in] pGraphicPathData The parameters of the elements to be drawn.
- Returns
- A3D_SUCCESS
- Version
- 9.1
| A3DStatus A3DPDFPageDrawLine | ( | A3DPDFPage * | pPage, |
| const A3DPDFGraphicLineData * | pGraphicLineData | ||
| ) |
Function to create a graphic line.
- Parameters
-
[in,out] pPage The page object to work with. [in] pGraphicLineData The Graphic line parameters.
- Returns
- A3D_SUCCESS
- Version
- 9.1
| A3DStatus A3DPDFPageDrawRectangle | ( | A3DPDFPage * | pPage, |
| const A3DPDFGraphicRectangleData * | pGraphicRectangleData | ||
| ) |
Function to create a graphic line.
- Parameters
-
[in,out] pPage The Page object to work with. [in] pGraphicRectangleData The Graphic rectangle parameters.
- Returns
- A3D_SUCCESS
- Version
- 9.1
| A3DStatus A3DPDFPageFieldButtonSetIcon | ( | A3DPDFPage * | pPage, |
| const A3DUTF8Char * | pcFieldName, | ||
| const A3DPDFImage * | pImage | ||
| ) |
Function to set the icon of a button form field.
The image is defined from a A3DPDFImage object. It is always scaled non-proportionally, which means always adapted and stretched to the size of the field. That way, the members m_iWidth and m_iHeight of A3DPDFImageData are not used by this function.
- Parameters
-
[in,out] pPage The Page object to work with. [in] pcFieldName The name of the form field. Only Acroform fields are supported. [in] pImage The image to store on the button field.
- Returns
- A3D_SUCCESS
- Version
- 4.1
| A3DStatus A3DPDFPageFieldButtonSetLabel | ( | A3DPDFPage * | pPage, |
| const A3DUTF8Char * | pcFieldName, | ||
| const A3DUTF8Char * | pcValue | ||
| ) |
Function to set the label of a button form field.
- Parameters
-
[in,out] pPage The Page object to work with. [in] pcFieldName The name of the button form field. Only Acroform fields are supported. [in] pcValue The label to set to the field.
- Returns
- A3D_SUCCESS
- Version
- 4.1
| A3DStatus A3DPDFPageFieldListAddItem | ( | A3DPDFPage * | pPage, |
| const A3DUTF8Char * | pcFieldName, | ||
| const A3DUTF8Char * | pcItemValue, | ||
| const A3DUTF8Char * | pcItemExportValue | ||
| ) |
Function to add an item to a form field of type list.
- Parameters
-
[in,out] pPage The Page object to work with. [in] pcFieldName The name of the form field. Only Acroform fields are supported. [in] pcItemValue The item string which will be visible to the user in the list field. [in] pcItemExportValue The export value for the item. This value acts as a 'symbolic value' for the item.
- Returns
- A3D_SUCCESS
- Version
- 4.3
| A3DStatus A3DPDFPageFieldSet3DAnnot | ( | A3DPDFPage * | pPage, |
| const A3DUTF8Char * | pcFieldName, | ||
| const A3DPDF3DAnnot * | p3DAnnot | ||
| ) |
Function to replace the form field specified with a 3D Annot object.
Note: starting with HOOPS Publish 1.10, several 3D Annots can be stored on a page.
- Parameters
-
[in,out] pPage The Page object to work with. [in] pcFieldName The name of the form field. Only Acroform fields are supported. [in] p3DAnnot The 3D Annot to set.
- Returns
- A3D_SUCCESS
- Version
- 4.1
| A3DStatus A3DPDFPageFieldSetActionJavascript | ( | A3DPDFPage * | pPage, |
| const A3DUTF8Char * | pcFieldName, | ||
| const A3DPDFEEventActionType | eEventActionType, | ||
| const A3DUTF8Char * | pcJavascriptString | ||
| ) |
Function to attach JavaScript to a form field. The JavaScript is defined as a string.
The goal of this function is to define a JavaScript action to be launched on an event. The action event is different depending on the type of the field. For fields of type:
- dropdown list: the action is the selection of a list item.
- listbox list: the action is the selection of a list item.
- button: the action is the button pushed.
- Parameters
-
[in,out] pPage The Page object to work with. [in] pcFieldName The name of the form field. Only Acroform fields are supported. [in] eEventActionType The action type. Only kA3DPDFEventPageOpened and kA3DPDFEventPageClosed are relevant at page level. [in] pcJavascriptString The string which contains the JavaScript.
- Returns
- A3D_SUCCESS
- Version
- 9.0
| A3DStatus A3DPDFPageFieldSetActionJavascriptFromFile | ( | A3DPDFPage * | pPage, |
| const A3DUTF8Char * | pcFieldName, | ||
| const A3DUTF8Char * | pcFileName | ||
| ) |
This method was deprecated in HOOPS Publish 1.1. Use A3DPDFPageFieldSetActionJavascriptFromString instead.
Function to attach JavaScript to a form field. The JavaScript is defined in a file.
- Parameters
-
[in,out] pPage The Page object to work with. [in] pcFieldName The name of the form field. Only Acroform fields are supported. [in] pcFileName The path of a file containing a JavaScript.
- Returns
- A3D_SUCCESS
- Version
- 4.1
| A3DStatus A3DPDFPageFieldSetActionJavascriptFromString | ( | A3DPDFPage * | pPage, |
| const A3DUTF8Char * | pcFieldName, | ||
| const A3DUTF8Char * | pcJavascriptString | ||
| ) |
Function to attach JavaScript to a form field. The JavaScript is defined as a string.
The goal of this function is to define a JavaScript action to be launched on an event. The action event is different depending on the type of the field. For fields of type:
- dropdown list: the action is the selection of a list item.
- listbox list: the action is the selection of a list item.
- button: the action is the button pushed.
- Parameters
-
[in,out] pPage The Page object to work with. [in] pcFieldName The name of the form field. Only Acroform fields are supported. [in] pcJavascriptString The string which contains the JavaScript.
- Returns
- A3D_SUCCESS
- Version
- 4.1
| A3DStatus A3DPDFPageFieldSetVisibility | ( | A3DPDFPage * | pPage, |
| const A3DUTF8Char * | pcFieldName, | ||
| const A3DBool | bIsVisible | ||
| ) |
Function to set the visibility of a form field.
- Parameters
-
[in,out] pPage The Page object to work with. [in] pcFieldName The name of the form field. Only Acroform fields are supported. [in] bIsVisible Specifies if the field should be visible or not.
- Returns
- A3D_SUCCESS
- Version
- 4.1
| A3DStatus A3DPDFPageFieldTextSetValue | ( | A3DPDFPage * | pPage, |
| const A3DUTF8Char * | pcFieldName, | ||
| const A3DUTF8Char * | pcValue | ||
| ) |
Function to set the text of a text form field.
- Parameters
-
[in,out] pPage The Page object to work with. [in] pcFieldName The name of the form field. Only Acroform fields are supported. [in] pcValue The value to set to the text field. Text fields set as multiline can contain carriage return characters, they must be '\r'.
- Returns
- A3D_SUCCESS
- Version
- 4.1
| A3DStatus A3DPDFPageGetFields | ( | A3DPDFPage * | pPage, |
| A3DInt32 * | piNbFields, | ||
| A3DPDFField *** | pppFields | ||
| ) |
Function to retrieve the fields of a PDF page. The fields supported are only form fields created with Acrobat. LiveCycle Designer fields (XFA) are not supported.
- Parameters
-
[in] pPage The Page object to work with. [out] piNbFields The number of fields. [out] pppFields The array of pointer on fields objects created.
- Returns
- A3D_SUCCESS
- Version
- 6.0
| A3DStatus A3DPDFPageInsert3DAnnot | ( | A3DPDFPage * | pPage, |
| const A3DPDF3DAnnot * | p3DAnnot, | ||
| const A3DPDFRectData * | pRectData | ||
| ) |
Function to insert a 3D Annot in a page.
Insert a 3D Annot object on the page. Note: starting with HOOPS Publish 1.10, several 3D Annots can be stored on a page.
- Parameters
-
[in,out] pPage The Page object to work with. [in] p3DAnnot The 3D Annot to insert on the page. [in] pRectData The rectangle to specify the position on the page.
- Returns
- A3D_SUCCESS
- Version
- 4.1
| A3DStatus A3DPDFPageInsertButton | ( | A3DPDFPage * | pPage, |
| A3DPDFButton * | pButton, | ||
| const A3DPDFRectData * | pRectData | ||
| ) |
Function to insert a button in a page.
- Parameters
-
[in,out] pPage The Page object to work with. [in] pButton The button object to insert on the page. [in] pRectData The rectangle to specify the position on the page.
- Returns
- A3D_SUCCESS
- Version
- 7.2
| A3DStatus A3DPDFPageInsertButtonInTable | ( | A3DPDFPage * | pPage, |
| A3DPDFTable * | pTable, | ||
| A3DPDFButton * | pButton, | ||
| A3DInt32 | iRowIndex, | ||
| A3DInt32 | iColumnIndex | ||
| ) |
Function to insert a button in a table.
- Parameters
-
[in,out] pPage The Page object to work with. [in] pTable The Table object to insert in the table. [in] pButton The Button object to insert in the table. [in] iRowIndex The index of the row of the table's cell to insert the button (starts from 1). [in] iColumnIndex The index of the column of the table's cell to insert the button (starts from 1).
- Returns
- A3D_SUCCESS
- Version
- 7.2
| A3DStatus A3DPDFPageInsertCheckBox | ( | A3DPDFPage * | pPage, |
| A3DPDFCheckBox * | pCheckBox, | ||
| const A3DPDFRectData * | pRectData | ||
| ) |
Function to insert a CheckBox in a page.
- Parameters
-
[in,out] pPage The Page object to work with. [in] pCheckBox The CheckBox object to insert on the page. [in] pRectData The rectangle to specify the position on the page.
- Returns
- A3D_SUCCESS
- Version
- 8.0
| A3DStatus A3DPDFPageInsertDigitalSignature | ( | A3DPDFPage * | pPage, |
| A3DPDFDigitalSignature * | pDigitalSignature, | ||
| const A3DPDFRectData * | pRectData | ||
| ) |
Function to insert a DigitalSignature in a page.
- Parameters
-
[in,out] pPage The Page object to work with. [in] pDigitalSignature The DigitalSignature object to insert on the page. [in] pRectData The rectangle to specify the position on the page.
- Returns
- A3D_SUCCESS
- Version
- 8.0
| A3DStatus A3DPDFPageInsertDropDownList | ( | A3DPDFPage * | pPage, |
| A3DPDFDropDownList * | pDropDownList, | ||
| const A3DPDFRectData * | pRectData | ||
| ) |
Function to insert a DropDownList (combo box) in a page.
- Parameters
-
[in,out] pPage The Page object to work with. [in] pDropDownList The DropDownList object to insert on the page. [in] pRectData The rectangle to specify the position on the page.
- Returns
- A3D_SUCCESS
- Version
- 8.0
| A3DStatus A3DPDFPageInsertImage | ( | A3DPDFPage * | pPage, |
| A3DPDFImage * | pImage, | ||
| const A3DInt32 | iPosLeft, | ||
| const A3DInt32 | iPosBottom | ||
| ) |
Function to insert an image in a page.
- Parameters
-
[in,out] pPage The Page object to work with. [in] pImage The Image object to insert on the page. [in] iPosLeft The x coordinate of the insertion point of the image. The insertion point is the bottom left corner of the image. The coordinate origin (0, 0) is the bottom left of the page. The unit is point. [in] iPosBottom The y coordinate of the insertion point of the image. The insertion point is the bottom left corner of the image. The coordinate origin (0, 0) is the bottom left of the page. The unit is point.
- Returns
- A3D_SUCCESS
- Version
- 4.1
| A3DStatus A3DPDFPageInsertLink | ( | A3DPDFPage * | pPage, |
| A3DPDFLink * | pLink, | ||
| const A3DPDFRectData * | pRectData | ||
| ) |
Function to insert a link in a page.
- Parameters
-
[in] pPage The Page object to work with. [in] pLink The Link object to insert on the page. [in] pRectData The rectangle to specify the position on the page.
- Returns
- A3D_SUCCESS
- Version
- 5.2
| A3DStatus A3DPDFPageInsertLinkInTable | ( | A3DPDFPage * | pPage, |
| A3DPDFTable * | pTable, | ||
| A3DPDFLink * | pLink, | ||
| A3DInt32 | iRowIndex, | ||
| A3DInt32 | iColumnIndex | ||
| ) |
Function to insert a link in a table.
- Parameters
-
[in,out] pPage The Page object to work with. [in] pTable The Table object to insert in the table. [in] pLink The Link object to insert in the table. [in] iRowIndex The index of the row of the table's cell to insert the link (start from 1) [in] iColumnIndex The index of the column of the table's cell to insert the link (start from 1)
- Returns
- A3D_SUCCESS
- Version
- 7.2
| A3DStatus A3DPDFPageInsertListBox | ( | A3DPDFPage * | pPage, |
| A3DPDFListBox * | pListBox, | ||
| const A3DPDFRectData * | pRectData | ||
| ) |
Function to insert a ListBox in a page.
- Parameters
-
[in,out] pPage The Page object to work with. [in] pListBox The ListBox object to insert on the page. [in] pRectData The rectangle to specify the position on the page.
- Returns
- A3D_SUCCESS
- Version
- 8.0
| A3DStatus A3DPDFPageInsertRadioButton | ( | A3DPDFPage * | pPage, |
| A3DPDFRadioButton * | pRadioButton, | ||
| const A3DPDFRectData * | pRectData | ||
| ) |
Function to insert a RadioButton in a page.
- Parameters
-
[in,out] pPage The Page object to work with. [in] pRadioButton The RadioButton object to insert on the page. [in] pRectData The rectangle to specify the position on the page.
- Returns
- A3D_SUCCESS
- Version
- 8.0
| A3DStatus A3DPDFPageInsertTable | ( | A3DPDFPage * | pPage, |
| A3DPDFTable * | pTable, | ||
| const A3DInt32 | iPosLeft, | ||
| const A3DInt32 | iPosTop | ||
| ) |
Function to insert a table in a page.
Warning: The positioning is not defined as in the other insertion functions (for texts or images). Here, the position is specified from the top of the page.
- Parameters
-
[in,out] pPage The Page object to work with. [in] pTable The Table object to insert on the page. [in] iPosLeft The x coordinate of the insertion point of the table. The insertion point is the top left corner of the table. The coordinate origin (0, 0) is the bottom left of the page. The unit is point. [in] iPosTop The y coordinate of the insertion point of the table. The insertion point is the top left corner of the table. The coordinate origin (0, 0) is the bottom left of the page. The unit is point.
- Returns
- A3D_SUCCESS
- Version
- 5.1
| A3DStatus A3DPDFPageInsertText | ( | A3DPDFPage * | pPage, |
| A3DPDFText * | pText, | ||
| const A3DInt32 | iPosLeft, | ||
| const A3DInt32 | iPosBottom | ||
| ) |
Function to insert a text in a page.
- Parameters
-
[in,out] pPage The Page object to work with. [in] pText The Text object to insert on the page. [in] iPosLeft The x coordinate of the insertion point of the text. The insertion point is the bottom left corner of the text. The coordinate origin (0, 0) is the bottom left of the page. The unit is point. [in] iPosBottom The y coordinate of the insertion point of the text. The insertion point is the bottom left corner of the text. The coordinate origin (0, 0) is the bottom left of the page. The unit is point.
- Returns
- A3D_SUCCESS
- Version
- 4.1
| A3DStatus A3DPDFPageInsertTextField | ( | A3DPDFPage * | pPage, |
| A3DPDFTextField * | pTextField, | ||
| const A3DPDFRectData * | pRectData | ||
| ) |
Function to insert a text field in a page.
The text field must have a name before inserting it.
- Parameters
-
[in,out] pPage The Page object to work with. [in] pTextField The Text field object to insert on the page. [in] pRectData The rectangle to specify the position on the page.
- Returns
- A3D_SUCCESS
- Version
- 7.2
| A3DStatus A3DPDFPageInsertTextFieldInTable | ( | A3DPDFPage * | pPage, |
| A3DPDFTable * | pTable, | ||
| A3DPDFTextField * | pTextField, | ||
| A3DInt32 | iRowIndex, | ||
| A3DInt32 | iColumnIndex | ||
| ) |
Function to insert a text field in a table.
- Parameters
-
[in,out] pPage The Page object to work with. [in] pTable The Table object to insert in the table. [in] pTextField The Text field object to insert in the table. [in] iRowIndex The index of the row of the table's cell to insert the button (start from 1) [in] iColumnIndex The index of the column of the table's cell to insert the button (start from 1)
- Returns
- A3D_SUCCESS
- Version
- 7.2
| A3DStatus A3DPDFPageInsertTextInTable | ( | A3DPDFPage * | pPage, |
| A3DPDFTable * | pTable, | ||
| A3DPDFText * | pText, | ||
| A3DInt32 | iRowIndex, | ||
| A3DInt32 | iColumnIndex | ||
| ) |
Function to insert a text in a table.
- Parameters
-
[in,out] pPage The Page object to work with. [in] pTable The Table object to insert in the table. [in] pText The Text object to insert in the table. [in] iRowIndex The index of the row of the table's cell to insert the button (start from 1) [in] iColumnIndex The index of the column of the table's cell to insert the button (start from 1)
- Returns
- A3D_SUCCESS
- Version
- 7.2
| A3DStatus A3DPDFPageRemoveTable | ( | A3DPDFPage * | pPage, |
| A3DPDFTable * | pTable | ||
| ) |
Function to remove a table from a page.
- Parameters
-
[in,out] pPage The Page object to work with. [in] pTable The Table object to remove from the page.
- Returns
- A3D_SUCCESS
- Version
- 8.1
| A3DStatus A3DPDFPageSetActionJavascript | ( | A3DPDFPage * | pPage, |
| const A3DPDFEEventActionType | eEventActionType, | ||
| const A3DUTF8Char * | pcJavascriptString | ||
| ) |
Function to define a javaScript action to an event triggered on the page. The JavaScript is defined as a string.
The goal of this function is to define a JavaScript action to be launched on an event triggered on the page level.
- Parameters
-
[in] pPage The Page object to work with. [in] eEventActionType The action type. Only kA3DPDFEventPageOpened and kA3DPDFEventPageClosed are relevant at page level. [in] pcJavascriptString The string which contains the JavaScript.
- Returns
- A3D_SUCCESS
- Version
- 9.0
| A3DStatus A3DPDFRadioButtonCreate | ( | A3DPDFDocument * | pDoc, |
| const A3DPDFRadioButtonData * | pRadioButtonData, | ||
| A3DPDFRadioButton ** | ppRadioButton | ||
| ) |
Function to create a RadioButton.
The RadioButton is primarily created with this function, and it should be positionned on the page with the function A3DPDFPageInsertRadioButton.
- Parameters
-
[in,out] pDoc The Document object to work with. [in] pRadioButtonData The RadioButton parameters. The name is mandatory. [out] ppRadioButton The RadioButton created.
- Returns
- A3D_SUCCESS
- Version
- 8.0
| A3DStatus A3DPDFTextFieldCreate | ( | A3DPDFDocument * | pDoc, |
| const A3DPDFTextFieldData * | pTextFieldData, | ||
| A3DPDFTextField ** | ppTextField | ||
| ) |
Function to create a text field.
The text field is primarily created with this function, and it should be positioned on the page with the function A3DPDFPageInsertTextField.
- Parameters
-
[in,out] pDoc The Document object to work with. [in] pTextFieldData The text field parameters. [out] ppTextField The text field created.
- Returns
- A3D_SUCCESS
- Version
- 7.2
