XGet
The function XGet gets the current value of a Property on an ActiveX Control or .NET Control object.
| Function | Group | Execution | Windows | Embedded | Thin Client | Mobile Access |
|---|---|---|---|---|---|---|
| XGet | ActiveX and .NET Control | Asynchronous | Supported | ActiveX Controls only (see “Notes” below) | Supported | Not supported |
Syntax
XGet(strName,strProperties)
- strName
- The unique name of the ActiveX Control or .NET Control object, as specified in the Name box in the Object Properties dialog box.
- strProperties
- The Property for which you want to get the value. Available Properties are listed in the Configuration (for an ActiveX Control) or Members (for a .NET Control) dialog box.
Returned value
This function returns the value of the specified Property.
Notes
If the option Enforce Web functionality equivalence is selected in the project settings, this function cannot be called from Global Procedures or Script worksheets. This is because the function is meaningful only when it is executed on stations that display project screens; it might cause unexpected behavior if it is called from background tasks that are executed on the project runtime server. For more information, see Preferences tab.
Also, this function is not supported for .NET Control objects running on a Windows Embedded device.
Examples
Get the current value of the Color property on the ActiveX Control object named “ActXRec”:
XGet("ActXRec","Color")