IPXC_Pages::InsertPage Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
|||
| Line 3: | Line 3: | ||
{{#customTitle:IPXC_Pages::InsertPage Method}} | {{#customTitle:IPXC_Pages::InsertPage Method}} | ||
{{#parentPage:PXV:IPXC_Pages|InsertPage Method|method}} | {{#parentPage:PXV:IPXC_Pages|InsertPage Method|method}} | ||
| − | |||
{{ToReview}} | {{ToReview}} | ||
| − | + | Inserts new empty page to the [[PXV:IPXC_Document|core document]]. | |
== Syntax == | == Syntax == | ||
| Line 16: | Line 15: | ||
== Parameters == | == Parameters == | ||
;nBefore | ;nBefore | ||
| − | :[in] | + | :[in] Select page before which the new page 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 page after the last page. |
;mediaBox | ;mediaBox | ||
| − | :[in] Pointer to [[PXV:PXC_Rect|PXC_Rect]]. | + | :[in] Pointer to [[PXV:PXC_Rect|PXC_Rect]] containing the new pages media box's dimensions. |
;ppUndoData | ;ppUndoData | ||
| − | :[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. |
;ppNewPage | ;ppNewPage | ||
| − | :[out, retval] Pointer to [[PXV:IPXC_Page|IPXC_Page]]. | + | :[out, retval] Pointer to [[PXV:IPXC_Page|IPXC_Page]] containing the newly created page. |
== Return Value == | == Return Value == | ||
Revision as of 06:01, 20 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 which exceeds or is equal to the pages count in the core document will insert new page after the last page.
- mediaBox
- [in] Pointer to PXC_Rect containing the new pages media box's dimensions.
- 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.
