Namespace: Consultingwerk
Class 
ListNameValuePair Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.Framework.Base.GenericList
Consultingwerk.ListNameValuePair

Inherits: Consultingwerk.Framework.Base.GenericList
Implements: Consultingwerk.Framework.Base.IEnumerable, Consultingwerk.Framework.Base.ISupportsListChanged, Consultingwerk.Framework.Base.ISupportsListHash

File:ListNameValuePair
Purpose:List of NameValuePair implementations
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Thu Mar 31 20:39:40 CEST 2011
Notes:Simplified dictionary implementation

Navigate to: Methods | Constructors | Events | Properties



Top Method Summary
Options Name Purpose
+ Consultingwerk.NameValuePair Add (character, character) Adds a NameValuePair to the List
+ Consultingwerk.NameValuePair Add (NameValuePair) Adds an item to the generic List
+ Add (NameValuePair[]) Adds an array of items to the generic List
+ Clear () Removes all items from the List
Inherited from Consultingwerk.Framework.Base.GenericList
+ LOGICAL Contains (Object) Determines if an object is a member of the List
Inherited from Consultingwerk.Framework.Base.GenericList
+ LOGICAL ContainsName (character) Returns if the ListNameValuePair contains a pair this the given Name
+ Consultingwerk.NameValuePair FindByName (character) Finds a NameValuePair by it's Name
+ Consultingwerk.ListNameValuePair FromSingleDelimitedList (character) Returns a ListNameValuePair from a single delimited list
+ Consultingwerk.ListNameValuePair FromSingleDelimitedList (character, character) Returns a ListNameValuePair from a single delimited list
+ Consultingwerk.Framework.Base.IEnumerator GetEnumerator () Returns a new IEnumerator instance for this object instance
Inherited from Consultingwerk.Framework.Base.GenericList
+ Consultingwerk.NameValuePair GetItem (integer) Retrieves an item from the generic List
+ CHARACTER GetValueByPair (character) Returns the value for the given Name
+ INTEGER IndexOf (Object) Determines the index of a specific item in the List
Inherited from Consultingwerk.Framework.Base.GenericList
# InternalAdd (Object) Adds an Item to the List
Inherited from Consultingwerk.Framework.Base.GenericList
# InternalAdd (Object[]) Adds the Items from an Array to the List
Inherited from Consultingwerk.Framework.Base.GenericList
# Progress.Lang.Object InternalGetItem (integer) Returns the Item at the specified Index
Inherited from Consultingwerk.Framework.Base.GenericList
# OnListChanged (ListChangedEventArgs) Raises the ListChanged event
Inherited from Consultingwerk.Framework.Base.GenericList
+ Remove (Object) Removes the first occurrence of a specific object from the List
Inherited from Consultingwerk.Framework.Base.GenericList
+ RemoveAt (integer) Removes the List item at the specified index.
Inherited from Consultingwerk.Framework.Base.GenericList
+ Consultingwerk.NameValuePair ToArray () Returns an Array with the elements of the List

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

Top Property Summary
Options Name Purpose
+ INTEGER Count Returns the Lists item count
Inherited from Consultingwerk.Framework.Base.GenericList
+ CHARACTER ListHash Returns a hash value representing the current list contents
Inherited from Consultingwerk.Framework.Base.GenericList


Method Detail
Top

PUBLIC Consultingwerk.NameValuePair Add (character, character)
Purpose: Adds a NameValuePair to the List
Notes:

Parameters:
pcName CHARACTER
The Name value
pcValue CHARACTER
The value
Returns Consultingwerk.NameValuePair
The new NameValuePair added to the List
Top

PUBLIC Consultingwerk.NameValuePair Add (NameValuePair)
Purpose: Adds an item to the generic List
Notes:

Parameters:
poItem Consultingwerk.NameValuePair
And item of the Lists member type
Returns Consultingwerk.NameValuePair
The new Item added to the List
Top

PUBLIC Add (NameValuePair[])
Purpose: Adds an array of items to the generic List
Notes:

Parameters:
poItem Consultingwerk.NameValuePair
An array of items of the Lists member type
Top

PUBLIC Clear ()
Inherited from Consultingwerk.Framework.Base.GenericList
Purpose: Removes all items from the List
Notes:

Top

PUBLIC LOGICAL Contains (Object)
Inherited from Consultingwerk.Framework.Base.GenericList
Purpose: Determines if an object is a member of the List
Notes:

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

PUBLIC LOGICAL ContainsName (character)
Purpose: Returns if the ListNameValuePair contains a pair this the given Name
Notes:

