THtmlEditor Methods

The methods of the THtmlEditor class are listed here.

	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
	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.
	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

Links

THtmlEditor Class, Legend, Public Methods

What do you think about this topic? Send feedback!