Value Methods

Add(KeyValuePairString, Value)

Adds a KeyValuePairTKey, TValue to the Value.

Add(Value)

Adds the specified Value to the Value.

Add(String, Value)

Adds a Value with the specified key to the Value.

AddOrUpdate

Adds a Value with the specified key to the Value if the key does not already exist, or updates a Value in the Value if the key already exists.

AddRange

Adds the specified Values to the end of the Value.

ChangeType

Changes the Type of this Value to the specified ValueType and adjusts the containing data.

Clear

Removes all Values from the Value.

CompareTo(Access)

Compares the current Value with another Access and returns an integer that indicates whether the current Value precedes, follows, or occurs in the same position in the sort order as the other Access.

CompareTo(Alarm)

Compares the current Value with another Alarm and returns an integer that indicates whether the current Value precedes, follows, or occurs in the same position in the sort order as the other Alarm.

CompareTo(Boolean)

Compares the current Value with another Boolean value and returns an integer that indicates whether the current Value precedes, follows, or occurs in the same position in the sort order as the other Boolean value.

CompareTo(Byte)

Compares the current Value with another Byte and returns an integer that indicates whether the current Value precedes, follows, or occurs in the same position in the sort order as the other Byte.

CompareTo(Byte)

Compares the current Value with other Bytes and returns an integer that indicates whether the current Value precedes, follows, or occurs in the same position in the sort order as the other Bytes.

CompareTo(Char)

Compares the current Value with another Char and returns an integer that indicates whether the current Value precedes, follows, or occurs in the same position in the sort order as the other Char.

CompareTo(DateTime)

Compares the current Value with another DateTime and returns an integer that indicates whether the current Value precedes, follows, or occurs in the same position in the sort order as the other DateTime.

CompareTo(Decimal)

Compares the current Value with another Decimal value and returns an integer that indicates whether the current Value precedes, follows, or occurs in the same position in the sort order as the other Decimal value.

CompareTo(Double)

Compares the current Value with another Double-precision floating-point number and returns an integer that indicates whether the current Value precedes, follows, or occurs in the same position in the sort order as the other Double-precision floating-point number.

CompareTo(Event)

Compares the current Value with another Event and returns an integer that indicates whether the current Value precedes, follows, or occurs in the same position in the sort order as the other Event.

CompareTo(Int16)

Compares the current Value with another Int16 and returns an integer that indicates whether the current Value precedes, follows, or occurs in the same position in the sort order as the other Int16.

CompareTo(Int32)

Compares the current Value with another Int32 and returns an integer that indicates whether the current Value precedes, follows, or occurs in the same position in the sort order as the other Int32.

CompareTo(Int64)

Compares the current Value with another Int64 and returns an integer that indicates whether the current Value precedes, follows, or occurs in the same position in the sort order as the other Int64.

CompareTo(Message)

Compares the current Value with another Message and returns an integer that indicates whether the current Value precedes, follows, or occurs in the same position in the sort order as the other Message.

CompareTo(SByte)

Compares the current Value with another SByte and returns an integer that indicates whether the current Value precedes, follows, or occurs in the same position in the sort order as the other SByte.

CompareTo(Severity)

Compares the current Value with another Severity and returns an integer that indicates whether the current Value precedes, follows, or occurs in the same position in the sort order as the other Severity.

CompareTo(Single)

Compares the current Value with another Single-precision floating-point number and returns an integer that indicates whether the current Value precedes, follows, or occurs in the same position in the sort order as the other Single-precision floating-point number.

CompareTo(String)

Compares the current Value with another String and returns an integer that indicates whether the current Value precedes, follows, or occurs in the same position in the sort order as the other String.

CompareTo(TimeSpan)

Compares the current Value with another TimeSpan and returns an integer that indicates whether the current Value precedes, follows, or occurs in the same position in the sort order as the other TimeSpan.

CompareTo(UInt16)

Compares the current Value with another UInt16 and returns an integer that indicates whether the current Value precedes, follows, or occurs in the same position in the sort order as the other UInt16.

CompareTo(UInt32)

Compares the current Value with another UInt32 and returns an integer that indicates whether the current Value precedes, follows, or occurs in the same position in the sort order as the other UInt32.

CompareTo(UInt64)

Compares the current Value with another UInt64 and returns an integer that indicates whether the current Value precedes, follows, or occurs in the same position in the sort order as the other UInt64.

CompareTo(Value)

Compares the current Value with another Value and returns an integer that indicates whether the current Value precedes, follows, or occurs in the same position in the sort order as the other Value.

Contains(KeyValuePairString, Value)

