IPXC_Pages::MovePages Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
m (Automatic page editing by robot) |
||
| Line 7: | Line 7: | ||
== Syntax == | == Syntax == | ||
| − | <pre class="brush:cpp;gutter:false">HRESULT MovePages([in] IBitSet* | + | <pre class="brush:cpp;gutter:false">HRESULT MovePages([in] IBitSet* Indexes, |
| − | [in] ULONG | + | [in] ULONG MoveToBeforeThisPage, |
| − | [in, defaultvalue(NULL)] IProgressMon* | + | [in, defaultvalue(NULL)] IProgressMon* Progress, |
| − | [out, defaultvalue(NULL)] IPXC_UndoRedoData** | + | [out, defaultvalue(NULL)] IPXC_UndoRedoData** UndoData);</pre> |
== Parameters == | == Parameters == | ||
| − | ; | + | ;Indexes |
:[in] Pointer to [[PXV:IBitSet|IBitSet]] containing the indexes of pages that need to be moved. Note that the [[PXV:IAUX_Inst_CreateBitSet|IAUX_Inst::CreateBitSet]] method should be used to create a bit set. | :[in] Pointer to [[PXV:IBitSet|IBitSet]] containing the indexes of pages that need to be moved. Note that the [[PXV:IAUX_Inst_CreateBitSet|IAUX_Inst::CreateBitSet]] method should be used to create a bit set. | ||
| − | ; | + | ;MoveToBeforeThisPage |
:[in] Select page before which the moved pages 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 moved pages after the last page. Entering a value of zero (0) will place the empty pages before the first page in the document. | :[in] Select page before which the moved pages 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 moved pages after the last page. Entering a value of zero (0) will place the empty pages before the first page in the document. | ||
| − | ; | + | ;Progress |
:[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]]. | :[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]]. | ||
| − | ; | + | ;UndoData |
:[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. | ||
Revision as of 06:09, 12 June 2015
Moves pages with given indexes before the entered destination page.
Syntax
HRESULT MovePages([in] IBitSet* Indexes,
[in] ULONG MoveToBeforeThisPage,
[in, defaultvalue(NULL)] IProgressMon* Progress,
[out, defaultvalue(NULL)] IPXC_UndoRedoData** UndoData);
Parameters
- Indexes
- [in] Pointer to IBitSet containing the indexes of pages that need to be moved. Note that the IAUX_Inst::CreateBitSet method should be used to create a bit set.
- MoveToBeforeThisPage
- [in] Select page before which the moved pages will be inserted. Note that entering value that exceeds or is equal to the pages count in the core document will insert moved pages after the last page. Entering a value of zero (0) will place the empty pages before the first page in the document.
- Progress
- [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.
- UndoData
- [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.
