IOptions

[ Interface ]

export interface IOptions {
    BindingMode?: TcHmi.BindingMode;
    BindingEvent?: string;
    BindingEvents?: string[];
    Timeout?: number;
    Interval?: number;
    Parallel?: boolean;
}

Properties

Name

Type

Description

BindingMode [ optional ]

TcHmi.BindingMode

Contains the value of the BindingMode option of the symbol expression.

BindingEvent [ optional ]

string

Contains the value of the first BindingEvent option of the symbol expression.

The value represents the name of an event of the control to which the symbol is linked.

The event is the trigger for reading back the corresponding attribute value to which the symbol is linked.

BindingEvents [ Optional ]
Available from 1.10.1171.21

string[]

Contains a list of values of all BindingEvent options of the symbol expression.

The values each represent the name of an event of the control to which the symbol is linked.

The events are trigger for reading back the corresponding attribute value to which the symbol is linked.

The events are registered in the order in which they appear in the symbol expression.

Timeout [ optional ]

number

Contains the value of the symbol expression timeout option.

Supported only by symbols of type "Server".

Requests against the TwinCAT HMI server based on this symbol object are aborted in milliseconds after the set time has elapsed and return an error.

Interval [ optional ]

number

Contains the value of the interval option of the symbol expression.

Supported only by symbols of type "Server".

Subscription requests against the TwinCAT HMI server based on this symbol object use this interval time instead of the global time.

Parallel [ optional ]

boolean

Contains the value of the parallel option of the symbol expression.

Supported only by symbols of type "Server".

This option can be used to specify whether ReadWrite requests are sent in parallel or serialized against the TwinCAT HMI server.

IOptions 1:

Available from version 1.10