Active picture manipulation functions
Functions are used for the active picture within the frame of which the script is implemented. Name of each function begins with the string %HI_... .
%HIX_ functions
Some %HI_ functions are also available in %HIX_ version. These functions are able to redirect the function executing to another picture (through the first two parameters).
Example: Function %HI_ClosePicture() is available in %HIX_ClosePictur (IN HBJ _picHBJ, IN INT _KInstance). %HI_ClosePicture closes picture in which it has been called. %HIX_ClosePicture closes picture defined by HOBJ (internal object identifier) and instance. Meaning of HOBJ and instance is the same as it is in the case of RPC CALL (parameters objIdent and instanceExpr).
If function %HIX_ is applied, the ESL script must be implemented for picture (it must be Active picture).
Types of functions:
- Active picture behaviour functions
- Functions for work with structures
- Popup menu manipulation functions
- HI menu manipulation functions
- Graph and Picture (displayer) manipulation functions
- Picture layers manipulation functions
- Picture history manipulation functions
- Other functions
The list of functions used for the work with the active picture
Active picture behaviour functions:
- %HI_CenterPicture
- %HI_ClosePicture, %HIX_ClosePicture
- %HI_EnableControls, %HIX_EnableControls
- %HI_EnableInOutVariables, %HIX_EnableInOutVariables
- %HI_EnablePicture, %HIX_EnablePicture
- %HI_GetBackColor
- %HI_GetBackColor2
- %HI_GetHistoryTime, %HIX_GetHistoryTime
- %HI_GetOwnerHBJ, %HIX_GetOwnerHBJ
- %HI_GetOwnerInstance, %HIX_GetOwnerInstance
- %HI_GetPaintEffects
- %HI_GetPictureConfigHeight, %HIX_GetPictureConfigHeight
- %HI_GetPictureConfigWidth, %HIX_GetPictureConfigWidth
- %HI_GetPictureScrollX, %HIX_GetPictureScrollX
- %HI_GetPictureScrollY, %HIX_GetPictureScrollY
- %HI_GetPictureScrollMaxX, %HIX_GetPictureScrollMaxX
- %HI_GetPictureScrollMaxY, %HIX_GetPictureScrollMaxY
- %HI_GetPicturePosX, %HIX_GetPicturePosX
- %HI_GetPicturePosY, %HIX_GetPicturePosY
- %HI_GetPictureSize, %HIX_GetPictureSize
- %HI_GetPictureWindowState
- %HI_GetPixelRGB
- %HI_GetSelfInstanceId
- %HI_HistoryEnd
- %HI_HistoryStart
- %HI_LockUpdate, %HIX_LockUpdate (without _refId)
- %HI_PicturePopUpMenuEnable, %HIX_PicturePopUpMenuEnable
- %HI_PrintWindow
- %HI_SetBackColor
- %HI_SetBackColor2
- %HI_SetCursorWait, %HIX_SetCursorWait
- %HI_SetDynamGraph
- %HI_SetHistoryTime
- %HI_SetLayoutManagement
- %HI_SetLocVarStText
- %HI_SetMinPictureSize, %HIX_SetMinPictureSize
- %HI_SetPaintEffects
- %HI_SetPictureBorderColor
- %HI_SetPictureDefaultButton
- %HI_SetPictureEscapeButton
- %HI_SetPictureHelp, %HIX_SetPictureHelp
- %HI_SetPicturePos, %HIX_SetPicturePos
- %HI_SetPictureScroll, %HIX_SetPictureScroll
- %HI_SetPictureSize, %HIX_SetPictureSize
- %HI_SetPictureTitle, %HIX_SetPictureTitle
- %HI_SetPictureWindowState
- %HI_TimerEnable, %HIX_TimerEnable
- %HI_VisiblePicture, %HIX_VisiblePicture
Functions for work with structures, whose values are partially-distributed into the picture (optimization by means of indexed local variable). The partial distribution allows to reduce the set of updated rows (values of the rows) of structured variable and, in some cases, to reduce new values (sending according the alteration method).
- %HI_CloseRow
- %HI_From_Clipboard
- %HI_Get_Clipboard_Cols
- %HI_Get_Clipboard_Rows
- %HI_ChangeRow
- %HI_OpenRow
- %HI_To_Clipboard
- %HI_Value_To_Clipboard
Popup menu manipulation functions:
HI menu manipulation functions:
- %HI_Menu_AddItem
- %HI_Menu_AddObject
- %HI_Menu_ApplyChanges
- %HI_Menu_Create
- %HI_Menu_Delete
- %HI_Menu_DeleteItem
- %HI_Menu_DeleteObject
- %HI_Menu_EnableItem
Graph and Picture/Componet (displayer) manipulation functions:
- HI_SetEnableGraphButtons%HI_SetModeCtrl, %HIX_SetModeCtrl
- %HI_SetModeMove, %HIX_SetModeMove
- %HI_SetModeZoom, %HIX_SetModeZoom
- %HI_SetVisibleGraphControls
Picture/Componet layers manipulation functions:
- %HI_GetCurrLayer, %HIX_GetCurrLayer
- %HI_GetCurrZoomX, %HIX_GetCurrZoomX
- %HI_GetCurrZoomY, %HIX_GetCurrZoomY
- %HI_LayersParams, %HIX_LayersParams
- %HI_SetCurrLayer, %HIX_SetCurrLayer
- %HI_SetCurrLayerIgnoreZoom, %HIX_SetCurrLayerIgnoreZoom
- %HI_SetZoom, %HIX_SetZoom
Picture/Componet history manipulation functions:
- %HI_HistoryStart, %HIX_HistoryStart
- %HI_HistoryEnd, %HIX_HistoryEnd
- %HI_GetHistoryTime, %HIX_GetHistoryTime
- %HI_SetHistoryTime, %HIX_SetHistoryTime
Other functions:
- %HI_Beep
- %HI_CaptureToFile
- %HI_CopySysColorPage
- %HI_EnableHI
- %HI_FileDialog
- %HI_DisableHIHotKeys
- %HI_GetConnectToKernelStatus
- %HI_GetHIHWND
- %HI_GetHiSizeX
- %HI_GetHiSizeY
- %HI_GetMonitorSizeX
- %HI_GetPalRGB
- %HI_GetUserObjName
- %HI_GetUserRFID
- %HI_LNG_GetCurrLngIdx
- %HI_LNG_Translate
- %HI_LogOut
- %HI_MAPI_SendMail
- %HI_NavHistoryGetInitialState
- %HI_NavHistoryPushState
- %HI_NavHistoryReplaceState
- %HI_OpenDynamGraph
- %HI_OpenLogDBByMask
- %HI_OpenLogDBForObject
- %HI_RegKeyHandler
- %HI_RemapBMP
- %HI_RemapColorPal
- %HI_SelectDir
- %HI_SelectTimeDialog
- %HI_SetTitleHI
- %HI_ShowHelp
- %HI_To_String
- %HI_UnRegKeyHandler
All functions are executed in picture in which they are called. E.g. calling the function %HI_ClosePicture() closes picture in which the calling has been done.
Related pages: