All of these functions are specifically for use in Dialogs definitions, to access or manipulate the controls on a dialog (and to open a user-defined dialog).
(Back to Function Types List)
Function: DlgAddComboText
Result-type: Boolean
Arguments: nControlID, cText
Description: Adds a text item to the specified Combo Box control in the current customized dialog. Returns FALSE if the current dialog is unknown, otherwise returns TRUE.
Function: DlgAddDropListText
Result-type: Boolean
Arguments: nControlID, cText
Description: Adds a text item to the specified Drop List control in the current customized dialog. Returns FALSE if the current dialog is unknown, otherwise returns TRUE.
Function: DlgAddInventoryItemSale
Result-type: Boolean
Arguments: rItemRec, nQuantity
Description: Used in the Point of Sale dialog only, adds an inventory item sale (as if the item was scanned), with the given quantity. The result is True if successful, False if there's an error.
Function: DlgAddListText
Result-type: Boolean
Arguments: nControlID, cText
Description: Adds a text item to the specified List Box control in the current customized dialog. Returns FALSE if the current dialog is unknown, otherwise returns TRUE.
Function: DlgAddNewTransaction
Result-type: Record
Arguments: cType, cCategory, cDescription, cPmtMethod, cRef, cExtra, cDiscount, nQty, nEach
Description: Adds a new transaction (possibly temporary) in a Transactions or Point of Sale dialog. All values must be filled in. The Total amount is calculated from the Qty and Each -- Qty can be 0 if you prefer to leave it blank (counts as 1 for the calculation). The result is the record created -- but be careful with it since it may only exist during the dialog, and may also be deleted by the operator before the dialog is closed.
Function: DlgAddUserComboText
Result-type: Boolean
Arguments: cControlName, cText
Description: Adds a text item to the named user-defined Combo Box control in the current customized dialog. Returns FALSE if the current dialog or control is unknown, otherwise returns TRUE.
Function: DlgAddUserDropListText
Result-type: Boolean
Arguments: cControlName, cText
Description: Adds a text item to the named user-defined Drop List control in the current customized dialog. Returns FALSE if the current dialog or control is unknown, otherwise returns TRUE.
Function: DlgAddUserListText
Result-type: Boolean
Arguments: cControlName, cText
Description: Adds a text item to the named user-defined List Box control in the current customized dialog. Returns FALSE if the current dialog or control is unknown, otherwise returns TRUE.
Function: DlgClearList
Result-type: Boolean
Arguments: nControlID
Description: Clears all selections from the specified List Box control in the current customized dialog. Returns TRUE if no errors.
Function: DlgClearUserList
Result-type: Boolean
Arguments: cControlName
Description: Clears all selections from the named user-defined List Box control in the current customized dialog. Returns TRUE if no errors.
Function: DlgClickButton
Result-type: Boolean
Arguments: nControlID
Description: Sends the specified command (assumed to be a button click) to the current customized dialog. Returns FALSE if the current dialog is unknown, otherwise returns TRUE.
Function: DlgClickCancel
Result-type: Boolean
Arguments: (none)
Description: Does the Cancel (or Close) command for the current customized dialog. Returns FALSE if the current dialog is unknown, otherwise returns TRUE.
Function: DlgClickSave
Result-type: Boolean
Arguments: (none)
Description: Does the Save (or OK or Done) command for the current customized dialog. Returns FALSE if the current dialog is unknown, otherwise returns TRUE.
Function: DlgClickUserButton
Result-type: Boolean
Arguments: cControlName
Description: Sends a button-click to the named user-defined control (assumed to be a button) in the current customized dialog. Returns FALSE if the current dialog or control is unknown, otherwise returns TRUE.
Function: DlgEnableCtrl
Result-type: Boolean
Arguments: nControlID, bEnable
Description: Enables or disables the specified control in the current customized dialog (bEnable = True to enable, False to disable). Returns FALSE if the current dialog is unknown, otherwise returns TRUE.
Function: DlgEnableUserCtrl
Result-type: Boolean
Arguments: cControlName, bEnable
Description: Enables or disables the named user-defined control in the current customized dialog (bEnable = True to enable, False to disable). Returns FALSE if the current dialog or control is unknown, otherwise returns TRUE.
Function: DlgGetChangedFlag
Result-type: Boolean
Arguments: (none)
Description: Gets the status of the 'Data Changed' flag in the current customized dialog. If the flag is not known (e.g. called in the wrong context), it will return FALSE.
Function: DlgGetCheckbox
Result-type: Boolean
Arguments: nControlID
Description: Returns the checked state of the specified checkbox or radio button in the current customized dialog. Returns FALSE if the current dialog is unknown, or returns TRUE if the control is checked.
Function: DlgGetComboText
Result-type: Text
Arguments: nControlID
Description: Returns the selected or entered text of the specified Combo Box control in the current customized dialog. Returns blank text if the current dialog is unknown.
Function: DlgGetCtrlDate
Result-type: Date/Time
Arguments: nControlID
Description: Returns the date of the specified control in the current customized dialog. Returns Jan 1 1970 if the current dialog is unknown.
Function: DlgGetCtrlDateCheck
Result-type: Boolean
Arguments: nControlID
Description: Returns the state of the check box in the specified checked-date control in the current customized dialog. Returns FALSE if the current dialog is unknown.
Function: DlgGetCtrlText
Result-type: Text
Arguments: nControlID
Description: Returns the text of the specified control in the current customized dialog. Returns blank text if the current dialog is unknown.
Function: DlgGetCtrlTime
Result-type: Date/Time
Arguments: nControlID
Description: Returns the time of the specified control in the current customized dialog. Returns 00:00:00 if the current dialog is unknown.
Function: DlgGetDropListSelectedText
Result-type: Text
Arguments: nControlID
Description: Returns the selected text of the specified Drop List control in the current customized dialog. Returns blank text if the current dialog is unknown.
Function: DlgGetListSelectedText
Result-type: Text
Arguments: nControlID
Description: Returns the selected text item of the specified List Box control in the current customized dialog. Returns blank text if the current dialog is unknown.
Function: DlgGetTitle
Result-type: Text
Arguments: (none)
Description: Returns the title (caption bar text) of the dialog
Function: DlgGetUserCheckbox
Result-type: Boolean
Arguments: cControlName
Description: Returns the checked state of the named user-defined checkbox or radio button in the current customized dialog. Returns FALSE if the current dialog or control is unknown, or returns TRUE if the control is checked.
Function: DlgGetUserComboText
Result-type: Text
Arguments: cControlName
Description: Returns the selected or entered text of the named user-defined Combo Box control in the current customized dialog. Returns blank text if the current dialog or control is unknown.
Function: DlgGetUserCtrlDate
Result-type: Date/Time
Arguments: cControlName
Description: Returns the date of the named user-defined control in the current customized dialog. Returns Jan 1 1970 if the current dialog or control is unknown.
Function: DlgGetUserCtrlDateCheck
Result-type: Boolean
Arguments: cControlName
Description: Returns the state of the check box in the named user-defined checked-date control in the current customized dialog. Returns FALSE if the current dialog or control is unknown.
Function: DlgGetUserCtrlText
Result-type: Text
Arguments: cControlName
Description: Returns the text of the named user-defined control in the current customized dialog. Returns blank text if the current dialog or control is unknown.
Function: DlgGetUserCtrlTime
Result-type: Date/Time
Arguments: cControlName
Description: Returns the time of the named user-defined control in the current customized dialog. Returns 00:00:00 if the current dialog or control is unknown.
Function: DlgGetUserDropListSelectedText
Result-type: Text
Arguments: cControlName
Description: Returns the selected text of the named user-defined Drop List control in the current customized dialog. Returns blank text if the current dialog or control is unknown.
Function: DlgGetUserListSelectedText
Result-type: Text
Arguments: cControlName
Description: Returns the selected text item of the named user-defined List Box control in the current customized dialog. Returns blank text if the current dialog or control is unknown.
Function: DlgNewResvRefreshSites
Result-type: Boolean
Arguments: (none)
Description: Used in a New Reservation dialog, refreshes the list of applicable sites according to any Preferences that may have been set (e.g. if you set reservation preference fields through expressions, call this to refresh the list of sites matching those preferences). Returns True if successful.
Function: DlgNewTransAt
Result-type: Record
Arguments: nIndex
Description: Used in a Transactions or Point of Sale dialog, returns the Nth transaction record being added (e.g. for looping through them). For use with DlgNumNewTrans() to get the transactions being added.
Function: DlgNumNewTrans
Result-type: Numeric
Arguments: (none)
Description: Used in a Transactions or Point of Sale dialog, returns the number of new transactions (possibly temporary), e.g. 'pending' transactions added while in the dialog. For use with DlgNewTransAt() to get the transactions being added.
Function: DlgOpenUserDialog
Result-type: Boolean
Arguments: cDialogName, rRecord
Description: Opens the named user-defined dialog, with the record passed as the context record. Returns FALSE if the dialog is unknown or if it's Cancelled, or returns TRUE if Save/OK is clicked with changes made.
Function: DlgSetChangedFlag
Result-type: Boolean
Arguments: bChanged
Description: Sets or clears the 'Data Changed' flag in the current customized dialog. If no argument is present, the flag is set to True Returns TRUE if successful.
Function: DlgSetCheckbox
Result-type: Boolean
Arguments: nControlID, bCheck
Description: Checks or unchecks the specified checkbox or radio button in the current customized dialog. Returns FALSE if the current dialog is unknown, otherwise returns TRUE.
Function: DlgSetComboSelectedText
Result-type: Boolean
Arguments: nControlID, cText
Description: Selects the item matching cText in the specified Combo Box control in the current customized dialog. Returns FALSE if the current dialog is unknown or the text item is not found, otherwise returns TRUE.
Function: DlgSetComboSelection
Result-type: Boolean
Arguments: nControlID, nIndex
Description: Selects an item (1-based index) in the specified Combo Box control in the current customized dialog. Returns FALSE if the current dialog is unknown or the index is out of range, otherwise returns TRUE.
Function: DlgSetCtrlDate
Result-type: Boolean
Arguments: nControlID, dDate
Description: Sets the date of the specified control in the current customized dialog. Returns FALSE if the current dialog is unknown, otherwise returns TRUE.
Function: DlgSetCtrlDateCheck
Result-type: Boolean
Arguments: nControlID, bCheck
Description: Sets or clears the check box in the specified checked-date control in the current customized dialog. Returns FALSE if the current dialog is unknown, otherwise returns TRUE.
Function: DlgSetCtrlSelectedText
Result-type: Boolean
Arguments: nControlID, nStart, nEnd
Description: Selects the specified characters of text in the specified control in the current customized dialog. The nStart and nEnd parameters are 1-based. For instance, use 1,3 to select the first 3 characters. If nStart is -1, any current selection is removed. If nStart is 1 and nEnd is -1, all text is selected. Returns FALSE if the current dialog is unknown, otherwise returns TRUE. Note: Best done in an 'Action on get focus' element, not control initialization.
Function: DlgSetCtrlText
Result-type: Boolean
Arguments: nControlID, cText
Description: Sets the text of the specified control in the current customized dialog. Returns FALSE if the current dialog is unknown, otherwise returns TRUE.
Function: DlgSetCtrlTime
Result-type: Boolean
Arguments: nControlID, dTime
Description: Sets the time of the specified control in the current customized dialog. Returns FALSE if the current dialog is unknown, otherwise returns TRUE.
Function: DlgSetDropListSelectedText
Result-type: Boolean
Arguments: nControlID, cText
Description: Selects the item matching cText in the specified Drop List control in the current customized dialog. Returns FALSE if the current dialog is unknown or the text item is not found, otherwise returns TRUE.
Function: DlgSetDropListSelection
Result-type: Boolean
Arguments: nControlID, nIndex
Description: Selects an item (1-based index) in the specified Drop List control in the current customized dialog. Returns FALSE if the current dialog is unknown or the index is out of range, otherwise returns TRUE.
Function: DlgSetFocusCtrl
Result-type: Boolean
Arguments: nControlID
Description: Sets the input focus to the specified control in the current customized dialog. Returns FALSE if the current dialog is unknown, otherwise returns TRUE.
Function: DlgSetFocusUserCtrl
Result-type: Boolean
Arguments: cControlName
Description: Sets the input focus to the named user-defined control in the current customized dialog. Returns FALSE if the current dialog or control is unknown, otherwise returns TRUE.
Function: DlgSetListSelectedText
Result-type: Boolean
Arguments: nControlID, cText
Description: Selects the item matching cText in the specified List Box control in the current customized dialog. Returns FALSE if the current dialog is unknown or the text item is not found, otherwise returns TRUE.
Function: DlgSetListSelection
Result-type: Boolean
Arguments: nControlID, nIndex
Description: Selects an item (1-based index) in the specified List Box control in the current customized dialog. Returns FALSE if the current dialog is unknown or the index is out of range, otherwise returns TRUE.
Function: DlgSetNewResvCust
Result-type: Boolean
Arguments: rCustomer
Description: Used in a New Reservation dialog, sets the customer to be used for the reservation (and fills in the dialog fields accordingly). Returns True if successful (it's a valid customer).
Function: DlgSetUserCheckbox
Result-type: Boolean
Arguments: cControlName, bCheck
Description: Checks or unchecks the named user-defined checkbox or radio button in the current customized dialog. Returns FALSE if the current dialog or control is unknown, otherwise returns TRUE.
Function: DlgSetUserComboSelectedText
Result-type: Boolean
Arguments: cControlName, cText
Description: Selects the item matching cText in the named user-defined Combo Box control in the current customized dialog. Returns FALSE if the current dialog or control is unknown or the text item is not found, otherwise returns TRUE.
Function: DlgSetUserComboSelection
Result-type: Boolean
Arguments: cControlName, nIndex
Description: Selects an item (1-based index) in the named user-defined Combo Box control in the current customized dialog. Returns FALSE if the current dialog or control is unknown or the index is out of range, otherwise returns TRUE.
Function: DlgSetUserCtrlDate
Result-type: Boolean
Arguments: cControlName, dDate
Description: Sets the date of the named user-defined control in the current customized dialog. Returns FALSE if the current dialog or control is unknown, otherwise returns TRUE.
Function: DlgSetUserCtrlDateCheck
Result-type: Boolean
Arguments: cControlName, bCheck
Description: Sets or clears the check box in the named user-defined checked-date control in the current customized dialog. Returns FALSE if the current dialog or control is unknown, otherwise returns TRUE.
Function: DlgSetUserCtrlSelectedText
Result-type: Boolean
Arguments: cControlName, nStart, nEnd
Description: Selects the specified characters of text in the named user-defined control in the current customized dialog. The nStart and nEnd parameters are 1-based. For instance, use 1,3 to select the first 3 characters. If nStart is -1, any current selection is removed. If nStart is 1 and nEnd is -1, all text is selected. Returns FALSE if the current dialog or control is unknown, otherwise returns TRUE. Note: Best done in an 'Action on get focus' element, not control initialization.
Function: DlgSetUserCtrlText
Result-type: Boolean
Arguments: cControlName, cText
Description: Sets the text of the named user-defined control in the current customized dialog. Returns FALSE if the current dialog or control is unknown, otherwise returns TRUE.
Function: DlgSetUserCtrlTime
Result-type: Boolean
Arguments: cControlName, dTime
Description: Sets the time of the named user-defined control in the current customized dialog. Returns FALSE if the current dialog or control is unknown, otherwise returns TRUE.
Function: DlgSetUserDropListSelectedText
Result-type: Boolean
Arguments: cControlName, cText
Description: Selects the item matching cText in the named user-defined Drop List control in the current customized dialog. Returns FALSE if the current dialog or control is unknown or the text item is not found, otherwise returns TRUE.
Function: DlgSetUserDropListSelection
Result-type: Boolean
Arguments: cControlName, nIndex
Description: Selects an item (1-based index) in the named user-defined Drop List control in the current customized dialog. Returns FALSE if the current dialog or control is unknown or the index is out of range, otherwise returns TRUE.
Function: DlgSetUserListSelectedText
Result-type: Boolean
Arguments: cControlName, cText
Description: Selects the item matching cText in the named user-defined List Box control in the current customized dialog. Returns FALSE if the current dialog or control is unknown or the text item is not found, otherwise returns TRUE.
Function: DlgSetUserListSelection
Result-type: Boolean
Arguments: cControlName, nIndex
Description: Selects an item (1-based index) in the named user-defined List Box control in the current customized dialog. Returns FALSE if the current dialog or control is unknown or the index is out of range, otherwise returns TRUE.
Function: DlgShowCtrl
Result-type: Boolean
Arguments: nControlID, bShow
Description: Show or hide the specified control in the current customized dialog (bShow = True to show, False to hide). Returns FALSE if the current dialog is unknown, otherwise returns TRUE.
Function: DlgShowUserCtrl
Result-type: Boolean
Arguments: cControlName, bShow
Description: Show or hide the named user-defined control in the current customized dialog (bShow = True to show, False to hide). Returns FALSE if the current dialog or control is unknown, otherwise returns TRUE.
Function: ThisDlgCtrlLastFocus
Result-type: Numeric
Arguments: (none)
Description: Returns the ID of the standard dialog control that last had focus (e.g. lost the focus most recently). If the last control to lose focus was a user-defined control, then the result is 0 (use ThisDlgUserCtrlLastFocus() for user-defined controls).
Function: ThisDlgUserCtrlLastFocus
Result-type: Text
Arguments: (none)
Description: Returns the name of the user-defined dialog control that last had focus (e.g. lost the focus most recently). If the last control to lose focus was not a user-defined control, then the result is blank (use ThisDlgCtrlLastFocus() for standard controls).
Function: ThisTempRec
Result-type: Record
Arguments: (none)
Description: Returns the temporary operating record in a Dialog definition, for instance the tentative reservation in a New Reservation dialog which contains the currently selected Preferences information.
Page URL http://CampgroundMaster.com/shelp/user_defineddialogs.html
Campground Master Home