Salesforce Console Integration Toolkit Developer's Guide
jNewer Version Available
setCustomConsoleComponentButtonText()
Sets the text on 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.setCustomConsoleComponentButtonText(text:String, (optional)callback:Function)Arguments
| Name | Type | Description |
|---|---|---|
| text | string | Text that’s displayed on a button used to launch a custom console component. |
| 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="testSetCustomConsoleComponentButtonText();return false">
20 Click here to set the text on 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 testSetCustomConsoleComponentButtonText() {
25 //Change the custom console component button text to 'Hello World'
26 sforce.console.setCustomConsoleComponentButtonText('Hello World');
27 }
28 </script>
29</apex:page>Response
| Name | Type | Description |
|---|---|---|
| success | boolean | true if setting the button text was successful; false if setting the button text wasn't successful. |