IPXC_Page::InsertNewAnnot Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
Line 2: Line 2:
 
{{#customTitle:IPXC_Page::InsertNewAnnot Method}}
 
{{#customTitle:IPXC_Page::InsertNewAnnot Method}}
 
{{#parentPage:PXV:IPXC_Page|InsertNewAnnot Method|method}}
 
{{#parentPage:PXV:IPXC_Page|InsertNewAnnot Method|method}}
{{ToWrite}}
 
 
{{ToReview}}
 
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
Inserts new annotation with given type into the given position with given Z-order.
  
 
== Syntax ==
 
== Syntax ==
Line 15: Line 14:
 
== Parameters ==
 
== Parameters ==
 
;nAnnotType
 
;nAnnotType
:[in]  Value of ULONG.
+
:[in]  Type of annotation which will be inserted.
 
;pLocation
 
;pLocation
:[in]  Pointer to [[PXV:PXC_Rect|PXC_Rect]].
+
:[in]  Pointer to [[PXV:PXC_Rect|PXC_Rect]] containing the coordinates of the inserted annotation.
 
;nPos
 
;nPos
:[in, defaultvalue(-1)]  Value of ULONG.
+
:[in, defaultvalue(-1)]  Position in annotation's Z-order on page. By default the inserted annotation will appear on top of the other annotations on the page.
 
;ppAnnot
 
;ppAnnot
:[out, retval, defaultvalue(NULL)]  Pointer to [[PXV:IPXC_Annotation|IPXC_Annotation]].
+
:[out, retval, defaultvalue(NULL)]  Pointer to [[PXV:IPXC_Annotation|IPXC_Annotation]] containing the resulting annotation.
  
 
== Return Value ==
 
== Return Value ==

Revision as of 05:52, 14 May 2015


Inserts new annotation with given type into the given position with given Z-order.

Syntax

HRESULT InsertNewAnnot([in]                               ULONG              nAnnotType,
                       [in]                               PXC_Rect*          pLocation,
                       [in, defaultvalue(-1)]             ULONG              nPos,
                       [out, retval, defaultvalue(NULL)]  IPXC_Annotation**  ppAnnot);

Parameters

nAnnotType
[in] Type of annotation which will be inserted.
pLocation
[in] Pointer to PXC_Rect containing the coordinates of the inserted annotation.
nPos
[in, defaultvalue(-1)] Position in annotation's Z-order on page. By default the inserted annotation will appear on top of the other annotations on the page.
ppAnnot
[out, retval, defaultvalue(NULL)] Pointer to IPXC_Annotation containing the resulting annotation.

Return Value

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

See Also

See also IPXC_Page.