IPXV_Control::GetPaneVisibility Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
m (Automatic page editing by robot)
 
(3 intermediate revisions by 2 users not shown)
Line 3: Line 3:
 
{{#customTitle:IPXV_Control::GetPaneVisibility Method}}
 
{{#customTitle:IPXV_Control::GetPaneVisibility Method}}
 
{{#parentPage:PXV:IPXV_Control#Methods|GetPaneVisibility|method}}
 
{{#parentPage:PXV:IPXV_Control#Methods|GetPaneVisibility|method}}
{{ToWrite}}
 
 
{{ToReview}}
 
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
Gets visibility state of UI-pane.
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT GetPaneVisibility([in]          BSTR  pPaneID,
+
<pre class="brush:cpp;gutter:false">HRESULT GetPaneVisibility([in]          BSTR  sPaneID,
                           [out, retval]  LONG*  pVal);</pre>
+
                           [out, retval]  LONG*  nVal);</pre>
  
 
== Parameters ==
 
== Parameters ==
;pPaneID
+
;sPaneID
:[in]  Value of BSTR.
+
:[in]  The unique identifier of UI-pane. For example:
;pVal
+
::<tt>searchView</tt>
:[out, retval]  Pointer to LONG.
+
::<tt>loupeView</tt>
 +
::<tt>searchView</tt>
 +
::<tt>pagesView</tt>
 +
::<tt>bookmarksView</tt>
 +
::<tt>pageThumbnailsView</tt>
 +
::<tt>...</tt>
 +
;nVal
 +
:[out, retval]  Returns visibility state. The supported values:
 +
::<tt>1</tt> - is visible;
 +
::<tt>0</tt> - is invisible, because is overlapped by other panes;
 +
::<tt>-1</tt> - is hidden permanently;
  
 
== Return Value ==
 
== Return Value ==

Latest revision as of 03:49, 15 June 2015


Gets visibility state of UI-pane.

Syntax

HRESULT GetPaneVisibility([in]           BSTR   sPaneID,
                          [out, retval]  LONG*  nVal);

Parameters

sPaneID
[in] The unique identifier of UI-pane. For example:
searchView
loupeView
searchView
pagesView
bookmarksView
pageThumbnailsView
...
nVal
[out, retval] Returns visibility state. The supported values:
1 - is visible;
0 - is invisible, because is overlapped by other panes;
-1 - is hidden permanently;

Return Value

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

See Also

IPXV_Control