IPXC_AcroForm::CreateField Method

From Tracker Software PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
Line 2: Line 2:
 
{{#customTitle:IPXC_AcroForm::CreateField Method}}
 
{{#customTitle:IPXC_AcroForm::CreateField Method}}
  
The method of interface of PDF-XChange Editor SDK.
+
Adds a new form field with widget or adds new widget to existing field. If there is already a field specified by ''sName'' new widget will be added if ''nType'' corresponds to the type of existing field.
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT CreateField([in] LPWSTR sName, [in] PXC_FormFieldType nType, [out, retval] IPXC_FormField** ppField);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT CreateField([in] LPWSTR sName, [in] PXC_FormFieldType nType, [in] ULONG nPage, [in] PXC_Rect* pRect, [out, retval] IPXC_FormField** ppField);</pre>
  
 
== Parameters ==
 
== Parameters ==
 
;''sName''
 
;''sName''
:[in]  Value of LPWSTR.
+
:[in]  Name of the field. Name may contains dot (.) character to specify full name of the field. If there are no field with specified name the method will add it to the form.
 
;''nType''
 
;''nType''
:[in]  Value of [[PXV:PXC_FormFieldType|PXC_FormFieldType]].
+
:[in]  Value of [[PXV:PXC_FormFieldType|PXC_FormFieldType]] that specifies new field type.
 +
;''nPage''
 +
:[in] Specifies 0-based number of page in the document where widget should be added.
 +
;''pRect''
 +
:[in] Pointer to the [[PXV::PXC_Rect|PXC_Rect]] structure that defines position and size of the widget on the page. It maybe be empty only for [[PXV:PXC_FormFieldType|FType_Signature]] type of field.
 
;''ppField''
 
;''ppField''
:[out, retval]  Pointer to [[PXV:IPXC_FormField|IPXC_FormField]].
+
:[out, retval]  Pointer to [[PXV:IPXC_FormField|IPXC_FormField]] that receives an object of newly created field.
  
 
== Return Value ==
 
== Return Value ==
Line 19: Line 23:
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IPXC_AcroForm|IPXC_AcroForm]].
+
See also [[PXV:IPXC_AcroForm|IPXC_AcroForm]], [[PXV:IPXC_Annotation|IPXC_Annotation]].

Revision as of 12:06, 12 April 2015

Adds a new form field with widget or adds new widget to existing field. If there is already a field specified by sName new widget will be added if nType corresponds to the type of existing field.

Syntax

HRESULT CreateField([in] LPWSTR sName, [in] PXC_FormFieldType nType, [in] ULONG nPage, [in] PXC_Rect* pRect, [out, retval] IPXC_FormField** ppField);

Parameters

sName
[in] Name of the field. Name may contains dot (.) character to specify full name of the field. If there are no field with specified name the method will add it to the form.
nType
[in] Value of PXC_FormFieldType that specifies new field type.
nPage
[in] Specifies 0-based number of page in the document where widget should be added.
pRect
[in] Pointer to the PXC_Rect structure that defines position and size of the widget on the page. It maybe be empty only for FType_Signature type of field.
ppField
[out, retval] Pointer to IPXC_FormField that receives an object of newly created field.

Return Value

Returns S_OK if operation was successful or error code in other cases.

See Also

See also IPXC_AcroForm, IPXC_Annotation.