lsxcommand.dll documentation
XML/XSL-generated documentation, on the official litestep docs model.
docs layout written by the LiteStep Documentation Effort, August 2000
XML schema by MrMidi, XSL by jesus_mjjg
What does lsxcommand.dll do?
The lsxcommand LoadModule is a text box that sits on your desktop. It will let you type !bangs, folder names, documents, apps, urls, etc an execute them. Think of it as a very customizable address bar :) if you specify a border width and you dont have CommandNotMoveable set, you can drag it around by the border. there is a problem that some people are having where the mouse cursor is not set back to a normal cursor after it is off the text box. to fix this, use CommandNoCursorChange to stop lsxcommand from changing the cursor. just a tip: lots of programs names work in lsxcommand.. you can type stuff like 'notepad', 'icq', 'netscape', to start some programs instead of the full path. the history is working great. Not all the text docs are in the html docs. All of the step.rc and bang commands are, but not all explanations. If you want to read more about the calculator, time, transparency, ... check lsxcommand.txt.

Step.rc syntax for lsxcommand.dll:
Positioning
CommandX x position on the screen.
CommandY y position on the screen.
CommandWidth width in pixels.
CommandHeight height in pixels.
CommandNotAlwaysOnTopoverides the default of being Always On Top of other windows
CommandHiddenOnStartstart hidden
Special positioning settings
CommandOffsetX-CommandOffsetYThis value determines which point on the screen LSXCommand should use as a reference for the CommandX/Y values. The default is the upper left corner. 0 - Left / Top 1 - Horizontal / Vertical Center 2 - Right / Bottom
CommandBevelBorder Use bevels instead of borders.
LsBox
CommandWaitForBoxLsxCommand will not appear until he is loaded in a box with the !CommandBoxHook. Please check lsbox documentation.
Border and text
BorderSizeWidth in pixels of the border. If you want to have different sized borders on each side, use CommandTopBorderSize, CommandBottomBorderSize, CommandLeft..., and CommandRight...
CommandTextSizepixel size of the text
Skins (see also lsxcommand.txt, section II.7 Backgrounds and Transparencies).
CommandBGColorbackground color
CommandBackgroundPath to your background image. If this is not an absolute path, LSXCommand looks in your images directory. If this option is not specified, the background and border colors are used.
CommandTransparentEditBoxMakes the area in which you type transparent to the background. If this option is not specified, the background image shows through. If there is no background, the background color is used.
CommandTextColortext color
CommandBorderColorcolor of the border
CommandTextFontFacefont for the text
Various settings
CommandNotMoveableif this is set you will not be able to drag it around by the border
CommandNoCursorChangedoes not change mouse cursor when over the text box
CommandAssumeNetAddressIf a command just doesn't cut it, you can have it start your browser with the address.
CommandExplorePathsIf enabled, any directory path you enter into LSXCommand will open a treed explorer window, instead of the standard folder window.
History (see also lsxcommand.txt, section II.5 Tab-MicroComplete and Context Menu Access).
CommandHistoryFileSpecifies the file lsxcommand stores its history in. Defaults to modules.ini.
CommandHistoryEntriesSets number of history entries of which to keep track. Note: I haven't really stress-tested LSXCommand, so I don't know how well it scales up, but it shouldn't be too taxing even at somewhere around 50 entries. But I think that's a bit much anyway...
CommandHistoryMenuEntriesSets the maximum number of history entries available from the context menu.
CommandClearHistoryOnStartupClears the history on startup. NOTE: You *will* lose the history in modules.ini - not only the history in memory.
CommandNewestHistoryItemsOnTopThis setting places newer history items at the top of the menu, instead of at the bottom.
CommandUnixHistoryThe most popular UNIX shell (bash) has the inverse history navigation: Up for previous, down for next. You can use this system with this setting.
CommandAddExternalsToHistoryIf this is on, LSXCommand will add any commands launched with the !Command !Bang command to the history. Since I've been using AlterScript with this a lot, it became annoying to have all of AlterScript's commands end up in LSXCommand's history.
Context menu
CommandContextMenuStandardItemsThis item does two things. It first turns on the standard menu items: Cut, Copy and Paste. Second, it tells where to put the standard items, above or below the LSXCommand specific menus. Example: CommandContextMenuStandardItems 1 ; Above CommandContextMenuStandardItems 2 ; Below CommandContextMenuStandardItems 0 ; Off (Default)
CommandContextMenuAboveBoxIf you have your LSXCommand window at the bottom of the screen, you will want to turn this on. If at the top, leave this off. This sets where the context menu will appear - above or below the LSXCommand box.
CommandContextMenuExecuteTells LSXCommand to execute a selection from the context menu instead of copying its data to the LSXCommand box. NOTE: Since the point of search engines is to have you enter a search phrase, it is not possible to have search engines execute.
CommandContextMenuOrderSpecifies which order each submenu should appear. For instance, you can have History, Alias, then Search Engines or Alias, History, Search Engines, or... The setting is 3 numbers: 0, 1, and 2. The combination of these numbers sets in which order each submenu appears. The first number is the position of the History submenu. The second is the Alias submenu. And the last is the Search Engines submenu.
CommandOn settings
CommandNoWarnOnErrorIf there is an error (for instance, if the command you entered is invalid or the calculator couldn't evaluate the expression you entered), you will get an error message. This, when turned on, will suppress it.
CommandHideOnCommand Hides lsxcommand when a command is issued.
CommandSelectAllOnFocusSelects everything in the command box on focus.
CommandSelectAllOnMouseFocusJust like CommandSelectAllOnFocus, just that it only works when clicking to focus LSXCommand. The reason these are two separate options is for people like me: I like to be able to just click once to put the cursor where I want it -not select the entire command. But, some people like the explorer way of doing things better, so I added it.
CommandHideOnUnfocusHides LSXCommand when it loses keyboard focus. This can be used to hide LSXCommand after it runs an app.
CommandNoClearOnCommandwont clear the input after you hit enter
CommandClearOnHideclear the text when mod is hidden
Clock
CommandTimeFormat string that tells LSXCommand how you want your time and date to look.(see lsxcommand.txt, section II.8 Clock Settings).
CommandClockDisappearsOnFocusIf you want the clock to automatically disappear when you click in LSXCommand, set this on. Otherwise, the clock will "pause" at the current time/date. This makes it easier for you to copy/paste the time and date into any app.
Winamp
CommandScrollWinAmpTitleIf on, this setting takes WinAmp's scrolling title and displays it in LSXCommand. Note that WinAmp's scroll song title preference must be on for this to happen. A neat trick with this is to have both a clock and a WinAmp scroller. The WinAmp scroller will show when WinAmp is running. If not, the clock will show.
CommandWinAmpDisappearsOnFocusJust like CommandClockDisappearsOnFocus, but for the WinAmp scrolling feature.
CommandMusicPlayerThis command enables LSXCommand to use the titles of other music players besides WinAmp. You should set it to the class name of the application you are looking for.
CommandTab settings
CommandNoTabMicroCompleteStops Tab-MicroCompletes (see also lsxcommand.txt, section II.5 Tab-MicroComplete and Context Menu Access) from taking place. When you are typing in LSXCommand and get an autocompletion, you may want to automatically go on to the next word.
CommandTabFileCompleteEnables the completion of file names by using the tab key (see also lsxcommand.txt, section II.9 Tab File Completion)..
CommandNoAutoCompleteTurns *off* AutoComplete. Someone asked for it, so I coded it :).
CommandCommaDelimiterSome Eurpoean countries use commas as decimal delimiters, so this changes decimals from periods to commas.
CommandRPNCalculatorMakes the calculator an RPN calculator. If you don't know what this is, don't use it! You'll only confuse yourself. Others call RPN "Postfix" notation. If you want to learn more, obtain a Hewlett-Packard RPN calculator (the 48/49 series are especially nice, IMO :).
CommandSearchEngineListThe path to your engines.list (see also lsxcommand.txt, section II.4 The engines.list File). - the list of search engines to use with LSXCommand.
CommandSearchEngineBrowserPath to the browser to be used with search engines. If not specified, LSXCommand uses the default browser on your system.
CommandOn actions
CommandOnFocusWill execute a command when you !FocusCommand
CommandOnUnfocus Will execute a command when you un-focus lsxcommand (get out of the edit box)

