THtmlEditor Members

The following tables list the members exposed by THtmlEditor.

	Name	Description
	Caret	Editor caret
	DesignerElement	Highligted block element containing caret.
	fAddictSpell	This is fAddictSpell, a member of class THtmlEditor.
	fAfterLoad	This is fAfterLoad, a member of class THtmlEditor.
	fChanged	This is fChanged, a member of class THtmlEditor.
	fCurrentFile	This is fCurrentFile, a member of class THtmlEditor.
	FMXCaret	This is FMXCaret, a member of class THtmlEditor.
	fOnChange	This is fOnChange, a member of class THtmlEditor.
	fOnSpellCheck	This is fOnSpellCheck, a member of class THtmlEditor.
	fOnWordCorrection	This is fOnWordCorrection, a member of class THtmlEditor.
	fPreserveStyleOnNewBlock	This is fPreserveStyleOnNewBlock, a member of class THtmlEditor.
	fReadOnly	This is fReadOnly, a member of class THtmlEditor.
	fSpellChecking	This is fSpellChecking, a member of class THtmlEditor.
	fWordCorrection	This is fWordCorrection, a member of class THtmlEditor.
	History	Undo history
	TextStyle	Current text style attributes. Many text style functions are accessible via this class. Changing TextStyle properties will change style of current selection, or current word at cursor (if nothing is selected) or style of subsequent text entered by user.
	THtmlEditor	HTML Editor

Public Methods

	Name	Description
	AddChar	Add char at caret position
	AddHR	Add horizontal divider <hr> at caret position
	AddHTMLAtCursor	Insert HTML at caret position. HTML is wrapped into <span> tag
	AddImageAtCursor	This is the overview for the AddImageAtCursor method overload.
	AddLineBreak	Add line break
	AddPara	Add new paragraph at caret position
	AddString	Add text string at caret positon
	AddTable	Add table at caret position.
	AddTextElement	Add new text element before or after specified element
	CanUndo	Returns true if undo history is not empty
	CaretDown	Move caret one line down
	CaretEnd	This is CaretEnd, a member of class THtmlEditor.
	CaretFirstCell	Move caret to first cell in table row
	CaretLastCell	Move caret to last cell in table row
	CaretLineEnd	This is CaretLineEnd, a member of class THtmlEditor.
	CaretLineStart	This is CaretLineStart, a member of class THtmlEditor.
	CaretNext	This is CaretNext, a member of class THtmlEditor.
	CaretNextCell	Move caret to next cell in table row
	CaretNextWord	Move caret to next word
	CaretPageDown	This is CaretPageDown, a member of class THtmlEditor.
	CaretPageUp	This is CaretPageUp, a member of class THtmlEditor.
	CaretParaEnd	Move caret to the end of a current paragraph
	CaretParaStart	Move caret to start of current paragraph
	CaretPrevious	This is CaretPrevious, a member of class THtmlEditor.
	CaretPreviousCell	Move caret to previous cell in table row
	CaretPreviousWord	Move caret to previous word
	CaretStart	Caret moving
	CarettoElement	This is the overview for the CarettoElement method overload.
	CarettoEndof	Move caret to the end of specified element
	CarettoStartof	Move caret to the start of specified element
	CaretUp	Move caret one line up
	CharAtCursor	This is CharAtCursor, a member of class THtmlEditor.
	CopySelectiontoClipboard	Copy current selection to clipboard as HTML and text
	Create	This is Create, a member of class THtmlEditor.
	CreateSearchResult	Create an HTML with search results. This method could be used to implement a search window, see Editor demo application.
	CreateTableofContents	Creates table of contents fpr document. See Editor demo application for details. Document should contain <h1>...<h5> tags for this method to work.
	CurrentIsText	Returns true if current element is text element
	CurrentText	Current element (containig caret) as TTextElement element. Use this function only after CurrentIsText checking
	CutSelectiontoClipboard	Cut current selection to clipboard as HTML and text
	DecreaseIdent	Increase indent of selection or current block if selection is empty
	DeleteBlockElement	This is DeleteBlockElement, a member of class THtmlEditor.
	DeleteChar	Delete char from text element or delete full element for non-text elements
	DeleteElement	Delete element and optionally add to undo history
	DeleteSelection	Delete current selection
	DeleteTextElement	This is DeleteTextElement, a member of class THtmlEditor.
	Destroy	This is Destroy, a member of class THtmlEditor.
	DisableCaret	Disable caret
	DocChanged	Use this method to notify the editor of any changes in document.
	DoctoScreen	Convert Document coordinate to screen coordinate
	DropImages	This is DropImages, a member of class THtmlEditor.
	EnableCaret	Enable caret
	FMXCreateCaret	This is FMXCreateCaret, a member of class THtmlEditor.
	FMXGetCaret	This is FMXGetCaret, a member of class THtmlEditor.
	FMXHideCaret	This is FMXHideCaret, a member of class THtmlEditor.
	FMXShowCaret	This is FMXShowCaret, a member of class THtmlEditor.
	GetAbsoluteCaretPostion	This is GetAbsoluteCaretPostion, a member of class THtmlEditor.
	GetElementbyAbsolutePosition	Return element by its absolute position in document. Absolute position is calculated by summing a visual length of all text elements and images (length=1).
	IncreaseIdent	Increase indent of selection or current block if selection is empty
	InsertElementTo	Insert (or move) element into other element at specified position. If destination element is text it will be divided into two new text elements.
	ListPara	This is ListPara, a member of class THtmlEditor.
	Paint	This is Paint, a member of class THtmlEditor.
	PaintCaret	caret
	PastefromClipboard	Paste text or HTML from clipboard at caret position
	PasteImageFromClipboard	Paste image from clipboard at caret position
	RecreateCaret	This is RecreateCaret, a member of class THtmlEditor.
	Refresh	Calculate document styles, layout and (optionally) repaint the editor window
	RegisterAutoreplace	Register autoreplace rule
	RemoveBlockElement	This is RemoveBlockElement, a member of class THtmlEditor.
	RestoreCaret	Restore caret position
	SaveCaret	Save caret position
	Scroll	This is Scroll, a member of class THtmlEditor.
	Selected	Returns true if selection is not empty
	SelectWordAtCursor	Select word at caret position
	SetAbsoluteCaretPosition	This is SetAbsoluteCaretPosition, a member of class THtmlEditor.
	SetAlignment	Set text alignment for selection or current block
	SetCaret	This is SetCaret, a member of class THtmlEditor.
	SetCarettoPoint	This is SetCarettoPoint, a member of class THtmlEditor.
	SetCurrent	This is SetCurrent, a member of class THtmlEditor.
	SetHeaderLevel	Set header level for current block. Level 0 = p. level 1-5 = h1-h5
	SetLineHeight	Set line height (CSS line-height) for current block
	SetListStyle	Convert selection to ordered or unordered list
	SetOnSpellCheck	This is SetOnSpellCheck, a member of class THtmlEditor.
	SetSpellChecking	This is SetSpellChecking, a member of class THtmlEditor.
	SplitBlock	This is SplitBlock, a member of class THtmlEditor.
	SplitBlockAtCursor	Split block at caret position
	SplitListItem	This is SplitListItem, a member of class THtmlEditor.
	TagSelection	Wrap current selection by tag
	UnionElements	This is UnionElements, a member of class THtmlEditor.
	UnlistItem	This is UnlistItem, a member of class THtmlEditor.
	UnListSelection	Remove list style from current selection
	UntagSelection	Remove specified tag from current selection. If attributes parameter is not empty only tags with same attributes (and values) will be removed
	UnwrapbyTag	This is UnwrapbyTag, a member of class THtmlEditor.
	UpdateCaret	Update caret position
	WordAt	Word at specified screen point.
	WordAtCursor	Word at caret position
	WrapBlock	This is WrapBlock, a member of class THtmlEditor.
	WrapbyTag	returns last element

