Namespace: Consultingwerk.Framework.Base
Class 
GenericDictionary Copy to Clipboard
Parent classes:
Inherits: Progress.Lang.Object
Implements: Consultingwerk.Framework.Base.IArrayList, Consultingwerk.Framework.Base.IEnumerable, Consultingwerk.Framework.Base.ISupportsListChanged, Consultingwerk.Framework.Base.ISupportsListHash
Inherited by: Consultingwerk.WindowIntegrationKit.Controls.RenderedBrowseControlDictionary Consultingwerk.SmartComponents.Base.DictionaryISmartDataSource Consultingwerk.SmartComponents.Support.DictionaryIClassCache Consultingwerk.Framework.Base.Dictionary Consultingwerk.Framework.Collections.DictionaryPrimitiveHolder Consultingwerk.ListQueryExpressionByTable Consultingwerk.SmartComponents.TypeDescriptor.PropertyDescriptorCollection Consultingwerk.SmartComponents.TypeDescriptor.Components.PropertiesSmartBindingSource Consultingwerk.SmartComponents.TypeDescriptor.Components.PropertiesSmartBusinessEntityAdapter Consultingwerk.SmartComponents.TypeDescriptor.Components.PropertiesSmartBusinessEntityBindingSource Consultingwerk.SmartComponents.TypeDescriptor.Components.PropertiesSmartBusinessEntityLookup Consultingwerk.SmartComponents.TypeDescriptor.Components.PropertiesSmartBusinessEntityLookupDesign Consultingwerk.SmartComponents.TypeDescriptor.Components.PropertiesSmartComboEditor Consultingwerk.SmartComponents.TypeDescriptor.Components.PropertiesSmartComboEditorDesign Consultingwerk.SmartComponents.TypeDescriptor.Components.PropertiesSmartDataAdapter Consultingwerk.SmartComponents.TypeDescriptor.Components.PropertiesSmartDataBrowser Consultingwerk.SmartComponents.TypeDescriptor.Components.PropertiesSmartDataObjectAdapter Consultingwerk.SmartComponents.TypeDescriptor.Components.PropertiesSmartDataObjectBindingSource Consultingwerk.SmartComponents.TypeDescriptor.Components.PropertiesSmartDataObjectLookup Consultingwerk.SmartComponents.TypeDescriptor.Components.PropertiesSmartDatasetAdapter Consultingwerk.SmartComponents.TypeDescriptor.Components.PropertiesSmartDatasetChildAdapter Consultingwerk.SmartComponents.TypeDescriptor.Components.PropertiesSmartLookup Consultingwerk.SmartComponents.TypeDescriptor.Components.PropertiesSmartPanelController Consultingwerk.SmartComponents.TypeDescriptor.Components.PropertiesSmartTempTableAdapter Consultingwerk.SmartComponents.TypeDescriptor.Components.PropertiesSmartToolbarController Consultingwerk.SmartComponents.TypeDescriptor.Components.PropertiesSmartUpdatableBrowser Consultingwerk.SmartComponents.TypeDescriptor.Components.PropertiesSmartViewerControl Consultingwerk.SmartComponents.TypeDescriptor.PropertyDescriptorCollectionCollection Consultingwerk.SmartFramework.Repository.DictionaryAttributeValue Consultingwerk.Web2.Services.Push.DictionaryFirebaseEndpoint Consultingwerk.Web2.SmartFramework.Language.DictionarySerializableSmartLanguage
ABSTRACT SERIALIZABLE

File:GenericDictionary
Purpose:Am abstract generic dictionary foundation
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Sun Dec 27 15:01:32 CET 2009



Top Method Summary
Options Name Purpose
+ Clear () Removes all items from the Dictionary
+ LOGICAL ContainsItem (Object) Determines if an object is a member of the Dictionary
+ LOGICAL ContainsKey (character) Determines if an key is a member of the Dictionary
+ Consultingwerk.Framework.Base.IEnumerator GetEnumerator () Returns a new IEnumerator instance for this object instance
+ Progress.Lang.Object GetItemInternal__ (integer) Returns the Item at the specified Index
+ CHARACTER GetKey (Object) Returns the Key of the specified Item
# Progress.Lang.Object InternalAdd (character, Object) Adds an Item to the Dictionary
# Progress.Lang.Object InternalGetItem (character) Returns the Item at the specified Index
# Progress.Lang.Object InternalGetItemOrUnknown (character) Returns the Item with the specified key
# OnListChanged (ListChangedEventArgs) Raises the ListChanged event
- RemoveEntry (integer) Removes an entry from the list of keys and values
+ LOGICAL RemoveItem (Object) Removes the first occurrence of a specific object from the Dictionary
+ RemoveKey (character) Removes the Dictionary item with the specified key
+ RemoveKeys (character) Removes the Dictionary items with the specified keys

Top Constructor Summary
Options Name Purpose
# GenericDictionary () Constructor for the Dictionary class

