Namespace: Consultingwerk.Framework.Base
Class 
List 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
SERIALIZABLE

File:List
Purpose:A List class for Progress.Lang.Object instances
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Sun Dec 27 15:01:32 CET 2009



Top Method Summary
Options Name Purpose
+ Progress.Lang.Object Add (Object) Adds an Item to the List
+ Add (Object[]) Adds the Items from an Array to the List
+ Progress.Lang.Object AddWhenNotContained (Object) Adds an Item to the List only when it is not yet contained - silently ignores items that are already contained
+ Clear () Removes all items from the List
+ LOGICAL Contains (Object) Determines if an object is a member of the List
+ Consultingwerk.Framework.Base.IEnumerator GetEnumerator () Returns a new IEnumerator instance for this object instance
+ Progress.Lang.Object GetItem (integer) Returns the Item at the specified Index
+ Progress.Lang.Object GetItemInternal__ (integer) Returns the Item at the specified Index
+ INTEGER IndexOf (Object) Determines the index of a specific item in the List
# OnListChanged (ListChangedEventArgs) Raises the ListChanged event
+ LOGICAL Remove (Object) Removes the first occurrence of a specific object from the List
+ LOGICAL RemoveAt (integer) Removes the List item at the specified index.
+ Progress.Lang.Object ToArray () Returns an Array with the elements of the List

Top Constructor Summary
Options Name Purpose
+ List () 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

Top Property Summary
Options Name Purpose
+ INTEGER Count
+ CHARACTER ListHash


Method Detail
Top

PUBLIC Progress.Lang.Object Add (Object)

Purpose: Adds an Item to the List
Notes:

Parameters:
poItem Progress.Lang.Object
The Item to add to the List
Returns Progress.Lang.Object
The item that was added to the List
Top

PUBLIC Add (Object[])

Purpose: Adds the Items from an Array to the List
Notes:

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

PUBLIC Progress.Lang.Object AddWhenNotContained (Object)

Purpose: Adds an Item to the List only when it is not
yet contained - silently ignores items that are already
contained
Notes:

Parameters:
poItem Progress.Lang.Object
The Item to add to the List
Returns Progress.Lang.Object
The item that was added to the List
Top

PUBLIC Clear ()

Purpose: Removes all items from the List
Notes:

Top

PUBLIC LOGICAL Contains (Object)

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 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 GetItem (integer)

Purpose: Returns the Item at the specified Index
Notes:

Parameters:
piIndex INTEGER
The index of the Item to be returned
Returns Progress.Lang.Object
The object at the specified list position
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 INTEGER IndexOf (Object)

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 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 LOGICAL Remove (Object)

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
Returns LOGICAL
Logical value indicating if the item was removed
Top

PUBLIC LOGICAL RemoveAt (integer)

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

Parameters:
piIndex INTEGER
The Index of the Item to remove from the List
Returns LOGICAL
Logical value indicating if the item was removed
Top

PUBLIC Progress.Lang.Object ToArray ()

Purpose: Returns an Array with the elements of the List
Notes:

Returns Progress.Lang.Object
The array of the elements of the List


Constructor Detail
Top

PUBLIC List ()

Purpose: Constructor for the List class
Notes:



Event Detail
Top

PUBLIC ListChanged (Object, ListChangedEventArgs)

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


Returns INTEGER
Top

PUBLIC CHARACTER ListHash


Returns CHARACTER


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