Difference between revisions of "How to Script Buttons"
From SDU
Agegeleruvy (Talk | contribs) |
m (Reverted edits by Agegeleruvy (Talk); changed back to last version by BrianM) |
||
| Line 1: | Line 1: | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
__NOTOC__ | __NOTOC__ | ||
{{Global Header}} | {{Global Header}} | ||
| Line 17: | Line 9: | ||
| − | {| style= | + | {| style="width:100%;vertical-align:top;" cellpadding="10" |
|- | |- | ||
| − | ! style= | + | ! style="width:10%;" | Attribute |
| − | ! style= | + | ! style="width:40%;" | Description |
| − | ! style= | + | ! style="width:50%;" | Examples |
| − | |-valign= | + | |-valign="top" |
| '''btnID''' | | '''btnID''' | ||
| Used for referencing the button. This is typically a label used for easy identification of the button in scripts. | | Used for referencing the button. This is typically a label used for easy identification of the button in scripts. | ||
| − | | | + | | <source lang="javascript">ImgBtnCreate("btn001", ... |
| − | ImgBtnCreate( | + | ImgBtnCreate("btnchg", ... |
| − | ImgBtnCreate( | + | ImgBtnCreate("mybtn", ...</source> |
| − | |-valign= | + | |-valign="top" |
| '''btnCaption''' | | '''btnCaption''' | ||
| − | | The text to be displayed on the button. Either identify the string such as | + | | The text to be displayed on the button. Either identify the string such as "My Button" or reference a msgtext() value. The msgtext() value is obtained from the msg_cat.js file. |
| − | | | + | | <source lang="javascript">ImgBtnCreate(..., "I am a button"... |
| − | ImgBtnCreate(..., msgtext(514), ... | + | ImgBtnCreate(..., msgtext(514), ...</source> |
| − | |-valign= | + | |-valign="top" |
| '''func''' | | '''func''' | ||
| The script to be initiated when the button is selection | | The script to be initiated when the button is selection | ||
| − | | | + | | <source lang="javascript">ImgBtnCreate(..., ..., "detailSave('NEW_CHANGE')", ... |
| − | ImgBtnCreate(..., ..., | + | ImgBtnCreate(..., ..., "myscript()", ...</source> |
| − | |-valign= | + | |-valign="top" |
| '''btnEnabled''' | | '''btnEnabled''' | ||
| If true then the button is Active. If false then it is not. | | If true then the button is Active. If false then it is not. | ||
| − | | | + | | <source lang="javascript">ImgBtnCreate(..., ..., ..., true, ... |
| − | ImgBtnCreate(..., ..., ..., false, ... | + | ImgBtnCreate(..., ..., ..., false, ...</source> |
| − | |-valign= | + | |-valign="top" |
| '''btnWidth''' | | '''btnWidth''' | ||
| Button width in pixels. 0 defaults to the size of the text. | | Button width in pixels. 0 defaults to the size of the text. | ||
| − | | | + | | <source lang="javascript">ImgBtnCreate(..., ..., ..., ..., 0, ... |
| − | ImgBtnCreate(..., ..., ..., ..., 220, ... | + | ImgBtnCreate(..., ..., ..., ..., 220, ...</source> |
| − | |-valign= | + | |-valign="top" |
| '''help''' | | '''help''' | ||
| Displays information in status bar of the browser window. This is typically the bottom left-hand corner of your. | | Displays information in status bar of the browser window. This is typically the bottom left-hand corner of your. | ||
| − | | | + | | <source lang="javascript">ImgBtnCreate(..., ..., ..., ..., ..., "Click here to open a ticket", ...</source> |
| − | |-valign= | + | |-valign="top" |
| '''tabIndex''' | | '''tabIndex''' | ||
| | | | ||
| Line 61: | Line 53: | ||
== More Examples == | == More Examples == | ||
'''Open a Service Desk htmpl file in a new window''' | '''Open a Service Desk htmpl file in a new window''' | ||
| − | + | <source lang="javascript">ImgBtnCreate("btn001", "Custom Form", "popup_window('','ztest.htmpl'))", true, 0, "Select this button to view a Service Desk htmpl in a new window");</source> | |
'''Open a Service Desk htmpl file in an existing window''' | '''Open a Service Desk htmpl file in an existing window''' | ||
| − | + | <source lang="javascript">ImgBtnCreate("btn001", "Existing Window", "upd_frame('ztest.htmpl')", true, 0, "Select this button to use the existing window");</source> | |
'''Open a new window referencing an external URL''' | '''Open a new window referencing an external URL''' | ||
| − | + | <source lang="javascript">ImgBtnCreate("btn001", "SDU", "popupWithURL('http://www.servicedeskusers.com', 1, 1, '')", true, 0, "User Community for CA/Unicenter Service Desk");</source> | |
'''Open a new email message referencing the ticket''' | '''Open a new email message referencing the ticket''' | ||
| − | + | <source lang="javascript">ImgBtnCreate("btn001", "Send eMail", "window.open('mailto:?subject=Regarding $args.type.sym $args.ref_num&body=Click on the following URL to view $args.type.sym $args.ref_num: $args.web_url')", true, 0);</source> | |
'''Launch an application''' | '''Launch an application''' | ||
| − | + | <source lang="javascript">function ExecuteMyApp() { | |
| − | var myshell = new ActiveXObject( | + | var myshell = new ActiveXObject( "WScript.shell" ); |
myshell.run( 'enter application command line here', 1, true ); | myshell.run( 'enter application command line here', 1, true ); | ||
} | } | ||
| − | ImgBtnCreate( | + | ImgBtnCreate("btn001", "My Application", "ExecuteMyApp()", true, 0, "Click this button to launch My Application");</source> |
Latest revision as of 05:25, 30 November 2010
To make corrections or additions to this article, select the edit tab above.
To discuss or ask questions about this article, select the discussion tab above.
To discuss or ask questions about this article, select the discussion tab above.
Overview
Service Desk buttons are created using a ImgBtnCreate function.
ImgBtnCreate(btnID, btnCaption, func, btnEnabled, btnWidth, help, tabIndex)
| Attribute | Description | Examples |
|---|---|---|
| btnID | Used for referencing the button. This is typically a label used for easy identification of the button in scripts. | <source lang="javascript">ImgBtnCreate("btn001", ...
ImgBtnCreate("btnchg", ... ImgBtnCreate("mybtn", ...</source> |
| btnCaption | The text to be displayed on the button. Either identify the string such as "My Button" or reference a msgtext() value. The msgtext() value is obtained from the msg_cat.js file. | <source lang="javascript">ImgBtnCreate(..., "I am a button"...
ImgBtnCreate(..., msgtext(514), ...</source> |
| func | The script to be initiated when the button is selection | <source lang="javascript">ImgBtnCreate(..., ..., "detailSave('NEW_CHANGE')", ...
ImgBtnCreate(..., ..., "myscript()", ...</source> |
| btnEnabled | If true then the button is Active. If false then it is not. | <source lang="javascript">ImgBtnCreate(..., ..., ..., true, ...
ImgBtnCreate(..., ..., ..., false, ...</source> |
| btnWidth | Button width in pixels. 0 defaults to the size of the text. | <source lang="javascript">ImgBtnCreate(..., ..., ..., ..., 0, ...
ImgBtnCreate(..., ..., ..., ..., 220, ...</source> |
| help | Displays information in status bar of the browser window. This is typically the bottom left-hand corner of your. | <source lang="javascript">ImgBtnCreate(..., ..., ..., ..., ..., "Click here to open a ticket", ...</source> |
| tabIndex |
More Examples
Open a Service Desk htmpl file in a new window <source lang="javascript">ImgBtnCreate("btn001", "Custom Form", "popup_window(,'ztest.htmpl'))", true, 0, "Select this button to view a Service Desk htmpl in a new window");</source>
Open a Service Desk htmpl file in an existing window <source lang="javascript">ImgBtnCreate("btn001", "Existing Window", "upd_frame('ztest.htmpl')", true, 0, "Select this button to use the existing window");</source>
Open a new window referencing an external URL <source lang="javascript">ImgBtnCreate("btn001", "SDU", "popupWithURL('http://www.servicedeskusers.com', 1, 1, )", true, 0, "User Community for CA/Unicenter Service Desk");</source>
Open a new email message referencing the ticket <source lang="javascript">ImgBtnCreate("btn001", "Send eMail", "window.open('mailto:?subject=Regarding $args.type.sym $args.ref_num&body=Click on the following URL to view $args.type.sym $args.ref_num: $args.web_url')", true, 0);</source>
Launch an application <source lang="javascript">function ExecuteMyApp() { var myshell = new ActiveXObject( "WScript.shell" ); myshell.run( 'enter application command line here', 1, true ); } ImgBtnCreate("btn001", "My Application", "ExecuteMyApp()", true, 0, "Click this button to launch My Application");</source>
