IPXC_Pages::MovePages Method

Revision as of 12:15, 21 May 2015

Moves pages with given indexes before the entered destination page.

Syntax

HRESULT MovePages([in]                       IBitSet*             pIndexes,
                  [in]                       ULONG                nMoveToBeforeThisPage,
                  [in, defaultvalue(NULL)]   IProgressMon*        pProgress,
                  [out, defaultvalue(NULL)]  IPXC_UndoRedoData**  ppUndoData);

Parameters

pIndexes

[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.

nMoveToBeforeThisPage

[in] Select page before which the moved pages will be inserted. Note that entering value which 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.

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.

ppUndoData

[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.