WM_CONTROL (in Multiline Entry Fields) - Parameters

usid (USHORT)

Control window identity.

usnotifycode (USHORT)

Notify code.

MLN_TEXTOVERFLOW

A key stroke causes the amount of text to exceed the limit on the number of bytes of data (refer to MLM_SETTEXTLIMIT). The parameter contains the number of bytes of data which would not fit within the current text limit. For character key strokes this can be 1 or 2 (DBCS). For Shift+Ins (paste) it can be any amount up to the paste limit.

The default rc of FALSE causes the default error handling, which is to ignore the key stroke, and beep.

An rc of TRUE implies that corrective action has been taken (such as deleting existing text or raising the limit) and the WM_CHAR (in Multiline Entry Fields) should be reprocessed as if just entered.

MLN_PIXHORZOVERFLOW
A key stroke causes the size of the display bit map to exceed the horizontal limit of the format rectangle (refer to MLM_SETFORMATRECT). The parameter contains the number of pels that would not fit within the current text limit.

The default rc of FALSE causes the default error handling, which is to ignore the key stroke, and beep.

An rc of TRUE implies that corrective action has been taken (such as changing to a smaller font or raising the limit) and the WM_CHAR (in Multiline Entry Fields) should be reprocessed as if just entered.

MLN_PIXVERTOVERFLOW
A key stroke causes the size of the display bit map to exceed the vertical limit of the format rectangle (refer to MLM_SETFORMATRECT). The parameter contains the number of pels that would not fit within the current text limit.

The default rc of FALSE causes the default error handling, which is to ignore the key stroke, and beep.

An rc of TRUE implies that corrective action has been taken (such as changing to a smaller font or raising the limit) and the WM_CHAR (in Multiline Entry Fields) should be reprocessed as if just entered.

MLN_OVERFLOW
An action other than entry of a key stroke causes a condition involving the text limit or format rectangle limit, such that either the limit becomes inadequate to contain the text or the text exceeds the limit.

This can be caused by:

MLM_SETWRAP MLM_SETTABSTOP
MLM_SETFONT
MLM_IMPORT
MLM_PASTE
MLM_CUT
MLM_UNDO
MLM_DELETE
WM_SIZE.

MLN_HSCROLL
Indicates that the MLE has completed a scrolling calculation and is about to update the display accordingly. All queries return values as if the scrolling were complete. However, no scrolling action is visible on the user interface.
MLN_VSCROLL
Indicates that the MLE has completed a scrolling calculation and is about to update the display accordingly. All queries return values as if the scrolling were complete. However, no scrolling action is visible on the user interface.
MLN_CHANGE
Signals that the text has changed. This notification is sent whenever any text change occurs.
MLN_UNDOOVERFLOW
Signals that the text change operation, which could normally be undone, cannot be undone because the amount of text involved exceeds the undo capability. This includes text entry, deletion, cutting, and pasting.
MLN_CLPBDFAIL
Signals that a clipboard operation failed.
MLN_MEMERROR
Signals that the required storage cannot be obtained. The action that results in the increased storage requirement fails.
MLN_SETFOCUS
Sent whenever the MLE window receives the input focus.
MLN_KILLFOCUS
Sent whenever the MLE window loses the input focus.
MLN_MARGIN
Whenever the user moves the mouse into the left, right top, or bottom margins, this message is sent to the owner of the window.

If the owner returns an rc of TRUE, the mouse move is assumed to have been processed by the owner and no further action need be taken.

If the owner returns an rc of FALSE, the MLE performs a default action appropriate to each different mouse action.

The exceptions to this are all mouse messages that occur after a button-down inside the margin, until and including the matching button-up. Conceptually the drag (button-down until button-up) is a single macro event. Therefore, if FALSE is returned for a button-down event, no further margin notifications are given until after the drag has ended (button-up).

Note: If the application receives a notification of button-down in the margin and processes it, it must capture the mouse until the button-up event.

MLN_SEARCHPAUSE
This notification is sent periodically by the MLE, while an MLM_SEARCH message is being processed, to give an application the opportunity to stop excessively long searches, and to provide search progress information. The owner window can respond either with TRUE or FALSE. FALSE causes the MLE to continue searching; TRUE causes the MLE to stop the search immediately. For further information, see MLM_SEARCH

ulOver (ULONG)

Number of bytes that do not fit.

param2 contains ulOver for a usnotifycode of MLN_TEXTOVERFLOW.

pixOver (PIX)

Linear distance of overflow in pels.

param2 contains pixOver for a usnotifycode of MLN_PIXHORZOVERFLOW or MLN_PIXVERTOVERFLOW.

