STSeriesDevice.GetTextButtonProperty Method

STSeriesDeviceGetTextButtonProperty Method

Warning: This API is deprecated, please consider using the new version located here: http://scriptel.com/developers/proscript/net-library/

Gets the boolean button property.

Namespace: Scriptel.STSeries
Assembly: STSeries (in STSeries.dll) Version: 2.5.0.454 (2.5.0.454)

Syntax

C++

Copy

public override string GetTextButtonProperty(
	int regionNumber,
	STSeriesDeviceButtonProperty buttonProperty
)

Public Overrides Function GetTextButtonProperty ( 
	regionNumber As Integer,
	buttonProperty As STSeriesDeviceButtonProperty
) As String

public:
virtual String^ GetTextButtonProperty(
	int regionNumber, 
	STSeriesDeviceButtonProperty buttonProperty
) override

abstract GetTextButtonProperty : 
        regionNumber : int * 
        buttonProperty : STSeriesDeviceButtonProperty -> string 
override GetTextButtonProperty : 
        regionNumber : int * 
        buttonProperty : STSeriesDeviceButtonProperty -> string

Parameters

regionNumber: Type: SystemInt32
The region number.
buttonProperty: Type: Scriptel.STSeriesSTSeriesDeviceButtonProperty
Button property to get.

Return Value

Type: String
The state of the requested property

Implements

ISTSeriesDeviceGetTextButtonProperty(Int32, STSeriesDeviceButtonProperty)
ISTSeriesDeviceGetTextButtonProperty(Int32, STSeriesDeviceButtonProperty)

Exceptions

Exception	Condition
NotAButtonException	when the region is not a button.
ArgumentException	when an invalid button property is requested

Reference

STSeriesDevice Class

Scriptel.STSeries Namespace