Salesforce Console Integration Toolkit Developer's Guide
jNewer Version Available
onCustomConsoleComponentButtonClicked()
Registers a function to call when
a button is clicked on an application-level custom console component. This method is only available in API version 25.0 or
later.
Syntax
1sforce.console.onCustomConsoleComponentButtonClicked(eventHandler:Function)Arguments
| Name | Type | Description |
|---|---|---|
| callback | function | JavaScript method called when a button is clicked on a custom console component. |
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 <apex:includeScript value="/support/console/25.0/integration.js"/>
20 <script type="text/javascript">
21 var eventHandler = function (result) {
22 alert('The Custom Console Component button is clicked. The component ID is: ' + result.id +
23 ' and the component window is: ' + (result.windowHidden ? 'hidden' : 'visible'));
24 };
25
26 sforce.console.onCustomConsoleComponentButtonClicked(eventHandler);
27 </script>
28
29</apex:page>Event Handler 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 |
|---|---|---|
| id | string | The ID of the custom console component which includes the page. |
| windowHidden | boolean | true if the custom console component window is hidden after the button is clicked; false if the custom console component window is visible after the button is clicked. |