Namespace: Consultingwerk.Windows.ListAndLabel
Class 
ListReportBuffer Copy to Clipboard
Parent classes:
Inherits: Consultingwerk.Framework.Base.GenericList
Implements: IArrayList, IEnumerable, ISupportsListChanged, ISupportsListHash
SERIALIZABLE

File:ListReportBuffer
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Sun Oct 14 20:34:11 CEST 2012
Purpose: Adds an item to the generic List
Notes:



Top Method Summary
Options Name Purpose
+ Consultingwerk.Windows.ListAndLabel.ReportBuffer Add (character, DefineBufferAsEnum, logical) Creates a ReportBuffer with the given values and adds it to the List
+ Consultingwerk.Windows.ListAndLabel.ReportBuffer Add (ReportBuffer) Adds an item to the generic List
+ Add (ReportBuffer[]) Adds an array of items to the generic List
+ Consultingwerk.Windows.ListAndLabel.ReportBuffer AddWhenNotContained (ReportBuffer) Adds an item to the generic List only when it is not yet contained - silently ignores keys that are already contained
+ 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
+ IEnumerator GetEnumerator () Returns a new IEnumerator instance for this object instance
Inherited from Consultingwerk.Framework.Base.GenericList
+ Consultingwerk.Windows.ListAndLabel.ReportBuffer GetItem (integer) Retrieves an item from the generic List
+ Consultingwerk.Windows.ListAndLabel.ReportBuffer GetItemByBufferName (character) Gets a ReportBuffer definition by the Buffer Name
+ Progress.Lang.Object GetItemInternal__ (integer) Returns the Item at the specified Index
Inherited from Consultingwerk.Framework.Base.GenericList
+ 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
+ LOGICAL IsEmpty () Returns if the List is empty
# OnListChanged (ListChangedEventArgs) Raises the ListChanged event
Inherited from Consultingwerk.Framework.Base.GenericList
+ LOGICAL Remove (Object) Removes the first occurrence of a specific object from the List
Inherited from Consultingwerk.Framework.Base.GenericList
+ LOGICAL RemoveAt (integer) Removes the List item at the specified index.
Inherited from Consultingwerk.Framework.Base.GenericList
+ Consultingwerk.Windows.ListAndLabel.ReportBuffer 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
Inherited from Consultingwerk.Framework.Base.GenericList
+ CHARACTER ListHash
Inherited from Consultingwerk.Framework.Base.GenericList


Method Detail
Top

PUBLIC Consultingwerk.Windows.ListAndLabel.ReportBuffer Add (character, DefineBufferAsEnum, logical)

Purpose: Creates a ReportBuffer with the given values and adds it to the List
Notes:

Parameters:
pcBufferName CHARACTER
The name of the record buffer
poDefineBufferAs Consultingwerk.Windows.ListAndLabel.DefineBufferAsEnum
An DefineBufferAsEnum value
plMultiple LOGICAL
Logical value indicating if the buffer will be iterated using a Query
Returns Consultingwerk.Windows.ListAndLabel.ReportBuffer
The new ReportBuffer
Top

PUBLIC Consultingwerk.Windows.ListAndLabel.ReportBuffer Add (ReportBuffer)

Purpose: Adds an item to the generic List
Notes:

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

PUBLIC Add (ReportBuffer[])

Purpose: Adds an array of items to the generic List
Notes:

Parameters:
poItem Consultingwerk.Windows.ListAndLabel.ReportBuffer
An array of items of the Lists member type
Top

PUBLIC Consultingwerk.Windows.ListAndLabel.ReportBuffer AddWhenNotContained (ReportBuffer)

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

Parameters:
poItem Consultingwerk.Windows.ListAndLabel.ReportBuffer
And item of the Lists member type
Returns Consultingwerk.Windows.ListAndLabel.ReportBuffer
The new Item added to the List
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 IEnumerator GetEnumerator ()

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

Returns IEnumerator
The IEnumerator instance for this object
Top

PUBLIC Consultingwerk.Windows.ListAndLabel.ReportBuffer GetItem (integer)

Purpose: Retrieves an item from the generic List
Notes:

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

PUBLIC Consultingwerk.Windows.ListAndLabel.ReportBuffer GetItemByBufferName (character)

Purpose: Gets a ReportBuffer definition by the Buffer Name
Notes:

Parameters:
pcBufferName CHARACTER
The Buffer Name
Returns Consultingwerk.Windows.ListAndLabel.ReportBuffer
The ReportBuffer or ?
Top

PUBLIC Progress.Lang.Object GetItemInternal__ (integer)

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

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

PUBLIC LOGICAL IsEmpty ()

Purpose: Returns if the List is empty
Notes:

Returns LOGICAL
Logical value indicating if the list if empty
Top

PROTECTED OnListChanged (ListChangedEventArgs)

Inherited from Consultingwerk.Framework.Base.GenericList
Purpose: Raises the ListChanged event
Notes:

Parameters:
e ListChangedEventArgs
The ListChangedEventArgs object instance with the data of the ListChanged event
Top

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

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

PUBLIC Consultingwerk.Windows.ListAndLabel.ReportBuffer ToArray ()

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

Returns Consultingwerk.Windows.ListAndLabel.ReportBuffer
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 ListChangedEventArgs
The ListChangedEventArgs object instance with the data of the ListChanged event


Property Detail
Top

PUBLIC INTEGER Count

Inherited from Consultingwerk.Framework.Base.GenericList

Returns INTEGER
Top

PUBLIC CHARACTER ListHash

Inherited from Consultingwerk.Framework.Base.GenericList

Returns CHARACTER


©2006-2023 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       19.02.2024 08:01:01