Salesforce Console Integration Toolkit Developer's Guide
jNewer Version Available
scrollCustomConsoleComponentButtonText()
Scrolls a button’s text on
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.scrollCustomConsoleComponentButtonText(interval:number, pixelsToScroll:number, isLeftScrolling:boolean, (optional)callback:Function)Arguments
| Name | Type | Description |
|---|---|---|
| interval | number | Controls how often the button text is scrolled in milliseconds. |
| pixelsToScroll | number | Controls how many pixels the button text scrolls. |
| isLeftScrolling | boolean |
If true, the text scrolls left. If false, the text scrolls right. |
| 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="testScrollCustomConsoleComponentButtonText();return false">
20 Click here to scroll the button text on a custom console component</A>
21
22 <apex:includeScript value="/support/console/25.0/integration.js"/>
23 <script type="text/javascript">
24 function testScrollCustomConsoleComponentButtonText() {
25 //Scroll the custom console component button text from right to left
26 sforce.console.scrollCustomConsoleComponentButtonText(500, 10, true, function(result){
27 if (result.success) {
28 alert('The text scrolling starts!');
29 } else {
30 alert('Could not initiate the text scrolling!');
31 }
32 });
33 }
34 </script>
35</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 scrolling the button text was successful; false if scrolling the button text wasn't successful. |