Foundation 6

Fnd_Dlg

23 shared methods.

Fnd_Dlg_Alert

Fnd_Dlg_Alert (message{; OK button title}) --> Longint

Replaces 4D's ALERT command.

ParameterTypeDirectionDescription
messageTextinThe message to display
inOkButtonTitleTextinThe OK button text (optional)
ResultLongintout1 (always)

Fnd_Dlg_Confirm

Fnd_Dlg_Confirm (message{; OK bttn{; Cancel bttn}}) --> Longint

A replacement for 4D's CONFIRM command.

ParameterTypeDirectionDescription
inMessageTextinThe message to display
inOkBttnTextinThe OK button text (optional)
inCancelBttnTextinThe Cancel button text (optional)
ResultLongintout1 if OK is clicked, 0 if Cancel is clicked

Fnd_Dlg_CustomIcon

Fnd_Dlg_CustomIcon (picture library name) --> Text

Allows the developer to set and get the custom icon name.

See also Fnd_Dlg_SetIcon.

ParameterTypeDirectionDescription
inPictureLibraryNameTextinThe picture library name
ResultTextoutThe current picture name

Fnd_Dlg_Display

Fnd_Dlg_Display --> Longint

Displays the built dialog.

Sets the OK variable.

ParameterTypeDirectionDescription
ResultLongintout1 if OK is clicked, 0 if Cancel is clicked, 2 if the optional button is clicked

Fnd_Dlg_FixButtonTexts

Fnd_Dlg_FixButtonTexts

Convert "*" in the button texts to local strings.

Do this just before displaying the dialog, since they get cleared after that.

No parameters.

Fnd_Dlg_FormAlert

Fnd_Dlg_FormAlert

Displays an alert using a 4D form. Called from Fnd_Dlg_Display

No parameters.

Fnd_Dlg_GetRequest

Fnd_Dlg_GetRequest --> Text

Returns the value entered by the user after displaying a Request dialog.

ParameterTypeDirectionDescription
ResultTextoutThe value entered by the user

Fnd_Dlg_Info

Fnd_Dlg_Info (label) --> Text

Returns requested information. See the Fnd_Gen_ComponentInfo method for more information.

ParameterTypeDirectionDescription
requestTextinInfo desired ("version" or "name")
ResultTextoutResponse

Fnd_Dlg_Localize

Fnd_Dlg_Localize

Passed the localization strings to the General and (if available) Localization components.

No parameters.

Fnd_Dlg_Message

Fnd_Dlg_Message (message text)

Displays a message window.   Stays open until it's called again with a blank string.

Designed to be a replacement for 4D's MESSAGE command.

See also: 4D's own Progress component (Progress New, Progress SET PROGRESS, Progress QUIT), which is the better choice for new code; Fnd_Dlg_Message stays for hosts that already call it.

ParameterTypeDirectionDescription
messageTextinThe message to display

Fnd_Dlg_MessageCanceled

Fnd_Dlg_MessageCanceled

Returns True if the user clicked the Cancel button.

ParameterTypeDirectionDescription
ResultBooleanoutTrue if the user clicked Cancel

Fnd_Dlg_MessageClose

Fnd_Dlg_MessageClose

Closes the progress indicator window.

No parameters.

Fnd_Dlg_MessageOpen

Fnd_Dlg_MessageOpen

Opens the message window.

No parameters.

Fnd_Dlg_MessageOpen2

Fnd_Dlg_MessageOpen2 (window title)

Called as a new process from Fnd_Dlg_MessageOpen to display the progress indicator window.

ParameterTypeDirectionDescription
windowTitleTextinThe window title

Fnd_Dlg_MessageUpdate

Fnd_Dlg_MessageUpdate (number)

Updates the message dialog's progress indicator.

ParameterTypeDirectionDescription
currentLongintinThe next number in the sequence.

Fnd_Dlg_PasswordEntry

Fnd_Dlg_PasswordEntry (->srcArea; ->curValue) --> Boolean

Replaces typed characters with bullet characters for password entry.

Returns True if the value has changed.

Based on the Keystroke function example in the 4D documentation.

ParameterTypeDirectionDescription
formObjectPointerinA pointer to the form object
currentValuePointerinA pointer to a text variable that holds the contents
ResultBooleanoutTrue if the current value has changed

Fnd_Dlg_Request

Fnd_Dlg_Request (msg{; default{; OK button{; Cancel button}}}) --> Text

Displays a Request dialog. Returns the user's response and sets the OK variable.

Use Fnd_Dlg_GetRequest to find out what the user typed.

ParameterTypeDirectionDescription
msgTextinThe message to display
inDefaultTextinThe default response text (optional)
inOkButtonTextinThe OK button text (optional)
inCancelButtonTextinThe Cancel button text (optional)
ResultTextoutText user entered in Request dialog

Fnd_Dlg_SetButtons

Fnd_Dlg_SetButtons ({button 1{; button 2{; button 3}}})

Sets the button texts for the upcoming alerts.

ParameterTypeDirectionDescription
inButton1TextinThe OK button text or "" or "*" for localized "OK" (optional)
inButton2TextinThe Cancel button text or "*" for localized "Cancel" (optional)
inButton3TextinThe third button text (optional)

Fnd_Dlg_SetCancelable

Fnd_Dlg_SetCancelable (cancelable?)

Specify whether or not the upcoming dialog can be canceled.

ParameterTypeDirectionDescription
cancelableBooleaninTrue if the message button should be enabled.

Fnd_Dlg_SetIcon

Fnd_Dlg_SetIcon ({icon number})

Sets the icon for the upcoming alert. 0 = Default icon (Note) 1 = Note Icon 2 = Warn Icon 3 = Stop Icon

These Foundation constants are available: Fnd_Dlg_NoteIcon = Note Icon Fnd_Dlg_WarnIcon = Warn Icon Fnd_Dlg_StopIcon = Stop Icon

See also Fnd_Dlg_CustomIcon.

ParameterTypeDirectionDescription
inIconNumberLongintinIcon number (optional)

Fnd_Dlg_SetProgress

Fnd_Dlg_SetProgress (to or from{; to})

The developer calls this to set the From and To numbers.

If only one number is passed, the From is assumed to be 1.

ParameterTypeDirectionDescription
inFromLongintinThe ending number if no second parameter or the starting number
inEndingNumberLongintinThe ending number (optional)

Fnd_Dlg_SetRequest

Fnd_Dlg_SetRequest ({default})

Sets up the next dialog to allow the user to enter a value. Optionally sets the default value of the value. Pass "*" as the default value to cause the entry area to display bullets rather than text.

ParameterTypeDirectionDescription
inDefaultTextinThe default value (optional)

Fnd_Dlg_SetText

Fnd_Dlg_SetText (text 1{; text 2})

Sets the message texts for the upcoming alert.

ParameterTypeDirectionDescription
text1TextinThe primary alert text
inText2TextinThe smaller alert text (optional)