Namespace: Consultingwerk.Framework.Base
Class 
GenericDictionary Copy to Clipboard
Parent classes:
Inherits: Progress.Lang.Object
Implements: Consultingwerk.Framework.Base.IEnumerable, Consultingwerk.Framework.Base.ISupportsListChanged, Consultingwerk.Framework.Base.ISupportsListHash
Inherited by: Consultingwerk.SmartComponents.Base.DictionaryISmartDataSource, Consultingwerk.SmartComponents.Support.DictionaryIClassCache, 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.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.ListQueryExpressionByTable
ABSTRACT

File:List
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 InternalAdd (character, Object) Adds an Item to the Dictionary
# Progress.Lang.Object InternalGetItem (character) Returns the Item at the specified Index
# OnListChanged (ListChangedEventArgs) Raises the ListChanged event
+ RemoveItem (Object) Removes the first occurrence of a specific object from the Dictionary
+ RemoveKey (character) Removes the Dictionary item at the specified index.

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 Returns the Dictionaries item count
+ CHARACTER ListHash Returns a hash value representing the current list contents


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

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 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

PUBLIC 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
Top

PUBLIC RemoveKey (character)

Purpose: Removes the Dictionary item at the specified index.
Notes:

Parameters:
pcKey CHARACTER
The Index of the Item 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

Purpose: Returns the Dictionaries item count
Notes:

Returns INTEGER
Top

PUBLIC CHARACTER ListHash

Purpose: Returns a hash value representing the current list contents
Notes:

Returns CHARACTER


©2006-2016 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       26.08.2016 08:28:37