Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

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.

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

1<apex:page>
2
3    <A HREF="#" onClick="testSetCustomConsoleComponentHeight();return false">
4         Click here to set the custom console component height to 100px</A> 
5
6    <apex:includeScript value="/support/console/68.0/integration.js"/>
7    <script type="text/javascript">
8        function testSetCustomConsoleComponentHeight() {
9        // Set the custom console component height
10            sforce.console.setCustomConsoleComponentHeight(100);
11        }
12    </script>
13</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 Developer Guide

setCustomConsoleComponentHeight()

Syntax

Arguments

Sample Code–Visualforce

Response