Class BooleanOptionSupport

Namespace

CENTREL.XIA.Configuration.Types

Assembly

CENTREL.XIA.Configuration.Types.dll

Provides boolean option support functions.

public static class BooleanOptionSupport

Inheritance

object

BooleanOptionSupport

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Methods

FromBool(bool)

Converts a System.Boolean value to a CENTREL.XIA.Configuration.Types.BooleanOption type.

public static BooleanOption FromBool(bool value)

Parameters

value bool

The boolean value to evaluate.

Returns

BooleanOption

A boolean option value from the specified boolean value.

FromBool(int)

Converts a System.Int32 value to a CENTREL.XIA.Configuration.Types.BooleanOption type treating any value greater than zero as true.

public static BooleanOption FromBool(int value)

Parameters

value int

The System.Int32 value to convert.

Returns

BooleanOption

A CENTREL.XIA.Configuration.Types.BooleanOption type.

FromBool(int, int, int)

Converts a System.Int32 value to a CENTREL.XIA.Configuration.Types.BooleanOption type.

public static BooleanOption FromBool(int value, int trueValue, int falseValue)

Parameters

value int

The System.Int32 value to convert.

trueValue int

The integer value that represents true.

falseValue int

The integer value that represents false.

Returns

BooleanOption

A CENTREL.XIA.Configuration.Types.BooleanOption type.

FromBool(bool?)

Converts a nullable System.Boolean value to a CENTREL.XIA.Configuration.Types.BooleanOption type.

public static BooleanOption FromBool(bool? value)

Parameters

value bool?

The nullable boolean value to evaluate.

Returns

BooleanOption

A boolean option value from the specified nullable boolean value.

FromBool(bool?, BooleanOption)

Converts a nullable System.Boolean value to a CENTREL.XIA.Configuration.Types.BooleanOption type.

public static BooleanOption FromBool(bool? value, BooleanOption nullValue)

Parameters

value bool?

The nullable boolean value to evaluate.

nullValue BooleanOption

The value to return if the nullable boolean value is null.

Returns

BooleanOption

A boolean option value from the specified nullable boolean value.

FromBool(uint)

Converts a System.UInt32 value to a CENTREL.XIA.Configuration.Types.BooleanOption type treating any value greater than zero as true.

public static BooleanOption FromBool(uint value)

Parameters

value uint

The System.UInt32 value to convert.

Returns

BooleanOption

A CENTREL.XIA.Configuration.Types.BooleanOption type.

InvertBooleanOption(BooleanOption)

Inverts the specified CENTREL.XIA.Configuration.Types.BooleanOption value.

public static BooleanOption InvertBooleanOption(BooleanOption value)

Parameters

value BooleanOption

The CENTREL.XIA.Configuration.Types.BooleanOption value to invert.

Returns

BooleanOption

The inverted value of the specified CENTREL.XIA.Configuration.Types.BooleanOption value.