IPXC_Pages::InsertPage Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
|||
Line 14: | Line 14: | ||
== Parameters == | == Parameters == | ||
;nBefore | ;nBefore | ||
− | :[in] Select page before which the new page will be inserted. Note that entering value | + | :[in] Select page before which the new page will be inserted. Note that entering value that exceeds or is equal to the pages count in the [[PXV:IPXC_Document|core document]] will insert new page after the last page. Entering a value of zero (0) will place the empty page before the first page in the document. |
;mediaBox | ;mediaBox | ||
:[in] Pointer to [[PXV:PXC_Rect|PXC_Rect]] containing the dimensions of the new page's media box. | :[in] Pointer to [[PXV:PXC_Rect|PXC_Rect]] containing the dimensions of the new page's media box. |
Revision as of 01:53, 25 May 2015
Inserts new empty page to the core document.
Syntax
HRESULT InsertPage([in] ULONG nBefore, [in] PXC_Rect* mediaBox, [out, defaultvalue(NULL)] IPXC_UndoRedoData** ppUndoData, [out, retval] IPXC_Page** ppNewPage);
Parameters
- nBefore
- [in] Select page before which the new page will be inserted. Note that entering value that exceeds or is equal to the pages count in the core document will insert new page after the last page. Entering a value of zero (0) will place the empty page before the first page in the document.
- mediaBox
- [in] Pointer to PXC_Rect containing the dimensions of the new page's media box.
- ppUndoData
- [out, defaultvalue(NULL)] Pointer to IPXC_UndoRedoData containing the filled Undo/Redo data if any was given to be filled.
- ppNewPage
- [out, retval] Pointer to IPXC_Page containing the newly created page.
Return Value
Returns S_OK if operation was successful or error code in other cases.