MarkdownStreamingSession Class

Definition

Streams markdown into a MarkdownViewer: text appended to the session, from any thread, is rendered at most once per update interval, re-rendering only the blocks the new text can have changed. Started with BeginStreaming(Nullable<TimeSpan>, Boolean).

public sealed class MarkdownStreamingSession : IDisposable

Remarks

After each update the viewer's Markdown holds the text received so far. Complete() (or Dispose()) applies the final update and ends the session. Between updates the viewer closes the inline syntax the text leaves open, unless BeginStreaming(Nullable<TimeSpan>, Boolean) was called with healIncompleteSyntax: false.

Setting Markdown, Source, Pipeline or any other property that makes the viewer render again ends the session silently: no final update is applied, IsCompleted becomes true and later appends throw.

Tip: use kind:method, kind:property, kind:ctor. Press Esc to clear.

Properties (1)

Methods (5)

Events (1)