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

1<apex:page>
2
3    <A HREF="#" onClick="testSetCustomConsoleComponentButtonText();return false">
4         Click here to set the text on a button used to launch a custom console component</A> 
5
6    <apex:includeScript value="/support/console/67.0/integration.js"/>
7    <script type="text/javascript">
8        function testSetCustomConsoleComponentButtonText() {
9        //Change the custom console component button text to 'Hello World'
10            sforce.console.setCustomConsoleComponentButtonText('Hello World');
11        }
12    </script>
13</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.