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

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

File:ListSortField
Purpose:List of SortField instances
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:15.08.2018 22:47:43
Purpose: Adds an item to the generic List
Notes:

Navigate to: Methods | Constructors | Events | Properties | ProDatasets | Temp-Tables



Top Method Summary
Options Name Purpose
+ Consultingwerk.SortField Add (character) Adds an Item to this List
+ Consultingwerk.SortField Add (character, SortOrderEnum) Adds an Item to this List
+ Consultingwerk.SortField Add (SortField) Adds an item to the generic List
+ Add (SortField[]) Adds an array of items to the generic List
+ Consultingwerk.SortField AddWhenNotContained (SortField) 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
+ Progress.Lang.Object Clone () Clones the object instance
+ LOGICAL Contains (character) Returns if the list contains the given sort field
+ LOGICAL Contains (character, SortOrderEnum) Returns if the list contains the given sort field
+ LOGICAL Contains (Object) Determines if an object is a member of the List
Inherited from Consultingwerk.Framework.Base.GenericList
+ Consultingwerk.Framework.Base.IEnumerator GetEnumerator () Returns a new IEnumerator instance for this object instance
Inherited from Consultingwerk.Framework.Base.GenericList
+ Consultingwerk.SortField GetItem (integer) Retrieves an item from the generic List
+ 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 (character) Removes the sort field from the list
+ LOGICAL Remove (character, SortOrderEnum) Removes the sort field from the list
+ 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
+ Ccs.BusinessLogic.SortOrderEnum SortOrder (character) Returns the SortOrder of the given field
+ Consultingwerk.SortField ToArray () Returns an Array with the elements of the List
+ CHARACTER ToSortPhrase () Returns a sort phrase (query string)

Top Constructor Summary
Options Name Purpose
+ ListSortField () Constructor for the ListSortField class
+ ListSortField (character, SortOrderEnum) Constructor for the ListSortField class
+ ListSortField (character, SortOrderEnum, character, SortOrderEnum) Constructor for the ListSortField class
+ ListSortField (character, SortOrderEnum, character, SortOrderEnum, character, SortOrderEnum) Constructor for the ListSortField 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.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.SortField Add (character)
Purpose: Adds an Item to this List
Notes:

Parameters:
pcFieldName CHARACTER
The value for the FieldName property
Returns Consultingwerk.SortField
The Item that was created
Top

PUBLIC Consultingwerk.SortField Add (character, SortOrderEnum)
Purpose: Adds an Item to this List
Notes:

Parameters:
pcFieldName CHARACTER
The name of the field to add
poSortOrder Ccs.BusinessLogic.SortOrderEnum
The sort order of the field to add
Returns Consultingwerk.SortField
The Item that was created
Top

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

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

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

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

PUBLIC Consultingwerk.SortField AddWhenNotContained (SortField)
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.SortField
And item of the Lists member type
Returns Consultingwerk.SortField
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 Progress.Lang.Object Clone ()
Purpose: Clones the object instance
Notes:

Returns Progress.Lang.Object
The cloned object instance
Top

PUBLIC LOGICAL Contains (character)
Purpose: Returns if the list contains the given sort field
Notes:

Parameters:
pcFieldName CHARACTER
The name of the field
Returns LOGICAL
Logical value indicating if the field is contained in the list
Top

PUBLIC LOGICAL Contains (character, SortOrderEnum)
Purpose: Returns if the list contains the given sort field
Notes:

Parameters:
pcFieldName CHARACTER
The name of the field
poSortOrder Ccs.BusinessLogic.SortOrderEnum
The sort order of the
Returns LOGICAL
Logical value indicating if the field is contained in the list
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 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.SortField 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.SortField
The item of the Lists member type
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 Consultingwerk.Framework.Base.ListChangedEventArgs
The ListChangedEventArgs object instance with the data of the ListChanged event
Top

PUBLIC LOGICAL Remove (character)
Purpose: Removes the sort field from the list
Notes:

Parameters:
pcFieldName CHARACTER
The name of the field to remove
Returns LOGICAL
Logical value indicating if the field was deleted
Top

PUBLIC LOGICAL Remove (character, SortOrderEnum)
Purpose: Removes the sort field from the list
Notes:

Parameters:
pcFieldName CHARACTER
The name of the field to remove
poSortOrder Ccs.BusinessLogic.SortOrderEnum
The sort order of the field to remove
Returns LOGICAL
Logical value indicating if the field was deleted
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 Ccs.BusinessLogic.SortOrderEnum SortOrder (character)
Purpose: Returns the SortOrder of the given field
Notes: Returns ? when the field is not in the list

Parameters:
pcFieldName CHARACTER
The name of the field of return the SortOrder for
Returns Ccs.BusinessLogic.SortOrderEnum
The SortOrderEnum for the given field or ?
Top

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

Returns Consultingwerk.SortField
The array of elements of the Lists member type
Top

PUBLIC CHARACTER ToSortPhrase ()
Purpose: Returns a sort phrase (query string)
Notes:

Returns CHARACTER
The sort phrase represented by the ListSortField


Constructor Detail
Top

PUBLIC ListSortField ()
Purpose: Constructor for the ListSortField class
Notes:

Top

PUBLIC ListSortField (character, SortOrderEnum)
Purpose: Constructor for the ListSortField class
Notes: Adds an Item to this List

Parameters:
pcFieldName CHARACTER
The name of the field to add
poSortOrder Ccs.BusinessLogic.SortOrderEnum
The sort order of the field to add
Top

PUBLIC ListSortField (character, SortOrderEnum, character, SortOrderEnum)
Purpose: Constructor for the ListSortField class
Notes: Adds an Item to this List

Parameters:
pcFieldName1 CHARACTER
The name of the first field to add
poSortOrder1 Ccs.BusinessLogic.SortOrderEnum
The sort order of the first field to add
pcFieldName2 CHARACTER
The name of the second field to add
poSortOrder2 Ccs.BusinessLogic.SortOrderEnum
The sort order of the second field to add
Top

PUBLIC ListSortField (character, SortOrderEnum, character, SortOrderEnum, character, SortOrderEnum)
Purpose: Constructor for the ListSortField class
Notes: Adds an Item to this List

Parameters:
pcFieldName1 CHARACTER
The name of the first field to add
poSortOrder1 Ccs.BusinessLogic.SortOrderEnum
The sort order of the first field to add
pcFieldName2 CHARACTER
The name of the second field to add
poSortOrder2 Ccs.BusinessLogic.SortOrderEnum
The sort order of the second field to add
pcFieldName3 CHARACTER
The name of the third field to add
poSortOrder3 Ccs.BusinessLogic.SortOrderEnum
The sort order of the third field to add


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

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       15.04.2024 05:51:58