Blur

Forms, interaction, input

Description

Clears Widget focus of a TPDFlibFormSession after finishing the active edit

When a Widget has focus, its active edit is committed or cancelled first, the /Bl blur action is dispatched for the focused Widget and only then is focus cleared

With no Widget focused but an edit active, the call only commits or cancels that edit and returns the corresponding result

A vetoed /Bl keeps the current focus and returns 0

Declaration

function Blur(CommitCurrent: Boolean = True): Integer;

Parameters

CommitCurrentTrue commits the active edit before blurring, False cancels it

Return value

Returns 1 when focus was cleared or nothing needed blurring, otherwise 0 when the call was reentrant, the commit failed or the /Bl action was vetoed

See also

FocusField, FocusNext, CommitEdit, CancelEdit, DispatchAction, FocusedFieldIndex, TPDFlibFormSession