Skip to content

Reference

IOpcDataFieldInfo Members

Defines the metadata of a field declared by a data type.

Reference

IOpcDataFieldInfo Members ​

Type
IOpcDataFieldInfo
Namespace
Opc.UaFx
Assembly
Opc.UaFx.Advanced.dll
Package
Opc.UaFx.Advanced v2.59.0
Also in
Opc.UaFx.Client

Properties ​

DeclaringType ​

Gets the type that declares the current IOpcDataFieldInfo.

csharp
IOpcDataTypeInfo DeclaringType { get; }
vbnet
ReadOnly Property DeclaringType As IOpcDataTypeInfo

Property value

IOpcDataTypeInfo

The IOpcDataTypeInfo which declares the current IOpcDataFieldInfo.

FieldType ​

Gets the type of value this field provides.

csharp
IOpcDataTypeInfo FieldType { get; }
vbnet
ReadOnly Property FieldType As IOpcDataTypeInfo

Property value

IOpcDataTypeInfo

The IOpcDataTypeInfo representing the type of value this field provides.

IsOptional ​

Gets a value indicating whether the current field might not necessarily exist in the object defined by the DeclaringType.

csharp
bool IsOptional { get; }
vbnet
ReadOnly Property IsOptional As Boolean

Property value

Boolean

The value true if the field might not always exists; otherwise the value false. Additionally see the Switch property.

Length ​

Gets the length of the field expressed either explicit or implicit using a different IOpcDataFieldInfo.

csharp
OpcMemberLength Length { get; }
vbnet
ReadOnly Property Length As OpcMemberLength

Property value

OpcMemberLength

An instance of the OpcMemberLength class with the explicit length of the field or the reference to the IOpcDataFieldInfo its value expresses the length of the current IOpcDataFieldInfo.

Name ​

Gets the name of the current IOpcDataFieldInfo.

csharp
string Name { get; }
vbnet
ReadOnly Property Name As String

Property value

String

A string containing the name of this field.

ReflectedType ​

Gets the type that was used to obtain this instance of IOpcDataFieldInfo.

csharp
IOpcDataTypeInfo ReflectedType { get; }
vbnet
ReadOnly Property ReflectedType As IOpcDataTypeInfo

Property value

IOpcDataTypeInfo

An IOpcDataTypeInfo object used to obtain this instance.

Switch ​

Gets the switch condition which applies to the current IOpcDataFieldInfo.

csharp
OpcMemberSwitch Switch { get; }
vbnet
ReadOnly Property Switch As OpcMemberSwitch

Property value

OpcMemberSwitch

An instance of the OpcMemberSwitch class which defines the conditions to fulfill so that the current IOpcDataFieldInfo exists in an instance.

Methods ​

GetValue ​

Gets the value of the field supported by the given object instance.

csharp
object GetValue(object instance)
vbnet
Function GetValue(instance As Object) As Object

Parameters

NameTypeDescription
instanceObjectThe object whose field value will be returned.

Returns

Object

An object containing the value of the field reflected by this instance.

SetValue ​

Sets the value of the field supported by the given object instance.

csharp
void SetValue(object instance, object value)
vbnet
Sub SetValue(instance As Object, value As Object)

Parameters

NameTypeDescription
instanceObjectThe object whose field value will be set.
valueObjectThe value to assign to the field.