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


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
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
Consultingwerk.SortField GetItem (integer) Retrieves an item from the generic List
LOGICAL IsEmpty () Returns if the List is empty
LOGICAL Remove (character) Removes the sort field from the list
LOGICAL Remove (character, SortOrderEnum) Removes the sort field from the list
Consultingwerk.SortField Replace (SortField, SortField) Replaces an item in the generic List
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


Method Detail
Top

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

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

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

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

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

Progress.Lang.Object Clone ()
Purpose: Clones the object instance
Notes:

Returns Progress.Lang.Object
The cloned object instance
Top

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

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

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

LOGICAL IsEmpty ()
Purpose: Returns if the List is empty
Notes:

Returns LOGICAL
Logical value indicating if the list if empty
Top

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

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

Consultingwerk.SortField Replace (SortField, SortField)
Purpose: Replaces an item in the generic List
Notes:

Parameters:
poExistingItem Consultingwerk.SortField
The item to replace
poNewItem Consultingwerk.SortField
The new item
Returns Consultingwerk.SortField
The reference to the replaced item
Top

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

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

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

Returns CHARACTER
The sort phrase represented by the ListSortField


Constructor Detail
Top

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

Top

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

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

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


©2006-2026 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       30.03.2026 11:04:40