Salesforce Console Developer Guide
jNote: 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.
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. This method isn’t supported in Lightning Console.
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
1<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/68.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. |