Salesforce Console Integration Toolkit Developer's Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
PDF

Newer Version Available

This content describes an older version of this product. View Latest

setCustomConsoleComponentWidth()

Usage

Sets the window width 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 “Set Multi-Monitor Components for a Salesforce Console” in the Salesforce Help.

Note

Syntax

1sforce.console.setCustomConsoleComponentWidth( width:number, callback:Function)

Arguments

Name Type Description
width number The new width in pixels.
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="testSetCustomConsoleComponentWidth();return false">
4         Click here to set the custom console component width to 100px</A> 
5
6    <apex:includeScript value="/support/console/32.0/integration.js"/>
7    <script type="text/javascript">
8        function testSetCustomConsoleComponentWidth() {
9        // Set the custom console component width
10            sforce.console.setCustomConsoleComponentWidth(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.