Key/ Value collection handling functionality.

This collection can store object types, but these will be ignored when serialising to/from a string.

Implements ICollection, I_ISDirty
Used in 3 samples

Methods

Name Description
Add Add an Item to the Key/Value List.
Clear Clears the list.
Clone Create a Clone of this object.
CompareTo Compares this Key Value List with another and returns 0 if the Items are the same. If any Item differs, 1 (non-zero) is returned.
CopyTo
CreateDifferencesKeyValueLists Compare two Key Value Lists and remove any items that have the same value in each list.
DirtyClear Clear Dirty state.
Exists
FromCsvString Populates the collection from a CSV-style string.
FromHtmlWidgetParametersJsonString Adds new and updates existing items from the JSON formatted String supplied by the HTML Widget Parameters Host control. This retains the correct data type and User Defined Index.
FromSimpleAdHocXmlOrJsonString System Use Only Adds items from the supplied XML or JSON formatted String where all first-left items from the root XML node or JSON object are added with a key based upon their tag name.
FromSimpleAdHocXmlString System Use Only Adds items from the supplied XML where all first-left items from the root node are added with a key based upon their tag name.
FromSimpleJsonString Adds items from the JSON formatted String where all first-left JSON items are added with a key based upon their property name.
FromUrlString Populates the collection from a URL-style Query string, i.e. the string portion after the "?" in a URL.
FromXmlNode System Use Only Populates the collection from an XML node or sub-node.
FromXmlString Populates the collection from an XML string.
GetBoolean
GetCurrency
GetDatabaseDateFromJsonUtcDate Get a Date in the Database Time Zone assuming the value was originally sourced from a JSON object containing a UTC date.
GetDate
GetDateRange
GetDecimal
GetDouble
GetEnum
GetEnumerator
GetInteger
GetKeyValueList
GetList Get a List from a delimited String value.
GetList2
GetListFromGroupingList Get a List from an entry that is stored as a Grouping Items collection (e.g., Item1;True|Item2;False|Item3;True).
GetListFromJsonArray Get a List from a JSON formatted array.
GetLong
GetNullableBoolean Returns a Nullable Boolean. If the Key does not exist or fails to convert to a Boolean, Null (Nothing) is returned.
GetNumberRange
GetObject
GetPercent
GetString
GetValue
HasValueStartsWith Determines whether any items have values where the Key starts with a specific String.
HasValues Determines whether any items have values.
Remove Removes an item with the specified key from the collection.
SetBoolean Set a Boolean value.
SetCurrency Set a Currency (Decimal) value.
SetDate Set a Date value.
SetDateRange Set a Date Range value.
SetDecimal Set a Decimal value.
SetDouble Set a Double value.
SetInteger Set an Integer value.
SetKeyValueList Set a Key/Value List value.
SetList Set an ISList value.
SetLong Set an Long value.
SetNumberRange Set a Number Range value.
SetObject Set an Object value.
SetPercent Set a Percentage value.
SetString Set a String value.
SetUserDefinedIndex Set the UserDefinedIndex of an item, ensuring that if another item has the same value that it is cleared (set to -1).
SetValue Set a value.
Sort Sorts the List into alphabetical order of "Keys".
ToCodeDescriptionList Create an ISCodeDescriptionList object where the Code is the Key and the Description is a string version of the Value.
ToCodeDescriptionListJsonObject Create an JSON object where the Code is the Key and the Description is a string version of the Value.
ToCodeDescriptionListJsonString Create a JSON string.
ToCsvString Converts to a CSV-style string.
ToHtmlWidgetParametersJsonString Converts the Key Value List into a JSON string that retains data-types and User Defined Indexes.
ToKeyValueListReadOnly Create a Read-Only Key Value List.
ToSimpleAdHocXmlString System Use Only
ToSimpleJsonString Converts the Key Value List into a simple JSON string.
ToUrlString Converts to a URL-style string.
ToUrlStringEncrypted Converts to an encrypted URL-style string that will be automatically decrypted in FromUrlString.
ToXmlString Persists collection to an XML string.
UpdateFromKeyValueList Update items in this Key/Value List with items defined in another Key/Value List.
UpdateFromSimpleJsonString Update existing and add new values from a Simple JSON Object without clearing existing entries.

Properties

Name Description
Count Read-Only The number of items in this collection.
CountAudited Read-Only Returns a Count of the Items that have the "Audit" flag set to True.
IsDirty Read-Only Indicates whether this object has been modified since being created, loaded or refreshed.
IsSynchronized Read-Only
ItemByIndex Read-Only Retrieve an item by its index in the collection.
ItemByUserDefinedIndex Read-Only Retrieve the first item whose UserDefinedIndex matches.
SyncRoot Read-Only
Namespace:
Intersoft.ISRuntime6
Assembly:
ISRuntime6, Version=6.0.3
Target Framework:
.NET 9.0