Public Properties

	Name	Description
	AbsoluteCaretPosition	Returns absolute caret position at document. Absolute position is calculated by summing a visual length of all text elements and images (length=1). This property can be used for saving and restoring caret position.
	Current	Return text or image element at caret position
	CurrentFile	Name of the file loaded into the editor
	Modified	This is Modified, a member of class THtmlEditor.

Published Events

	Name	Description
	OnWordCorrection	Use this event for integration with spellchecking systems. Note that HtmlEditor has build-in integration with Addict which do not require using this event.

Published Properties

	Name	Description
	AddictSpell	Use this property enable live spellchecking and word correction via Addict library.
	AfterLoad	Occurs when new document is loaded into the editor. Write an AfterLoad event handler to take specific action whenever the new document is loaded into the editor or new blank document is created.
	CanFocus	This is CanFocus, a member of class THtmlEditor.
	OnCaretMoved	Occurs when editor caret is moved into new position. Use Current property to get a current element and Caret.CurrentChar to get index of char at caret.
	OnChange	Occurs when the text for the editor may have changed. Write an OnChange event handler to take specific action whenever the document may have changed. Use the Modified property to see if a change actually occurred. Note that HTML property will not reflect the changes. Use Doc.InnerHTML to get a current text.
	OnKeyDown	This is OnKeyDown, a member of class THtmlEditor.
	OnKeyPress	This is OnKeyPress, a member of class THtmlEditor.
	OnSpellCheck	This is OnSpellCheck, a member of class THtmlEditor.
	PreserveStyleOnNewBlock	Use this property to preserve current style for new blocks. For example, new para created when user press Enter will have same font size, name and color as current.
	ReadOnly	Determines whether the user can change the text of the editor. To restrict the editor to display only, set the ReadOnly property to true. Set ReadOnly to false to allow the contents of the editor to be edited. Setting ReadOnly to true ensures that the text is not altered, while still allowing the user to select text. The selected text can then be manipulated by the application, or copied to the Clipboard.
	SpellChecking	Enable or disable live spellchecking.
	WordCorrection	Enable or disable automatic word correction. For word correction to work Addict property should be set or OnWordCorrection event handler implemented.

Links

THtmlEditor Class, Legend, Public Fields, Public Methods, Public Properties, Published Events, Published Properties

What do you think about this topic? Send feedback!