Methoden von RichTextEditor

Name: RichTextEditor
Price: 129 USD
Author: Richscripts Inc.

RichTextEditor stellt die folgenden Methoden bereit.

Methode	Beschreibung
`duplicateCurrentBlock()`	Nur in neueren Core-Builds aus den Quellen (nicht in jedem veröffentlichten Bundle): dupliziert den Block bzw. die Blöcke an der Auswahl und setzt den Cursor in die Kopie. Eindeutige IDs und Review-Identitäten werden nicht geklont. Schreibgeschützte Inhalte bzw. Inhalte im Modus „nur Kommentare“, nicht unterstützte Zeilenverbünde und der Vorschlagsmodus verweigern die Operation. Ein Rückgabewert true kann auch bedeuten, dass abgesichert nichts getan wurde, und beweist nicht, dass Inhalt kopiert wurde. Prüfen Sie typeof editor.duplicateCurrentBlock, bevor Sie die Methode mit einer älteren Laufzeit verwenden.
`recordUndo()`	Zeichnet das aktuelle Dokument auf und schließt seinen Rückgängig-Schritt ab. Rufen Sie die Methode nach einer eigenen DOM-Änderung auf, damit sich die Änderung rückgängig machen lässt.
`makePanelResizable(panel, opts)`	Ab Core 2.6.11. Fügt einem Seitenbereich einen ziehbaren, per Tastatur bedienbaren Rand zur Größenänderung hinzu (ArrowLeft / ArrowRight / Home / End). opts: minimale und maximale Breite in px (Standard 240 / 720), Beschriftung für Screenreader. Löst das Ereignis panelresized aus. Gibt das Griffelement zurück oder null, wenn das Panel fehlt oder bereits in der Größe veränderbar ist.
`setListStart(n)`	Setzt die Startnummer der nummerierten Liste an der Auswahl, einschließlich 0. Gibt false zurück, wenn keine nummerierte Liste ausgewählt ist oder n ungültig ist.
`continueListNumbering()`	Setzt die Nummerierung der ausgewählten nummerierten Liste von der vorhergehenden nummerierten Liste fort. Gibt false zurück, wenn keine passende Liste gefunden wird.
`toggleTableCaption()`	Fügt die Beschriftung der ausgewählten Tabelle hinzu oder entfernt sie und zeichnet einen Rückgängig-Schritt auf. Gibt false zurück, wenn keine Tabelle ausgewählt ist.
`execCommand(cmd,value)`	Führt einen Befehl auf der aktuellen Auswahl oder dem angegebenen Bereich aus.
`attachEvent(name,handler)`	Registriert einen Ereignishandler. Sie können damit arbeiten, sobald der Editor geladen ist und läuft.
`detachEvent(name,handler)`	Entfernt einen Ereignishandler von einem Ereignis.
`getHTMLCode()`	Mit dieser Methode rufen Sie den Inhalt von RichTextEditor als HTML ab.
`setHTMLCode(html)`	Mit dieser Methode setzen Sie den Inhalt von RichTextEditor.
`getReadOnly()`	Gibt einen Wert zurück, der angibt, ob der Editor clientseitig schreibgeschützt ist.
`setReadOnly(bReadOnly)`	Schaltet den schreibgeschützten Modus ein oder aus.
`isCommandEnabled(cmd)`	Ermittelt, ob der angegebene Befehl aktiviert ist.
`isCommandActive(cmd)`	Prüft, ob dieser Befehl derzeit ausgeführt werden kann.
`focus()`	Versucht, den Fokus auf das Inhaltsfenster des Editors zu setzen.
`setContentCssText(text)`	Mit dieser Methode setzen Sie Inline-CSS-Text, den der bearbeitbare Bereich verwendet.
`insertRootParagraph(tagname)`	Mit dieser Methode fügen Sie am Ende des Editors einen neuen Absatz ein.
`insertByTagName(tagName)`	Fügt ein Element über seinen Tag-Namen ein.
`surroundByTagName(tagName)`	Nimmt den Inhalt der Auswahl und legt ihn in ein Element. Anschließend wird dieses neue Element eingefügt.
`insertElement(element)`	Fügt ein Element ein. Dieses Element muss mit editor.document erstellt worden sein.
`surroundElement(element)`	Erstellen Sie ein Element mit editor.document. Die Methode legt den Inhalt der Auswahl in das Element und fügt dieses neue Element dann ein.
`insertText(text)`	Mit dieser Methode fügen Sie den angegebenen reinen Text in das Editor-Dokument ein.
`insertHTML(text)`	Mit dieser Methode fügen Sie das angegebene HTML an einer Stelle im Editor-Dokument ein. Ist etwas ausgewählt, wird die Auswahl durch das neue HTML und den neuen Text ersetzt.
`selectControl(element)`	Wählt ein Steuerelement aus.
`selectDoc(bStart)`	Wählt das Dokument aus. bStart ist ein boolescher Wert: true setzt die Auswahl an den Anfang, false an das Ende. Ohne Angabe gilt false.
`collapse(bStart)`	Lässt die aktuelle Auswahl auf einen einzelnen Punkt zusammenfallen. bStart ist ein boolescher Wert: true lässt den Bereich auf seinen Anfang zusammenfallen, false auf sein Ende. Ohne Angabe gilt false.
`delete()`	Löscht eine Auswahl.
`commitBookmark()`	Erstellt ein Bookmark für den Rückgängig-Verlauf.
`clearHistory()`	Löscht alle Einträge für Rückgängig/Wiederherstellen.
`notifySelectionChange()`	Benachrichtigt den Editor über eine Änderung des Inhalts.
`htmlEncode(text)`	Wandelt einen String in einen HTML-kodierten String um.
`htmlDecode(html)`	Wandelt einen String, der für die Übertragung per HTTP HTML-kodiert wurde, in einen dekodierten String um.
`getSelection()`	Gibt das Objekt editor.selection zurück.
`getDocument()`	Gibt das Objekt editor.document zurück.
`getEditable()`	Gibt das Wurzelelement des bearbeitbaren Bereichs zurück.
`ensureStyleSheetLive(doc,element,id,csstext)`	Rufen Sie diese Methode direkt nach dem Anhängen Ihres eigenen <style>-Elements auf. Normalerweise tut sie nichts: Sie greift nur, wenn eine strenge Content-Security-Policy das Element geleert hat, und fügt dann dasselbe CSS über das CSSOM erneut ein, damit die Regeln gelten, statt stillschweigend verworfen zu werden. Nur wenn Ihr <style>-Element der primäre Weg bleibt, behält es seinen Platz in der Kaskade.
`injectStyleSheet(doc,id,csstext)`	Fügt dem angegebenen Dokument ein Stylesheet ohne <style>-Element hinzu, sodass es ein strenges style-src übersteht. Verwenden Sie die Methode, wenn Sie kein Element zu erhalten haben; haben Sie eines, ziehen Sie ensureStyleSheetLive() vor, weil die Regeln in einem übernommenen Stylesheet landen, das nach jedem Stylesheet im Dokument einsortiert wird. Ein erneuter Aufruf mit derselben id und anderem CSS aktualisiert das vorhandene Stylesheet.
`getPlainText()`	Gibt das Objekt editor.document.body.innerText zurück.
`getJSON()`	Verfügbar, wenn die Bridge für strukturierte Inhalte geladen ist. Gibt ein semantisches JSON-Dokumentmodell für den aktuellen Editor-Inhalt zurück.
`setJSON(documentModel)`	Verfügbar, wenn die Bridge für strukturierte Inhalte geladen ist. Stellt den Editor aus dem strukturierten JSON-Dokumentmodell wieder her.
`getSelectedControl()`	Gibt das ausgewählte Steuerelement zurück.
`getSelectionElement()`	Gibt das ausgewählte Element zurück.
`getSelectedText()`	Gibt den ausgewählten reinen Text zurück.
`createToolbarButton(cmd)`	Erstellt eine Schaltfläche in der Symbolleiste mit den Standardstilen. Einzelheiten finden Sie im Plugin-Beispiel.
`createToolbarDropDown(cmd)`	Erstellt ein Dropdown in der Symbolleiste mit den Standardstilen. Einzelheiten finden Sie im Plugin-Beispiel.
`createDialog(title,className)`	Erstellt einen Dialog mit den Standardstilen. Einzelheiten finden Sie im Plugin-Beispiel.
`closeCurrentPopup()`	Versucht, alle Popups, Dropdowns, Menüs und Dialoge zu schließen.
`setImageForCommand(element,cmdname)`	Fügt dem Element ein Bild (SVG oder PNG) für cmdname hinzu.
`destroy()`	Baut den Editor ab und gibt seine Listener und sein DOM frei. Rufen Sie die Methode beim Unmounten in einer SPA auf; prepareDestroy() ist ein Alias.
`getHTML() / setHTML(html)`	Aliase von getHTMLCode() und setHTMLCode().
`bindDocumentEvent(type, handler, capture)`	Ab Core 2.6.10. Lauscht auf dem Bearbeitungsdokument (keydown, input, ...). Verwenden Sie die Methode statt getDocument().addEventListener: Der Editor hängt den Listener neu an, wenn der Bearbeitungsrahmen ein neues Dokument erhält (siehe das Ereignis documentreplaced).
`bindEditableEvent(type, handler, capture)`	Ab Core 2.6.10. Dasselbe auf dem bearbeitbaren body (getEditable()).
`runInSavedView(fn)`	Ab Core 2.6.10. Führt fn aus, während der Bearbeitungsbereich genau das zeigt, was GESPEICHERT würde (Vorschauen von Plugins wie Beispielwerte von Seriendruckfeldern werden für den Aufruf abgeschaltet), und gibt das Ergebnis von fn zurück. Verwenden Sie die Methode für jeden Export, der berechnete Styles oder das Layout lesen muss.
`cancelUploads(reason)`	Bricht alle noch laufenden Uploads ab und gibt zurück, wie viele abgebrochen wurden. Ruft die vom Handler zurückgegebene Abbruchfunktion auf, sofern vorhanden, und ignoriert verspätete Ergebnisse. Auch destroy() bricht Uploads ab. Ein Ergebnis für ein aus dem Dokument entferntes Bild wird verworfen; das Entfernen allein garantiert keinen sofortigen Abbruch im Netzwerk.
`getPendingUploadCount()`	Wie viele Uploads noch laufen.
`uploadEmbeddedImages(callback)`	Lädt Bilder, die bereits als Base64-data:-URLs im Inhalt eingebettet sind – mit setHTMLCode gesetzter, aus einer Seite eingefügter oder aus einem Entwurf wiederhergestellter Inhalt –, über file_upload_handler hoch und ersetzt jedes src durch die zurückgegebene URL. Der Callback erhält { uploaded, failed, skipped, errors }. Bilder mit http(s) bleiben unverändert; ohne konfigurierten Handler ändert sich nichts.
`getText() / setText(text)`	Aliase von getPlainText() und setPlainText().
`setPlainText(text)`	Ersetzt das Dokument durch reinen Text; jeder Zeilenumbruch wird zu einem eigenen Block.
`formatChanged(formats, callback)`	Abonniert Änderungen am Zustand von Formaten und Befehlen, sodass eine eigene Symbolleiste den aktiven Zustand ohne Polling verfolgen kann. Entspricht formatChanged() von TinyMCE; wird von derselben Aktualisierung gesteuert wie die eingebaute Symbolleiste, sodass ein Abonnent nicht aus dem Takt geraten kann. Auch als editor.formatter.formatChanged verfügbar.
`getSelectedHTML()`	Gibt die aktuelle Auswahl als HTML-String zurück.
`getStatistics()`	Gibt die Inhaltsstatistik des Editors zurück (Wörter, Zeichen und verwandte Zählungen).
`showWordCount()`	Öffnet den Dialog zur Wortzählung.
`showShortcuts()`	Öffnet die Übersicht der Tastenkürzel (Cmd/Ctrl + /).
`toMarkdown()`	Gibt den aktuellen Inhalt als CommonMark zurück.
`fromMarkdown(md, opts)`	Ersetzt den Inhalt durch geparstes CommonMark.
`exportPdf(options)`	Exportiert das Dokument als getaggtes Vektor-PDF.
`printPreview()`	Öffnet die Druckvorschau für das aktuelle Dokument.
`insertImageByUrl(url, alt)`	Fügt am Cursor ein Bild von einer URL ein. Das optionale alt setzt den Alt-Text (Core 2.6.5+); ohne diesen Parameter wird kein alt-Attribut geschrieben.
`openFindDialog()`	Öffnet den Dialog zum Suchen und Ersetzen.
`findHighlight(query, options)`	Hebt jeden Treffer für eine Suchanfrage hervor, ohne den Dialog zu öffnen.
`clearFindHighlights()`	Entfernt die von findHighlight() hinzugefügten Hervorhebungen.
`markAllOccurrencesOfSelection()`	Hebt jedes Vorkommen der aktuellen Auswahl hervor.
`toggleReadingMode(state) / isReadingMode()`	Schaltet die ablenkungsfreie Leseansicht ein oder aus und meldet ihren Zustand.
`setCommentsOnly(bVal) / getCommentsOnly()`	Beschränkt die Bearbeitung auf Kommentieren und meldet, ob dieser Modus aktiv ist.
`applyMathMarkup() / renderMath()`	Wandelt TeX in das Formel-Markup des Editors um und stellt es dar, wenn KaTeX oder MathJax auf der Seite vorhanden ist.
`setPreviewCssText(text)`	Setzt Inline-CSS für den Vorschaumodus.
`getLangText(key)`	Sucht einen lokalisierten Oberflächentext für die aktive Sprache.
`fireEvent(name, ...args)`	Löst einen Ereignis-Hook per Code aus.
`autoSave`	Vorhanden, wenn config.autoSave gesetzt ist. Speichert während des Tippens auf Ihrem eigenen Server: trigger() speichert sofort, retryNow() wiederholt ein fehlgeschlagenes Speichern sofort, hasUnsavedChanges() meldet, ob noch ein Speichern aussteht, isDirty() vergleicht den Inhalt mit der zuletzt gespeicherten Version, und lastSavedAt() gibt den Zeitstempel zurück. Ein fehlgeschlagenes Speichern wird mit sich verdoppelnder Verzögerung wiederholt sowie dann, wenn der Browser wieder online ist, wobei der fehlgeschlagene Snapshot erneut gesendet wird. Die Ereignisse autosaved und autosavefailed melden beide Ergebnisse. Für Entwürfe im Browser siehe stattdessen die Option localDraft.