Class PropBoolean

Boolean properties represent a feature whose value is a simple on/off switch.

Inheritance

PropBoolean

Implements

Namespace: ic4
Assembly: ic4dotnet.dll
Syntax
public class PropBoolean : Property, IDisposable
Remarks

PropBoolean instances are created in multiple ways:

Properties

Value

The current value of this property

The value is only writable is the property's writability is not restricted. See IsLocked, IsReadonly, IsAvailable.

Declaration

public bool Value { get; set; }
Property Value
Type Description
bool

The current value of this property

Exceptions

Type Condition
IC4Exception

Check ErrorCode and ToString() for details.

Methods

TryGetValue(out bool)

Tries to get the value of this property without throwing an exception in case of an error.

Declaration

public bool TryGetValue(out bool val)

Parameters

Type Name Description
bool val

Output parameter receiving the current value of the property

Returns

Type Description
bool

true, if the property value was read successfully, otherwise false

TrySetValue(bool)

Tries to set the value of this property without throwing an exception in case of an error.

Declaration

public bool TrySetValue(bool val)

Parameters

Type Name Description
bool val

The new value to set

Returns

Type Description
bool

true, if the property value was set successfully, otherwise false

Implements