Fnd_List
24 shared methods.
- Fnd_List_AddButton
- Fnd_List_AddItem
- Fnd_List_AddToListEditor
- Fnd_List_ChoiceList
- Fnd_List_Clear
- Fnd_List_CommandDialog
- Fnd_List_CreateTable
- Fnd_List_DoesListExist
- Fnd_List_EditOne
- Fnd_List_EditOne2
- Fnd_List_Editor
- Fnd_List_Info
- Fnd_List_ListToRecord
- Fnd_List_Localize
- Fnd_List_OnExit
- Fnd_List_OnStartup
- Fnd_List_RecordLoaded
- Fnd_List_SaveListItems
- Fnd_List_UpdateItemsList
- Fnd_List_UpdateStructureLists
- Fnd_List_UseTypeAhead
- Fnd_List_XML_FilePath
- Fnd_List_XML_GetDateTime
- Fnd_List_XML_SetDateTime
Fnd_List_AddButton
Fnd_List_AddButton (label)
Allows the developer to add an additional button to the Choice List dialog.
| Parameter | Type | Direction | Description |
|---|---|---|---|
label | Text | in | The new button's label |
Fnd_List_AddItem
Fnd_List_AddItem (command name; method name)
Adds a command to the Command Dialog.
| Parameter | Type | Direction | Description |
|---|---|---|---|
commandName | Text | in | The command name to add to the dialog |
commandMethod | Text | in | The method name to run if it's selected |
Fnd_List_AddToListEditor
Fnd_List_AddToListEditor (listname)
Called from the Fnd_Hook_List_SetEditableLists method.
| Parameter | Type | Direction | Description |
|---|---|---|---|
listName | Text | in | The name of the list to make available. |
Fnd_List_ChoiceList
Fnd_List_ChoiceList (prompt; ->text array) --> Number
Allows the user to select an element from a list.
| Parameter | Type | Direction | Description |
|---|---|---|---|
prompt | Text | in | The prompt |
pointerTextArray | Pointer | in | A pointer to a text array |
Result | Longint | out | The selected element number |
Fnd_List_Clear
Fnd_List_Clear
Clears the Command List elements.
No parameters.
Fnd_List_CommandDialog
Fnd_List_CommandDialog
Displays the Admin dialog.
No parameters.
Fnd_List_CreateTable
Fnd_List_CreateTable
Global and IP variables accessed:
C_POINTER(<>Fnd_List_Table_ptr; <>Fnd_List_ListNameFld_ptr)
Method Type: Private
| Parameter | Type | Direction | Description |
|---|---|---|---|
Result | out | Nothing |
Fnd_List_DoesListExist
Fnd_List_DoesListExist (List Name) -> Boolean
Checks if a list exists
| Parameter | Type | Direction | Description |
|---|---|---|---|
listName | Text | in | A choice list defined in the List Editor |
Result | Boolean | out | True = The list exists |
Fnd_List_EditOne
Fnd_List_EditOne (list name)
Call this method to edit the specified list in a semi-modal dialog.
| Parameter | Type | Direction | Description |
|---|---|---|---|
listName | Text | in | The name of the list |
Fnd_List_EditOne2
Fnd_List_EditOne2 (list name)
Called as a new process by Fnd_List_EditOne to edit a list.
| Parameter | Type | Direction | Description |
|---|---|---|---|
listName | Text | in | The list name |
Fnd_List_Editor
Fnd_List_Editor
Displays the List Editor window in a new process.
No parameters.
Fnd_List_Info
Fnd_List_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_List_ListToRecord
Fnd_List_ListToRecord (list name)
Saves the list as a 4D list and as a record.
| Parameter | Type | Direction | Description |
|---|---|---|---|
listName | Text | in | The name of the list to save |
Fnd_List_Localize
Fnd_List_Localize
Passed the localization strings to the General and (if available) Localization components.
No parameters.
Fnd_List_OnExit
Fnd_List_OnExit
Stores the current date and time in both the structure file (as a list) and the data file (as a record). We can compare these at startup to determine if the structure file has been updated.
No parameters.
Fnd_List_OnStartup
Fnd_List_OnStartup
Called when the database is launched to determine if the lists in the structure file neeed to be updated from the lists in the data file.
No parameters.
Fnd_List_RecordLoaded
Fnd_List_RecordLoaded (->table{; timeout in seconds}) --> Boolean
Makes sure the current record is not locked. If it is, it waits a while to see if the record becomes avaialble.
If no timeout period is specified control is returned immediately if the record is locked.
| Parameter | Type | Direction | Description |
|---|---|---|---|
table | Pointer | in | The record's table |
inSecondsToWait | Longint | in | Number of seconds to wait if it's locked (optional) |
Result | Boolean | out | True if the record isn't locked |
Fnd_List_SaveListItems
Fnd_List_SaveListItems
Assumes the proper [Fnd_List] record is loaded.
Called from the Fnd_List_Editor and ListsCreateSystemLists2 methods.
No parameters.
Fnd_List_UpdateItemsList
Fnd_List_UpdateItemsList
Assumes the proper [Lists] record is loaded.
Assumes any previous changes to the list have been saved.
Called from the [Constants].ListEditor form.
No parameters.
Fnd_List_UpdateStructureLists
Fnd_List_UpdateStructureLists
Copies the Foundation maintained lists to the 4D structure file.
No parameters.
Fnd_List_UseTypeAhead
Fnd_List_UseTypeAhead ({$inBoolean_b : Boolean}) --> Boolean
Reports whether type-ahead is enabled for lists, and optionally sets it.
Getter and setter in one: called with no parameter it reports, called with one it sets and then reports. The setting lives on Fnd.List, so it persists for the session rather than the call.
| Parameter | Type | Direction | Description |
|---|---|---|---|
inBoolean | Boolean | in | Turns type-ahead on or off (optional) |
Result | Boolean | out | The setting after any change |
Fnd_List_XML_FilePath
Fnd_List_XML_FilePath --> Text
Returns the path to the Fnd_List.xml file.
| Parameter | Type | Direction | Description |
|---|---|---|---|
Result | Text | out | The file path |
Fnd_List_XML_GetDateTime
Fnd_List_XML_GetDateTime --> Text
Returns the date-time value stored in the Fnd_List.xml file.
| Parameter | Type | Direction | Description |
|---|---|---|---|
Result | Text | out | The date-time value |
Fnd_List_XML_SetDateTime
Fnd_List_XML_SetDateTime (date-time string)
Updates the Fnd_List.xml file with the last use date for this structure file.
| Parameter | Type | Direction | Description |
|---|---|---|---|
dateTime | Text | in | A date-time string (e.g.: "2007-10-16T17:55:04") |