IPXC_AcroForm::FlattenField Method

From Tracker Software PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
m
Line 2: Line 2:
 
{{#customTitle:IPXC_AcroForm::FlattenField Method}}
 
{{#customTitle:IPXC_AcroForm::FlattenField Method}}
 
{{#parentPage:PXV:IPXC_AcroForm|FlattenField Method|method}}
 
{{#parentPage:PXV:IPXC_AcroForm|FlattenField Method|method}}
{{ToReview}}
 
  
Flatten specified field of the form. When field is flattened, current appearance of its widgets become a part of content of pages where they were located, and the field itself is removed from the form.
+
 
 +
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]].
 
This method cannot be applied for [[PXV:PXC_PDFFormType|dymanic forms]].
Line 13: Line 13:
 
== Parameters ==
 
== Parameters ==
 
;sName
 
;sName
:[in] Specifies the name of the field to flatten.
+
:[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 ==
 
See also [[PXV:IPXC_AcroForm|IPXC_AcroForm]], [[PXV:IPXC_FormField|IPXC_FormField]].
 
See also [[PXV:IPXC_AcroForm|IPXC_AcroForm]], [[PXV:IPXC_FormField|IPXC_FormField]].

Revision as of 05:41, 13 May 2015


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.

See Also

See also IPXC_AcroForm, IPXC_FormField.