IPXV_Inst::CreateOpenDocParams Method

From PDF XChange PDF SDK
Jump to: navigation, search
Line 37: Line 37:
 
| DIPath
 
| DIPath
 
| [[PXV:CabDataTypeID|dt_Bool]]
 
| [[PXV:CabDataTypeID|dt_Bool]]
| Indicates whether the DIPath format should be used when opening the document.
+
| Indicates whether the device independent path format should be used when opening the document.
 
Default value: <tt>'''false'''</tt>
 
Default value: <tt>'''false'''</tt>
 +
|-
 +
| DeleteOnClose
 +
| [[PXV:CabDataTypeID|dt_Bool]]
 +
| Indicates whether the document should be physically removed after closing.
 +
Default value: <tt>'''false'''</tt>
 +
|-
 +
| DestTabGroup
 +
| [[PXV:CabDataTypeID|dt_IUnknown]]
 +
| Specifies a [[PXV:IUIX_LayoutItem|tab group]] where the document's tab would be added to.
 +
Default value: <tt>'''NULL'''</tt>
 +
|-
 +
| ErrDetails
 +
| [[PXV:CabDataTypeID|dt_String]]
 +
| Used to store string data that will be used when error occur.
 +
Default value: <tt>'''Empty String'''</tt>
 +
|-
 +
| FS
 +
| [[PXV:CabDataTypeID|dt_String]]
 +
| Used to identify the file system that should be used.
 +
Default value: <tt>'''Empty String'''</tt>
 +
|-
 +
| Hidden
 +
| [[PXV:CabDataTypeID|dt_Bool]]
 +
| The document will open with hidden view.
 +
Default value: <tt>'''false'''</tt>
 +
|-
 +
| IVP
 +
| [[PXV:CabDataTypeID|dt_IUnknown]]
 +
| Specifies the document's [[PXV:IPXV_PagesViewPointInf|initial view point]].
 +
Default value: <tt>'''NULL'''</tt>
 
|-
 
|-
 
| SecPermMask
 
| SecPermMask

Revision as of 09:35, 13 April 2016


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

SecPermMask dt_Int Sets the security permissions mask.

Default value: 0

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

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