IPXV_Inst::CreateOpenDocParams Method

From Tracker Software PDF SDK
Jump to: navigation, search
Line 19: Line 19:
 
! [[PXV:CabDataTypeID|Cab Data Type]]
 
! [[PXV:CabDataTypeID|Cab Data Type]]
 
! Description
 
! Description
 +
|-
 +
| CanAddToHistory
 +
| [[PXV:CabDataTypeID|dt_Bool]]
 +
| Indicates whether the document should be added to the Recents List.
 +
Default value: <tt>'''true'''</tt>
 +
|-
 +
| CanRestoreLastView
 +
| [[PXV:CabDataTypeID|dt_Bool]]
 +
| Indicates whether the document should be opened at the last viewed page and destination.
 +
Default value: <tt>'''true'''</tt>
 +
|-
 +
| CanShowErrMsg
 +
| [[PXV:CabDataTypeID|dt_Bool]]
 +
| Indicates whether the document should display any error messages that occur when opening the document.
 +
Default value: <tt>'''false'''</tt>
 +
|-
 +
| DIPath
 +
| [[PXV:CabDataTypeID|dt_Bool]]
 +
| Indicates whether the DIPath format should be used when opening the document.
 +
Default value: <tt>'''false'''</tt>
 
|-
 
|-
 
| SecPermMask
 
| SecPermMask
 
| [[PXV:CabDataTypeID|dt_Int]]
 
| [[PXV:CabDataTypeID|dt_Int]]
 
| Sets the security permissions mask.
 
| Sets the security permissions mask.
 +
Default value: <tt>'''0'''</tt>
 
|-
 
|-
 
| Temp
 
| Temp
 
| [[PXV:CabDataTypeID|dt_Bool]]
 
| [[PXV:CabDataTypeID|dt_Bool]]
| Indicates whether the document should be created as a temporary document.
+
| 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: <tt>'''false'''</tt>
 
|}
 
|}
  

Revision as of 08:24, 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 DIPath format should be used when opening the document.

Default value: false

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