Parameters:
pcName CHARACTER
The Name value to search
Returns LOGICAL
True, when the ListNameValuePair contains a pair this the given Name
Top

PUBLIC Consultingwerk.NameValuePair FindByName (character)
Purpose: Finds a NameValuePair by it's Name
Notes: Performs a FIND-FIRST, does not verify if there is a second pair
with the same name

Parameters:
pcName CHARACTER
The Name value to search
Returns Consultingwerk.NameValuePair
The matching NameValuePair or ? when no Pair has been found
Top

PUBLIC Consultingwerk.ListNameValuePair FromSingleDelimitedList (character)
Purpose: Returns a ListNameValuePair from a single delimited list
Notes: name1,name2,name3

Parameters:
pcList CHARACTER
The simple delimited list
Returns Consultingwerk.ListNameValuePair
The new ListNameValuePair
Top

PUBLIC Consultingwerk.ListNameValuePair FromSingleDelimitedList (character, character)
Purpose: Returns a ListNameValuePair from a single delimited list
Notes: name1,name2,name3

Parameters:
pcList CHARACTER
The simple delimited list
pcDelimiter CHARACTER
The list delimiter
Returns Consultingwerk.ListNameValuePair
The new ListNameValuePair
Top

PUBLIC Consultingwerk.Framework.Base.IEnumerator GetEnumerator ()
Inherited from Consultingwerk.Framework.Base.GenericList
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.NameValuePair GetItem (integer)
Purpose: Retrieves an item from the generic List
Notes: CAST's the element from the underlying Progress.Lang.Object based
list

Parameters:
piIndex INTEGER
The 1 based index of the item to retrieve
Returns Consultingwerk.NameValuePair
The item of the Lists member type
Top

PUBLIC CHARACTER GetValueByPair (character)
Purpose: Returns the value for the given Name
Notes: When the Name is used in the List more than once, the first occurence
is returned

Parameters:
pcName CHARACTER
The Name value to search
Returns CHARACTER
The Value of the Pair with the given Name or ? when no pair was found
Top

PUBLIC INTEGER IndexOf (Object)
Inherited from Consultingwerk.Framework.Base.GenericList
Purpose: Determines the index of a specific item in the List
Notes:

Parameters:
poListItem Progress.Lang.Object
The object to locate in the List
Returns INTEGER
Integer value indicating if position of the object in the list
Top

PROTECTED InternalAdd (Object)
Inherited from Consultingwerk.Framework.Base.GenericList
Purpose: Adds an Item to the List
Notes: Protected method to be overridden in the actual generic List class

Parameters:
poItem Progress.Lang.Object
The Item to add to the List
Top

PROTECTED InternalAdd (Object[])
Inherited from Consultingwerk.Framework.Base.GenericList
Purpose: Adds the Items from an Array to the List
Notes: Protected method to be overridden in the actual generic List class

Parameters:
poItem Progress.Lang.Object
The Array of Items to add to the List
Top

PROTECTED Progress.Lang.Object InternalGetItem (integer)
Inherited from Consultingwerk.Framework.Base.GenericList
Purpose: Returns the Item at the specified Index
Notes: Protected method to be overridden in the actual generic List class

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

PROTECTED OnListChanged (ListChangedEventArgs)
Inherited from Consultingwerk.Framework.Base.GenericList
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 Remove (Object)
Inherited from Consultingwerk.Framework.Base.GenericList
Purpose: Removes the first occurrence of a specific object from the List
Notes:

Parameters:
poListItem Progress.Lang.Object
The member to remove from the List
Top

PUBLIC RemoveAt (integer)
Inherited from Consultingwerk.Framework.Base.GenericList
Purpose: Removes the List item at the specified index.
Notes:

Parameters:
piIndex INTEGER
The Index of the Item to remove from the List
Top

PUBLIC Consultingwerk.NameValuePair ToArray ()
Purpose: Returns an Array with the elements of the List
Notes:

Returns Consultingwerk.NameValuePair
The array of elements of the Lists member type


Event Detail
Top

PUBLIC ListChanged (Object, ListChangedEventArgs)
Inherited from Consultingwerk.Framework.Base.GenericList
Purpose: Raised when the List is changed by adding or removing items or
clearing the list
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.GenericList
Purpose: Returns the Lists item count
Notes:

Returns INTEGER
Top

PUBLIC CHARACTER ListHash
Inherited from Consultingwerk.Framework.Base.GenericList
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:29:23