Important Notice

The pages on this site contain documentation for very old MS-DOS software, purely for historical purposes. If you're looking for up-to-date documentation, particularly for programming, you should not rely on the information found here, as it will be woefully out of date.

◄CWnd►                                        ◄Up► ◄Contents► ◄Index► ◄Back►
──Microsoft Foundation Classes──────────────────────────────────────────────
 
  Description
 
  The CEdit class provides the functionality of a Windows edit control. An
  edit control is a rectangular child window in which the user can enter
  text.
 
  You create an edit control in two steps. First, call the constructor
  CEdit to construct the CEdit object, then call the ◄Create► member
  function to create the Windows edit control and attach it to the CEdit
  object.
 
  Construction can be a one-step process in a class derived from CEdit.
  Write a constructor for the derived class and call Create from within
  the constructor.
 
  If you want to handle the Windows notification messages sent by a CEdit
  object to its parent (usually a class derived from CDialog), add the
  following message-map entries and message-handler member functions to
  the parent class:
 
  ON_COMMAND
  ON_EN_SETFOCUS
  ON_EN_KILLFOCUS
  ON_EN_MAXTEXT
  ON_EN_CHANGE
  ON_EN_UPDATE
  ON_EN_HSCROLL
  ON_EN_VSCROLL
 
  If you create a CEdit object within a dialog box, the CEdit is
  automatically destroyed when the user closes the dialog box.
 
  If you create a CEdit object within a window, you may also need to
  destroy it. If you create the CEdit object on the stack, it is destroyed
  automatically. If you create the CEdit object on the heap by using the
  new function, you must call delete on the object to destroy it when the
  user terminates the Windows edit control. If you allocate any memory in
  the CEdit object, override the CEdit destructor to dispose of the
  allocations.
 
  See Also
 
  ◄CWnd►, ◄CButton►, ◄CComboBox►, ◄CListBox►, ◄CScrollBar►, ◄CStatic►,
  ◄CModalDialog►, ◄CDialog►
 
  Public Members
 
  Construction/Destruction
 
  ◄CEdit►   Constructs a CEdit control object.
 
  Initialization
 
  ◄Create►   Creates the Windows edit control and attaches it to the CEdit
             object.
 
  Multiple-Line Operations
 
  ◄GetLineCount►   Retrieves the number of lines in a multiple-line edit
                   control.
 
  ◄GetHandle►      Retrieves a handle to the memory currently allocated
                   for a multiple-line edit control.
 
  ◄SetHandle►      Sets the handle to the local memory that will be used
                   by a multiple-line edit control.
 
  ◄FmtLines►       Sets the inclusion of soft line-break characters on or
                   off within a multiple-line edit control.
 
  ◄LineIndex►      Retrieves the character index of a line within a
                   multiple-line edit control.
 
  ◄SetRect►        Sets the formatting rectangle of a multiple-line edit
                   control and updates the control.
 
  ◄SetRectNP►      Sets the formatting rectangle of a multiple-line edit
                   control without updating the control.
 
  ◄SetTabStops►    Sets the tab stops in a multiple-line edit control.
 
  General Operations
 
  ◄CanUndo►           Determines if an edit-control operation can be
                      undone.
 
  ◄GetModify►         Determines if the contents of an edit control have
                      been modified.
 
  ◄SetModify►         Sets or clears the modification flag for an edit
                      control.
 
  ◄GetRect►           Gets the formatting rectangle of an edit control.
 
  ◄GetSel►            Gets the starting and ending character positions of
                      the current selection in an edit control.
 
  ◄GetLine►           Retrieves a line of text from an edit control.
 
  ◄EmptyUndoBuffer►   Resets (clears) the undo flag of an edit control.
 
  ◄LimitText►         Limits the length of the text that the user may
                      enter into an edit control.
 
  ◄LineFromChar►      Retrieves the line number of the line that contains
                      the specified character index.
 
  ◄LineLength►        Retrieves the length of a line in an edit control.
 
  ◄LineScroll►        Scrolls the text of a multiple-line edit control.
 
  ◄ReplaceSel►        Replaces the current selection in an edit control
                      with the specified text.
 
  ◄SetPasswordChar►   Sets or removes a password character displayed in an
                      edit control when the user enters text.
 
  ◄SetSel►            Selects a range of characters in an edit control.
 
  ◄Undo►              Reverses the last edit-control operation.
 
  ◄Clear►             Deletes (clears) the current selection (if any) in
                      the edit control.
 
  ◄Copy►              Copies the current selection (if any) in the edit
                      control to the Clipboard in CF_TEXT format.
 
  ◄Cut►               Deletes (cuts) the current selection (if any) in the
                      edit control, and copies the deleted text to the
                      Clipboard in CF_TEXT format.
 
  ◄Paste►             Inserts the data from the Clipboard into the edit
                      control at the current cursor position. Data is
                      inserted only if the Clipboard contains data in
                      CF_TEXT format.
 
  Windows 3.1 Functions
 
  ◄SetReadOnly►           Sets the read-only state of an edit control.
 
  ◄GetFirstVisibleLine►   Determines the topmost visible line in an edit
                          control.
 
  ◄GetPasswordChar►       Retrieves the password character displayed in an
                          edit control when the user enters text.
 
 
                                     -♦-