TCustomMaskEdit.RestoreMask function

Member of TCustomMaskEditprotectedIn unit MaskEdit

Restores the saved edit mask in the control.

Declaration

pascal

function RestoreMask(const NewText: string): Boolean

Arguments

NewText

New value assigned to the Text property.

Function result

True on success.

Description

RestoreMask is a procedure used to restore the saved edit mask in the control. The edit mask is saved when DisableMask is called and an edit mask is active for the control. The return value is True when the edit mask (and control state and value) are successfully restored.

In either circumstance, the value in NewText is assigned as the value for the Text property in the control.

An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.