Namespace: Consultingwerk.SmartComponents.Base
Class 
DictionaryISmartDataSource Copy to Clipboard
Parent classes:
Inherits: Consultingwerk.Framework.Base.GenericDictionary
Implements: Consultingwerk.Framework.Base.IArrayList, Consultingwerk.Framework.Base.IEnumerable, Consultingwerk.Framework.Base.ISupportsListChanged, Consultingwerk.Framework.Base.ISupportsListHash

File:DictionarySmartDataSource
Purpose:Dictionary of ISmartDataSource instances
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Mon Apr 20 17:05:08 CEST 2015
Purpose: Adds an item to the generic Dictionary
Notes:



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

Top Event Summary
Options Name Purpose
+ ListChanged (Object, ListChangedEventArgs) Raised when the Dictionary is changed by adding or removing items or clearing the dictionary
Inherited from Consultingwerk.Framework.Base.GenericDictionary

Top Property Summary
Options Name Purpose
+ INTEGER Count
Inherited from Consultingwerk.Framework.Base.GenericDictionary
+ CharacterList Keys
Inherited from Consultingwerk.Framework.Base.GenericDictionary
+ CHARACTER ListHash
Inherited from Consultingwerk.Framework.Base.GenericDictionary


Method Detail
Top

PUBLIC Consultingwerk.SmartComponents.Interfaces.ISmartDataSource Add (character, ISmartDataSource)

Purpose: Adds an item to the generic Dictionary
Notes:

Parameters:
pcKey CHARACTER
The key value
poItem Consultingwerk.SmartComponents.Interfaces.ISmartDataSource
And item of the Lists member type
Returns Consultingwerk.SmartComponents.Interfaces.ISmartDataSource
The item that was added to the List
Top

PUBLIC Consultingwerk.SmartComponents.Interfaces.ISmartDataSource AddWhenNotContained (character, ISmartDataSource)

Purpose: Adds an item to the generic Dictionary
Notes:

Parameters:
pcKey CHARACTER
The key value
poItem Consultingwerk.SmartComponents.Interfaces.ISmartDataSource
And item of the Lists member type
Returns Consultingwerk.SmartComponents.Interfaces.ISmartDataSource
The item that was added to the List
Top

PUBLIC Clear ()

Inherited from Consultingwerk.Framework.Base.GenericDictionary
Purpose: Removes all items from the Dictionary
Notes:

Top

PUBLIC LOGICAL ContainsItem (Object)

Inherited from Consultingwerk.Framework.Base.GenericDictionary
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)

Inherited from Consultingwerk.Framework.Base.GenericDictionary
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 ()

Inherited from Consultingwerk.Framework.Base.GenericDictionary
Purpose: Returns a new IEnumerator instance for this object instance
Notes:

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

PUBLIC Consultingwerk.SmartComponents.Interfaces.ISmartDataSource GetItem (character)

Purpose: Retrieves an item from the generic Dictionary
Notes: CAST's the element from the underlying Progress.Lang.Object

Parameters:
pcKey CHARACTER
The key of the item to retrieve
Returns Consultingwerk.SmartComponents.Interfaces.ISmartDataSource
The item of the Lists member type
Top

PUBLIC Progress.Lang.Object GetItemInternal__ (integer)

Inherited from Consultingwerk.Framework.Base.GenericDictionary
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 Consultingwerk.SmartComponents.Interfaces.ISmartDataSource GetItemOrNull (character)

Purpose: Retrieves an item from the generic Dictionary
Notes: CAST's the element from the underlying Progress.Lang.Object
This method does not fail when the key is not valid

Parameters:
pcKey CHARACTER
The key of the item to retrieve
Returns Consultingwerk.SmartComponents.Interfaces.ISmartDataSource
The item of the Lists member type
Top

PUBLIC CHARACTER GetKey (Object)

Inherited from Consultingwerk.Framework.Base.GenericDictionary
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)

Inherited from Consultingwerk.Framework.Base.GenericDictionary
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)

Inherited from Consultingwerk.Framework.Base.GenericDictionary
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)

Inherited from Consultingwerk.Framework.Base.GenericDictionary
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)

Inherited from Consultingwerk.Framework.Base.GenericDictionary
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 LOGICAL RemoveItem (Object)

Inherited from Consultingwerk.Framework.Base.GenericDictionary
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)

Inherited from Consultingwerk.Framework.Base.GenericDictionary
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)

Inherited from Consultingwerk.Framework.Base.GenericDictionary
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


Event Detail
Top

PUBLIC ListChanged (Object, ListChangedEventArgs)

Inherited from Consultingwerk.Framework.Base.GenericDictionary
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

Inherited from Consultingwerk.Framework.Base.GenericDictionary

Returns INTEGER
Top

PUBLIC CharacterList Keys

Inherited from Consultingwerk.Framework.Base.GenericDictionary

Returns CharacterList
Top

PUBLIC CHARACTER ListHash

Inherited from Consultingwerk.Framework.Base.GenericDictionary

Returns CHARACTER


©2006-2020 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       27.09.2022 23:48:17