IPXC_Pages::InsertPage Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
|||
| (6 intermediate revisions by 2 users not shown) | |||
| Line 2: | Line 2: | ||
[[Category:Editor]] | [[Category:Editor]] | ||
{{#customTitle:IPXC_Pages::InsertPage Method}} | {{#customTitle:IPXC_Pages::InsertPage Method}} | ||
| − | {{#parentPage:PXV:IPXC_Pages|InsertPage | + | {{#parentPage:PXV:IPXC_Pages#Methods|InsertPage|method}} |
| − | + | ||
Inserts new empty page to the [[PXV:IPXC_Document|core document]]. | Inserts new empty page to the [[PXV:IPXC_Document|core document]]. | ||
| Line 9: | Line 8: | ||
== Syntax == | == Syntax == | ||
<pre class="brush:cpp;gutter:false">HRESULT InsertPage([in] ULONG nBefore, | <pre class="brush:cpp;gutter:false">HRESULT InsertPage([in] ULONG nBefore, | ||
| − | [in] PXC_Rect* | + | [in] PXC_Rect* stMediaBox, |
| − | [out, defaultvalue(NULL)] IPXC_UndoRedoData** | + | [out, defaultvalue(NULL)] IPXC_UndoRedoData** pUndoData, |
| − | [out, retval] IPXC_Page** | + | [out, retval] IPXC_Page** pNewPage);</pre> |
== 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. |
| − | ; | + | ;stMediaBox |
:[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. | ||
| − | ; | + | ;pUndoData |
:[out, defaultvalue(NULL)] Pointer to [[PXV:IPXC_UndoRedoData|IPXC_UndoRedoData]] containing the filled Undo/Redo data if any was given to be filled. | :[out, defaultvalue(NULL)] Pointer to [[PXV:IPXC_UndoRedoData|IPXC_UndoRedoData]] containing the filled Undo/Redo data if any was given to be filled. | ||
| − | ; | + | ;pNewPage |
:[out, retval] Pointer to [[PXV:IPXC_Page|IPXC_Page]] containing the newly created page. | :[out, retval] Pointer to [[PXV:IPXC_Page|IPXC_Page]] containing the newly created page. | ||
| Line 27: | Line 26: | ||
== See Also == | == See Also == | ||
| − | [[PXV:IPXC_Pages|IPXC_Pages]] | + | [[PXV:IPXC_Pages|IPXC_Pages]] |
Latest revision as of 02:33, 15 June 2015
Inserts new empty page to the core document.
Syntax
HRESULT InsertPage([in] ULONG nBefore,
[in] PXC_Rect* stMediaBox,
[out, defaultvalue(NULL)] IPXC_UndoRedoData** pUndoData,
[out, retval] IPXC_Page** pNewPage);
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.
- stMediaBox
- [in] Pointer to PXC_Rect containing the dimensions of the new page's media box.
- pUndoData
- [out, defaultvalue(NULL)] Pointer to IPXC_UndoRedoData containing the filled Undo/Redo data if any was given to be filled.
- pNewPage
- [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.
