Namespace: Consultingwerk.Framework.Collections
Class 
HandleList Copy to Clipboard
Parent classes:
Inherits: Consultingwerk.Framework.Base.AblPrimitiveList
Implements: Consultingwerk.Framework.Base.ISupportsListChanged, Consultingwerk.Framework.Base.ISupportsListHash

File:HandleList
Purpose:A general purpose List class with a Character as
the key and a Integer as the value
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Sun Jan 22 16:02:41 CET 2012
Purpose: Constructor for the List class
Notes:



Top Method Summary
Options Name Purpose
+ Add (handle) Adds the specified value to the List.
+ AddWhenNotContained (handle) Adds the specified value to the List only when it is not yet contained - silently ignores keys that are already contained
+ Clear () Removes all keys and values from the List
Inherited from Consultingwerk.Framework.Base.AblPrimitiveList
+ LOGICAL ContainsValue (handle) Determines whether the List contains the specified value.
+ Consultingwerk.Framework.Collections.HandleListEnumerator GetEnumerator () Returns the Enumerator for the List
+ HANDLE GetValue (integer) Returns the Value for the specified Key
+ INTEGER IndexOf (handle) Returns the index of the given value in the list
+ Insert (handle, integer) Inserts the specified value to the List at the specified position
# InternalAdd (character) Adds the specified value to the list.
Inherited from Consultingwerk.Framework.Base.AblPrimitiveList
# LOGICAL InternalContainsValue (character) Determines whether the List contains the specified value.
Inherited from Consultingwerk.Framework.Base.AblPrimitiveList
# CHARACTER InternalGetValue (integer) Returns the Value for the specified Index
Inherited from Consultingwerk.Framework.Base.AblPrimitiveList
# INTEGER InternalIndexOf (character) Return the Index of the specified element
Inherited from Consultingwerk.Framework.Base.AblPrimitiveList
# InternalInsert (character, integer) Inserts the specified value to the List at the specified position
Inherited from Consultingwerk.Framework.Base.AblPrimitiveList
# InternalSetValue (integer, character) Assigns the Value for the specified Key
Inherited from Consultingwerk.Framework.Base.AblPrimitiveList
# OnListChanged (ListChangedEventArgs) Raises the ListChanged event
Inherited from Consultingwerk.Framework.Base.AblPrimitiveList
+ Remove (integer) Removes the Value on the given Index from the List
Inherited from Consultingwerk.Framework.Base.AblPrimitiveList
+ SetValue (integer, handle) Assigns the Value for the specified Key
+ HANDLE ToArray () Returns an array with the elements of the list
# ValidateValue (character) Validates a Value
Inherited from Consultingwerk.Framework.Base.AblPrimitiveList

Top Constructor Summary
Options Name Purpose
+ HandleList () Constructor for the List class
+ HandleList (longchar) Constructor for the List class
+ HandleList (longchar, character) Constructor for the List class

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

Top Property Summary
Options Name Purpose
+ INTEGER Count
Inherited from Consultingwerk.Framework.Base.AblPrimitiveList
+ CHARACTER ListHash
Inherited from Consultingwerk.Framework.Base.AblPrimitiveList
+ CHARACTER ValueDelimiter
Inherited from Consultingwerk.Framework.Base.AblPrimitiveList
+ LONGCHAR Values
Inherited from Consultingwerk.Framework.Base.AblPrimitiveList


Method Detail
Top

PUBLIC Add (handle)

Purpose: Adds the specified value to the List.
Notes:

Parameters:
pValue HANDLE
The value for the key/value pair to add to the List
Top

PUBLIC AddWhenNotContained (handle)

Purpose: Adds the specified value to the List only when it is not
yet contained - silently ignores keys that are already
contained
Notes:

Parameters:
pValue HANDLE
The value for the key/value pair to add to the List
Top

PUBLIC Clear ()

Inherited from Consultingwerk.Framework.Base.AblPrimitiveList
Purpose: Removes all keys and values from the List
Notes: Raises the ListChanged event

Top

PUBLIC LOGICAL ContainsValue (handle)

Purpose: Determines whether the List contains the specified value.
Notes:

Parameters:
pValue HANDLE
The value to locate in the List
Returns LOGICAL
Logical value indicating if the List contains the value
Top

PUBLIC Consultingwerk.Framework.Collections.HandleListEnumerator GetEnumerator ()

Purpose: Returns the Enumerator for the List
Notes:

Returns Consultingwerk.Framework.Collections.HandleListEnumerator
The Enumerator instance
Top

PUBLIC HANDLE GetValue (integer)

Purpose: Returns the Value for the specified Key
Notes:

Parameters:
piIndex INTEGER
The index to remove from the List
Returns HANDLE
The Value for the specified Index
Top

PUBLIC INTEGER IndexOf (handle)

