YOUSEFUL / FILEMAKER

YsflDialog functions (v1.0.0)

FAQ, examples and tutorial

Native Win32 dialogs. Buttons are a list of up to 4 captions. A modal dialog returns the button number (1..4), 0 for Escape or the close box (or the cancel=N button), and -1 on timeout. Options are space-separated tokens; per-call options override YsflDl_Set values. A failing call returns ? message and sets YsflDl_LastError / YsflDl_LastErrorText.

Common options: icon=none|info|caution|stop|question, default=N, cancel=N, timeout=SECONDS, x=PX y=PX, width=PX.

Function Returns
YsflDl_Message ( title ; prompt ; buttons ; {options} ) button number
YsflDl_Input ( title ; prompt ; fields ; buttons ; {options} ) button¶value1¶value2… (values are returned for every button; empty on Escape)
YsflDl_InputLarge ( title ; prompt ; initialText ; buttons ; {options} ) button¶text (text keeps its paragraph marks)
YsflDl_List ( title ; prompt ; items ; buttons ; {options} ) button¶index… (1-based) or button¶text… with text

fields: one line per field, label|type|initial|choices. Types: text (default), password, checkbox (1/0), dropdown (choices separated by ,), multiline (returns embedded returns as line feeds). Up to 20 fields. Extra options: focus=N, labelwidth=PX, monospace.

YsflDl_InputLarge options: min=N max=N (all but the last button stay disabled until the length is in range), height=PX, monospace, selectall.

YsflDl_List options: multi, require (first button disabled until a selection exists), text, height=PX. An item that is just - is a separator.

Progress and toast (non-modal)

Function Description
YsflDl_ProgressOpen ( id ; title ; message ; min ; max ; {options} ) opens a floating progress window; options pause, cancel, indeterminate, x= y=
YsflDl_ProgressUpdate ( id ; value ; {message} ; {subMessage} ) sets the value and texts
YsflDl_ProgressIncrement ( id ; {delta} ; {subMessage} ) adds delta (default 1)
YsflDl_ProgressState ( id ) running, paused, cancelled or closed; poll this inside the loop
YsflDl_ProgressClose ( id ) closes one window, or all with all
YsflDl_Toast ( message ; {durationMs} ; {options} ) auto-dismissing notice; icon=, `corner=topright
YsflDl_Delay ( milliseconds ) waits while keeping windows responsive (max 120000)

Settings and plugin

Function Description
YsflDl_Set ( selector ; {value} ) position (x¶y or center), timeout, icon, defaultButton, cancelButton, width, font (name¶size), reset
YsflDl_Get ( selector ) lastButton, lastValues, lastPosition (x¶y), lastError, lastErrorText, screen (width¶height), dpi, version
YsflDl_Version, YsflDl_Register ( {option} ), YsflDl_LastError, YsflDl_LastErrorText as other Youseful plugins