# SftMask/DLL 7.0 — API Reference

> Index of the SftMask/DLL 7.0 API reference, which is split into files by class or object. Each entry links one file and names the topics in it; read only the files you need. For an exact declaration, read the signatures file named under the class first: one line per member. The guide is in https://softelvdm.com/Vault/Softelvdm.com/llms/SftMask-DLL-7.0.txt

Online documentation: https://softelvdm.com/Documentation/SftMask%20DLL%207%200

## Overview

- [Overview](https://softelvdm.com/Vault/Softelvdm.com/llms/SftMask-DLL-7.0-reference-Overview.txt)
  - Notifications: The masked edit control sends notifications to its parent window.
  - Windows Messages: In addition to the standard Windows messages (WM_SETFONT, WM_COMMAND, WM_NOTIFY, etc.) that a SftMask control understands as a first-class Windows window, the control defines the following custom messages.
  - C/C++ API: The complete C and C++/MFC API for SftMask/DLL 7.0, in alphabetical order.

## Functions

Signatures: https://softelvdm.com/Vault/Softelvdm.com/llms/SftMask-DLL-7.0-signatures-1.txt

- [Functions](https://softelvdm.com/Vault/Softelvdm.com/llms/SftMask-DLL-7.0-reference-Functions.txt)
  - ActivateInput (SftMask_ActivateInput): Activates or deactivates data entry.
  - AutoCompleteAddBottom (SftMask_AutoComplete_AddBottom): Adds a custom entry at the bottom of the open autocomplete suggestion list.
  - AutoCompleteAddTop (SftMask_AutoComplete_AddTop): Adds a custom entry at the top of the open autocomplete suggestion list.
  - AutoCompleteRefresh (SftMask_AutoComplete_Refresh): Opens or refreshes the autocomplete window.
  - AutoCompleteSeed (SftMask_AutoComplete_Seed): Adds an array of strings to the autocomplete save file, skipping entries already present.
  - CanUndo (SftMask_CanUndo): Returns whether an undo operation is possible.
  - Create: Creates a masked edit control as a child window programmatically (C++/MFC only).
  - CSftMask: Constructor and destructor for the MFC class CSftMask (C++/MFC only).
  - EmptyUndo (SftMask_EmptyUndo): Empties the undo buffer.
  - FreeGDIPlusImage (SftMask_FreeGDIPlusImageLoadedFromFile, SftMask_FreeGDIPlusImageLoadedFromResource): Frees a GDI+ image previously loaded with LoadGDIPlusImageFromFile or LoadGDIPlusImageFromResource.
  - GetCharIndex (SftMask_GetCharIndex): Returns the index of the character at a given location.
  - GetCharPos (SftMask_GetCharPos): Returns the bounding rectangle of a range of characters.
  - GetControlInfo (SftMask_GetControlInfo): Retrieves the current SFTMASK_CONTROL structure describing the masked edit control's attributes.
  - GetDarkMode (SftMask_GetDarkMode): Returns the current dark mode setting (OFF / ON / AUTO).
  - GetDateTime (SftMask_Contents_GetDateTime): Retrieves the masked edit control's contents as a date/time value.
  - GetDesign (SftMask_GetDesign): Returns whether the masked edit control is in design mode.
  - GetDPI (SftMask_GetDPI): Returns the effective DPI of the monitor the masked edit control is currently displayed on.
  - GetHighContrastMode (SftMask_GetHighContrastMode): Returns the current high contrast setting (OFF / ON / AUTO).
  - GetImageScaling (SftMask_GetImageScaling): Returns the current image scaling setting (ASIS / STRETCH).
  - GetInsertPosition (SftMask_GetInsertPosition): Calculates the closest valid caret location for insertion.
  - GetPixelScaling (SftMask_GetPixelScaling): Returns the current pixel scaling setting (ASIS / STRETCH).
  - GetPosition (SftMask_GetPosition): Returns the position and dimensions of a control area.
  - GetSelText (SftMask_GetSelText): Retrieves the currently selected (highlighted) text.
  - GetText (SftMask_GetText): Retrieves the masked edit control's contents.
  - GetTextDisplay (SftMask_GetTextDisplay): Retrieves the masked edit control's contents as displayed (the formatted representation).
  - GetValue (SftMask_Contents_GetValue): Retrieves the value of a numeric input field or a mask variable.
  - HitTest (SftMask_HitTest): Determines the control area at a given location.
  - IsCalculatorWindowOrChildWindow (SftMaskCalculatorWindow_IsCalculatorWindowOrChildWindow): Returns whether a window is the popup calculator window or one of its child windows.
  - IsCalendarWindowOrChildWindow (SftMaskCalendarWindow_IsCalendarWindowOrChildWindow): Returns whether a window is the popup calendar window or one of its child windows.
  - IsDarkModeActive (SftMask_IsDarkModeActive): Returns whether dark-palette rendering is currently in effect.
  - IsEmpty (SftMask_IsEmpty): Returns whether the masked edit control is empty.
  - IsHighContrastActive (SftMask_IsHighContrastActive): Returns whether high contrast rendering is currently in effect.
  - IsValid (SftMask_IsValid): Returns whether the masked edit control's contents are valid.
  - IsValidWithMsg (SftMask_IsValid_WithMsg): Validates the masked edit control's contents, displaying a suitable error message if invalid.
  - LoadGDIPlusImage (SftMask_LoadGDIPlusImageFromFile, SftMask_LoadGDIPlusImageFromResource): Loads a PNG / TIFF / JPEG / GIF / EMF image from a file or an embedded application resource as a GDI+ image suitable for SFT_PICTURE_GDIPLUS.
  - NextControl (SftMask_NextControl): Moves the input focus to the next control on the dialog.
  - OptimalPosition (SftMask_OptimalPosition): Positions the caret at the optimal input position.
  - PrevControl (SftMask_PrevControl): Moves the input focus to the previous control on the dialog.
  - QueryChar (SftMask_QueryChar): Tests whether the masked edit control accepts the specified character at the current caret location.
  - RegisterApp (SftMask_RegisterApp, SftMask_UnregisterApp): Registers the SftMask window classes with a process (RegisterApp); unregisters them and performs cleanup (UnregisterApp).
  - Rollup (SftMask_Rollup): Closes any open popup window (calendar, calculator, autocomplete).
  - SetBoldDate (SftMask_SetBoldDate): Sets a date shown bold in the popup calendar.
  - SetControlInfo (SftMask_SetControlInfo): Applies a SFTMASK_CONTROL structure to the masked edit control, setting its attributes.
  - SetDarkMode (SftMask_SetDarkMode): Selects how the masked edit control participates in Windows dark mode.
  - SetDateTime (SftMask_Contents_SetDateTime): Sets the masked edit control's contents from a date/time value.
  - SetDefaultValue (SftMask_SetDefaultValue): Applies the default text to an empty control.
  - SetDesign (SftMask_SetDesign): Switches the masked edit control into or out of design mode.
  - SetHighContrastMode (SftMask_SetHighContrastMode): Selects how the masked edit control honors the Windows High Contrast setting.
  - SetImageScaling (SftMask_SetImageScaling): Selects whether the caller-supplied error images are scaled for the current monitor DPI.
  - SetPixelScaling (SftMask_SetPixelScaling): Selects whether caller-supplied pixel dimensions are interpreted as 96-DPI reference values.
  - SetSelText (SftMask_SetSelText): Replaces the currently selected (highlighted) text.
  - SetText (SftMask_SetText): Sets the masked edit control's contents.
  - SetValue (SftMask_Contents_SetValue): Sets the value of a numeric input field or a mask variable.
  - SFTMASK_CLASS: The window class name of the masked edit control, "SftMaskControl70".
  - SFTMASK_NOCOLOR: The color value SFTMASK_NOCOLOR ((COLORREF)-1) is used for color fields of the SFTMASK_CONTROL structure to select the applicable default color instead of an explicit RGB value.
  - SFTMASK_VERSION: Identifies the SftMask/DLL version the application is compiled against.
  - ShowDropPosition (SftMask_ShowDropPosition): Visualizes the insert location at the given character position, used by drop targets during drag & drop.
  - WndProc (SftMask_WndProc): The masked edit control's window procedure.

## Constants

Signatures: https://softelvdm.com/Vault/Softelvdm.com/llms/SftMask-DLL-7.0-signatures-1.txt

- [Constants](https://softelvdm.com/Vault/Softelvdm.com/llms/SftMask-DLL-7.0-reference-Constants.txt)
  - SFTMASK_AREA: Identifies an area of the masked edit control, used by the HitTest and GetPosition functions (see Components).
  - SFTMASK_AUTOCOMPLETE: Values for the auto_iMode field on SFTMASK_CONTROL, defining the autocomplete display method (see AutoComplete).
  - SFTMASK_AUTOCOMPLETECONTENTS: Values for the auto_iContents field on SFTMASK_CONTROL, defining what the autocomplete feature offers (see AutoComplete).
  - SFTMASK_BORDER: Values for the iBorderStyle field on SFTMASK_CONTROL.
  - SFTMASK_CLIP: Values for the iClipMode field on SFTMASK_CONTROL, defining whether literal characters are included when text is retrieved, stored or copied to the clipboard.
  - SFTMASK_DARKMODE: Values for the nDarkMode field on SFTMASK_CONTROL and the SetDarkMode function (see Dark Mode).
  - SFTMASK_DEFAULT: Values for the iDefaultStyle field on SFTMASK_CONTROL, defining when the default text (lpszDefaultText) is applied to an empty control (see Default Text).
  - SFTMASK_DRAG: Values for the iDragMode field on SFTMASK_CONTROL, defining the drag & drop behavior (see Drag & Drop).
  - SFTMASK_DROPDOWN: Values for the action member of the NM_SFTMASK_DROPDOWN notification structure, identifying which popup window is being shown or hidden.
  - SFTMASK_EDIT: Values for the iEditStyle field on SFTMASK_CONTROL, defining the additional buttons displayed by the masked edit control.
  - SFTMASK_ENTRY: Values for the iEntrySelect field on SFTMASK_CONTROL, defining the selection behavior when the control receives the input focus.
  - SFTMASK_ERR: Values for the read-only errorValue field on SFTMASK_CONTROL, set when SetControlInfo rejects a field.
  - SFTMASK_ERRORHANDLING: Values for the erroriHandling field on SFTMASK_CONTROL, defining when the error image is updated (see Error Image).
  - SFTMASK_ERRORPOSITION: Values for the erroriPosition field on SFTMASK_CONTROL, defining the location of the error image (see Error Image).
  - SFTMASK_FAILURE: Values for the failureCode member of the NM_SFTMASK_VALIDATIONERROR notification structure, identifying the error condition detected (see Input Validation).
  - SFTMASK_FIRSTDAY: Values for the caliFirstDay field on SFTMASK_CONTROL, defining the first day of the week shown by the popup calendar (see Popup Calendar).
  - SFTMASK_GETTEXTDISPLAY: Bit flags combined in the wParam of the SFTMASKM_GETTEXTDISPLAY_A and SFTMASKM_GETTEXTDISPLAY_W messages, carrying the fPure and fLiterals arguments of GetTextDisplay.
  - SFTMASK_HIGHCONTRAST: Values for the nHighContrastMode field on SFTMASK_CONTROL and the SetHighContrastMode function (see High Contrast).
  - SFTMASK_IMAGESCALING: Values for the imageScaling field on SFTMASK_CONTROL and the SetImageScaling function (see Per-Monitor DPI and Scaling).
  - SFTMASK_INPUT: Values for the iInputMode field on SFTMASK_CONTROL, defining the control's insert/overtype mode behavior (see Insert/Overtype Mode).
  - SFTMASK_LABELPOSITION: Values for the iLabelPosition field on SFTMASK_CONTROL, defining the position of the label inside the edit area (see Label).
  - SFTMASK_PIXELSCALING: Values for the pixelScaling field on SFTMASK_CONTROL and the SetPixelScaling function (see Per-Monitor DPI and Scaling).
  - SFTMASK_POSITION: Values for the captioniPosition field on SFTMASK_CONTROL, defining the position of the built-in caption relative to the edit area (see Built-In Caption).
  - SFTMASK_THEME: Values for the iUseThemes field on SFTMASK_CONTROL, defining whether Windows themes are used (see Using Themes).
  - SFTMASK_VERTALIGN: Values for the captioniVerticalAlignment field on SFTMASK_CONTROL, defining the vertical alignment of the built-in caption (see Built-In Caption).

## Structures

Signatures: https://softelvdm.com/Vault/Softelvdm.com/llms/SftMask-DLL-7.0-signatures-1.txt

- [Structures](https://softelvdm.com/Vault/Softelvdm.com/llms/SftMask-DLL-7.0-reference-Structures.txt)
  - SFTMASK_CONTROL: SFTMASK_CONTROL holds the complete state of a SftMask control - its edit mask, behavior flags, caption, label, calendar, calculator, autocomplete settings and colors - in a single structure.