The TSC pop-up library gives LabVIEW developers the ability to create customized, beautiful pop-up dialogs to users to give instructions, warnings, or to get their attention!
Standard
image pop-ups provide a consistent size and set of selected images
PNG
image pop-ups allow for developer to define a custom image to load while running and give the ability to customize placement of image and size of message text box
Plain
simple dialog for one, two, or three button message with a defined Title
See Example VIs for usage of a few of the different types of pop ups.
In general, each included pop-up library type has the following options:
- One Button - dialog box with a single button option
Note: the typical toggle action is RETURN will trigger the single or Y button and ESC will toggle the N button
The message text can be formatted with the following HTML-style tags:
<b>bold</b>
= bold
<i>italic</i>
= itallic
<strong>Strong</strong>
= strong
<del>strike</del>
= strike
<em>emphasis</em>
= emphasis
<ins>underline</ins>
= underline
<font rgb(0, 0, 255)><b>blue</b></font> other text
= blue other text
<font rgb(0, 255, 0)>green</font>
= green
<font rgb(255, 0, 0)>red</font>
= red
Note: And tags can be nested as well, but internal tag must be closed before closing the outer tag.
The pop-up library allows you to define a theme for the coloration of the pop ups in an application. Open the theme definer by going to:
Tools->TSC->Theme Definer UI...
Edit and save the theme for use in LabVIEW with download button or Ctrl+S
. For the application, the data is saved in a flattened XML file using a LabVIEW class.
Choose the color scheme and see a live preview with the standard hourglass
image applied for reference on how the theme will appear when applied. Once completed, save the theme (*.style) file for use in your development. This theme can be loaded in program initialization
by calling Theme.lvclass:Load Theme.vi
.
For the standard pop-ups, the Graphics input is a type definition combo box but it allows for undefined inputs. Because it is a string, the name of the standard image that has been added can be defined as an input to any of the standard types as long as the following rules are adhered to:
-
Image Dimensions are
Height = 264px
andWidth = 420px
with a recommendation for whitespace around the image border so that no portion is cut off. -
The image must be a
PNG
orJPEG
file. -
Modify the VI
Pop-Up.lvlib:Popup.lvclass:Convert Enum to Image.vi
and add a new case.
Note: In original design, this VI would open from the file, but it is a much faster process to keep it standardized and hardcode the constant for the
image data
into the case structure
As long as these rules are followed, developers can extend the standard library of pop-up images. If any images should be considered for addition to the library as a standard selection, add them to the Issues page.
To create an additional pop-up type, create a new class and choose PopUp.lvclass as the parent. The required override method is called Display.vi
- it is a protected method meaning that it cannot be called from within a VI outside of the class hierarchy. This means that an accessor VI or constructor of some sort must be created to launch the dialog.
The front panel of the dialog should be designed to mimic how the desired behavior should be for the application. Setting up a pop-up in this manner allows the developer to use any functionality built into the class to apply a theme, set up the message, and pass the information into the Display.vi
override.