Octobox API  4.1.0
Octobox Scripting API
Public Member Functions | Protected Member Functions | Properties
SCLookupDialogabstract

Object containing the common settings of a lookup dialog box. More...

Inheritance diagram for SCLookupDialog:
SCLookupDialogAlternatives SCLookupDialogCustom SCLookupDialogLocalDb

Public Member Functions

abstract List< ResultRow > ExecuteLookup (Dictionary< string, string > searches)
 Execute the search to populate the lookup dialog box. More...
 
 SCLookupDialog ()
 Lookupdialog constructor. (Internal use only!) More...
 
 SCLookupDialog (SCDocument document, string name, ValidationScriptBase parent)
 Lookupdialog constructor. More...
 
void ShowDialog ()
 Shows the database dialog and the selected record will be supplied through the LookupDialog_Closed event. Can be used for both desktop and web validation. More...
 
SCLookupResult ShowDialogInstant ()
 Shows the database dialog and returns the selected record. Can only be used for desktop validation. More...
 

Protected Member Functions

void AddLocationByName (string dialogName, string locationString)
 
string [] GetLocationByName (string dialogName)
 
virtual SCLookupResult ShowDialogWeb ()
 
abstract SCLookupResult ShowDialogWindow ()
 

Properties

List< SCGridHeader > ColumnHeaders [get, set]
 Collection of column headers to use for this lookup dialog box. More...
 
static StringCollection DialogLocations [get, set]
 
string DialogTitle [get, set]
 Window title of this dialog. More...
 
SCDocument Document [get, set]
 
int Height = -1 [get, set]
 Height of the dialog at startup. If not set the last height will be used. More...
 
Dictionary< string, string > InitialValues [get, set]
 Collection of initial values to use in this lookup dialog box. More...
 
bool InstantSearch [get, set]
 Indicates to perform a search with the initial files on opening the dialog box. More...
 
int Left = -1 [get, set]
 Left value of top left corner of the dialog at startup. If not set the last position will be used. More...
 
int MaxResults [get, set]
 Maximum number of results returned by this lookup (default is 100, 0 returns all results). More...
 
string Name [get]
 Unique identifier for this dialog. More...
 
bool RequireWildCard = -1 [get, set]
 True if fuzzy searching requires a * More...
 
ValidationScriptBase Script [get, set]
 
int Top [get, set]
 Top value of top left corner of the dialog at startup. If not set the last position will be used. More...
 
int Width = -1 [get, set]
 Width of the dialog at startup. If not set the last width will be used. More...
 

Detailed Description

Object containing the common settings of a lookup dialog box.

Constructor & Destructor Documentation

◆ SCLookupDialog() [1/2]

SCLookupDialog ( )
inline

Lookupdialog constructor. (Internal use only!)

◆ SCLookupDialog() [2/2]

SCLookupDialog ( SCDocument  document,
string  name,
ValidationScriptBase  parent 
)
inline

Lookupdialog constructor.

Parameters
documentCurrent document
nameUnique identifier for this dialog
parentValidation script calling this dialog. Should always be 'this'

Member Function Documentation

◆ ExecuteLookup()

abstract List<ResultRow> ExecuteLookup ( Dictionary< string, string >  searches)
pure virtual

Execute the search to populate the lookup dialog box.

Parameters
searchesCollection of fields and values to use in the search

Implemented in SCLookupDialogCustom, SCLookupDialogLocalDb, and SCLookupDialogAlternatives.

◆ ShowDialog()

void ShowDialog ( )
inline

Shows the database dialog and the selected record will be supplied through the LookupDialog_Closed event. Can be used for both desktop and web validation.

◆ ShowDialogInstant()

SCLookupResult ShowDialogInstant ( )
inline

Shows the database dialog and returns the selected record. Can only be used for desktop validation.

Returns
The selected record

Property Documentation

◆ ColumnHeaders

List<SCGridHeader> ColumnHeaders
getset

Collection of column headers to use for this lookup dialog box.

◆ DialogTitle

string DialogTitle
getset

Window title of this dialog.

◆ Height

int Height = -1
getset

Height of the dialog at startup. If not set the last height will be used.

◆ InitialValues

Dictionary<string, string> InitialValues
getset

Collection of initial values to use in this lookup dialog box.

◆ InstantSearch

bool InstantSearch
getset

Indicates to perform a search with the initial files on opening the dialog box.

◆ Left

int Left = -1
getset

Left value of top left corner of the dialog at startup. If not set the last position will be used.

◆ MaxResults

int MaxResults
getset

Maximum number of results returned by this lookup (default is 100, 0 returns all results).

◆ Name

string Name
get

Unique identifier for this dialog.

◆ RequireWildCard

bool RequireWildCard = -1
getset

True if fuzzy searching requires a *

◆ Top

int Top
getset

Top value of top left corner of the dialog at startup. If not set the last position will be used.

◆ Width

int Width = -1
getset

Width of the dialog at startup. If not set the last width will be used.