ConfigListener Class

Represents a listener to interact with the configuration of the TwinCAT HMI server configuration. This class cannot be inherited.

Inheritance Hierarchy

SystemObject
  Listener
    TcHmiSrv.Core.ListenersConfigListener

Namespace: TcHmiSrv.Core.Listeners
Assembly: TcHmiSrvExtNet.Core (in TcHmiSrvExtNet.Core.dll) Version: 3.1.7447.0+85f9b473a1dd11b8f3e5c9a182fd1901975e46f9

Syntax

C#

public sealed class ConfigListener : Listener, 
    IExternalCaller<string>, IAsyncExternalCaller<string>

The ConfigListener type exposes the following members.

Constructors

 

Name

Description

ConfigListener Class 1:

ConfigListener

Initializes a new instance of the ConfigListener class.

Properties

 

Name

Description

ConfigListener Class 2:

Type

Gets the type of the ConfigListener.
(Overrides Listener.Type)

Methods

 

Name

Description

ConfigListener Class 3:

Equals

Determines whether the specified object is equal to the current object.
(Inherited from Object)

ConfigListener Class 4:

GetHashCode

Serves as the default hash function.
(Inherited from Object)

ConfigListener Class 5:

GetType

Gets the Type of the current instance.
(Inherited from Object)

ConfigListener Class 6:

ToString

Returns a string that represents the current object.
(Inherited from Object)

Events

 

Name

Description

ConfigListener Class 7:

BeforeChange

Called before a configuration Value is changed.
If an Exception is thrown, the change will be aborted.
This method is also called for all parent elements in the path of the changed configuration Value.

ConfigListener Class 8:

BeforeChangeAsync

Called before a configuration Value is changed.
If an Exception is thrown, the change will be aborted.
This method is also called for all parent elements in the path of the changed configuration Value.

ConfigListener Class 9:

BeforeDelete

Called before a configuration Value is deleted.
If an Exception is thrown, the deletion will be aborted.

ConfigListener Class 10:

BeforeDeleteAsync

Called before a configuration Value is deleted.
If an Exception is thrown, the deletion will be aborted.

ConfigListener Class 11:

BeforeRename

Called before a configuration Value is renamed.
If an Exception is thrown, renaming will be aborted.

ConfigListener Class 12:

BeforeRenameAsync

Called before a configuration Value is renamed.
If an Exception is thrown, renaming will be aborted.

ConfigListener Class 13:

OnChange

Called after a configuration Value has been successfully changed.
This method is also called for all parent elements in the path of the changed configuration Value.

ConfigListener Class 14:

OnChangeAsync

Called after a configuration Value has been successfully changed.
This method is also called for all parent elements in the path of the changed configuration Value.

ConfigListener Class 15:

OnDelete

Called after a configuration Value has been deleted.
This method is also called for all parent elements in the path of the deleted configuration Value.

ConfigListener Class 16:

OnDeleteAsync

Called after a configuration Value has been deleted.
This method is also called for all parent elements in the path of the deleted configuration Value.

ConfigListener Class 17:

OnRename

Called after a configuration Value has been renamed.

ConfigListener Class 18:

OnRenameAsync

Called after a configuration Value has been renamed.

Version Information

Supported in: 3.1.7447.0, 2.3.7447.0, 1.10.7447.0

Reference

TcHmiSrv.Core.Listeners Namespace

Copyright © Beckhoff Automation GmbH & Co. KG