Fnd_Find
21 shared methods.
- Fnd_Find_AddCustom
- Fnd_Find_AddField
- Fnd_Find_AddItem
- Fnd_Find_AddMultiField
- Fnd_Find_AddSeparator
- Fnd_Find_AddSubfield
- Fnd_Find_AddTable
- Fnd_Find_BestPopupSize
- Fnd_Find_Display
- Fnd_Find_Engine
- Fnd_Find_Engine2
- Fnd_Find_Engine3
- Fnd_Find_GetExtraWidth
- Fnd_Find_Info
- Fnd_Find_Localize
- Fnd_Find_Now
- Fnd_Find_PrefsGet
- Fnd_Find_PrefsPut
- Fnd_Find_SetEditorButton
- Fnd_Find_SizeArrayObject
- Fnd_Find_UpdateOperators
Fnd_Find_AddCustom
Fnd_Find_AddCustom (label; method name{; position})
Adds a custom field to the search dialog.
| Parameter | Type | Direction | Description |
|---|---|---|---|
label | Text | in | The label to use |
method | Text | in | The method to call |
inPosition | Longint | in | The position (optional) |
Fnd_Find_AddField
Fnd_Find_AddField (->field{; position})
Lets the developer add a field to the search 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_Find_AddItem
Fnd_Find_AddItem (position; label; method{; ->field{; type}})
Called by the protected "Fnd_Find_Add" routines to add stuff to the arrays.
If the label is blank, the field name will be used.
| Parameter | Type | Direction | Description |
|---|---|---|---|
inPosition | Longint | in | The position |
label | Text | in | The label |
method | Text | in | The method |
inField | Pointer | in | The field (optional) |
inFieldType | Longint | in | The field's type (optional) |
Fnd_Find_AddMultiField
Fnd_Find_AddMultiField (->array of field ptrs; label{; position})
Lets the developer add one item for searching multiple fields.
| Parameter | Type | Direction | Description |
|---|---|---|---|
field | Pointer | in | A pointer to an array of pointers |
label | Text | in | The label for the popup item |
inPosition | Longint | in | The position in which to add the first item (optional) |
Fnd_Find_AddSeparator
Fnd_Find_AddSeparator ({position})
Adds a separator line to the list of searchable fields.
| Parameter | Type | Direction | Description |
|---|---|---|---|
inPosition | Longint | in | Position of the separator (optional) |
Fnd_Find_AddSubfield
Fnd_Find_AddSubfield (->subfield; field type{; position})
Lets the developer add a subfield to the Find dialog. The field type must be specified because we can't procedurally determine this like we can for fields. 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 |
fieldType | Longint | in | The type of the subfield |
inPosition | Longint | in | The position in which to add the item (optional) |
Fnd_Find_AddTable
Fnd_Find_AddTable (->table{; position})
Loads the visible, searchable fields for the specified table into an array named Fnd_Find_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_Find_BestPopupSize
Fnd_Find_BestPopupSize (->popup array) --> Number
Returns the best object width to use for a pop-up menu form object.
| Parameter | Type | Direction | Description |
|---|---|---|---|
array | Pointer | in | The array associated with the popup |
Result | Longint | out | The best object size for the pop-up |
Fnd_Find_Display
Fnd_Find_Display
Displays a Find dialog and performs the query.
No parameters.
Fnd_Find_Engine
Fnd_Find_Engine ("Query" or "Query Selection")
Does the grunt work.
| Parameter | Type | Direction | Description |
|---|---|---|---|
searchScope | Text | in | Either "Query" or "Query Selection" |
Fnd_Find_Engine2
Fnd_Find_Engine2 ("Query" or "Query Selection"; ->field; operator)
Adds a query to the built search.
| Parameter | Type | Direction | Description |
|---|---|---|---|
searchScope | Text | in | Either "Query" or "Query Selection" |
field | Pointer | in | A pointer to the field to search |
operator | Text | in | The operator code to use |
Fnd_Find_Engine3
Fnd_Find_Engine3 ("Query" or "Query Selection"; ->field; operator)
Adds a query to the built search.
Exactly the same as Fnd_Find_Engine2, but with "|" operators.
| Parameter | Type | Direction | Description |
|---|---|---|---|
searchScope | Text | in | Either "Query" or "Query Selection" |
field | Pointer | in | A pointer to the field to search |
operator | Text | in | The operator code to use |
Fnd_Find_GetExtraWidth
Fnd_Find_GetExtraWidth --> Number
Returns the extra width needed to display the Find dialog so none of the text in the pop-up menus gets truncated.
Lots of stuff is hard-coded here because we can't get it procedurally. :-(
| Parameter | Type | Direction | Description |
|---|---|---|---|
Result | Longint | out | The extra width required |
Fnd_Find_Info
Fnd_Find_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_Find_Localize
Fnd_Find_Localize
Passed the localization strings to the General and (if available) Localization components.
No parameters.
Fnd_Find_Now
Fnd_Find_Now ("Query" or "Query Selection")
Finishes up the built search. This is separate from the Fnd_Find_Engine routine so it's possible to change the dialog to a multi-criteria find.
| Parameter | Type | Direction | Description |
|---|---|---|---|
searchScope | Text | in | Either "Query" or "Query Selection" |
Fnd_Find_PrefsGet
Fnd_Find_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_Find_PrefsPut
Fnd_Find_PrefsPut (pref name; text value)
Adds an item to the user's preferences if the Fnd_Pref component is available.
| Parameter | Type | Direction | Description |
|---|---|---|---|
name | Text | in | The preference name |
value | Text | in | The value to store |
Fnd_Find_SetEditorButton
Fnd_Find_SetEditorButton (label{; method})
Allows the developer to hide or modify the Query Editor button.
| Parameter | Type | Direction | Description |
|---|---|---|---|
label | Text | in | The new label |
inMethod | Text | in | The method to run (optional) |
Fnd_Find_SizeArrayObject
Fnd_Find_SizeArrayObject (->object; alignment) --> Number
Sets the best size for an array based form object based on the contents it displays.
Rather than using BEST OBJECT SIZE, we calculate the size the same way we did before opening the dialog using the Fnd_Find_GetExtraWidth method.
| Parameter | Type | Direction | Description |
|---|---|---|---|
object | Pointer | in | A pointer to the form object |
alignment | Longint | in | The alignment (side not to move) |
Result | Longint | out | The increase in the button size |
Fnd_Find_UpdateOperators
Fnd_Find_UpdateOperators
Updates the Search Operators pop-up menu depending on the type of the selected field.
No parameters.