Idmadmin at 13:03, 2 August 2021

2021-08-02T13:03:21Z

Idmadmin: /* Output tab */

2020-07-29T21:10:37Z

‎Output tab

Idmadmin at 19:59, 3 January 2018

2018-01-03T19:59:20Z

Idmadmin: Created page with "right
Shortcut: Ctrl+Shift+# ''(where # corresponds to the numb..."

2018-01-03T15:20:32Z

Created page with "alt=user tools menu in UltraEdit|right <div class="idm-shortcut"> Shortcut: Ctrl+Shift+# ''(where # corresponds to the numb..."

New page

[[File:UltraEdit user tools menu.png|alt=user tools menu in UltraEdit|right]]
<div class="idm-shortcut">
Shortcut: Ctrl+Shift+# ''(where # corresponds to the number of the tool)''
</div>

A '''user tool''' is a way for you to interact with other applications or programs on your system by executing a DOS or Windows command. You can configure up to 50 user tools - 25 standard tools and 25 [[:Category:Project tab|Project]] tools. You can access and execute user tools in the [[:Category:Advanced tab|Advanced tab]] in the '''User tools''' drop down. You can also add your tools to the ribbon or toolbars and [[Settings:Key mapping|map keyboard shortcuts]] to your tools. You can also use user tools in macros or scripts.

Clicking '''Configure tools''' opens the "Tool configuration" dialog, where you can create and delete tools. Here you can also configure tools, including defining the command line, setting parameters, configuring output handling, and setting options for interacting with the active file.

You can modify existing tools by selecting them from the list at the bottom of the dialog. The dialog also includes the following global buttons for adding / removing tools.

'''Insert''' 
Creates a new tool and makes it active.

'''Copy''' 
Creates a copy of the active / selected tool and makes it active.

'''Delete''' 
Deletes the active / selected tool.

Your changes to tools are not saved until you click either the '''OK''' or '''Apply''' button in the "Tool configuration" dialog.

You can configure tools in the '''Command''', '''Options''', and '''Output''' tabs in the "Tool configuration" dialog. The settings for each tab are described below.

==Command tab==

[[File:UltraEdit tool config - command.png|right]]

'''Menu item name''' 
This is the name of the tool and is shown in the user / project tool drop down as well as the tool list in the "Tool configuration" dialog.

