IPXV_Control::GetPaneVisibility Method

Latest revision as of 02:49, 15 June 2015

PDF Editor Layer > Interfaces > IPXV_Control > IPXV_Control::GetPaneVisibility Method

Gets visibility state of UI-pane.

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

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;

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

@@ Line 3: / Line 3: @@
 {{#customTitle:IPXV_Control::GetPaneVisibility Method}}
 {{#parentPage:PXV:IPXV_Control#Methods|GetPaneVisibility|method}}
-{{ToWrite}}
 {{ToReview}}
-The method of interface of PDF-XChange Editor SDK.
+Gets visibility state of UI-pane.
 == 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 ==
-;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 ==