GuiRichEdit user defined functions Reference

Below is a complete list of the user defined functions available in AutoIt. Click on a user defined function name for a detailed description.

When using them you need to add a #include <GuiRichEdit.au3>.

 

User Defined Function Description
_GUICtrlRichEdit_AppendText Appends text at the end of the client area
_GUICtrlRichEdit_AutoDetectURL Enables or disables automatic detection of URLS
_GUICtrlRichEdit_CanPaste Can the contents of the clipboard be pasted into the control?
_GUICtrlRichEdit_CanPasteSpecial Can the contents of the clipboard be pasted into the control in both formats?
_GUICtrlRichEdit_CanRedo Can an undone action be redone?
_GUICtrlRichEdit_CanUndo Can an action be undone?
_GUICtrlRichEdit_ChangeFontSize Increment or decrement font size(s) of selected text
_GUICtrlRichEdit_Copy Copy text to clipboard
_GUICtrlRichEdit_Create Create an Edit control
_GUICtrlRichEdit_Cut Cut text to clipboard
_GUICtrlRichEdit_Deselect Deselects text, leaving none selected
_GUICtrlRichEdit_Destroy Delete the Rich Edit control
_GUICtrlRichEdit_EmptyUndoBuffer Resets the undo flag of the control
_GUICtrlRichEdit_FindText Search for a text starting at insertion point or at anchor point of selection
_GUICtrlRichEdit_FindTextInRange Search for a text in a range of inter-character positions
_GUICtrlRichEdit_GetBkColor Gets the background color of the control
_GUICtrlRichEdit_GetCharAttributes Returns attributes of selected text
_GUICtrlRichEdit_GetCharBkColor Retrieves the background color of the selected text or, if none selected, of the character to the right of the insertion point
_GUICtrlRichEdit_GetCharColor Retrieves the color of the selected text or, if none selected, of the character to the right of the insertion point
_GUICtrlRichEdit_GetCharPosFromXY Gets inter-character position closest to a specified point in the client area
_GUICtrlRichEdit_GetCharPosOfNextWord Gets inter-character position before the next word
_GUICtrlRichEdit_GetCharPosOfPreviousWord Gets inter-character position before the Previous word
_GUICtrlRichEdit_GetCharWordBreakInfo Gets inter-character position before the Previous word/
_GUICtrlRichEdit_GetFirstCharPosOnLine Retrieves the inter-character position preceding the first character of a line
_GUICtrlRichEdit_GetFont Gets the font attributes of a selection or, if no selection, at the insertion point
_GUICtrlRichEdit_GetLineCount Retrieves the number of lines in a multi-line edit control
_GUICtrlRichEdit_GetLineLength Retrieves the length of a line
_GUICtrlRichEdit_GetLineNumberFromCharPos Retrieves the line number on which an inter-character position is found
_GUICtrlRichEdit_GetNextRedo Retrieves the name or type ID of the next possible redo action
_GUICtrlRichEdit_GetNextUndo Retrieves the name or type ID of the next possible Undo action
_GUICtrlRichEdit_GetNumberOfFirstVisibleLine Gets number of the first line which is visible in the control
_GUICtrlRichEdit_GetParaAlignment Gets the alignment of selected paragraph(s), or (if no selection) of the current paragraph
_GUICtrlRichEdit_GetParaAttributes Gets the attributes of (first) selected paragraph or (if no selection) of the current paragraph
_GUICtrlRichEdit_GetParaBorder Gets the border settings of (first) selected paragraph or (if no selection) of the current paragraph
_GUICtrlRichEdit_GetParaIndents Gets the border indent settings of (first) selected paragraph or (if no selection) of the current paragraph
_GUICtrlRichEdit_GetParaNumbering Gets the numbering style of (first) selected paragraph or (if no selection) of the current paragraph
_GUICtrlRichEdit_GetParaShading Gets the shading settings of (first) selected paragraph or (if no selection) of the current paragraph
_GUICtrlRichEdit_GetParaSpacing Gets the spacing settings of (first) selected paragraph or (if no selection) of the current paragraph
_GUICtrlRichEdit_GetParaTabStops Gets the tabstops of (first) selected paragraph or (if no selection) of the current paragraph
_GUICtrlRichEdit_GetPasswordChar Gets the password character that a rich edit control displays when the user enters text
_GUICtrlRichEdit_GetRECT Retrieves the formatting rectangle of a control
_GUICtrlRichEdit_GetScrollPos Gets the Scrolling position of the control
_GUICtrlRichEdit_GetSel Gets the low and high inter-character positions of a selection
_GUICtrlRichEdit_GetSelAA Gets the anchor and active inter-character positions of a selection, in that order
_GUICtrlRichEdit_GetSelText Retrieves the currently selected text
_GUICtrlRichEdit_GetSpaceUnit Gets the unit of measure of horizontal and vertical space used in parameters of various _GUICtrlRichEdit functions
_GUICtrlRichEdit_GetText Get all of the text in the control
_GUICtrlRichEdit_GetTextInLine Gets a line of text
_GUICtrlRichEdit_GetTextInRange Gets the text from from one inter-character position to another
_GUICtrlRichEdit_GetTextLength Get the length of the whole text in the control
_GUICtrlRichEdit_GetVersion Retrieves the version of Rich Edit
_GUICtrlRichEdit_GetXYFromCharPos Retrieves the XY coordinates of an inter-character position
_GUICtrlRichEdit_GetZoom Gets the zoom level of the control
_GUICtrlRichEdit_GotoCharPos Moves the insertion point to an inter-character position
_GUICtrlRichEdit_HideSelection Hides (or shows) a selection
_GUICtrlRichEdit_InsertText Inserts text at insertion point or anchor point of selection
_GUICtrlRichEdit_IsModified Retrieves the state of a rich edit control's modification flag
_GUICtrlRichEdit_IsTextSelected Is text selected?
_GUICtrlRichEdit_Paste Paste RTF or RTF with Objects from clipboard
_GUICtrlRichEdit_PasteSpecial Paste RTF or RTF and Objects from clipboard
_GUICtrlRichEdit_PauseRedraw Pauses redrawing of the control
_GUICtrlRichEdit_Redo Redoes last undone action
_GUICtrlRichEdit_ReplaceText Replaces selected text
_GUICtrlRichEdit_ResumeRedraw Resumes redrawing of the control
_GUICtrlRichEdit_ScrollLineOrPage Scrolls the text down or up a line or a page
_GUICtrlRichEdit_ScrollLines Scrolls the text down or up a number of lines
_GUICtrlRichEdit_ScrollToCaret Scrolls to show line on which caret (insertion point) is
_GUICtrlRichEdit_SetBkColor Sets the background color of the control
_GUICtrlRichEdit_SetCharAttributes Turns an attribute on or off for selected text or, if none selected, for text inserted at the insertion point
_GUICtrlRichEdit_SetCharBkColor Sets the background color of selected text or, if none selected, sets the background color of text inserted at the insertion point
_GUICtrlRichEdit_SetCharColor Sets the color of selected text or, if none selected, sets the color of text inserted at the insertion point
_GUICtrlRichEdit_SetEventMask Specifies which notification messages are sent to the parent window
_GUICtrlRichEdit_SetFont Sets the font attributes of selected text or, if none selected, sets those of text inserted at the insertion point
_GUICtrlRichEdit_SetLimitOnText Change number of characters that can be typed, pasted or streamed in as Rich Text Format
_GUICtrlRichEdit_SetModified Sets or clears the modification flag
_GUICtrlRichEdit_SetParaAlignment Sets alignment of paragraph(s) in the current selection or, if no selection, of paragraphs inserted at the insertion point
_GUICtrlRichEdit_SetParaAttributes Sets attributes of paragraph(s) in the current selection or, if no selection, of paragraphs inserted at the insertion point
_GUICtrlRichEdit_SetParaBorder Sets the border of paragraph(s) in the current selection or, if no selection, of paragraphs inserted at the insertion point
_GUICtrlRichEdit_SetParaIndents Sets indents of paragraph(s) in the current selection or, if no selection, of paragraphs inserted at the insertion point
_GUICtrlRichEdit_SetParaNumbering Sets numbering of paragraph(s) in the current selection or, if no selection, of paragraph(s) inserted at the insertion point
_GUICtrlRichEdit_SetParaShading Sets the shading of paragraph(s) in the current selection or, if no selection, of paragraphs inserted at the insertion point
_GUICtrlRichEdit_SetParaSpacing Sets paragraph spacing of paragraphs having selected text or, if none selected, sets it for text inserted at the insertion point
_GUICtrlRichEdit_SetParaTabStops Sets tab stops of paragraphs having selected text or, if none selected, sets it for text inserted at the insertion point
_GUICtrlRichEdit_SetPasswordChar Sets the characters to be displayed instead of those typed, or causes typed characters to show
_GUICtrlRichEdit_SetReadOnly Sets or removes the read-only state
_GUICtrlRichEdit_SetRECT Sets the formatting rectangle of a Rich Edit control
_GUICtrlRichEdit_SetScrollPos Scrolls the display such that ($ix,$iY) is in the upper left corner of the control
_GUICtrlRichEdit_SetSel Sets the low and high character position of a selection
_GUICtrlRichEdit_SetSpaceUnit Sets the unit of measure of horizontal and vertical space used in parameters of various _GUICtrlRichEdit functions
_GUICtrlRichEdit_SetTabStops Sets tab stops for the control
_GUICtrlRichEdit_SetText Sets the text of a control
_GUICtrlRichEdit_SetUndoLimit Sets the maximum number of actions that can stored in the undo queue
_GUICtrlRichEdit_SetZoom Sets zoom level of the control
_GUICtrlRichEdit_StreamFromFile Sets text in a control from a file
_GUICtrlRichEdit_StreamFromVar Sets text in a control from a variable
_GUICtrlRichEdit_StreamToFile Writes contents of a control to a file
_GUICtrlRichEdit_StreamToVar Writes contents of a control to a variable
_GUICtrlRichEdit_Undo Undoes the last edit control operation in the control's undo queue