| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <html> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> |
| <title>Command Details Section</title> |
| <link rel="STYLESHEET" href="../../../../book.css" type="text/css"> |
| <link rel="STYLESHEET" href="../../../tweak.css" type="text/css"> |
| <script language="JavaScript" type="text/javascript" src="PLUGINS_ROOT/org.eclipse.help/livehelp.js"></script> |
| </head> |
| <body> |
| <h2>Command Details Section</h2> |
| |
| <h3>About This Section</h3> |
| |
| <p> |
| This section allows you to do the following: |
| </p> |
| |
| <ul> |
| <li> |
| Test an executable workbench command |
| </li> |
| <li> |
| Edit an executable workbench command's applicable parameters |
| </li> |
| <li> |
| Copy an executable workbench command's string representation to the clipboard. |
| </li> |
| </ul> |
| |
| <p> |
| This section is activated by selecting a command node in the <strong>Commands</strong> section. |
| </p> |
| |
| <img src="../../../images/simple_cs_editor/dialog_composer_master.png" alt="Command Composer Content Section"> |
| |
| <h3>Section Fields</h3> |
| |
| <p> |
| This section contains the following fields: |
| </p> |
| |
| <table cellspacing="0"> |
| <tr> |
| <td class="header"> |
| Label |
| </td> |
| <td class="header"> |
| Type |
| </td> |
| <td class="header"> |
| Name |
| </td> |
| <td class="header"> |
| Description |
| </td> |
| <td class="header"> |
| Required |
| </td> |
| </tr> |
| <tr> |
| <td class="body"> |
| <strong>Command ID</strong> |
| </td> |
| <td class="body"> |
| Text |
| </td> |
| <td class="body"> |
| Workbench Command ID |
| </td> |
| <td class="body"> |
| This non-editable field shows the workbench command ID. |
| </td> |
| <td class="body"> |
| N/A |
| </td> |
| </tr> |
| <tr> |
| <td class="body"> |
| Command Parameter (0 or more) |
| </td> |
| <td class="body"> |
| Text or Combo Box |
| </td> |
| <td class="body"> |
| Command Parameter |
| </td> |
| <td class="body"> |
| A workbench command may have 0 or more configurable parameters. |
| One input field is generated for each command parameter. |
| <br> |
| <br> |
| Enter applicable values into these fields to modify |
| the behavior of the workbench command accordingly. |
| </td> |
| <td class="body"> |
| N/A |
| </td> |
| </tr> |
| </table> |
| |
| <p> |
| An executable workbench command with parameters: |
| </p> |
| |
| <img src="../../../images/simple_cs_editor/dialog_composer_details_1.png" alt="Command Composer Details Section 1"> |
| |
| <p> |
| An executable workbench command without parameters: |
| </p> |
| |
| <img src="../../../images/simple_cs_editor/dialog_composer_details_3.png" alt="Command Composer Details Section 2"> |
| |
| <h3>Section Actions</h3> |
| |
| <p> |
| This section provides the following actions: |
| </p> |
| |
| <table cellspacing="0"> |
| <tr> |
| <td class="header"> |
| Label |
| </td> |
| <td class="header"> |
| Type |
| </td> |
| <td class="header"> |
| Name |
| </td> |
| <td class="header"> |
| Description |
| </td> |
| </tr> |
| <tr> |
| <td class="body"> |
| <strong>Execute</strong> |
| </td> |
| <td class="body"> |
| Hyperlink |
| </td> |
| <td class="body"> |
| Execute Workbench Command |
| </td> |
| <td class="body"> |
| Click this link to execute the workbench command from within the |
| <strong>Command Composer Dialog</strong>. |
| <br> |
| <br> |
| Note: This action is not available for workbench commands that |
| cannot be executed from within a dialog. |
| </td> |
| </tr> |
| <tr> |
| <td class="body"> |
| <strong>Copy To Clipboard</strong> |
| </td> |
| <td class="body"> |
| Hyperlink |
| </td> |
| <td class="body"> |
| Copy Command String To Clipboard |
| </td> |
| <td class="body"> |
| Click this link to copy an executable workbench command's |
| string representation to the clipboard. |
| <br> |
| <br> |
| The string representation can be used to directly embed workbench |
| commands into simple cheat sheets and user assistance documentation. |
| </td> |
| </tr> |
| </table> |
| |
| <img src="../../../images/simple_cs_editor/dialog_composer_details_2.png" alt="Command Composer Details Section 2"> |
| |
| <h3>Relevant Links</h3> |
| |
| <ul> |
| <li> |
| <a href="../../../../../org.eclipse.platform.doc.isv/guide/wrkAdv_keyBindings_actionDef.htm">Commands</a> |
| </li> |
| <li> |
| <a href="dialog_command-composer.htm">Command Composer Dialog</a> |
| </li> |
| <li> |
| <a href="section_commands.htm">Commands Section</a> |
| </li> |
| </ul> |
| |
| </body> |
| </html> |
