Newer Version Available

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

setCustomConsoleComponentButtonStyle()

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. The styles supported include font, font color, and background color. Font and font color isn’t available for Internet Explorer® 7.
callback function JavaScript method that’s 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="testSetCustomConsoleComponentButtonStyle();return false">
20         Click here to set the style of a button used to launch a custom console component</A> 
21
22    <apex:includeScript value="/support/console/25.0/integration.js"/>
23    <script type="text/javascript">
24        function testSetCustomConsoleComponentButtonStyle() {
25            sforce.console.setCustomConsoleComponentButtonStyle('background:red;');
26        }
27    </script>
28</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.