IPXC_AcroForm::CreateField Method

From Tracker Software PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
m
Line 2: Line 2:
 
{{#customTitle:IPXC_AcroForm::CreateField Method}}
 
{{#customTitle:IPXC_AcroForm::CreateField Method}}
 
{{#parentPage:PXV:IPXC_AcroForm|CreateField Method|method}}
 
{{#parentPage:PXV:IPXC_AcroForm|CreateField Method|method}}
{{ToReview}}
 
  
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.
+
Adds a new form field with widget or adds a new widget to an existing field. If there already is a field with the name specified by ''sName'' a new widget will be added if ''nType'' corresponds to the type of existing field.
  
 
== Syntax ==
 
== Syntax ==
Line 15: Line 14:
 
== Parameters ==
 
== Parameters ==
 
;sName
 
;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.
+
:[in]  Name of the field. The name may contain the dot (.) character to specify the full field name. If there are no fields with the specified name the method will add it to the form.
 
;nType
 
;nType
:[in]  Value of [[PXV:PXC_FormFieldType|PXC_FormFieldType]] that specifies new field type.
+
:[in]  The value of [[PXV:PXC_FormFieldType|PXC_FormFieldType]] that specifies the new field type.
 
;nPageIdx
 
;nPageIdx
:[in] Specifies 0-based number of page in the document where widget should be added.
+
:[in] Specifies the 0-based page number in the document where the widget should be added.
 
;pRect
 
;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.
+
:[in] Pointer to the [[PXV::PXC_Rect|PXC_Rect]] structure that defines the 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]] that receives an object of newly created field.
+
:[out, retval]  Pointer to [[PXV:IPXC_FormField|IPXC_FormField]] that receives the object of the newly created field.
  
 
== 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_Annotation|IPXC_Annotation]].
 
See also [[PXV:IPXC_AcroForm|IPXC_AcroForm]], [[PXV:IPXC_Annotation|IPXC_Annotation]].

Revision as of 06:01, 13 May 2015

Adds a new form field with widget or adds a new widget to an existing field. If there already is a field with the name specified by sName a 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              nPageIdx,
                    [in]           PXC_Rect*          pRect,
                    [out, retval]  IPXC_FormField**   ppField);

Parameters

sName
[in] Name of the field. The name may contain the dot (.) character to specify the full field name. If there are no fields with the specified name the method will add it to the form.
nType
[in] The value of PXC_FormFieldType that specifies the new field type.
nPageIdx
[in] Specifies the 0-based page number in the document where the widget should be added.
pRect
[in] Pointer to the PXC_Rect structure that defines the 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 the object of the newly created field.

Return Value

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

See Also

See also IPXC_AcroForm, IPXC_Annotation.