IPXC_AcroForm::FlattenField Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
|||
| (10 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
| + | __NOTOC__ | ||
[[Category:Editor]] | [[Category:Editor]] | ||
{{#customTitle:IPXC_AcroForm::FlattenField Method}} | {{#customTitle:IPXC_AcroForm::FlattenField Method}} | ||
| + | {{#parentPage:PXV:IPXC_AcroForm#Methods|FlattenField|method}} | ||
| − | + | Flattens the specified form field. When the field is flattened, the current appearance of its widgets becomes part of the contents of the pages where they were located, and the field itself is removed from the form. | |
| + | |||
| + | This method cannot be applied for [[PXV:PXC_PDFFormType|dymanic forms]]. | ||
== Syntax == | == Syntax == | ||
| − | <pre class="brush:cpp;gutter:false">HRESULT FlattenField([in] LPWSTR sName);</pre> | + | <pre class="brush:cpp;gutter:false">HRESULT FlattenField([in] LPWSTR sName);</pre> |
== Parameters == | == Parameters == | ||
| − | ; | + | ;sName |
| − | :[in] Specifies the name of the field to | + | :[in] Specifies the name of the field to be flattened. |
== Return Value == | == Return Value == | ||
| − | Returns S_OK if operation was successful or error code in other cases. | + | Returns S_OK if operation was successful or an error code in other cases. |
== See Also == | == See Also == | ||
| − | + | [[PXV:IPXC_AcroForm|IPXC_AcroForm]] | |
Latest revision as of 22:56, 30 November 2017
Flattens the specified form field. When the field is flattened, the current appearance of its widgets becomes part of the contents of the pages where they were located, and the field itself is removed from the form.
This method cannot be applied for dymanic forms.
Syntax
HRESULT FlattenField([in] LPWSTR sName);
Parameters
- sName
- [in] Specifies the name of the field to be flattened.
Return Value
Returns S_OK if operation was successful or an error code in other cases.
