LiteStep v. 0.24.6 documentation

written by the LiteStep Documentation Effort, August 2000
Changes.TXT

  .: introduction   .: configuration   .: installation   .: theme installation   .: theme creation   .: development   .: glossary   .: links  
  .: command   .: desktop   .: hotkey   .: litestep   .: lstime   .: popup   .: shortcut   .: systray   .: taskbar   .: vwm   .: wharf  

What does systray2.dll do?
The "system tray" is the name for the area in the right hand corner of the Windows Explorer taskbar containing the time. Some programs (such as many AntiVirus programs) place an icon in the system tray for easy access. Systray2.dll acts as a LiteStep alternative to the Explorer system tray, giving you access to any icons that your programs may place in the tray. Unlike the Explorer tray, the position, size, appearance, and behavior of Systray2.dll can all be customized. Click here to see a comparison of the explorer and systray2.dll system trays.
Step.RC Syntax for systray2.dll
Although Systray2.dll is based on earlier third party system tray modules, some commands and syntax have changed in the rewrite. Therefore, it is recommended that you read this document fully while configuring (or updating to) the core Systray2.dll from the older Systray.dll.
SystrayAlwaysOnTop [BOOL] The Systray will be placed above all other application windows and LiteStep Modules loaded before it.
SystrayHidden [BOOL] The Systray will be hidden both on startup and after a !Recycle.
SystrayHideIfEmpty [BOOL] The Systray will hide itself if there are no icons in it and will automatically unhide when an icon is placed in it again.
SystrayAutoSize [BOOL] When set to true, the Systray will automatically grow or shrink as icons are added or removed. When set to false, the Systray will remained a fixed size regardless of the number of icons in the tray.
SystrayX [X Co-ordinate] The horizontal co-ordinate of the Systray's screen position.

Default: 0.

SystrayY [Y Co-ordinate] The vertical co-ordinate of the Systray's screen position.

Default: 0.

SystrayWidth [WIDTH] Sets the width of the Systray, in pixels.

Default: 64 pixels.

Note: If SystrayAutoSize is specified, SystrayWidth will be ignored.

SystrayHeight [HEIGHT] Sets the height of the Systray, in pixels.

Default: 64 pixels.

Note: If SystrayAutoSize is specified, SystrayWidth will be ignored.

SystrayDirection [POSITION] This command specifies the direction in which the Systray will grow as icons are added to the tray. Accepted values are up, down, left or right.

Default: Right.

Note: SystrayAutoSize must be set to true for SystrayDirection to work.

SystrayWrapCount [NUMBER] This command specifies the number of icons to allow in the Systray before automatically creating another line for new icons. If set to a value of zero, the Systray will never wrap.

Default: 0.

SystrayWrapDirection [DIRECTION] This command specifies the direction in which a new row is formed after the SystrayWrapCount is reached. If SystrayDirection is set to left or right, accepted values for SystrayWrapDirection are up or down. If SystrayDirection is set to up or down, accepted values for SystrayWrapDirection are left or right.

Default: Down.

SystrayIconSpacingX [NUMBER] Specifies the horizontal distance between icons in the Systray, and also between icons and the border of the Systray. A small value is useful for pushing icons closer together and a larger value is useful for spacing icons out.

Default: 1.

SystrayIconSpacingY [NUMBER] Specifies the vertical distance between icons in the Systray, and also between icons and the border of the Systray. A small value is useful for pushing icons closer together and a larger value is useful for spacing icons out.

Default: 1.

SystrayBGColor [COLOR] Defines the background color for the Systray.

Default: #FFFFFF.

Note: SystrayBGColor will be ignored if SystrayBitmap is used.

SystrayBorderColor [COLOR] Defines the color of the Systray border.

Default: #FFFFFF.

Note: SystrayBorderColor will be ignored if SystrayBitmap is used.

SystrayBitmap [IMAGE.BMP] Defines the image to be used for the background of the Systray.
SystrayBitmapTiled [BOOL] When set to true, the SystrayBitmap will be tiled if it is smaller than the current size of the Systray. When set to false, the SystrayBitmap will be stretched if it is smaller than the current size of the Systray.
SystrayBorderSize [NUMBER] Defines a uniform border width for all sides of the Systray.

Default: 0 pixels.

Note: SystrayBorderSize will be ignored if SystrayBorderLeft, SystrayBorderRight, SystrayBorderTop, and SystrayBorderBottom are used.

SystrayBorderLeft [NUMBER] Defines the border width in pixels for the left side of the Systray.

Default: 0 pixels.

SystrayBorderRight [NUMBER] Defines the border width in pixels for the right side of the Systray.

Default: 0 pixels.

SystrayBorderTop [NUMBER] Defines the border width in pixels for the top side of the Systray.

Default: 0 pixels.

SystrayBorderBottom [NUMBER] Defines the border width in pixels for the bottom side of the Systray.

Default: 0 pixels.

SystrayBorderDrag [BOOL] When set to true, the Systray can be dragged by clicking and holding on the border of the Systray. When set to false, the Systray remains fixed and cannot be dragged.
SystraySnap [BOOL] The Systray will position itself directly against the edge of the screen when dragged there.
SystraySnapDistance [NUMBER] If the Systray is placed within this distance from the screen edge, the Systray will snap to the edge automatically.

Default: 10 pixels.

Note: This command will only work is SystraySnap is set to true.

!Bang Commands for systray2.dll
!SystrayShow Tells the Systray to become visible if it was hidden.
!SystrayHide Tells the Systray to become hidden if it was visible.
!SystrayToggle Toggles the Systray between visible and hidden states depending on its current state.
!SystrayOnTop Toggles the OnTop property of the Systray.
!SystrayMove [X Co-ordinate] [Y Co-ordinate] Positions the Systray so that its top left corner is placed at the specified X and Y Co-ordinates.
!SystraySize [WIDTH] [HEIGHT] Resizes the Systray to the specified width and height.