focusPrimaryTabByName()

Focuses the browser on a primary tab that is already open with the specified name. This method is only available in API version 22.0 or later.

Syntax

sforce.console.focusPrimaryTabByName(name:String, (optional)callback:Function)

Arguments

Sample Code–Visualforce

<apex:page standardController="Case">

     <A HREF="#" onClick="testFocusPrimaryTabByName();return false">
         Click here to go to a primary tab by name</A> 

    <apex:includeScript value="/support/console/68.0/integration.js"/>
    <script type="text/javascript">
        function testFocusPrimaryTabByName() {
            //Get the value for 'myPrimaryTab' from the openPrimaryTab method
            //This value is for example purposes only
            var primaryTabName = 'myPrimaryTab';
            sforce.console.focusPrimaryTabByName(primaryTabName, focusSuccess);
        }
        
        var focusSuccess = function focusSuccess(result) {
            //Report whether going to the primary tab was successful
            if (result.success == true) {
                alert('Going to the primary tab was successful');
            } else {
                alert('Going to the Primary tab was not successful');
            }
        };
        
  </script>

</apex:page>

note: To see this example in action, click the custom link on a case. For more information, see Define Custom Buttons and Links in Salesforce Help.

Response

This method is asynchronous, so it returns its response in an object in a callback method. The response object contains the following field: