setCustomConsoleComponentWindowVisible()

Usage

Sets the window visibility of an application-level custom console component that’s on a page. 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.setCustomConsoleComponentWindowVisible(visible:Boolean, (optional)callback:Function)

Arguments

Name	Type	Description
visible	boolean	`true` to make the custom console component window visible, `false` to hide the custom console component window.
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="testSetCustomConsoleComponentWindowVisible();return false">
4         Click here to make the custom console component window visible</A> 
5
6    <apex:includeScript value="/support/console/25.0/integration.js"/>
7    <script type="text/javascript">
8        function testSetCustomConsoleComponentWindowVisible() {
9        //Make the custom console component window visible
10            sforce.console.setCustomConsoleComponentWindowVisible(true);
11        }
12    </script>
13</apex:page>

Response

Name	Type	Description
success	boolean	`true` if setting the button window visibility was successful; `false` if setting the button window visibility wasn't successful.

Salesforce Console Integration Toolkit Developer's Guide