IPXC_Pages::AddEmptyPages Method

From Tracker Software PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
m (Automatic page editing by robot)
 
(12 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IPXC_Pages::AddEmptyPages Method}}
 
{{#customTitle:IPXC_Pages::AddEmptyPages Method}}
{{#parentPage:PXV:IPXC_Pages|AddEmptyPages Method|method}}
+
{{#parentPage:PXV:IPXC_Pages#Methods|AddEmptyPages|method}}
{{ToWrite}}
+
{{ToReview}}
+
  
The method of interface of PDF-XChange Editor SDK.
+
Adds new empty pages to the [[PXV:IPXC_Document|core document]].
  
 
== Syntax ==
 
== Syntax ==
 
<pre class="brush:cpp;gutter:false">HRESULT AddEmptyPages([in]                      ULONG                nBefore,
 
<pre class="brush:cpp;gutter:false">HRESULT AddEmptyPages([in]                      ULONG                nBefore,
 
                       [in]                      ULONG                nCount,
 
                       [in]                      ULONG                nCount,
                       [in]                      PXC_Rect*            mediaBox,
+
                       [in]                      PXC_Rect*            stMediaBox,
 
                       [in, defaultvalue(NULL)]  IProgressMon*        pProgress,
 
                       [in, defaultvalue(NULL)]  IProgressMon*        pProgress,
                       [out, defaultvalue(NULL)]  IPXC_UndoRedoData**  ppUndoData);</pre>
+
                       [out, defaultvalue(NULL)]  IPXC_UndoRedoData**  pUndoData);</pre>
  
 
== Parameters ==
 
== Parameters ==
 
;nBefore
 
;nBefore
:[in]  Value of ULONG.
+
:[in]  Select page before which the new pages will be inserted. Note that entering value which exceeds or is equal to the pages count in the [[PXV:IPXC_Document|core document]] will insert new pages after the last page. Entering a value of zero (0) will place the empty pages before the first page in the document.
 
;nCount
 
;nCount
:[in]  Value of ULONG.
+
:[in]  Number of empty pages that will be inserted.
;mediaBox
+
;stMediaBox
:[in]  Pointer to [[PXV:PXC_Rect|PXC_Rect]].
+
:[in]  Pointer to [[PXV:PXC_Rect|PXC_Rect]] containing the new pages media box's dimensions.
 
;pProgress
 
;pProgress
:[in, defaultvalue(NULL)]  Pointer to [[PXV:IProgressMon|IProgressMon]].
+
:[in, defaultvalue(NULL)]  Pointer to [[PXV:IProgressMon|IProgressMon]] containing the progress monitor. Note that the [[PXV:IPXV_Inst_ProgressMon|IPXV_Inst::ProgressMon]] property should be used to get the progress monitor from the [[PXV:IPXV_Inst|instance]].
;ppUndoData
+
;pUndoData
:[out, defaultvalue(NULL)]  Pointer to [[PXV:IPXC_UndoRedoData|IPXC_UndoRedoData]].
+
:[out, defaultvalue(NULL)]  Pointer to [[PXV:IPXC_UndoRedoData|IPXC_UndoRedoData]] containing the filled Undo/Redo data if any was given to be filled.
  
 
== Return Value ==
 
== Return Value ==
Line 30: Line 29:
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IPXC_Pages|IPXC_Pages]].
+
[[PXV:IPXC_Pages|IPXC_Pages]]

Latest revision as of 03:33, 15 June 2015

Adds new empty pages to the core document.

Syntax

HRESULT AddEmptyPages([in]                       ULONG                nBefore,
                      [in]                       ULONG                nCount,
                      [in]                       PXC_Rect*            stMediaBox,
                      [in, defaultvalue(NULL)]   IProgressMon*        pProgress,
                      [out, defaultvalue(NULL)]  IPXC_UndoRedoData**  pUndoData);

Parameters

nBefore
[in] Select page before which the new pages will be inserted. Note that entering value which exceeds or is equal to the pages count in the core document will insert new pages after the last page. Entering a value of zero (0) will place the empty pages before the first page in the document.
nCount
[in] Number of empty pages that will be inserted.
stMediaBox
[in] Pointer to PXC_Rect containing the new pages media box's dimensions.
pProgress
[in, defaultvalue(NULL)] Pointer to IProgressMon containing the progress monitor. Note that the IPXV_Inst::ProgressMon property should be used to get the progress monitor from the instance.
pUndoData
[out, defaultvalue(NULL)] Pointer to IPXC_UndoRedoData containing the filled Undo/Redo data if any was given to be filled.

Return Value

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

See Also

IPXC_Pages