EmEditor Home - EmEditor Help - Plug-in Reference

Messages

EE_ADD_REF Increments the reference number of the plug-in.
EE_CLIP_HISTORY Manipulates the Clipboard history.
EE_CONVERT Converts characters.
EE_CUSTOM_BAR_CLOSE Closes a custom bar.
EE_CUSTOM_BAR_OPEN Opens a custom bar.
EE_DEV_TO_VIEW Converts the device (client) coordinates of a specified position to the display coordinates.
EE_DO_IDLE Refreshes the toolbar, the window title, the tab, and others.
EE_EDIT_TEMP Opens temporary text as a new document, or activates, saves, or closes the existing temporary text.
EE_EMPTY_UNDO_BUFFER Empties the buffer for the Undo and Redo commands.
EE_ENUM_CONFIG Enumerates available configurations.
EE_ENUM_HIGHLIGHT Enumerates highlighted strings.
EE_EXEC_COMMAND Executes a specified command.
EE_FILTER Filters the document with the specified string and settings.
EE_FIND_IN_FILESA Searches for an ANSI string from multiple files in the specified path.
EE_FIND_IN_FILESW Searches for a Unicode string from multiple files in the specified path.
EE_FIND_REGEX Searches a string for a regular expression.
EE_FINDA Searches for an ANSI string.
EE_FINDW Searches for an Unicode string.
EE_FREE Frees a specified plug-in.
EE_GET_ACCEL_ARRAY Retrieves the array of the shortcut keys.
EE_GET_ANCHOR_POS Retrieves the origin point of the selection.
EE_GET_ATTR Retrieves the configurations and attributes at the specified position.
EE_GET_CARET_POS Retrieves the current cursor position.
EE_GET_CELL Retrieves the Unicode text on the current cell.
EE_GET_CMD_ID Obtains the Plug-in command ID.
EE_GET_COLOR Retrieves the text and background colors and style for the specified part.
EE_GET_CONFIGA Retrieves the selected configuration name by an ANSI string.
EE_GET_CONFIGW Retrieves the selected configuration name by a Unicode string.
EE_GET_DROPPED_FILE Retrieves the most recently dropped file.
EE_GET_LINEA Retrieves the ANSI text on the specified line.
EE_GET_LINES Retrieves the number of the lines in EmEditor.
EE_GET_LINEW Retrieves the Unicode text on the specified line.
EE_GET_MARGIN Retrieves the margin size.
EE_GET_MODIFIED Retrieves the modified state of the text.
EE_GET_MULTI_SEL Retrieves the information of a specified selection when multiple selections are available.
EE_GET_OUTLINE_LEVEL Retrieves the outline level for the specified logical line.
EE_GET_OUTPUT_STRING Retrieves the text in the output bar.
EE_GET_PAGE_SIZE Retrieves a page size.
EE_GET_REDRAW Retrieves the flag that allows changes in EmEditor to be redrawn or prevents changes in EmEditor to be redrawn.
EE_GET_REF Retrieves the reference number of a specified plug-in.
EE_GET_SCROLL_POS Retrieves the current positions of the scroll bars.
EE_GET_SEL_END Retrieves the ending character position of the selection.
EE_GET_SEL_START Retrieves the starting character position of the selection.
EE_GET_SEL_TEXTA Retrieves the selected ANSI text.
EE_GET_SEL_TEXTW Retrieves the selected Unicode text.
EE_GET_SEL_TYPE Obtains the type of selection status.
EE_GET_STATUSA Retrieves the ANSI text displayed on the status bar.
EE_GET_STATUSW Retrieves the Unicode text displayed on the status bar.
EE_GET_VERSION Returns the version number.
EE_GET_WORD Returns a word at the cursor position.
EE_HELP Displays the specified page of the Help.
EE_INFO Retrieves or sets the value of one of the information parameters used by EmEditor.
EE_INSERT_FILEA Inserts the specified file contents at the cursor (ANSI).
EE_INSERT_FILEW Inserts the specified file contents at the cursor (Unicode).
EE_INSERT_STRINGA Inserts an ANSI string into the current cursor position.
EE_INSERT_STRINGW Inserts a Unicode string into the current cursor position.
EE_IS_CHAR_HALF_OR_FULL Queries whether a specified character is a half-width or full-width character.
EE_JOIN Combines two CSV documents specifying key columns, using a method similar to JOIN operations, and creates a new document.
EE_KEYBOARD_PROP Displays the Keyboard Properties for the specified command ID and configuration.
EE_LINE_FROM_CHAR Retrieves the index of the line that contains the specified character index (the serial position).
EE_LINE_INDEX Retrieves the character index of the first character of a specified line in EmEditor.
EE_LOAD_CONFIGA Reloads a configuration of which name is specified by an ANSI string.
EE_LOAD_CONFIGW Reloads a configuration of which name is specified by a Unicode string.
EE_LOAD_FILEA Loads a specified file into EmEditor (ANSI).
EE_LOAD_FILEW Loads a specified file into EmEditor (Unicode).
EE_LOGICAL_TO_SERIAL Converts the logical coordinates to the serial position.
EE_LOGICAL_TO_VIEW Converts the logical coordinates to the display coordinates.
EE_MATCH_REGEX Searches a string for a regular expression.
EE_OUTPUT_DIR Sets the current directory for the output bar.
EE_OUTPUT_STRING Appends a string to the output bar.
EE_QUERY_STATUS Queries the status of the command, whether the command is enabled and whether the command is a checked status.
EE_QUERY_STRING Queries the string associated with the specified command.
EE_REDRAW Allows changes in EmEditor to be redrawn or prevents changes in EmEditor to be redrawn.
EE_REG_QUERY_VALUE Queries a value from the Registry or an INI file depending on the EmEditor settings.
EE_REG_SET_VALUE Sets a value into the Registry or an INI file depending on the EmEditor settings.
EE_RELEASE Decrements the reference number of the plug-in.
EE_REPLACE_IN_FILESA Replaces an ANSI string in multiple files in the specified path.
EE_REPLACE_IN_FILESW Replaces a Unicode string in multiple files in the specified path.
EE_REPLACEA Replaces an ANSI string.
EE_REPLACEW Replaces an Unicode string.
EE_RUN_MACRO Runs a macro.
EE_SAVE_FILEA Saves the text to a specified file(ANSI).
EE_SAVE_FILEW Saves the text to a specified file(Unicode).
EE_SERIAL_TO_LOGICAL Converts the serial position to the logical coordinates.
EE_SET_ANCHOR_POS Sets the origin point of the selection.
EE_SET_CARET_POS Moves the cursor position and optionally extends the selection.
EE_SET_CONFIGA Changes to a configuration specified by an ANSI string.
EE_SET_CONFIGW Changes to a configuration specified by a Unicode string.
EE_SET_MODIFIED Changes the modified state of the text.
EE_SET_OUTLINE_ARRAY Sets the outline levels for the specified multiple lines.
EE_SET_OUTLINE_LEVEL Sets the outline level for the specified logical line.
EE_SET_SCROLL_POS Specifies the scroll bars position.
EE_SET_SEL_LENGTH Changes the character length of the selection.
EE_SET_SEL_TYPE Sets the type of selection status.
EE_SET_SEL_VIEW Changes the the starting and ending position of the selection.
EE_SET_STATUSA Displays an ANSI message on the status bar.
EE_SET_STATUSW Displays a Unicode message on the status bar.
EE_SHOW_OUTLINE Shows or hides the outline.
EE_TOOLBAR_CLOSE Closes a custom toolbar.
EE_TOOLBAR_OPEN Opens a custom toolbar.
EE_TOOLBAR_SHOW Shows or hides a custom toolbar.
EE_UPDATE_TOOLBAR Updates a button status in a toolbar.
EE_VIEW_TO_DEV Converts the display coordinates of a specified position to the device (client) coordinates.
EE_VIEW_TO_LOGICAL Converts the display coordinates of a specified position to the logical coordinates.

These constants are defined at the header file (plugin.h).

The following Windows API messages are also supported. Some of their supports may not be complete. As the window handle parameter for the message, specify the window handle of the view, not frame of EmEditor. See Microsoft MSDN library for more information on these messages.

EM_GETSEL Retrieves the starting and ending character positions of the current selection.
EM_SCROLLCARET Scrolls the cursor into view.
EM_SETSEL Selects a range of characters.
EM_REPLACESEL Replaces the current selection with the specified text.
WM_CLEAR Deletes the current selection.
WM_COPY Copies the current selection to the Clipboard.
WM_CUT Deletes the current selection and copy the deleted text to the Clipboard.
WM_GETTEXT Copies the entire document into a buffer.
WM_GETTEXTLENGTH Retrieves the size of buffer needed to retrieve the entire document excluding a terminating null character.
WM_PASTE Copies the current content of the clipboard at the current cursor position.
WM_SETTEXT Sets the entire document.
WM_UNDO Undo the last operation.
Copyright 2003-2015 by Emurasoft, Inc.