OPC Studio User's Guide and Reference
EventFilter Property (UAMonitoringParameters)



OpcLabs.EasyOpcUA Assembly > OpcLabs.EasyOpc.UA Namespace > UAMonitoringParameters Class : EventFilter Property
Optional event filter. Defines the conditions under which an event notification should be reported.
Syntax
'Declaration
 
<NullableAttribute()>
<XmlIgnoreAttribute()>
Public Property EventFilter As UAEventFilter
'Usage
 
Dim instance As UAMonitoringParameters
Dim value As UAEventFilter
 
instance.EventFilter = value
 
value = instance.EventFilter
[Nullable()]
[XmlIgnore()]
public UAEventFilter EventFilter {get; set;}
[Nullable()]
[XmlIgnore()]
public:
property UAEventFilter^ EventFilter {
   UAEventFilter^ get();
   void set (    UAEventFilter^ value);
}

Property Value

This value of this property can be null (Nothing in Visual Basic).

The default value of this property is null.

Remarks

In order to obtain or modify this parameter, access the OpcLabs.EasyOpc.UA.OperationModel.UAMonitoredItemArguments.MonitoringParameters.

The getter method of this property is pure, i.e. it does not have observable side effects.

This method or property does not throw any exceptions, aside from execution exceptions such as System.Threading.ThreadAbortException or System.OutOfMemoryException.

Because the UAEventFilter has an implicit conversion from UAAttributeFieldCollection, in languages that support implicit conversion operators (such as C# or VB.NET), you can simply use an OPC UA attribute field collection (representing the Select clauses of the event filter) in place of UAEventFilter value when setting this property, and the corresponding OPC UA event filter will be constructed automatically. When the implicit conversion operators are not supported (such as with Python.NET), you can use the FromUAAttributeFieldCollection static method instead.

Also, because the UAEventFilterBuilder has an implicit conversion to UAEventFilter, in languages that support implicit conversion operators (such as C# or VB.NET), you can simply use a UAEventFilterBuilder in place UAEventFilter value when setting this property, and the corresponding OPC UA event filter will be constructed automatically. When the implicit conversion operators are not supported (such as with Python.NET), you can convert a UAEventFilterBuilder to UAEventFilter using the ToUAEventFilter static method instead.

Requirements

Target Platforms: .NET Framework: Windows 10 (selected versions), Windows 11 (selected versions), Windows Server 2016, Windows Server 2022; .NET: Linux, macOS, Microsoft Windows

See Also