PopupNotify Action Plugin Help
Warmuskerken Consulting (http://www.warmuskerken.com)

table PopupNotify.GetClickInfo()

Returns a table with the current information on the last left mouse button click.

Example:
tblPNClick = PopupNotify.GetClickInfo()
if tblPNClick then
     Dialog.Message("Area Clicked", "The area clicked was: " .. tblPNClick.Area);
end


table
PopupNotify.GetScreenXY(number nX, number nY)

Returns a table of the Screen X, Y coordinates from the given application X, Y coordinate

Example:
tblPos = Input.GetPos("Input1")
tblSize = Input.GetSize("Input1")
tblScreenPos = PopupNotify,GetScreenXY(tblPos.X, tblPos.Y)
PopupNotify.ShowStatic(tblScreenPos.X, tblScreenPos.Y + tblSize.Height)

 

PopupNotify.Hide()

Hides the current popup notification window.

Example:
PopupNotify.Hide();

 

PopupNotify.SetBackGroundImage(string sFilename, color nMaskColor)

Sets the background image to be used and the color to set to transparent

Example:
PopupNotify.SetBackGroundImage("Autoplay\\Images\\popup.bmp", 16711935);

 

PopupNotify.SetCaption(string sCaption, string sFont, number nFontSize, color nFontColor, boolean bBold, boolean bItalic, boolean bMultiLine)

Sets the caption text area to a string, using the specified font and characteristics

Example:
PopupNotify.SetCaption("This is the Caption", "Arial", 90, 0, true, false, false);

 

PopupNotify.SetCaptionRect(number nLeft, number nTop, number nRight, number nBottom)

Defines the rectangular area to display the caption in.  The two points defined are the upper left corner, and the bottom right corner.

Example:
PopupNotify.SetCaptionRect(25,10,200,25);

 

PopupNotify.SetClickToClose(boolean bClickToClose, boolean bAnywhere, boolean bTextArea1, boolean bTextArea2, boolean bTextArea3, boolean bTextArea4)

Sets the values on whether clicking the dialog will hide/close it.  bClickToClose must be true to have the dialog be closable by a click.  Setting the individual areas to true will close the dialog when the area is clicked.

Example:
--Set click to close true, but only on Text Area 2
PopupNotify.SetClickToClose(true, false, false, true, false, false);

 

PopupNotify.SetText1(string sText, string sFont, number nFontSize, color nFontColor, boolean bBold, boolean bItalic, boolean bActive, boolean bActiveBold, boolean bActiveItalic, color nActiveFontColor, boolean bMultiLine)

Sets the text in text area 1 using the specified font and font characteristics.  If the areas active value is true, the text will take on the active font characteristics when the mouse is over the rectangular region defined in SetText1Rect.

Example:
--Set text area 1's text, using the font Arial sized at 90.  Use magenta as the normal color
--the font will be bold and italic.  Since bActive is true, the font will become only italic and black
-- when the pointer is hovering.  Multiline is false, so the text will be centered in the rectangle
-- both vertically and horizontally.
PopupNotify.SetText1("This is Text Area 1", "Arial", 90, 6723891, true, true, true, false, true, 0, false)

Note:
The above also applies for SetText2, SetText3, and SetText4

 

PopupNotify.SetText1Rect(number nLeft, number nTop, number nRight, number nBottom)

Defines the rectangular area to display the text in.  The two points defined are the upper left corner, and the bottom right corner.

Example:
PopupNotify.SetText1Rect(25,50,200,100);

Note:
The above also applies for SetText2Rect, SetText3Rect, and SetText4Rect

 

PopupNotify.SetOffset(number nX, number nY)

Sets the offset on the X and Y axis.  The values will move the dialog the corresponding pixels from the screens edge, or the taskbars edge.

Example:
PopupNotify.SetOffset(100, 50);



number PopupNotify.Show(number nDelay, number nSpeed, boolean bModal)

Shows the dialog. 
nDelay is the time in milliseconds to show the dialog (-1 will show the dialog until it is close manually)
nSpeed is a value between 1 and 5, 5 being the fastest
bModal determines whether the dialog must be closed before the main app can will continue processing.

Example:
PopupNotify.Show(-1,5, false);


number PopupNotify.ShowStatic(number nX, number nY)

Shows the dialog without animation at the given X/Y coordinate.  The dialog will be modal always be displayed modally
Example:
tblPos = Input.GetPos("Input1")
tblSize = Input.GetSize("Input1")
tblScreenPos = PopupNotify,GetScreenXY(tblPos.X, tblPos.Y)
PopupNotify.ShowStatic(tblScreenPos.X, tblScreenPos.Y + tblSize.Height)