TiComponent.ErrorActive

TiComponent See Also

Sets or get's the Error Active state of the component.

property ErrorActive : Boolean;

Description

Use ErrorActive to specify or inspect whether the entire component is in an error state. This property is to be used by the developer to specify the Error State of the Component.

When this property is True, the entire component will draw itself to indicate that it is in an error state. This will differ depending on the type of control. For example, a text based control such as the TiEdit or TiAnalogOutput controls will display a text error indication that the control is in an error state. For non-text controls, such as the TiLedRectangle or TiOdometer, they will each have a customized way of indicating an error state such as a background color state, etc.

When this property is False, the entire component draws as usual, indicating that it is not in an error state.

Tip: Use the ErrorText, ErrorFont, and ErrorBackGroundColor properties to control how the error is displayed in the component. Understand that not all components will use all Error properties since they display the error state in different ways.

Note: for OPC applications, you can use the OPCItem AutoError property to automatically set ErrorActive for you. When AutoError is True, ErrorActive is set to an error condition whenever the OPC Data Quality is not good. The ErrorActive property is returned to a non-error condition whenever the OPC Data Quality returns to normal. You do not need to be using the OPC features of our components to make use of the Error State features. The AutoError property is just a helper feature when used in conjunction with OPC.

Important Note: currently, only the TiAnalogOutput, TiEdit, TiModeComboBox, and TiAnalogDisplay components implement the Error State properties.

Example

Delphi

iComponent.ErrorActive := True; //Places the component in an error state

C++ Builder

iComponent->ErrorActive = True; //Places the component in an error state

Contents | Index | Previous | Next