IPXV_Control::GetPaneVisibility Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
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 ==
Line 14: Line 13:
 
== Parameters ==
 
== Parameters ==
 
;pPaneID
 
;pPaneID
:[in]  Value of BSTR.
+
:[in]  The unique identifier of UI-pane. For example:
 +
::<tt>searchView</tt>
 +
::<tt>loupeView</tt>
 +
::<tt>searchView</tt>
 +
::<tt>pagesView</tt>
 +
::<tt>bookmarksView</tt>
 +
::<tt>pageThumbnailsView</tt>
 +
::<tt>...</tt>
 
;pVal
 
;pVal
:[out, retval]  Pointer to LONG.
+
:[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 ==

Revision as of 18:11, 27 May 2015


Gets visibility state of UI-pane.

Syntax

HRESULT GetPaneVisibility([in]           BSTR   pPaneID,
                          [out, retval]  LONG*  pVal);

Parameters

pPaneID
[in] The unique identifier of UI-pane. For example:
searchView
loupeView
searchView
pagesView
bookmarksView
pageThumbnailsView
...
pVal
[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