ISelectionManager.FrameOffset (PROP) ¶ PROPERTY FrameOffset : INT
ISelectionManager.ResetSelection (METH) ¶ METHOD ResetSelection : DWORD Resets the currently selection InOut: Scope Name Type Comment Return ResetSelection DWORD Input pClientData POINTER TO VisuStructClientData the client, where the selection should be reset
IVisuUserEventManager (ITF) ¶ INTERFACE IVisuUserEventManager This interface declared the methods that are publically available in the visu user manager. This interface might be extended in the future so it should not be implemented by customer components! Methods: SetCustomEventHandler SetEditBoxEventHandler SetGestureEventHandler SetInputOnElementEventHandler SetKeyEventHandler SetMouseEventHandler SetSpecialEventHandler SetUserMgmtEventHandler Structure: SetCustomEventHandler (Method) SetEditBoxEventHandler (Method) SetGestureEventHandler (Method) SetInputOnElementEventHandler (Method) SetKeyEventHandler (Method) SetMouseEventHandler (Method) SetSpecialEventHandler (Method) SetUserMgmtEventHandler (Method)
IVisuUserEventManager.SetCustomEventHandler (METH) ¶ METHOD SetCustomEventHandler : BOOL This method assigns the eventhandler for custom events. InOut: Scope Name Type Comment Return SetCustomEventHandler BOOL TRUE - When there was no previous handler, i.e. the handler was registered successfully FALSE - When there was a previous event handler. Input itfCustomEventHandler ICustomEventHandler
IVisuUserEventManager.SetEditBoxEventHandler (METH) ¶ METHOD SetEditBoxEventHandler : BOOL This method assigns the eventhandler for catching write events using the edit control. You must only assign one handler here because later calls to this method will overwrite the previous event handler. The method will return <c>TRUE</c> when there was no previous handler, and <c>FALSE</c> when there was a previous event handler. InOut: Scope Name Type Return SetEditBoxEventHandler BOOL Input handler IEditBoxInputHandler
IVisuStreamReader (ITF) ¶ INTERFACE IVisuStreamReader EXTENDS IVisuStreamHandler Implementors of this interface can be configured in the input action “File Transfer” in case of streaming data from the plc to the visualization Methods: Read EndOperation , inherited from IVisuStreamHandler StartOperation , inherited from IVisuStreamHandler Structure: Read (Method)
IVisuStreamReader.Read (METH) ¶ METHOD Read : SysTypes.RTS_IEC_RESULT This method can be implemented for reading data from a stream like object. The return value can either be: ERR_OK: reading succeeded, udiNrBytes is > 0 ERR_PENDING: reading is temporarily not possible, udiNrBytes = 0 Any other error code: reading failed, reason see error code, udiNrBytes = 0 InOut: Scope Name Type Comment Return Read SysTypes.RTS_IEC_RESULT Input pbyBuffer POINTER TO BYTE A buffer where the data should be written to by the callee. The callee must always write the this buffer starting at offset 0. udiMaxNrBytes UDINT The maximal number of bytes that should be written to pbyBuffer by the callee. Output udiNrBytes UDINT The number of bytes that were read by the callee. A value of 0 signals that the end of the stream was reached or that an error happened. The according decision between error or end of stream is made by evaluating the return value.
IVisuStreamSetFileName (ITF) ¶ INTERFACE IVisuStreamSetFileName This interface can be optionally implemented by implementors of IVisuStreamWriter when the plc filename should be set. Properties: FileName Structure: FileName (Property)
IVisuStreamSetFileName.FileName (PROP) ¶ PROPERTY FileName : STRING This property will be called to set the file name which comes from the visu client
IVisuStreamWriter (ITF) ¶ INTERFACE IVisuStreamWriter EXTENDS IVisuStreamHandler Implementors of this interface can be configured in the input action “File Transfer” in case of streaming data from the visualization to the plc Methods: Write EndOperation , inherited from IVisuStreamHandler StartOperation , inherited from IVisuStreamHandler Structure: Write (Method)