Determines whether the Value contains the specified KeyValuePairTKey, TValue.

Contains(Value)

Determines whether the Value contains the specified Value.

ContainsKey

Determines whether the Value contains a Value with the specified key.

CopyTo(KeyValuePairString, Value, Int32)

Copies the KeyValuePairTKey, TValues of the Value to the specified Array, starting at the specified index.

CopyTo(Value, Int32)

Copies the Values of the Value to the specified Array, starting at the specified index.

DeepCopy

Creates a new object that is a deep copy of the current Value.

Equals(Access)

Indicates whether the current Value is equal to another Access.

Equals(Alarm)

Indicates whether the current Value is equal to another Alarm.

Equals(Boolean)

Indicates whether the current Value is equal to another Boolean value.

Equals(Byte)

Indicates whether the current Value is equal to another Byte.

Equals(Byte)

Indicates whether the current Value is equal to another Array of Byte s.

Equals(Char)

Indicates whether the current Value is equal to another Char.

Equals(DateTime)

Indicates whether the current Value is equal to another DateTime.

Equals(Decimal)

Indicates whether the current Value is equal to another Decimal value.

Equals(Double)

Indicates whether the current Value is equal to another Double-precision floating-point number.

Equals(Event)

Indicates whether the current Value is equal to another Event.

Equals(Int16)

Indicates whether the current Value is equal to another Int16.

Equals(Int32)

Indicates whether the current Value is equal to another Int32.

Equals(Int64)

Indicates whether the current Value is equal to another Int64.

Equals(Message)

Indicates whether the current Value is equal to another Message.

Equals(Object)

Determines whether the specified Object is equal to the current Value.
(Overrides ObjectEquals(Object))

Equals(SByte)

Indicates whether the current Value is equal to another SByte.

Equals(Severity)

Indicates whether the current Value is equal to another Severity.

Equals(Single)

Indicates whether the current Value is equal to another Single-precision floating-point number.

Equals(String)

Indicates whether the current Value is equal to another String.

Equals(TimeSpan)

Indicates whether the current Value is equal to another TimeSpan.

Equals(UInt16)

Indicates whether the current Value is equal to another UInt16.

Equals(UInt32)

Indicates whether the current Value is equal to another UInt32.

Equals(UInt64)

Indicates whether the current Value is equal to another UInt64.

Equals(Value)

Indicates whether the current Value is equal to another Value.

Finalize

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)

FromAccess

Converts an instance of the Value class to the appropriate Access.

FromAlarm

Converts an Alarm to the appropriate instance of the Value class.

FromBoolean

Converts a Boolean value to the appropriate instance of the Value class.

FromByte

Converts an Byte to the appropriate instance of the Value class.

FromBytes

Converts an array of Bytes to the appropriate instance of the Value class.

FromChar

Converts a Char to the appropriate instance of the Value class.

FromDateTime

Converts an instance of the DateTime class to the appropriate instance of the Value class.

FromDecimal

Converts a Decimal value to the appropriate instance of the Value class.

FromDouble

Converts a Double-precision floating-point number to the appropriate instance of the Value class.

FromEvent

Converts an Event to the appropriate instance of the Value class.

FromInt16

Converts an Int16 to the appropriate instance of the Value class.

FromInt32

Converts an Int32 to the appropriate instance of the Value class.

FromInt64

Converts a Int64 to the appropriate instance of the Value class.

FromMessage

Converts an Message to the appropriate instance of the Value class.

FromSByte

Converts an SByte to the appropriate instance of the Value class.

FromSeverity

Converts a Severity to the appropriate instance of the Value class.

FromSingle

Converts a Single-precision floating-point number to the appropriate instance of the Value class.

FromString

Converts a String to the appropriate instance of the Value class.

FromTimeSpan

Converts an instance of the TimeSpan class to the appropriate instance of the Value class.

FromUInt16

Converts an UInt16 to the appropriate instance of the Value class.

FromUInt32

Converts an UInt32 to the appropriate instance of the Value class.

FromUInt64

Converts a UInt64 to the appropriate instance of the Value class.

GetAccess

Gets the Access of the Value.

GetAlarm

Gets the Alarm of the Value.

GetBool

Gets the Boolean value of the Value.

GetBool(IFormatProvider)

Gets the Boolean value of the Value, using the specified culture-specific formatting information.

GetByte

Gets the Byte of the Value.

GetBytes

Gets the Bytes of the Value.

GetChar

Gets the Char of the Value.

GetDateTime

Gets the DateTime of the Value.

GetDateTime(IFormatProvider)

Gets the DateTime of the Value, using the specified culture-specific formatting information.

