Octobox API  4.0.0
Octobox Scripting API
Public Member Functions | Protected Member Functions | Properties
SCLookupDialogExternalDb

Object containing the settings of a lookup dialog box with a database. More...

Inheritance diagram for SCLookupDialogExternalDb:
SCLookupDialog

Public Member Functions

override List< ResultRow > ExecuteLookup (Dictionary< string, string > searches)
 Execute the search to populate the lookup dialog box. More...
 
 SCLookupDialogExternalDb ()
 Lookupdialog constructor (Internal use only!). More...
 
 SCLookupDialogExternalDb (SCDocument document, string name, ValidationScriptBase parent)
 Lookupdialog constructor. More...
 
- Public Member Functions inherited from SCLookupDialog
 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

override SCLookupResult ShowDialogWindow ()
 Show the lookup dialog box. More...
 
- Protected Member Functions inherited from SCLookupDialog
void AddLocationByName (string dialogName, string locationString)
 
string [] GetLocationByName (string dialogName)
 
virtual SCLookupResult ShowDialogWeb ()
 

Properties

string ConnectionString [get, set]
 Connection string to the database. More...
 
LookupDatabaseTypes DatabaseType = ";" [get, set]
 Database type to connect to. More...
 
string Delimiter [get, set]
 Text file delimiter. Default ';' (DatabaseType File only). More...
 
string FileName [get, set]
 Full filename of the file to query. (DatabaseType File only) More...
 
string TableName [get, set]
 Name of the table to use. More...
 
string TablePrefix [get, set]
 Optional table prefix More...
 
- Properties inherited from SCLookupDialog
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 settings of a lookup dialog box with a database.

Constructor & Destructor Documentation

◆ SCLookupDialogExternalDb() [1/2]

Lookupdialog constructor (Internal use only!).

◆ SCLookupDialogExternalDb() [2/2]

SCLookupDialogExternalDb ( 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()

override List<ResultRow> ExecuteLookup ( Dictionary< string, string >  searches)
inlinevirtual

Execute the search to populate the lookup dialog box.

Parameters
searchesCollection of fields and values to use in the search
Returns
Returns a collection of rows

Implements SCLookupDialog.

◆ ShowDialogWindow()

override SCLookupResult ShowDialogWindow ( )
inlineprotectedvirtual

Show the lookup dialog box.

Implements SCLookupDialog.

Property Documentation

◆ ConnectionString

string ConnectionString
getset

Connection string to the database.

◆ DatabaseType

LookupDatabaseTypes DatabaseType = ";"
getset

Database type to connect to.

◆ Delimiter

string Delimiter
getset

Text file delimiter. Default ';' (DatabaseType File only).

◆ FileName

string FileName
getset

Full filename of the file to query. (DatabaseType File only)

◆ TableName

string TableName
getset

Name of the table to use.

◆ TablePrefix

string TablePrefix
getset

Optional table prefix