ClientUI Class

Namespace: T.Modules.ClientStation
Assembly: T.Kernel.Tags (in T.Kernel.Tags.dll)
Class for ClientUI properties.
VB
C#
F#
C++
JScript
Copy 
Public Class ClientUI
This language is not supported or no code example is available.
VB
C#
F#
C++
JScript
Copy 
public class ClientUI
This language is not supported or no code example is available.
Constructors
 
Name Description
Public constructor ClientUI(RunObj, int) Construct the instance
Top
Properties
 
Name Description
Public property AutoScaleMargin Margin to be used in AutoScale of TTrendChart and TDrillingChart controls. Default is 2
Public property BackPage Toggles to back page.
Public property BlinkFast Gets the client's blink fast property. The blink fast property is a digital variable that toggles from 0 to 1 and from 1 to 0, remaining 500 msec in each state.
Public property BlinkSlow Gets the client's blink slow property. The blink slow property is a digital variable that toggles from 0 to 1 and from 1 to 0, remaining 250 msec in each state.
Public property CurrentPage Gets the name of the client's page currently displayed.
Public property DisplayValueMode Gets the current display value mode.
Public property HistorianDateTime Gets current historian date time
Public property HistoryPages String array containg open pages. Max = 10 pages.
Public property HistoryPagesIndex Current index of HistoryPage.
Public property LayoutName Gets the client's layout name.
Public property NextPage Toggles to next page.
Public property ObjectSelectedMethod Full ObjectSelectedMethod method name in "Script.Class" with Client domain. Ex: Script.Class.ClientMain.MyObjectSelectedMethod. Prototype: public void ObjectSelectedMethod(string[] tagList).
Public property PageClosingMethod Full PageClosingMethod method name in "Script.Class" with Client domain. Ex: Script.Class.ClientMain.MyPageClosingMethod. Prototype: public void PageClosingMethod(TDisplay display).
Public property PageOpeningMethod Full PageOpeningMethod method name in "Script.Class" with Client domain. Ex: Script.Class.ClientMain.MyPageOpeningMethod. Prototype: public void PageOpeningMethod(TDisplay display).
Public property PreviousLayout Gets the client's previous layout name.
Public property PreviousPage Gets the client's previous page name.
Public property RunAlwaysOnTop Flag to indicate to run always on top.
Public property Simulation Gets and sets the client's simulation state.
Public property SimulationAnalog Gets the analog int simulation variable, which varies from 0 to 100 (in steps of 1); returns to 0 in one step and then repeats the same pattern (sawtooth waveform).
Public property SimulationDigital Gets the digital simulation variable, which toggles from 0 to 1 and from 1 to 0, remaining 3 seconds in each state.
Public property SimulationDouble Gets the analog double simulation variable, which varies in steps from 0 to 100; returns in steps from 100 to 0, then repeats the same pattern.
Public property TooltipInitialShowDelay Gets or sets the time in ms that passes before the ToolTip appears.
Public property TooltipOptions Tooltip options to be displayed when mouse is over control
Public property Uid Gets the Uid information
Public property ValueOutOfRangeMethod Full ValueOutOfRangeMethod method name in "Script.Class" with Client domain. Ex: Script.Class.ClientMain.MyValueOutOfRangeMethod. Prototype: public bool ValueOutOfRangeMethod(string tagName, object min, object max, object value, Rect rect).
Top
Methods
 
Name Description
Public method AddDisplayInCacheList(string) Get string array with tag list of a display
Public method CloseDisplay(string) Begin close display
Public method GetCursorX() Gets the X cursor coordinates (WPF Only)
Public method GetCursorY() Gets the Y cursor coordinates (WPF Only).
Public method GetDisplayTagList(string, bool) Get string array with tag list of a display
Public method IsDisplayOpen(string) Check if display is open
Public method IsDisplayOpeningExecuted(string) Check if DisplayOpening method already executed
Public method NewPopup(string, params object[]) Begin open new popup. If display is already open then a new instance will be open
Public method OpenDisplay(string, params object[]) Open display with optional parameters
Public method OpenDisplayAtIndex(string, int) Begin open display at z-order list of displays. Current display is closed.
Public method OpenDisplayAtPanel(string, int) OpenDisplayAtPanel
Public method OpenLayout(string) Begin open layout
Public method OpenLayout(string, string) Begin open layout
Public method OpenPreviousPage() Open previous page
Public method OpenQuickNote(string, string, bool, double, double) Open quick popup note
Public method PrintDisplay(string, bool) Begin print display
Public method PrintDisplayDefaultPrinter(string, int) Begin print display using default printer
Public method PrintLayout() Begin print current layout
Public method PrintLayoutDefaultPrinter(int) Begin print current layout
Public method PrintScreenDefaultPrinter(int) Print desktop using default printer
Public method SaveDisplayAsImageFile(string, string) Save display to file. Display must be opened
Public method SaveDisplayAsPngFile(string, string) Save display to file. Display must be opened
Public method SaveLayoutAsImageFile(string) Sabe current layout to file
Public method SaveScreenAsImageFile(string) Save desktop to file
Public method SetDisplayValueToCurrent() Sets property DisplayValue of tags to display Value property
Public method SetDisplayValueToEstimated() Sets property DisplayValue of tags to display Estimated property
Public method SetDisplayValueToHistorian(DateTime) Sets property DisplayValue of tags with values in a specified date time
Public method SetMainWindowSize(double, double) Set main window size
Top
Enumerations
 
Name Description
Public enumeration e Enum containg list of IDs of runtime objects
Top
Inheritance Hierarchy
 
T.Modules.ClientStation.ClientUI
Applies to
 

.NET Framework

Supported in: 4.8
See Also
 

In this article

Definition