SMTPit_StatusWindow

Description

Use this function to show a status window that displays information about what the plug-in is currently doing. When you are sending an email, the status window will show you what part of the email it is currently sending as well as a progress bar indicating how much of that part it has completed. Default placement of the status window is the center of the screen.

If you want to specify a starting location for the status window, specify the coordinates of the left and top of the dialog in pixels. If you wanted to display it in the top right hand corner of your screen, and your screen resolution is set to 800x600, you could specify left as "700" and top as "100". If you specify a negative one ("-1") as either the x (across) or y (down) coordinates, the status window will be centered on that axis. For instance, if you want to display it on the bottom of your screen in the center, you would specify left as "-1" and top as "600"; or in the center of the screen by specifying left as "-1" and top as "-1".

You can move the Status Window by using "Move" for the Action parameter and the location in pixels that you would like to move it to.

If you need to know if the Status Window is shown or hidden, use "State" as the "Action" parameter. This will return the state as well as the current location of the Status Window.

Return Type

Text

Format

SMTPit_StatusWindow ( Action ; Left ; Top ; WindowTitle )

Required Parameters

• Action
  

  The action for the Status Window. (Specify "Show", "Hide", "State", or "Move".)

Optional Parameters

• Left
  

  The horizontal screen coordinate for the Status Window. (Use -1 to Center on this axis.)

• Top
  

  The vertical screen coordinate for the Status Window. (Use -1 to Center on this axis.)

• WindowTitle
  

  A Custom Title for the Status Window. (Only valid with the "Show" action.)

Examples

Example 1

Code:

SMTPit_StatusWindow("Show")

Result:

Displays the status window in the center of the screen.

Example 2

Code:

SMTPit_StatusWindow("Show"; 700 ; 100 )

Result:

Opens the status window 700 pixels from the left, and 100 pixels from the top.

Example 3

Code:

SMTPit_StatusWindow("Show";-1 ; 600 )

Result:

Opens the status window 600 pixels from the top, and centers it from left to right on the screen.

Example 4

Code:

SMTPit_StatusWindow("Move"; 100 ; 100 )

Result:

Moves the status window 100 pixels from the top, and 100 pixels from left of the screen.

Example 5

Code:

SMTPit_StatusWindow("Hide")

Result:

Hides the status window.

Example 6

Code:

SMTPit_StatusWindow("State")

Result:

Returns the state the Status Window as either shown or hidden, and the current location of the Status Window.