Bang commands:

!ToggleCommandToggle lsxcommand visibility.
!FocusCommandSet focus to command (nice for binding to hotkeys).
!CommandRescanEnginesRescans the engines.list file. Note: it does not load a new engines.list file if specified in the step.rc; it will attempt to reload the same engines.list file.
!CommandClearHistoryClears both the history in memory *and* the history in modules.ini
!CommandShowContextMenuMakes LSXCommand's Context Menu visible wherever the cursor is on the screen, regardless of LSXCommand's visibility.
!CommandNow use the power of LSXCommand anywhere within Litestep! Shortcuts, wharf items, whatever that can run !bang commands outside of its own can now use LSXCommand.
!CommandShowJust shows LSXCommand. NOTE: It does *not* give LSXCommand focus. To do this, use !FocusCommand - this command gives focus to LSXCommand, and if it's not visible, it shows it also.
!CommandHideJust hides LSXCommand. Nothing really special.
!CommandBrowseFileBrings up an Open Dialog Box to browse for a file for LSXCommand to open. It's just the same as typing in the file's name. NOTE: You can send an argument to this !Bang command to specify the filter for the open box. For instance, to see just Text Files, you might do this: !CommandBrowseFile All Text Files (*.txt, *.ini)|*.txt;*.ini
!CommandBrowseFolderBrings up a folder selection dialog. You can select a folder to browse to. There are no arguments for this !Bang command.
!CommandMoveMoves the LSXCommand window either to an absolute position, or by a delta along each axis. The horizontal and vertical values can be configured separately (you can mix absolute and delta values). If the horizontal or vertical values are surrounded by parentheses, they are interpreted as absolute values. Otherwise, they are interpreted as +/- deltas along their respective axis. If there is only one parameter, it is interpreted as a horizontal value. !CommandMove 0 100 ; moves it 100 pixels down When !CommandMove is called without parameters, it moves to the current mouse cursor position. If !CommandMove is called with "home" as its parameter, it moves back to the original position it received from step.rc
!CommandToggleTimerToggles the current timer. If you use this, the WinAmp timer no longer takes precedence over the clock. You have to call this !Bang again for the WinAmp scroller to appear.
!CommandSetTextThis !Bang sets the text in LSXCommand to its arguments. This makes for some really neat stuff (for instance, a shortcut that pops up LSXCommand with a question mark and a space already in it ready for an argument to search with). Note that this !Bang command does not show LSXCommand if it is hidden. Example: !SetText "?Altavista "
!CommandBoxHookThis is used with lsbox: *ModuleHook !CommandBoxHook Please, check LsBox documentation
About lsxcommand.dll v1.8.4:
Author contact informations:
Name: Visigoth
E-mail:sgandhi__AT__andrew__DOT__cmu__DOT__edu
Project homepage: http://home.att.net/~gandhimail/
valid-html401