BeginStreaming(Nullable, Boolean) Method

Definition

Assembly MarkView.Avalonia.dll

Starts a streaming session that appends to the current Markdown; set it to an empty string (or null) first to stream a new document. Text appended to the session is rendered at most once per updateInterval, re-rendering only the blocks the new text can have changed: the scroll position, the selection in unchanged blocks, the active search and an open image lightbox are kept. After each update Markdown holds the text so far; a null Markdown is treated as empty, so it is "" once a session that appended nothing completes. Must be called on the UI thread.

public MarkdownStreamingSession BeginStreaming(TimeSpan? updateInterval = default(TimeSpan? ), bool healIncompleteSyntax = true)

Parameters

updateInterval
Nullable<TimeSpan>

The shortest time between two updates; DefaultStreamingUpdateInterval when null.

healIncompleteSyntax
Boolean

Whether each update closes the inline syntax the text so far leaves open (emphasis, code spans, link addresses, bracket math when enabled), so the construct renders as it will once complete. The closers are parse input only: Markdown holds the text as appended, and the final update renders the text as it is.

Returns

MarkdownStreamingSession
The session to append text to and complete.