'''Command line''' 
This is the actual command line to be executed when the tool is run. The command line uses the same syntax as a DOS command prompt, however this field also supports a special placeholder syntax (described below) which allows variables, such as the active file's path and name, to be passed to the command line. You can use the '''Browse''' button to browse to and select an existing batch or cmd file.

'''Working directory''' 
This is the active directory the tool and ensuing process will be launched in. You can use the '''Browse''' button to browse to and select an existing folder on your system.

For both the '''command line''' and '''working directory''' fields, the following placeholders are available.

''All examples provided below are based upon a hypothetical file path '''D:\work\Dev Projects\Cycle One\some file.c'''.''

{|
!Placeholder
!Meaning
|-
|%F
|Active file's full path and name (short version) ''Example: '''D:\work\DEVPRO~1\CYCLEO~1\SOMEFI~1.C'''''
|-
|%f
|Active file's full path and name (long version). Make sure to encapsulate in quotes if the file path or name might contain spaces. ''Example: '''D:\work\Dev Projects\Cycle One\some file.c'''''
|-
|%P
|Active file's full path (short version) ''Example: '''D:\work\DEVPRO~1\CYCLEO~1\'''''
|-
|%p
|Active file's full path (long version). Make sure to encapsulate in quotes if the file path might contain spaces. ''Example: '''D:\work\Dev Projects\Cycle One\'''''
|-
|%P
|Active file's name only (short version) ''Example: '''SOMEFI~1'''''
|-
|%p
|Active file's name only (long version). Make sure to encapsulate in quotes if the name might contain spaces. ''Example: '''some file'''''
|-
|%E
|Active file's extension only (short version) ''Example: '''.C'''''
|-
|%e
|Active file's extension only (long version). Make sure to encapsulate in quotes if the extension might contain spaces. ''Example: '''.c'''''
|-
|%R
|Active project's full path and name (short version), similar to %F above.
|-
|%r
|Active project's full path and name (long version), similar to %f above. Make sure to encapsulate in quotes if the path or name might contain spaces.
|-
|%RP
|Active project's full path (short version), similar to %P above.
|-
|%rp
|Active project's full path (long version), similar to %p above. Make sure to encapsulate in quotes if the project path might contain spaces.
|-
|%RN
|Active project's name (short version), similar to %N above.
|-
|%rn
|Active project's full path (long version), similar to %n above. Make sure to encapsulate in quotes if the project path might contain spaces.
|-
|%modify%
|Using this placeholder will allow you to specify any arbitrary command line argument(s) (in its place) in a dialog prompt when the command is run.
|-
|%sel%
|Selected text. Make sure to encapsulate in quotes if the selection might contain spaces.
|-
|%Env:
|An existing environment variable. The environment variable must immediately follow "%Env:". Note that this placeholder does not require the closing percent sign "%". ''Example: '''%Env:TEMP''' would be replaced with '''C:\Users\[USERNAME]\AppData\Local\Temp'''''
|-
|%line%
|Current line number in active file (based on first line number of 1)
|-
|%col%
|Current column number in active file (based on first column number of 1)
|}

'''Toolbar bitmap/icon (file path)''' 
This field allows you to set the path to a bitmap, png, or icon file to be used in the ribbon, context menu, or toolbar for the tool. Use the '''Browse''' button to browse to and select the image file you'd like to use. The image will be scaled to fit in the ribbon or toolbar. If this isn't set, the default tool icon (with associated number) is displayed with the tool.

==Options tab==
[[File:UltraEdit tool config - options.png|right]]
'''Program type''' 
You must define the program type as one of the following two options:

* '''DOS program''' (default) The "Command" field is launched in console mode, just as you would run a command in a DOS command prompt window. Most user tools will use this setting.
* '''Windows program''' The "Command" field is launched as a Windows executable program, just as if you were to double-click its icon in Windows explorer.

'''Save active file first''' 
If checked, the active file is saved before the tool is run.

'''Save all files first''' 
If checked, all open files are saved before the tool is run.

{{clear}}
==Output tab==
[[File:UltraEdit tool config - output.png|right]]
'''Command output (DOS commands)''' 
You can optionally capture the output from your DOS command user tool to a file. The four options for DOS command output are:

# '''Append to existing''' Appends the tool output to the existing "Command Output" tool output file, ''or'' create the "Command Output" file if it does not yet exist.
# '''Replace existing''' Replaces existing text with tool output in the "Command Output" tool output file, ''or'' create the "Command Output" file if it does not yet exist.
# '''Create new file''' Always creates a new "Command Output" file for the tool output regardless of whether one already exists.
# '''Output to list box''' Sends tool output to the [[output window]].

'''Replace selected text with''' 
You can choose what to do with the selection in the active file after the user tool is run. This is especially useful if you want to send a selection of text (a code procedure, a forumala, etc.) to an external process and have it reformatted or recalculated in some way. The three options are:
# '''No replace''' The selection is left unaltered.
# '''Captured output''' The selection is replaced with all output from the user tool.
# '''Clipboard''' The selection is replaced with the clipboard contents after the tool completes execution.

'''Handle output as''' 
This allows you to specify the encoding to use when displaying the output returned from the DOS command. These options don't actually convert the output, but allow you to configure which encoding UltraEdit / UEStudio uses to display the output. The three options are:
# '''ANSI''' ''(Default, recommended for most cases)'' The user tool output is displayed as ANSI with your system's default code page.
# '''UTF-8''' The user tool output is displayed as though it were UTF-8. This option is not recommended unless your external process specifically creates output as UTF-8. Otherwise, the output may look garbled or incorrect.
# '''UTF-16''' The user tool output is displayed as though it were UTF-16. Additionally, this will cause the command prompt to be internally invoked with the "/u" flag, creating a Unicode (UTF-16) DOS command prompt before the command is run. This option is not recommended unless your external process specifically creates output as UTF-16. Otherwise, the output may look garbled or incorrect.

<div class="idm-see-also">
See also:
* [[Run DOS / Windows command]]
</div>

@@ Line 56: / Line 56: @@
 |Active file's full path (long version). Make sure to encapsulate in quotes if the file path might contain spaces. <br>''Example: '''D:\work\Dev Projects\Cycle One\'''''
 |-
-|%P
+|%N
 |Active file's name only (short version)<br>''Example: '''SOMEFI~1'''''
 |-
-|%p
+|%n
 |Active file's name only (long version). Make sure to encapsulate in quotes if the name might contain spaces. <br>''Example: '''some file'''''
 |-

@@ Line 129: / Line 129: @@
 # '''Create new file'''<br>Always creates a new "Command Output" file for the tool output regardless of whether one already exists.
 # '''Output to list box'''<br>Sends tool output to the [[output window]].
 '''Replace selected text with'''<br>

@@ Line 1: / Line 1: @@
-[[File:UltraEdit user tools menu.png|alt=user tools menu in UltraEdit|right]]
+[[Category:Advanced tab]][[File:UltraEdit user tools menu.png|alt=user tools menu in UltraEdit|right]]
 <div class="idm-shortcut">
 Shortcut: <span>Ctrl+Shift+#</span> ''(where # corresponds to the number of the tool)''

Configure tools - Revision history

Idmadmin at 13:03, 2 August 2021

Idmadmin: /* Output tab */

Idmadmin at 19:59, 3 January 2018

Idmadmin: Created page with "right Shortcut: Ctrl+Shift+# ''(where # corresponds to the numb..."

Idmadmin: Created page with "right
Shortcut: Ctrl+Shift+# ''(where # corresponds to the numb..."