Top Event Summary
Options Name Purpose
+ ListChanged (Object, ListChangedEventArgs) Raised when the Dictionary is changed by adding or removing items or clearing the dictionary

Top Property Summary
Options Name Purpose
+ INTEGER Count
+ Consultingwerk.Framework.Collections.CharacterList Keys
+ CHARACTER ListHash


Method Detail
Top

PUBLIC Clear ()

Purpose: Removes all items from the Dictionary
Notes:

Top

PUBLIC LOGICAL ContainsItem (Object)

Purpose: Determines if an object is a member of the Dictionary
Notes:

Parameters:
poItem Progress.Lang.Object
The object to locate in the Dictionary
Returns LOGICAL
Logical value indicating if the object is contained in the Dictionary
Top

PUBLIC LOGICAL ContainsKey (character)

Purpose: Determines if an key is a member of the Dictionary
Notes:

Parameters:
pcKey CHARACTER
The key to locate in the Dictionary
Returns LOGICAL
Logical value indicating if the object is contained in the Dictionary
Top

PUBLIC Consultingwerk.Framework.Base.IEnumerator GetEnumerator ()

Purpose: Returns a new IEnumerator instance for this object instance
Notes:

Returns Consultingwerk.Framework.Base.IEnumerator
The IEnumerator instance for this object
Top

PUBLIC Progress.Lang.Object GetItemInternal__ (integer)

Purpose: Returns the Item at the specified Index
Notes: This method is only intended to be used by the ListEnumerator
Any other use of this method is not supported

Parameters:
piIndex INTEGER
The index of the Item to be returned
Returns Progress.Lang.Object
The object at the specified list position
Top

PUBLIC CHARACTER GetKey (Object)

Purpose: Returns the Key of the specified Item
Notes:

Parameters:
poItem Progress.Lang.Object
The Item to return the Key for
Returns CHARACTER
The Key of the given Item
Top

PROTECTED Progress.Lang.Object InternalAdd (character, Object)

Purpose: Adds an Item to the Dictionary
Notes:

Parameters:
pcKey CHARACTER
The key value
poItem Progress.Lang.Object
The Item to add to the Dictionary
Returns Progress.Lang.Object
The item that was added to the dictionary
Top

PROTECTED Progress.Lang.Object InternalGetItem (character)

Purpose: Returns the Item at the specified Index
Notes:

Parameters:
pcKey CHARACTER
The Key of the Item to be returned
Returns Progress.Lang.Object
The object at the specified dictionary position
Top

PROTECTED Progress.Lang.Object InternalGetItemOrUnknown (character)

Purpose: Returns the Item with the specified key
Notes: This method does not fail when the key is not valid

Parameters:
pcKey CHARACTER
The Key of the Item to be returned
Returns Progress.Lang.Object
The object at the specified dictionary position
Top

PROTECTED OnListChanged (ListChangedEventArgs)

Purpose: Raises the ListChanged event
Notes:

Parameters:
e Consultingwerk.Framework.Base.ListChangedEventArgs
The ListChangedEventArgs object instance with the data of the ListChanged event
Top

PRIVATE RemoveEntry (integer)

Purpose: Removes an entry from the list of keys and values
Notes:

Parameters:
piPos INTEGER
The position of the entry to remove
Top

PUBLIC LOGICAL RemoveItem (Object)

Purpose: Removes the first occurrence of a specific object from the Dictionary
Notes:

Parameters:
poDictionaryItem Progress.Lang.Object
The member to remove from the Dictionary
Returns LOGICAL
Logical value indicating if the item has been removed
Top

PUBLIC RemoveKey (character)

Purpose: Removes the Dictionary item with the specified key
Notes: Raises an InvalidDictionaryKeyException for non existing keys

Parameters:
pcKey CHARACTER
The Key of the Item to remove from the Dictionary
Top

PUBLIC RemoveKeys (character)

Purpose: Removes the Dictionary items with the specified keys
Notes: Does not raise an error for invalid keys

Parameters:
pcKeys CHARACTER
The Keys of the Items to remove from the Dictionary


Constructor Detail
Top

PROTECTED GenericDictionary ()

Purpose: Constructor for the Dictionary class
Notes:



Event Detail
Top

PUBLIC ListChanged (Object, ListChangedEventArgs)

Purpose: Raised when the Dictionary is changed by adding or removing items or
clearing the dictionary
Notes:

Parameters:
sender Progress.Lang.Object
The sender of the event
e Consultingwerk.Framework.Base.ListChangedEventArgs
The ListChangedEventArgs object instance with the data of the ListChanged event


Property Detail
Top

PUBLIC INTEGER Count


Returns INTEGER
Top

PUBLIC Consultingwerk.Framework.Collections.CharacterList Keys


Returns Consultingwerk.Framework.Collections.CharacterList
Top

PUBLIC CHARACTER ListHash


Returns CHARACTER


©2006-2020 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       21.11.2022 08:24:06