Salesforce Console Developer Guide
j
No Results
Search Tips:
- Please consider misspellings
- Try different search keywords
setSidebarVisible()
Shows or hides a console sidebar based on tabId and region. This method is available in API version
33.0 or later. This method isn’t supported in Lightning Console.
Syntax
sforce.console.setSidebarVisible( visible:Boolean, (optional)tabId:String, (optional)region:String, (optional)callback:Function)Arguments
| Name | Type | Description |
|---|---|---|
| visible | boolean | true to show the sidebar or false to hide the sidebar. |
| tabId | string | The ID of the tab on which to show or hide the sidebar. |
| region | string | The region on the console where the sidebar is located, such as left or right,
top or bottom. Regions are represented as:
|
| callback | function | JavaScript method called upon completion of the method. |
Sample Code–Visualforce
<apex:page>
<apex:includeScript value="/support/console/63.0/integration.js"/>
<script type="text/javascript">
var callback = function (result) {
if (result.success) {
alert('Congratulations!');
}else {
alert('something is wrong!');
}
};
function setSidebarVisible() {
sforce.console.setSidebarVisible(true,'scc-st-1',sforce.console.Region.LEFT,callback);
}
</script>
<A HREF="#" onClick="setSidebarVisible(); return false">SetSidebarToExpand</A>
</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 the method call was successful; false otherwise. |