Purpose: Returns the index of the given value in the list
Notes: Returns 0 if the value is not in the list

Parameters:
pValue HANDLE
The value to locate in the list
Returns INTEGER
The index of the given value in the list
Top

PUBLIC Insert (handle, integer)

Purpose: Inserts the specified value to the List at the specified position
Notes:

Parameters:
pValue HANDLE
The value for the key/value pair to add to the List
piPosition INTEGER
The position to add the new value to
Top

PROTECTED InternalAdd (character)

Inherited from Consultingwerk.Framework.Base.AblPrimitiveList
Purpose: Adds the specified value to the list.
Notes: Internal method, used by derived class (which converts from the
original value type to the CHARACTER value expected by this method)

Parameters:
pcValue CHARACTER
The value for the key/value pair to add to the List
Top

PROTECTED LOGICAL InternalContainsValue (character)

Inherited from Consultingwerk.Framework.Base.AblPrimitiveList
Purpose: Determines whether the List contains the specified value.
Notes: Internal method, used by derived class (which converts from the

Parameters:
pcValue CHARACTER
The value to locate in the List
Returns LOGICAL
True, when the value is contained in the List, otherwise false
Top

PROTECTED CHARACTER InternalGetValue (integer)

Inherited from Consultingwerk.Framework.Base.AblPrimitiveList
Purpose: Returns the Value for the specified Index
Notes: Internal method, used by derived class (which converts from the
original value type to the CHARACTER value expected by this method)

Parameters:
piIndex INTEGER
The index to remove from the List
Returns CHARACTER
The Value for the specified Index
Top

PROTECTED INTEGER InternalIndexOf (character)

Inherited from Consultingwerk.Framework.Base.AblPrimitiveList
Purpose: Return the Index of the specified element
Notes: Returns 0 if the value is not in the list

Parameters:
pcValue CHARACTER
The value to locate
Returns INTEGER
The Index of the given Value
Top

PROTECTED InternalInsert (character, integer)

Inherited from Consultingwerk.Framework.Base.AblPrimitiveList
Purpose: Inserts the specified value to the List at the specified position
Notes:

Parameters:
pcValue CHARACTER
The value for the key/value pair to add to the List
piPosition INTEGER
The position to add the new value to
Top

PROTECTED InternalSetValue (integer, character)

Inherited from Consultingwerk.Framework.Base.AblPrimitiveList
Purpose: Assigns the Value for the specified Key
Notes: Internal method, used by derived class (which converts from the
original value type to the CHARACTER value expected by this method)

Parameters:
piIndex INTEGER
The index to remove from the List
pcValue CHARACTER
The value to assign for the Key in the List
Top

PROTECTED OnListChanged (ListChangedEventArgs)

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

Inherited from Consultingwerk.Framework.Base.AblPrimitiveList
Purpose: Removes the Value on the given Index from the List
Notes: Internal method, used by derived class (which converts from the
original value type to the CHARACTER value expected by this method)

Parameters:
piEntry INTEGER
The index to remove from the List
Top

PUBLIC SetValue (integer, handle)

Purpose: Assigns the Value for the specified Key
Notes:

Parameters:
piIndex INTEGER
The index to remove from the List
pValue HANDLE
The value to assign for the Key in the List
Top

PUBLIC HANDLE ToArray ()

Purpose: Returns an array with the elements of the list
Notes:

Returns HANDLE
The array with the elements of the list
Top

PROTECTED ValidateValue (character)

Inherited from Consultingwerk.Framework.Base.AblPrimitiveList
Purpose: Validates a Value
Notes:

Parameters:
pcValue CHARACTER
The value to validate


Constructor Detail
Top

PUBLIC HandleList ()

Purpose: Constructor for the List class
Notes:

Top

PUBLIC HandleList (longchar)

Purpose: Constructor for the List class
Notes: Defaults to the comma (",") as the delimiter for Keys and Values

Parameters:
pcValues LONGCHAR
The initial list of Values
Top

PUBLIC HandleList (longchar, character)

Purpose: Constructor for the List class
Notes:

Parameters:
pcValues LONGCHAR
The initial list of Values
pcValueDelimiter CHARACTER
The delimiter for the Values


Event Detail
Top

PUBLIC ListChanged (Object, ListChangedEventArgs)

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

Returns INTEGER
Top

PUBLIC CHARACTER ListHash

Inherited from Consultingwerk.Framework.Base.AblPrimitiveList

Returns CHARACTER
Top

PUBLIC CHARACTER ValueDelimiter

Inherited from Consultingwerk.Framework.Base.AblPrimitiveList

Returns CHARACTER
Top

PUBLIC LONGCHAR Values

Inherited from Consultingwerk.Framework.Base.AblPrimitiveList

Returns LONGCHAR


©2006-2023 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       19.02.2024 07:26:35