User Notification
 
Properties
Methods
 

Properties

AppName
Values:
string
Description:
A string that contains the name of an executable that is used to get an icon for the dialog at notification time when using the Set method or that is to be executed when using the RunAppAtTime Method.
DateTime
Values:
variant
Description:
Any variant that can be converted to a date and time.
Dialog
Values:
True|False
Description:
Determines whether a dialog box should be displayed at notification time.
DialogText
Values:
string
Description:
The text for the dialog to display.
DialogTitle
Values:
string
Description:
The title for the dialog to display.
LED
Values:
True|False
Description:
Determines whether the LED will flash on the Windows CE machine.
Left
Values:
integer
Description:
Pixels from the left edge of the output window to left edge of ActiveX control.GetUserPreferences method uses this to determine where to display the dialog. It will try to center the dialog on top of the control.
Repeat
Values:
True|False
Description:
Repeat playing the SoundFile for 10-15 seconds if Sound=True.
Sound
Values:
True|False
Description:
Determines whether to play a sound at notification time.
SoundFile
Values:
string
Description:
The name of the .wav file to play. If you are using GetUserPreferences method this should be the name a the .wav file only, not the path, name, and extension.
Tag
Values:
variant
Description:
User defined.
Top
Values:
integer
Description:
Pixels from top edge of output window to top edge of ActiveX control.GetUserPreferences method uses this to determine where to display the dialog. It will try to center the dialog on top of the control.
Version
Values:
integer
Description:
Returns the version of the S309UserNotification. (I.E. 104) (Read Only)
VersionMajor
Values:
integer
Description:
Returns the major version of the S309UserNotification. (Read Only)
VersionMinor
Values:
integer
Description:
Returns the minor version of the S309UserNotification. (Read Only)
Vibrate
Values:
True|False
Description:
Determines whether to vibrate the Windows CE machine at notification time.

Methods

AboutBox
Parameter(s):
Return Value:
 
Description:
Displays the About Box for this ActiveX control.
Clear
Parameter(s):
The handle returned from the Set method.
Return Value:
True|False
Description:
Cancels the UserNotification specified by handle. Returns False if there were errors.
GetUserPreferences
Parameter(s):
Return Value:
True|False
Description:
Displays a dialog box allowing the user to specify preferences for sound, soundfile, repeat, dialogbox, and LED. If True is returned the user changed one or more options and the changes are reflected in the Properties for this control.
Handle
Parameter(s):
The AppName specified with the RunAppAtTime or Set methods.
Return Value:
True|False
Description:
This method will notify Windows CE that the program has handled the notification events and will turn off the task bar annunciator and flashing LED. (I have found that if I Dialog=False and use the Set method the LED does not stop flashing on some units). Returns False if there were errors.
RunAppAtTime
Parameter(s):
Return Value:
True|False
Description:
Will execute the program specified in the AppName property at the time specified in the DateTime property. Returns False if there were errors.
Set
Parameter(s):
0 for a new event or handle of event to modify.
Return Value:
handle
Description:
Will set or modify a User Notification. Returns 0 if there were errors.