pErrInfo (POVERFLOW)

Overflow error information structure.

param2 contains pErrInfo for a usnotifycode of MLN_OVERFLOW.

The afErrInd field of the MLEOVERFLOW structure can take one or more of the following values:

MLFEFR_RESIZE

The window is resized, and the format rectangle is tied to the window size and limited either horizontally, vertically, or both. The implicit change of the format rectangle to the new size does not contain the text. The format rectangle is made static at the previous size, and the MLESFR_MATCHWINDOW style is turned off until set again by the application. This is done in response to a WM_SIZE message, and therefore the multi-line entry field does not forward the return value from this notification message.
MLFEFR_TABSTOP
A tab stop location change is requested, and the text is limited either horizontally, vertically, or both. Changing the tab stops causes the text to exceed the limit. The tab stop change is rejected.
MLFEFR_FONT
A font change is requested, and the text is limited either horizontally, vertically, or both. Changing the font causes the text to exceed the limit. The font change is rejected.
MLFEFR_WORDWRAP
The word-wrap state is requested to be changed, and the text is limited either horizontally, vertically, or both. Wrapping the text differently exceeds the limit, and the request is rejected. This happens in situations where the horizontal limit is not set, there are lines exceeding it, and word-wrap is being changed from off to on, such that it creates soft line breaks resulting in increased vertical size. This happens if word-wrap is being changed from on to off, and there is at least one line created by a soft line-break, such that when that line-break is removed, the full line (up to the hard line break) exceeds the horizontal limit.
MLFEFR_TEXT
Text is changed by MLM_IMPORT, MLM_PASTE, MLM_CUT, MLM_UNDO, or MLM_DELETE, and the text is limited either horizontally, vertically, or both within the format rectangle. The change causes the text to exceed the format rectangle in a dimension that is limited. For example, Delete and EOL joins text from two lines into one line long enough to exceed the horizontal limit.
MLFETL_TEXTBYTES
Text is changed by MLM_IMPORT MLM_PASTE, or MLM_UNDO, and the text is limited to a maximum number of bytes. The change causes the text to exceed that maximum.

ulErrInd (ULONG)

Clipboard fail flag.

param2 contains ulErrInd for a usnotifycode of MLN_CLPBDFAIL.

MLFCPBD_TOOMUCHTEXT

Text amount exceeds clipboard capacity
MLFCPBD_CLPBDERROR
A clipboard error occurred.

pmrg (PMARGSTRUCT)

Margin structure.

param2 contains pmrg for a usnotifycode of MLN_MARGIN.

The left and right margins are defined as going all the way to the top and bottom such that the top and bottom margins are contained between them. Therefore, the corners are included in the sides.

usMouMsg contains the mouse message that signals the event.

iptNear contains the insertion point of the nearest point in the text. For situations where the nearest location is beyond the end of a line, the insertion point for the end of the line is returned. (The EOL character is considered to be beyond the end of the line.)

iptSearchedTo (IPT)

Current insertion point of search.

param2 contains iptSearchedTo for a usnotifycode of MLN_SEARCHPAUSE.

ulReserved (ULONG)

Reserved value, should be 0.

param2 contains ulReserved for a usnotifycode of MLN_HSCROLL, MLN_VSCROLL, MLN_CHANGE, MLN_UNDOOVERFLOW, MLN_MEMERROR, MLN_SETFOCUS, or MLN_KILLFOCUS.

rc (BOOL)

Action taken by application.

ReturnCode contains rc for a usnotifycode of MLN_TEXTOVERFLOW, MLN_PIXHORZOVERFLOW, MLN_PIXVERTOVERFLOW, MLN_MARGIN, or MLN_SEARCHPAUSE.

TRUE

The multiline entry field control assumes that appropriate action has been taken by the application. Appropriate action depends on the MLN_* notification code, and is documented under the usnotifycode field.
FALSE
The multiline entry field control assumes that the application has ignored this WM_CONTROL (in Multiline Entry Fields) message, and takes action appropriate to the MLN_* notification code, as documented under the usnotifycode field.

ulReserved (ULONG)

Reserved value, should be 0.

ReturnCode contains ulReserved for a usnotifycode of MLN_OVERFLOW, MLN_HSCROLL, MLN_VSCROLL, MLN_CHANGE, MLN_UNDOOVERFLOW, MLN_CLPBDFAIL, MLN_MEMERROR, MLN_SETFOCUS, or MLN_KILLFOCUS.

---

[Back: WM_CONTROL (in Multiline Entry Fields) Field - ulReserved]
[Next: WM_CONTROL (in Multiline Entry Fields) - Syntax]