ITextStudioTextSourceBackend

InterfaceTextStudioTextStudio

public interface ITextStudioTextSourceBackend

Optional backend capability for synchronizing authored markup with an external text target.

Methods

TryPullText(bool, TextStudioBackendWriteHandling, string, out string, out bool)

bool TryPullText(bool isDriving, TextStudioBackendWriteHandling handling, string currentMarkup, out string newMarkup, out bool ignoredExternalWrite)

Resolves an external text mutation according to the host’s write-handling policy.

Parameters

Name	Type
isDriving	System.Boolean
handling	TextStudio.TextStudioBackendWriteHandling
currentMarkup	System.String
newMarkup	System.String
ignoredExternalWrite	System.Boolean

Returns

System.Boolean: true when newMarkup should replace host markup.

PushText(in TextStudioBackendTextRequest)

void PushText(in TextStudioBackendTextRequest request)

Pushes compiled text and its transient plan view to the backend.

Parameters

Name	Type	Description
request	TextStudio.TextStudioBackendTextRequest	Text request valid only for the duration of the call.

PushRawAuthoringText(string)

void PushRawAuthoringText(string markup)

Writes raw authoring markup when the target supports editing.

Parameters

Name	Type	Description
markup	System.String	Uncompiled markup to display or edit.

Properties

HasUnobservedTextChange

bool HasUnobservedTextChange { get; }

Gets whether the target changed since the host last pulled its text.

Returns

System.Boolean

CurrentText

string CurrentText { get; }

Gets the text currently stored by the backend target.

Returns

System.String