|
Using NA Global Variables With Objects And Methods
The following table shows which variables can be used on specific objects, including the relevant data types:
|
Category
|
Object Type
|
Global Variable - in properties
|
|
Buttons
|
Button
|
NO
|
|
Toggle Button
|
YES (Boolean)
|
|
Momentary Button
|
YES (Boolean)
|
|
Reset Button
|
YES (Boolean)
|
|
Set Button
|
YES (Boolean)
|
|
Lamps
|
Bit Lamp
|
YES - Expression (must equate to a Boolean value)
|
|
Data Lamp
|
YES - Expression (must equate to a numeric value)
|
|
Shapes
|
Line
|
NO
|
|
Curve
|
NO
|
|
Ellipse
|
NO
|
|
Triangle
|
NO
|
|
Rectangle
|
NO
|
|
Polyline
|
NO
|
|
Polygon
|
NO
|
|
Standard Controls
|
Label
|
NO
|
|
Textbox
|
NO
|
|
Date/Time
|
YES (DateTime)
|
|
Data Display
|
YES (All)
|
|
Data Edit
|
YES (All)
|
|
Image
|
NO
|
|
Checkbox
|
YES (Boolean)
|
|
Radio Button
|
YES ( Short, Integer, Long, Ushort, Uinteger, Ulong, Single, Double, Decimal)
|
|
Slider
|
YES ( Short, Integer, Long, Ushort, Uinteger, Ulong, Single, Double, Decimal)
|
|
Dropdown
|
YES ( Short, Integer, Long, Ushort, Uinteger, Ulong, Single, Double, Decimal)
|
|
Listbox
|
YES (Short, Integer, Long, Ushort, Uinteger, Ulong, Single, Double, Decimal)
|
|
Gauges
|
Linear Gauge
|
YES ( Short, Integer, Long, Ushort, Uinteger, Ulong, Single, Double, Decimal)
|
|
Rotational Gauge
|
YES ( Short, Integer, Long, Ushort, Uinteger, Ulong, Single, Double, Decimal)
|
|
HMI Controls
|
Trend Graph
|
YES (analogue and digital traces)
|
|
User Alarms Viewer
|
NO
|
|
Recipe Viewer
|
NO
|
|
Media Player
|
NO
|
The Following table shows the list of Actions where the user can use Global Variables:
|
Category
|
Actions
|
Global Variable
|
|
User administration
|
Login
|
NO
|
|
Logout
|
NO
|
|
Pages
|
ShowPage
|
YES (String)
|
|
ClosePage
|
Yes (String)
|
|
ShowPreviousPage
|
NO
|
|
ShowSystemMenu
|
NO
|
|
Variables
|
InvertVariable
|
YES (Boolean)
|
|
IncreaseVariable
|
YES(Numeric)
|
|
DecreaseVariable
|
YES(Numeric)
|
|
SetVariable
|
YES (Any)
|
|
ResetVariable
|
YES (Any)
|
|
User Alarms
|
ClearUserAlarmLog
|
NO
|
|
SaveUserAlarmLogToFile
|
YES(String)
|
|
Data Logging
|
StartDataLogging
|
YES(String)
|
|
StopDataLogging
|
YES(String)
|
|
Document Viewers
|
ShowDocument
|
YES(String)
|
|
ShowDocument
|
YES(String)
|
|
Dimming
|
SetBrightness
|
YES(Integer)
|
|
Multi-Language
|
SetLanguage
|
YES(String)
|
|
External Storage
|
EjectSDMemory
|
NO
|
|
User operation
|
EnableTouchScreenInput
|
Yes (Boolean)
|
|
General
|
CallSubroutine
|
NO
|
The Following table shows the list of Actions (Code Functions) where the user can use Global Variables:
|
Category
|
Actions ( Script functions )
|
Global Variable
|
|
User Administration
|
Login
|
NO
|
|
Login
|
YES (String)
|
|
Logout
|
YES (String)
|
|
GetCurrentUserName
|
NO
|
|
GetCurrentUserPassword
|
NO
|
|
GetCurrentUserRole
|
NO
|
|
Pages
|
ShowPage
|
YES (String)
|
|
ClosePage
|
YES (String)
|
|
ShowPreviousPage
|
NO
|
|
ShowSystemMenu
|
NO
|
|
Variables
|
InvertVariable
|
YES (Boolean)
|
|
IncreaseVariable
|
YES(Numeric)
|
|
DecreaseVariable
|
YES(Numeric)
|
|
SetVariable
|
YES (Any)
|
|
ResetVariable
|
YES (Any)
|
|
EditVariable(value)
|
YES (String)
|
|
User Alarms
|
AcknowledgeUserAlarm
|
NO
|
|
AcknowledgeLatestUserAlarm
|
NO
|
|
AcknowledgeAllUserAlarms
|
NO
|
|
IsUserAlarmActive
|
NO?
|
|
IsUserAlarmRaised
|
NO?
|
|
ClearUserAlarmLog
|
NO
|
|
SaveUserAlarmLogToFile
|
YES (String)
|
|
ReadActiveUserAlarmInfo
|
YES (String)
|
|
ScrollAlarmViewerList
|
YES (String)
|
|
GetSelectedAlarm
|
YES (String)
|
|
GetAlarmInfo
|
NO
|
|
Data Logging
|
StartDataLogging
|
YES (String)
|
|
StartDataLogging
|
NO
|
|
StopDataLogging
|
YES (String)
|
|
StopDataLogging
|
NO
|
|
ClearDataLogBuffer
|
YES (String)
|
|
ClearDataLogBuffer
|
NO
|
|
ExportDataLogBuffer
|
YES (String)
|
|
Recipes
|
GetRecipeTemplates
|
NO?
|
|
GetRecipes
|
YES(String)
|
|
SaveRecipe
|
YES(String)
|
|
SaveRecipeAs
|
YES(String)
|
|
AddRecipe
|
YES(String)
|
|
DeleteRecipe
|
YES(String)
|
|
ImportRecipes
|
YES(String)
|
|
ReadRecipeFromController
|
YES(String)
|
|
WriteRecipeToController
|
YES(String)
|
|
GetRecipeIngredients
|
YES(String/Object)
|
|
SetRecipeIngredients
|
YES(String/Object)
|
|
GetRecipeIngredientValue
|
YES(String/Object)
|
|
SetRecipeIngredientValue
|
YES(String/object
|
|
GetSelectedRecipeTemplate
|
YES (String)
|
|
GetSelectedRecipe
|
YES (String)
|
|
Movie
|
OpenMovieFile
|
YES(String)
|
|
PlayMovie
|
YES(String)
|
|
StopMovie
|
YES(String)
|
|
PauseMovie
|
YES(String)
|
|
Trend Graph
|
ScrollTrendToStart
|
YES(String)
|
|
ScrollTrendToEnd
|
YES(String)
|
|
ScrollTrendForward
|
YES(String)
|
|
ScrollTrendBackward
|
YES(String)
|
|
ScrollTrendUp
|
YES(String)
|
|
ScrollTrendDown
|
YES(String)
|
|
ScrollTrendOverlayForward
|
YES (String/Integer)
|
|
ScrollTrendOverlayBackward
|
YES (String/Integer)
|
|
ZoomIntoTrend
|
YES (String/Integer)
|
|
ZoomOutofTrend
|
YES (String/Integer)
|
|
ShowTrendCursor
|
YES (String/Integer)
|
|
MoveTrendCursor
|
YES (String/Integer)
|
|
AddOverlayGraph
|
YES (String)
|
|
RemoveOverlayGraph
|
YES (String)
|
|
SetTrendDisplayMode
|
YES (String)
|
|
Multi-Language
|
SetLanguage
|
YES(String)
|
|
GetLanguage
|
YES(String)
|
|
GetResourceString
|
YES(String)
|
|
Date & Time
|
SetDateTime
|
YES(DateTime)
|
|
External storage
|
EjectSDMemory
|
NO
|
|
EjectUSBDevice
|
YES(String)
|
|
GetConnectedUSBDevices
|
YES (String/Integer)
|
|
User operation
|
EnableInputOperation
|
NO
|
|
Document Viewers
|
ShowDocument
|
YES(String)
|
|
ShowDocument
|
YES(String/Integer)
|
|
Others
|
StartApplication
|
YES(String/String)
|
See Also:
Introduction to the NA series HMI
Link:
http://www.myomron.com/index.php?action=kb&print=1615
|