Back to Devexpress

DocumentLoadedEvent Class

aspnetcore-js-devexpress-dot-richedit-eb41b9cd.md

latest3.6 KB
Original Source

DocumentLoadedEvent Class

An event that occurs when a document model is loaded into the control.

Declaration

ts
export class DocumentLoadedEvent extends RichEditEvent<EventArgs>

Remarks

You can define the DocumentLoaded event handler either at the server side, at the client side, or at runtime.

Use the OnDocumentLoaded(String) method to specify the event handler.

cshtml
@(Html.DevExpress().RichEdit("richEdit")
 .OnDocumentLoaded("function(s,e) {
   s.document.insertText(0, 'Dear Mr Stanley,');
   s.document.insertParagraph(s.document.length);
   var startPosition = s.document.length;
   s.document.insertParagraph(startPosition);
   s.document.insertText(startPosition, '[Type your text here]');
   s.selection.setSelection(new DevExpress.RichEdit.Interval(startPosition, s.document.length - startPosition));
   s.focus();
 }")
 // ...

Use the documentLoaded property to specify the event handler.

javascript
const options = DevExpress.RichEdit.createOptions();
options.events.documentLoaded = function(s,e) {
  s.document.insertText(0, 'Dear Mr Stanley,');
  s.document.insertParagraph(s.document.length);
  var startPosition = s.document.length;
  s.document.insertParagraph(startPosition);
  s.document.insertText(startPosition, '[Type your text here]');
  s.selection.setSelection(new DevExpress.RichEdit.Interval(startPosition, s.document.length - startPosition));
  s.focus();
};

The documentLoaded property provides access to the addHandler(handler), removeHandler(handler), and clearHandlers methods that allow you to dynamically add and remove event handlers.

javascript
richEdit.events.documentLoaded.addHandler(function(s, e) {
  s.document.insertText(0, 'Dear Mr Stanley,');
  s.document.insertParagraph(s.document.length);
  var startPosition = s.document.length;
  s.document.insertParagraph(startPosition);
  s.document.insertText(startPosition, '[Type your text here]');
  s.selection.setSelection(new DevExpress.RichEdit.Interval(startPosition, s.document.length - startPosition));
  s.focus();
});

The event handler receives an argument of the EventArgs type.

Inherited Members

addHandler(handler)

clearHandlers

isEmpty

removeHandler(handler)

Inheritance

Event<TSource, TEventArgs> RichEditEvent<TEventArgs> DocumentLoadedEvent

See Also

Client-Side Events