GetDecimal

Gets the Decimal value of the Value.

GetDouble

Gets the Double-precision floating-point number of the Value.

GetDouble(IFormatProvider)

Gets the Double-precision floating-point number of the Value, using the specified culture-specific formatting information.

GetEvent

Gets the Event of the Value.

GetHashCode

Serves as the default hash function.
(Overrides ObjectGetHashCode)

GetInt16

Gets the Int16 integer of the Value.

GetInt32

Gets the Int32 of the Value.

GetInt32(IFormatProvider)

Gets the Int32 of the Value, using the specified culture-specific formatting information.

GetInt64

Gets the Int64 integer of the Value.

GetInt64(IFormatProvider)

Gets the Int64 integer of the Value, using the specified culture-specific formatting information.

GetMessage

Gets the Message of the Value.

GetSByte

Gets the SByte of the Value.

GetSeverity

Gets the Severity of the Value.

GetSingle

Gets the Single-precision floating-point number of the Value.

GetString

Gets the String of the Value.

GetString(IFormatProvider)

Gets the String of the Value, using the specified culture-specific formatting information.

GetTimeSpan

Gets the TimeSpan of the Value.

GetTimeSpan(IFormatProvider)

Gets the TimeSpan of the Value, using the specified culture-specific formatting information.

GetType

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

GetTypeCode

Gets the TypeCode for this Value.

GetUInt16

Gets the UInt16 integer of the Value.

GetUInt32

Gets the UInt32 of the Value.

GetUInt64

Gets the UInt64 integer of the Value.

GetUInt64(IFormatProvider)

Gets the UInt64 integer of the Value, using the specified culture-specific formatting information.

IndexOf

Determines the index of the specified Value in the Value.

Insert

Inserts a Value to the Value at the specified index.

MemberwiseClone

Creates a shallow copy of the current Object.
(Inherited from Object)

Remove(KeyValuePairString, Value)

Removes the first occurrence of the specified KeyValuePairTKey, TValue from the Value.

Remove(String)

Removes the Value with the specified key from the Value.

Remove(Value)

Removes the first occurrence of the specified Value from the Value.

RemoveAt

Removes the Value at the specified index.

RemoveRange

Removes a range of Values from the Value.

SetValue(Access)

Sets the Access of the Value.

SetValue(Alarm)

Sets the Alarm of the Value.

SetValue(Boolean)

Sets the Boolean value of the Value.

SetValue(Byte)

Sets the Byte of the Value.

SetValue(Byte)

Sets the Bytes of the Value.

SetValue(Char)

Sets the Char of the Value.

SetValue(DateTime)

Sets the DateTime of the Value.

SetValue(Decimal)

Sets the Decimal value of the Value.

SetValue(Double)

Sets the Double-precision floating-point number of the Value.

SetValue(Event)

Sets the Event of the Value.

SetValue(Int16)

Sets the Int16 integer of the Value.

SetValue(Int32)

Sets the Int32 of the Value.

SetValue(Int64)

Sets the Int64 integer of the Value.

SetValue(Message)

Sets the Message of the Value.

SetValue(SByte)

Sets the SByte of the Value.

SetValue(Severity)

Sets the Severity of the Value.

SetValue(Single)

Sets the Single-precision floating-point number of the Value.

SetValue(String)

Sets the String of the Value.

SetValue(TimeSpan)

Sets the TimeSpan of the Value.

SetValue(UInt16)

Sets the UInt16 integer of the Value.

SetValue(UInt32)

Sets the UInt32 of the Value.

SetValue(UInt64)

Sets the UInt64 integer of the Value.

ShallowCopy

Creates a new Value that is a shallow copy of the current Value.

ToAccess

Converts this instance of the Value class to the appropriate Access.

ToAlarm

Converts this instance of the Value class to the appropriate Alarm.

ToArray

Converts this instance of the Value class to the appropriate Array.

ToBoolean

Converts this instance of the Value class to the appropriate Boolean.

ToBoolean(IFormatProvider)

Converts the Value to an equivalent Boolean value using the specified IFormatProvider.

ToByte

Converts this instance of the Value class to the appropriate Byte.

ToByte(IFormatProvider)

Converts the Value to an equivalent Byte using the specified IFormatProvider.

ToBytes

Converts this instance of the Value class to the appropriate array of Bytes.

ToChar

Converts this instance of the Value class to the appropriate Char.

ToChar(IFormatProvider)

Converts the Value to an equivalent Char using the specified IFormatProvider.

ToDateTime

Converts this instance of the Value class to the appropriate instance of the DateTime class.

ToDateTime(IFormatProvider)

