IPXV_Inst::CreateOpenDocParams Method

From Tracker Software PDF SDK
Jump to: navigation, search
(Automatic page editing by robot)
 
m (Automatic page editing by robot)
 
(21 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IPXV_Inst::CreateOpenDocParams Method}}
 
{{#customTitle:IPXV_Inst::CreateOpenDocParams Method}}
 +
{{#parentPage:PXV:IPXV_Inst#Methods|CreateOpenDocParams|method}}
 +
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
Creates container with additional parameters for documents opening. Then it can be passed to [[PXV:IPXV_MainFrame_OpenDocFrom|IPXV_MainFrame::OpenDocFrom]]/[[PXV:IPXV_MainFrame_OpenDocFromPath|IPXV_MainFrame::OpenDocFromPath]] to customize document opening process.
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT CreateOpenDocParams([out, retval] ICab** ppOpenDocParams);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT CreateOpenDocParams([out, retval] ICab** pOpenDocParams);</pre>
  
 
== Parameters ==
 
== Parameters ==
;''ppOpenDocParams''
+
;pOpenDocParams
:[out, retval]  Pointer to [[PXV:ICab|ICab]].
+
:[out, retval]  Returns pointer to a new [[PXV:ICab|ICab]] object with additional parameters for documents opening.
 +
 
 +
{| class="wikitable" border="1"
 +
|-
 +
! Cab Item Name
 +
! [[PXV:CabDataTypeID|Cab Data Type]]
 +
! 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 device independent path format should be used when opening the document.
 +
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 initial view point.
 +
Default value: <tt>'''NULL'''</tt>
 +
|-
 +
| InNewFrameWnd
 +
| [[PXV:CabDataTypeID|dt_Int]]
 +
| Specifies whether the document should be opened in the new frame window.
 +
Default value: <tt>'''-1'''</tt> which means that global preferences would be used.
 +
|-
 +
| [[PXV:cs_PDFDestParams|InitialDest]]
 +
| [[PXV:CabDataTypeID|dt_Dictionary]]
 +
| Specifies the initial document's destination.
 +
|-
 +
| InsertBeforeTab
 +
| [[PXV:CabDataTypeID|dt_Int]]
 +
| Specifies the document's tab position in the [[PXV:IUIX_LayoutItem|tab group]].
 +
Default value: <tt>'''-1'''</tt>
 +
|-
 +
| LinkToParent
 +
| [[PXV:CabDataTypeID|dt_Bool]]
 +
| Indicates whether the document should be linked to the parent document.
 +
Default value: <tt>'''true'''</tt>
 +
|-
 +
| MakeLocalCopy
 +
| [[PXV:CabDataTypeID|dt_Bool]]
 +
| Indicates whether the internal local copy for the input stream or file will be created.
 +
Default value: <tt>'''false'''</tt>
 +
|-
 +
| NativeOnly
 +
| [[PXV:CabDataTypeID|dt_Bool]]
 +
| Indicates whether only the real pdf files should be opened meaning that the file format conversion would be denied.
 +
Default value: <tt>'''false'''</tt>
 +
|-
 +
| NewDocView
 +
| [[PXV:CabDataTypeID|dt_Bool]]
 +
| Indicates whether new view should be created when opening document.
 +
Default value: <tt>'''false'''</tt>
 +
|-
 +
| NoAuth
 +
| [[PXV:CabDataTypeID|dt_Bool]]
 +
| Indicates whether the authentication will be allowed when opening the document.
 +
Default value: <tt>'''false'''</tt>
 +
|-
 +
| NoProgress
 +
| [[PXV:CabDataTypeID|dt_Bool]]
 +
| Indicates whether the progress bar should be drawn when opening the document.
 +
Default value: <tt>'''false'''</tt>
 +
|-
 +
| [[PXV:AFS_OpenFileFlags|OpenFileFlags]]
 +
| [[PXV:CabDataTypeID|dt_Int]]
 +
| Sets open file flags that will be used when opening the document.
 +
Default value: <tt>'''0'''</tt>
 +
|-
 +
| Parent
 +
| [[PXV:CabDataTypeID|dt_IUnknown]]
 +
| Specifies a parent [[PXV:IPXV_Document|document]] for the currently opening document.
 +
Default value: <tt>'''NULL'''</tt>
 +
|-
 +
| Password
 +
| [[PXV:CabDataTypeID|dt_String]]
 +
| Sets the password that should be used when opening the document.
 +
Default value: <tt>'''Empty String'''</tt>
 +
|-
 +
| PrivateMode
 +
| [[PXV:CabDataTypeID|dt_Bool]]
 +
| Indicates whether the document should be opened in private mode.
 +
Default value: <tt>'''false'''</tt>
 +
|-
 +
| [[PXV:PXC_PermsFlags|SecPermMask]]
 +
| [[PXV:CabDataTypeID|dt_Int]]
 +
| Sets the security permissions mask.
 +
Default value: <tt>'''0'''</tt>
 +
|-
 +
| Sync
 +
| [[PXV:CabDataTypeID|dt_Bool]]
 +
| Indicates whether the synchronized document opening should be used.
 +
Default value: <tt>'''false'''</tt>
 +
|-
 +
| Temp
 +
| [[PXV:CabDataTypeID|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: <tt>'''false'''</tt>
 +
|-
 +
| UIFileName
 +
| [[PXV:CabDataTypeID|dt_String]]
 +
| Sets custom UI File Name for the opened document.
 +
Default value: <tt>'''Empty String'''</tt>
 +
|-
 +
| UITitle
 +
| [[PXV:CabDataTypeID|dt_String]]
 +
| Sets custom UI File Title for the opened document.
 +
Default value: <tt>'''Empty String'''</tt>
 +
|-
 +
| UrlExtra
 +
| [[PXV:CabDataTypeID|dt_String]]
 +
| Sets the additional document's open parameters through the URL.
 +
Default value: <tt>'''Empty String'''</tt>
 +
|}
  
 
== Return Value ==
 
== Return Value ==
Line 15: Line 169:
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IPXV_Inst|IPXV_Inst]].
+
[[PXV:IPXV_Inst|IPXV_Inst]], [[PXV:IPXV_MainFrame_OpenDocFrom|IPXV_MainFrame::OpenDocFrom]], [[PXV:IPXV_MainFrame_OpenDocFromPath|IPXV_MainFrame::OpenDocFromPath]]

Latest revision as of 08:22, 13 June 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

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