IPXC_Page::MoveAnnot Method

From PDF XChange PDF SDK
Jump to: navigation, search
(Automatic page editing by robot)
 
m (Automatic page editing by robot)
 
(10 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IPXC_Page::MoveAnnot Method}}
 
{{#customTitle:IPXC_Page::MoveAnnot Method}}
 +
{{#parentPage:PXV:IPXC_Page#Methods|MoveAnnot|method}}
 +
{{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 ==
<pre class="brush:cpp;gutter:false">HRESULT MoveAnnot([in] IPXC_Annotation* pAnnot, [in] ULONG nDestPage, [in, optional] LONG nInsertBefore);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT MoveAnnot([in]                   IPXC_Annotation* pAnnot,
 +
                  [in]                   ULONG             nDestPage,
 +
                  [in, defaultvalue(-1)] LONG             nInsertBefore);</pre>
  
 
== Parameters ==
 
== Parameters ==
;''pAnnot''
+
;pAnnot
:[in]  Pointer to [[PXV:IPXC_Annotation|IPXC_Annotation]].
+
:[in]  Pointer to [[PXV:IPXC_Annotation|IPXC_Annotation]] containing the annotation that will be moved.
;''nDestPage''
+
;nDestPage
:[in]  Value of ULONG.
+
:[in]  Destination page number.
;''nInsertBefore''
+
;nInsertBefore
:[in, optionalValue 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 ==
Line 19: Line 24:
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IPXC_Page|IPXC_Page]].
+
[[PXV:IPXC_Page|IPXC_Page]]

Latest revision as of 03:32, 15 June 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 that 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

IPXC_Page