IPXV_Control::ShowPane Method

From Tracker Software PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
(Parameters)
 
(10 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IPXV_Control::ShowPane Method}}
 
{{#customTitle:IPXV_Control::ShowPane Method}}
{{#parentPage:PXV:IPXV_Control|method}}
+
{{#parentPage:PXV:IPXV_Control#Methods|ShowPane|method}}
{{ToWrite}}
+
 
{{ToReview}}
 
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
Shows/hides the UI-pane.
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT ShowPane([in] BSTR pPaneID, [in] VARIANT_BOOL bShow, [in, defaultvalue(0)] VARIANT_BOOL bHighlightOnShow);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT ShowPane([in]                   BSTR         sPaneID,
 +
                [in]                   VARIANT_BOOL bShow,
 +
                [in, defaultvalue(0)] VARIANT_BOOL bHighlightOnShow);</pre>
  
 
== Parameters ==
 
== Parameters ==
;''pPaneID''
+
;sPaneID
:[in]  Value of BSTR.
+
:[in]  The unique identifier of pane. For example:
;''bShow''
+
::pageThumbnailsView
:[in]  Value of VARIANT_BOOL.
+
::bookmarksView
;''bHighlightOnShow''
+
::contentsView
:[in, defaultvalue(0)]  Value of VARIANT_BOOL.
+
::attachmentsView
 +
::signaturesView
 +
::commentsView
 +
::layersView
 +
::pdfNamedDestsView
 +
::propertiesView
 +
::searchView
 +
::stampsView
 +
::commentStylesView
 +
::panzoomView
 +
::linksView
 +
::...
 +
;bShow
 +
:[in]  The flag to show/hide.
 +
;bHighlightOnShow
 +
:[in, defaultvalue(0)]  The flag to highlight an visible pane.
  
 
== Return Value ==
 
== Return Value ==
Line 22: Line 39:
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IPXV_Control|IPXV_Control]].
+
[[PXV:IPXV_Control|IPXV_Control]]

Latest revision as of 23:41, 11 September 2019


Shows/hides the UI-pane.

Syntax

HRESULT ShowPane([in]                   BSTR          sPaneID,
                 [in]                   VARIANT_BOOL  bShow,
                 [in, defaultvalue(0)]  VARIANT_BOOL  bHighlightOnShow);

Parameters

sPaneID
[in] The unique identifier of pane. For example:
pageThumbnailsView
bookmarksView
contentsView
attachmentsView
signaturesView
commentsView
layersView
pdfNamedDestsView
propertiesView
searchView
stampsView
commentStylesView
panzoomView
linksView
...
bShow
[in] The flag to show/hide.
bHighlightOnShow
[in, defaultvalue(0)] The flag to highlight an visible pane.

Return Value

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

See Also

IPXV_Control