IPXC_AcroForm::GetFieldByPDFObject Method
From PDF XChange PDF SDK
m |
m (Automatic page editing by robot) |
||
| Line 1: | Line 1: | ||
| + | __NOTOC__ | ||
[[Category:Editor]] | [[Category:Editor]] | ||
{{#customTitle:IPXC_AcroForm::GetFieldByPDFObject Method}} | {{#customTitle:IPXC_AcroForm::GetFieldByPDFObject Method}} | ||
{{#parentPage:PXV:IPXC_AcroForm|GetFieldByPDFObject Method|method}} | {{#parentPage:PXV:IPXC_AcroForm|GetFieldByPDFObject Method|method}} | ||
| − | |||
Looks up and returns the [[PXV:IPXC_FormField|field]] specified by its [[PXV:IPXS_PDFVariant|pdf object]]. If the specified pdf object is a [[PXV:IPXC_Annotation|widget's]] object, this method will return the form field to which that widget belongs. | Looks up and returns the [[PXV:IPXC_FormField|field]] specified by its [[PXV:IPXS_PDFVariant|pdf object]]. If the specified pdf object is a [[PXV:IPXC_Annotation|widget's]] object, this method will return the form field to which that widget belongs. | ||
| Line 20: | Line 20: | ||
== See Also == | == See Also == | ||
| − | + | [[PXV:IPXC_AcroForm|IPXC_AcroForm]], [[PXV:IPXC_FormField|IPXC_FormField]], [[PXV:IPXS_PDFVariant|IPXS_PDFVariant]]. | |
Revision as of 03:56, 20 May 2015
Looks up and returns the field specified by its pdf object. If the specified pdf object is a widget's object, this method will return the form field to which that widget belongs.
Syntax
HRESULT GetFieldByPDFObject([in] IPXS_PDFVariant* pVariant,
[out, retval] IPXC_FormField** ppField);
Parameters
- pVariant
- [in] The pdf object of the field this method will look for.
- ppField
- [out, retval] Returns a IPXC_FormField object if the specified form field was found or nullptr otherwise.
Return Value
Returns S_OK if operation was successful or an error code in other cases.
