IPXV_Inst::CreateOpenDocParams Method

From PDF XChange PDF SDK
Jump to: navigation, search


Creates container with additional parameters for documents opening. Then it can be passed to IPXV_MainFrame::OpenDocFrom/IPXV_MainFrame::OpenDocFromPath to customize document opening process.

Syntax

HRESULT CreateOpenDocParams([out, retval]  ICab**  pOpenDocParams);

Parameters

pOpenDocParams
[out, retval] Returns pointer to a new ICab object with additional parameters for documents opening.
Cab Item Name Cab Data Type Description
CanAddToHistory dt_Bool Indicates whether the document should be added to the Recents List.

Default value: true

CanRestoreLastView dt_Bool Indicates whether the document should be opened at the last viewed page and destination.

Default value: true

CanShowErrMsg dt_Bool Indicates whether the document should display any error messages that occur when opening the document.

Default value: false

DIPath dt_Bool Indicates whether the device independent path format should be used when opening the document.

Default value: false

DeleteOnClose dt_Bool Indicates whether the document should be physically removed after closing.

Default value: false

DestTabGroup dt_IUnknown Specifies a tab group where the document's tab would be added to.

Default value: NULL

ErrDetails dt_String Used to store string data that will be used when error occur.

Default value: Empty String

FS dt_String Used to identify the file system that should be used.

Default value: Empty String

Hidden dt_Bool The document will open with hidden view.

Default value: false

IVP dt_IUnknown Specifies the document's initial view point.

Default value: NULL

InNewFrameWnd dt_Int Specifies whether the document should be opened in the new frame window.

Default value: -1 which means that global preferences would be used.

InitialDest dt_Dictionary Specifies the initial document's destination.
InsertBeforeTab dt_Int Specifies the document's tab position in the tab group.

Default value: -1

LinkToParent dt_Bool Indicates whether the document should be linked to the parent document.

Default value: true

MakeLocalCopy dt_Bool Indicates whether the internal local copy for the input stream or file will be created.

Default value: false

NativeOnly dt_Bool Indicates whether only the real pdf files should be opened meaning that the file format conversion would be denied.

Default value: false

NewDocView dt_Bool Indicates whether new view should be created when opening document.

Default value: false

NoAuth dt_Bool Indicates whether the authentication will be allowed when opening the document.

Default value: false

NoProgress dt_Bool Indicates whether the progress bar should be drawn when opening the document.

Default value: false

OpenFileFlags dt_Int Sets open file flags that will be used when opening the document.

Default value: 0

Parent dt_IUnknown Specifies a parent document for the currently opening document.

Default value: NULL

Password dt_String Sets the password that should be used when opening the document.

Default value: Empty String

PrivateMode dt_Bool Indicates whether the document should be opened in private mode.

Default value: false

SecPermMask dt_Int Sets the security permissions mask.

Default value: 0

Sync dt_Bool Indicates whether the synchronized document opening should be used.

Default value: false

Temp dt_Bool Indicates whether the document should be created as a temporary document which means that the document cannot be added to Recents List and 'Save' will work like 'Save As'.

Default value: false

UIFileName dt_String Sets custom UI File Name for the opened document.

Default value: Empty String

UITitle dt_String Sets custom UI File Title for the opened document.

Default value: Empty String

UrlExtra dt_String Sets the additional document's open parameters through the URL.

Default value: Empty String

Return Value

Returns S_OK if operation was successful or error code in other cases.

See Also

IPXV_Inst, IPXV_MainFrame::OpenDocFrom, IPXV_MainFrame::OpenDocFromPath