ClientContext Class

Class for ClientContext operation.
Public Class ClientContext
This language is not supported or no code example is available.
public class ClientContext
This language is not supported or no code example is available.
Name Description
Public constructor ClientContext(RunObj, int) Construct the instance
Top
Name Description
Public property AreaId Gets the selected AreaId
Public property AreaName Gets the selected AreaName.
Public property AssetId Gets the selected assetId
Public property AssetName Gets the selected asset.
Public property AssetNodeDepth Gets the selected AssetNodeDepth.
Public property AssetNodeName Gets the selected AssetNodeName.
Public property AssetPath Gets the selected asset path.
Public property DateTimeEnd DateTime Client side value, availble to be used on displays
Public property DateTimeStart DateTime Client side value, availble to be used on displays
Public property DeviceId Gets the selected DeviceId
Public property DeviceName Gets the selected DeviceName.
Public property DigitalValue Digital value to create and test symbols
Public property DisplayValueMode Gets the current display value mode.
Public property EquipmentId Gets the selected EquipmentId
Public property EquipmentName Gets the selected EquipmentName.
Public property HistorianDateTime Gets current historian date time
Public property Interval TimeSpan Client side value, availble to be used on displays
Public property LineId Gets the selected LineId
Public property LineName Gets the selected LineName.
Public property NumericValue Numeric value to create and test symbols
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 SelectedAlarmList Integer Client side value, tipycally used to chagned the ListType on AlarmView
Public property SelectedProperty Gets the selected asset.
Public property SelectedTag Gets the selected asset.
Public property SiteId Gets the selected assetId
Public property SiteName Gets the selected asset.
Public property TextValue Text value to create and test symbols
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).
Public property WellId Gets the selected WellId
Public property WellName Gets the selected WellName.
Top
Methods
 
Name Description
Public method GetDisplayTagList(string, bool) Get string array with tag list of a display
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 SetRetentiveContextToTags(string[], string) Set retentive context to tags
Top
Name Description
Public enumeration e Enum containg list of IDs of runtime objects
Top
T.Modules.ClientStation.ClientContext

.NET Framework

Supported in: 4.6.2, 4.7

In this article

Definition