Fnd_Sort
12 shared methods.
- Fnd_Sort_AddField
- Fnd_Sort_AddItem
- Fnd_Sort_AddSeparator
- Fnd_Sort_AddTable
- Fnd_Sort_Direction
- Fnd_Sort_Display
- Fnd_Sort_Info
- Fnd_Sort_Localize
- Fnd_Sort_OrderByEditor
- Fnd_Sort_PrefsGet
- Fnd_Sort_PrefsPut
- Fnd_Sort_SelectedField
Fnd_Sort_AddField
Fnd_Sort_AddField (->field{; position})
Lets the developer add a field to the Sort dialog. If a position isn't specified, the field is added to the end of the list.
| Parameter | Type | Direction | Description |
|---|---|---|---|
field | Pointer | in | A pointer to the field to add |
inPosition | Longint | in | The position in which to add the item (optional) |
Fnd_Sort_AddItem
Fnd_Sort_AddItem (position; label; method{; ->field{; type}})
Called by the protected "Fnd_Sort_Add" routines to add stuff to the arrays.
If the label is blank, the field name will be used.
| Parameter | Type | Direction | Description |
|---|---|---|---|
inPosition | Position | in | The position |
inFieldName | Text | in | The label |
method | Text | in | The method |
inField | Pointer | in | The field (optional) |
inFieldType | Longint | in | The field's type (optional) |
Fnd_Sort_AddSeparator
Fnd_Sort_AddSeparator ({position})
Adds a separator line to the list of sortable fields.
| Parameter | Type | Direction | Description |
|---|---|---|---|
inPosition | Longint | in | Position of the separator (optional) |
Fnd_Sort_AddTable
Fnd_Sort_AddTable (->table{; position})
Loads the visible, sortable fields for the specified table into an array named Fnd_Sort_Fields_aptr.
| Parameter | Type | Direction | Description |
|---|---|---|---|
table | Pointer | in | A pointer to the table to add |
inPosition | Longint | in | The position in which to add the item (optional) |
Fnd_Sort_Direction
Fnd_Sort_Direction ({direction}) --> Longint
Allows the developer to set or get the currently selected sort direction.
If a valid direction is specified, this routine will make it the default direction.
| Parameter | Type | Direction | Description |
|---|---|---|---|
desiredDirection | Longint | in | The desired sort direction (optional) |
Result | Longint | out | The current sort direction |
Fnd_Sort_Display
Fnd_Sort_Display ({->table})
Displays the simple Sort dialog. If the Macintosh Option key or Windows Alt key is down, 4D's Order By editor is displayed instead.
| Parameter | Type | Direction | Description |
|---|---|---|---|
inPointerTable | Pointer | in | A pointer to the table to use (optional) |
Fnd_Sort_Info
Fnd_Sort_Info (label) --> Text
Returns requested information. See the Fnd_Gen_ComponentInfo method for more information.
| Parameter | Type | Direction | Description |
|---|---|---|---|
request | Text | in | Info desired ("version" or "name") |
Result | Text | out | Response |
Fnd_Sort_Localize
Fnd_Sort_Localize
Passed the localization strings to the General and (if available) Localization components.
No parameters.
Fnd_Sort_OrderByEditor
Fnd_Sort_OrderByEditor
Displays the simple Sort dialog. If the Macintosh Option key or Windows Alt key is down, 4D's Order By editor is displayed instead.
No parameters.
Fnd_Sort_PrefsGet
Fnd_Sort_PrefsGet (pref name) --> Text
Gets a value from the user preferences if the Fnd_Pref component is available.
| Parameter | Type | Direction | Description |
|---|---|---|---|
prefName | Text | in | The preference name |
Result | Text | out | The saved value |
Fnd_Sort_PrefsPut
Fnd_Sort_PrefsPut (pref name; text value)
Adds an item to the user's preferences if the Fnd_Pref component is available.
| Parameter | Type | Direction | Description |
|---|---|---|---|
prefName | Text | in | The preference name |
textValue | Text | in | The value to store |
Fnd_Sort_SelectedField
Fnd_Sort_SelectedField ({->field}) --> Pointer
Allows the developer to set or get the currently selected sort field.
If a field pointer is specified, this routine will make it the default selection if it's available in the list. If not, nothing changes.
| Parameter | Type | Direction | Description |
|---|---|---|---|
desiredField | Pointer | in | The field to default to (optional) |
Result | Pointer | out | The selected sort field |