setCustomConsoleComponentHeight()

Sets the window height of an application-level custom console component that’s on a page. This method is available in API version 32.0 or later.

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

Note

Syntax

1sforce.console.setCustomConsoleComponentHeight( height:number, (optional)callback:Function)

Arguments

Name	Type	Description
height	number	The new height in pixels.
callback	function	Javascript method called upon completion of the method.

Sample Code–Visualforce

1swfobject.registerObject("clippy.codeblock-1", "9");
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17<apex:page>
18
19    <A HREF="#" onClick="testSetCustomConsoleComponentHeight();return false">
20         Click here to set the custom console component height to 100px</A> 
21
22    <apex:includeScript value="/support/console/32.0/integration.js"/>
23    <script type="text/javascript">
24        function testSetCustomConsoleComponentHeight() {
25        // Set the custom console component height
26            sforce.console.setCustomConsoleComponentHeight(100);
27        }
28    </script>
29</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
success	boolean	`true` if the method call was successful; `false` otherwise.

Salesforce Console Integration Toolkit Developer's Guide

setCustomConsoleComponentHeight()

Syntax

Arguments

Sample Code–Visualforce

Response