Note: 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.

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. This method isn’t supported in Lightning Console.

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.

Try to give buttons short names. Scrolling is limited to the width of the button. If a button name is too long, scrolling can restart before the name finishes displaying.

Tip

Sample Code–Visualforce

1<apex:page>
2
3    <A HREF="#" onClick="testScrollCustomConsoleComponentButtonText();return false">
4         Click here to scroll the button text on a custom console component</A> 
5
6    <apex:includeScript value="/support/console/68.0/integration.js"/>
7    <script type="text/javascript">
8        function testScrollCustomConsoleComponentButtonText() {
9        //Scroll the custom console component button text from right to left
10            sforce.console.scrollCustomConsoleComponentButtonText(500, 10, true, function(result){
11              if (result.success) {
12               alert('The text scrolling starts!');
13              } else {
14               alert('Could not initiate the text scrolling!');
15              }
16            });
17           }
18    </script>
19</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.

Salesforce Console Developer Guide

scrollCustomConsoleComponentButtonText()

Syntax

Arguments

Sample Code–Visualforce

Response