isCustomConsoleComponentWindowHidden()

Usage

Determines if the application-level custom console component window is hidden.This method is only available in API version 25.0 or later.

If this method is called from a popped out component in a Salesforce console where multi-montior components is turned on, nothing will happen. For more information, see “Turn on Multi-Monitor Components for a Salesforce Console” in the online help.

Note

Syntax

1sforce.console.isCustomConsoleComponentWindowHidden((optional) callback:Function)

Arguments

Name	Type	Description
callback	function	JavaScript method called upon completion of the method.

Sample Code–Visualforce

1swfobject.registerObject("clippy.codeblock-1", "9");<apex:page>
2
3     <A HREF="#" onClick="testIsCustomConsoleComponentWindowHidden();return false">
4         Click here to check if the custom console component window is hidden</A> 
5
6    <apex:includeScript value="/support/console/25.0/integration.js"/>
7    <script type="text/javascript">
8        function testIsCustomConsoleComponentWindowHidden() {
9            sforce.console.isCustomConsoleComponentWindowHidden(checkWindowVisibility);
10        }
11        
12        var checkWindowVisibility = function checkWindowVisibility(result) {
13            //Display the window visibility
14            if (result.success) {
15              alert('Is window hidden: ' + result.hidden);
16            } else {
17              alert('Error!');
18            }
19        }
20  </script>
21
22</apex:page>

Response

This method is asynchronous so it returns its response in an object in a callback method. The response object contains the following field:

Name	Type	Description
hidden	boolean	`true` if the custom console component window is hidden; `false` if the custom console component window is visible.
success	boolean	`true` if returning the custom console component window visibility was successful; `false` if returning the custom console component window visibility wasn't successful.

Salesforce Console Integration Toolkit Developer's Guide