IASEditBox

This interface provides the methods to manage an Auto PC simple edit box control.

Method
Description
IASEditBox::Delete Deletes the character currently selected for editing
IASEditBox::get_Editing Checks to see if editing is enabled
IASEditBox::get_ItemWidth Gets the width of an item.
IASEditBox::get_MaxChars Gets the maximum number of characters allowed in the edit box.
IASEditBox::get_NumChars Gets the number of characters in the edit box.
IASEditBox::get_ReadOnly Retrieves whether or not the edit box is read-only.
IASEditBox::get_Selection Gets the currently selected character.
IASEditBox::get_SelectionIndex Gets the index of the currently selected character.
IASEditBox::get_Text Gets a copy of the string currently in the edit box.
IASEditBox::get_TextPrivate Indicates whether the edit control displays asterisks instead of the characters that the user enters.
IASEditBox::get_TrimRight Retrieves whether or not white space is trimmed.
IASEditBox::Insert Inserts a character to the left of the current character.
IASEditBox::put_Editing Sets whether editing is enabled or not.
IASEditBox::put_ItemWidth Sets the width of an item.
IASEditBox::put_MaxChars Sets the maximum number of characters allowed in the edit box.
IASEditBox::put_ReadOnly Sets whether an edit box is read-only or not.
IASEditBox::put_Selection Sets the current item to the specified character.
IASEditBox::put_SelectionIndex Sets the index of the currently selected item.
IASEditBox::put_Text Replaces the current text string with another.
IASEditBox::put_TextPrivate Specifies whether the edit control displays asterisks instead of the characters that the user enters.
IASEditBox::put_TrimRight Sets whether or not trailing white spaces are trimmed.

Remarks

The IASEditBox interface, which has a global unique identifier (GUID) equal to IID_ASEDITBOX, extends the IASCharSpinner interface. An edit control has a programmatic identifier equal to APC_Edit.

Edit mode is entered when the user presses the ENTER key, or the application invokes IASEditBox::put_Editing(TRUE). When editing a particular character, the WM_COMMAND message is fired to the event sink whenever when the edit mode is exited. This happens when the user presses either the ENTER or ESCAPE key. The values of the wParam and lParam parameters that accompany the WM_COMMAND message are described in the following table.

Parameter
Description
LOWORD(wParam) Control identifier
HIWORD(wParam) EN_CHANGE
LOWORD(lParam) Notification flags
HIWORD(lParam) Form identifier

The low-order word of lParam is one of the following notification flags:

ASFC_EDITNOTIFY_COMMITTED
The user exited edit mode by pressing the ENTER key.
ASFC_EDITNOTIFY_CHANGED
The text has changed since edit mode was entered.

When using an edit control in a power list box, HIWORD(lParam) contains the power list box identifier instead of the form’s identifier.

See Also

IASCharSpinner, HIWORD, LOWORD