Converts the Value to an equivalent DateTime using the specified IFormatProvider.

ToDecimal

Converts this instance of the Value class to the appropriate Decimal.

ToDecimal(IFormatProvider)

Converts the Value to an equivalent Decimal value using the specified IFormatProvider.

ToDouble

Converts this instance of the Value class to the appropriate Double-precision floating-point number.

ToDouble(IFormatProvider)

Converts the Value to an equivalent Double-precision floating-point number using the specified IFormatProvider.

ToEvent

Converts this instance of the Value class to the appropriate Event.

ToInt16

Converts this instance of the Value class to the appropriate Int16.

ToInt16(IFormatProvider)

Converts the Value to an equivalent Int16 integer using the specified IFormatProvider.

ToInt32

Converts this instance of the Value class to the appropriate Int32.

ToInt32(IFormatProvider)

Converts the Value to an equivalent Int32 using the specified IFormatProvider.

ToInt64

Converts this instance of the Value class to the appropriate Int64.

ToInt64(IFormatProvider)

Converts the Value to an equivalent Int64 integer using the specified IFormatProvider.

ToMessage

Converts this instance of the Value class to the appropriate Message.

ToSByte

Converts this instance of the Value class to the appropriate SByte.

ToSByte(IFormatProvider)

Converts the Value to an equivalent SByte using the specified IFormatProvider.

ToSeverity

Converts this instance of the Value class to the appropriate Severity.

ToSingle

Converts this instance of the Value class to the appropriate Single-precision floating-point number.

ToSingle(IFormatProvider)

Converts the Value to an equivalent Single-precision floating-point number using the specified IFormatProvider.

ToString

Returns a String that represents the current Value.
(Overrides ObjectToString)

ToString(IFormatProvider)

Converts the Value to an equivalent String using the specified IFormatProvider.

ToTimeSpan

Converts this instance of the Value class to the appropriate instance of the TimeSpan class.

ToType

Converts the Value to an equivalent Object of the specified Type using the specified IFormatProvider.

ToUInt16

Converts this instance of the Value class to the appropriate UInt16.

ToUInt16(IFormatProvider)

Converts the Value to an equivalent UInt16 integer using the specified IFormatProvider.

ToUInt32

Converts this instance of the Value class to the appropriate UInt32.

ToUInt32(IFormatProvider)

Converts the Value to an equivalent UInt32 using the specified IFormatProvider.

ToUInt64

Converts this instance of the Value class to the appropriate UInt64.

ToUInt64(IFormatProvider)

Converts the Value to an equivalent UInt64 integer using the specified IFormatProvider.

ToValue

Returns the current Value.

TryGetValue

Gets the Value associated with the specified key.

OrderBy

Sorts the Values of a sequence according to the specified String.
When using this method to order and assign the result to a ReadValue, also add PagingHandled to the Options of the same Command to inform the TwinCAT HMI server that sorting was handled by the TwinCAT HMI server extension and must not be handled again by the TwinCAT HMI server.
(Defined by ValueExtensions)

ResolveBy

Resolves the current Value by the specified QueueT of elements.
(Defined by ValueExtensions)

ResolveBy

Resolves the current Value by the specified path.
(Defined by ValueExtensions)

ToJson

Returns an unformatted JSON String that represents the current Value.
(Defined by ValueExtensions)

ToJson

Returns an unformatted JSON String that represents the current Value.
(Defined by ValueExtensions)

ToJson

Returns a JSON String that represents the current Value.
(Defined by ValueExtensions)

ToJsonValue

Returns a JsonValue that contains an unformatted JSON String representing the current Value.
(Defined by ValueExtensions)

TryResolveBy

Resolves the current Value by the specified QueueT of elements. A return value indicates whether resolving succeeded.
(Defined by ValueExtensions)

TryResolveBy

Resolves the current Value by the specified QueueT of elements. A return value indicates whether resolving succeeded.
(Defined by ValueExtensions)

Where

Filters a sequence of Values based on a Value that contains filters.
When using this method to filter and assign the result to a ReadValue, also add PagingHandled to the Options of the same Command to inform the TwinCAT HMI server that filtering was handled by the TwinCAT HMI server extension and must not be handled again by the TwinCAT HMI server.
(Defined by ValueExtensions)

Where

Filters a sequence of Values based on a Value that contains filters.
When using this method to filter and assign the result to a ReadValue, also add PagingHandled to the Options of the same Command to inform the TwinCAT HMI server that filtering was handled by the TwinCAT HMI server extension and must not be handled again by the TwinCAT HMI server.
(Defined by ValueExtensions)