setCustomConsoleComponentButtonStyle()

Usage

Sets the style of a button used to launch an application-level custom console component that’s on a page. This method is only available in API version 25.0 or later.

Syntax

1sforce.console.setCustomConsoleComponentButtonStyle(style:String, (optional)callback: Function)

Arguments

Name	Type	Description
style	string	The style of a button used to launch a custom console component.
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="testSetCustomConsoleComponentButtonStyle();return false">
4         Click here to set the style of a button used to launch a custom console component</A> 
5
6    <apex:includeScript value="/support/console/25.0/integration.js"/>
7    <script type="text/javascript">
8        function testSetCustomConsoleComponentButtonStyle() {
9            sforce.console.setCustomConsoleComponentButtonStyle('background:red;');
10        }
11    </script>
12</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 setting the button style was successful; `false` if setting the button style wasn't successful.

Salesforce Console Integration Toolkit Developer's Guide