IPXC_Page::MoveAnnot Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
Line 2: Line 2:
 
{{#customTitle:IPXC_Page::MoveAnnot Method}}
 
{{#customTitle:IPXC_Page::MoveAnnot Method}}
 
{{#parentPage:PXV:IPXC_Page|MoveAnnot Method|method}}
 
{{#parentPage:PXV:IPXC_Page|MoveAnnot Method|method}}
{{ToWrite}}
 
 
{{ToReview}}
 
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
Moves annotation from the page to the destination page with given Z-order.
  
 
== Syntax ==
 
== Syntax ==
Line 14: Line 13:
 
== Parameters ==
 
== Parameters ==
 
;pAnnot
 
;pAnnot
:[in]  Pointer to [[PXV:IPXC_Annotation|IPXC_Annotation]].
+
:[in]  Pointer to [[PXV:IPXC_Annotation|IPXC_Annotation]] containing the annotation which will be moved.
 
;nDestPage
 
;nDestPage
:[in]  Value of ULONG.
+
:[in]  Destination page number.
 
;nInsertBefore
 
;nInsertBefore
:[in, defaultvalue(-1)]  Value of LONG.
+
:[in, defaultvalue(-1)]  Position in annotation's Z-order on page. By default the moved annotation will appear on top of the other annotations on the page.
  
 
== Return Value ==
 
== Return Value ==

Revision as of 05:55, 14 May 2015


Moves annotation from the page to the destination page with given Z-order.

Syntax

HRESULT MoveAnnot([in]                    IPXC_Annotation*  pAnnot,
                  [in]                    ULONG             nDestPage,
                  [in, defaultvalue(-1)]  LONG              nInsertBefore);

Parameters

pAnnot
[in] Pointer to IPXC_Annotation containing the annotation which will be moved.
nDestPage
[in] Destination page number.
nInsertBefore
[in, defaultvalue(-1)] Position in annotation's Z-order on page. By default the moved annotation will appear on top of the other annotations on the page.

Return Value

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

See Also

See also IPXC_Page.