Back to all docs
API Reference / Telerik.Windows.SyntaxEditor.Core.Text / TextDocument
New to Telerik UI for WPF? Start a free 30-day trial

TextDocument

Class

Represents a text document.

Definition

Namespace:Telerik.Windows.SyntaxEditor.Core.Text

Assembly:Telerik.Windows.SyntaxEditor.Core.dll

Syntax:
C#
public class TextDocument

Inheritance: objectTextDocument

Constructors

TextDocument()

Initializes a new instance of the TextDocument class.

C#
public TextDocument()

TextDocument(string)

Initializes a new instance of the TextDocument class.

C#
public TextDocument(string text)
Parameters:textstring

TextDocument(TextDocument)

Initializes a new instance of the TextDocument class.

C#
public TextDocument(TextDocument document)
Parameters:documentTextDocument

TextDocument(TextReader)

Initializes a new instance of the TextDocument class.

C#
public TextDocument(TextReader textReader)
Parameters:textReaderTextReader

Properties

CurrentSnapshot

Gets the current snapshot.

C#
public TextSnapshot CurrentSnapshot { get; }

History

Gets the document history.

C#
public TextDocumentHistory History { get; }

Methods

Delete(Span)

Deletes the given span.

C#
public bool Delete(Span spanToDelete)
Parameters:spanToDeleteSpanReturns:

bool

Find(string, int, bool, bool, bool)

Looks up for a span containing the search text or matching a regex pattern.

C#
public Span? Find(string searchText, int startIndex, bool matchCase, bool useRegularExpression, bool matchWord)
Parameters:searchTextstringstartIndexintmatchCasebooluseRegularExpressionboolmatchWordboolReturns:

Span?

Find(string, int, bool, bool)

Looks up for a span containing the search text or matching a regex pattern.

C#
public Span? Find(string searchText, int startIndex, bool matchCase, bool useRegularExpression)
Parameters:searchTextstringstartIndexintmatchCasebooluseRegularExpressionboolReturns:

Span?

Find(string, int, bool)

Looks up for a span containing the search text.

C#
public Span? Find(string searchText, int startIndex, bool useRegularExpression)
Parameters:searchTextstringstartIndexintuseRegularExpressionboolReturns:

Span?

Find(string, int)

Looks up for a span containing the search text.

C#
public Span? Find(string searchText, int startIndex)
Parameters:searchTextstringstartIndexintReturns:

Span?

FindAll(string, bool, bool, bool)

Looks up for a all spans containing the search text or matching a regex pattern.

C#
public IEnumerable<Span> FindAll(string searchText, bool matchCase, bool useRegularExpression, bool matchWord = false)
Parameters:searchTextstringmatchCasebooluseRegularExpressionboolmatchWordboolReturns:

IEnumerable<Span>

FindAll(string, bool)

Looks up for a all spans containing the search text or matching a regex pattern.

C#
public IEnumerable<Span> FindAll(string searchText, bool useRegularExpression)
Parameters:searchTextstringuseRegularExpressionboolReturns:

IEnumerable<Span>

FindAll(string)

Looks up for a all spans containing the search text.

C#
public IEnumerable<Span> FindAll(string searchText)
Parameters:searchTextstringReturns:

IEnumerable<Span>

FindPrevious(string, int, bool, bool, bool)

Looks up for a previous span containing the search text or matching a regex pattern.

C#
public Span? FindPrevious(string searchText, int startIndex, bool matchCase, bool useRegularExpression, bool matchWord)
Parameters:searchTextstringstartIndexintmatchCasebooluseRegularExpressionboolmatchWordboolReturns:

Span?

FindPrevious(string, int, bool)

Looks up for a previous span containing the search text or matching a regex pattern.

C#
public Span? FindPrevious(string searchText, int startIndex, bool matchCase)
Parameters:searchTextstringstartIndexintmatchCaseboolReturns:

Span?

Insert(int, string)

Inserts text at the given position.

C#
public bool Insert(int position, string text)
Parameters:positioninttextstringReturns:

bool

OnPreviewTextContentChanged(TextContentChangedEventArgs)

Raises the PreviewTextContentChanged event.

C#
protected virtual void OnPreviewTextContentChanged(TextContentChangedEventArgs args)
Parameters:argsTextContentChangedEventArgs

OnPreviewTextContentChanging(TextContentChangingEventArgs)

Raises the PreviewTextContentChanging event.

C#
protected virtual void OnPreviewTextContentChanging(TextContentChangingEventArgs args)
Parameters:argsTextContentChangingEventArgs

OnTextContentChanged(TextContentChangedEventArgs)

Raises the TextContentChanged event.

C#
protected virtual void OnTextContentChanged(TextContentChangedEventArgs args)
Parameters:argsTextContentChangedEventArgs

OnTextContentChanging(TextContentChangingEventArgs)

Raises the TextContentChanging event.

C#
protected virtual void OnTextContentChanging(TextContentChangingEventArgs args)
Parameters:argsTextContentChangingEventArgs

Replace(Span, string)

Replaces the given span with the given replace text.

C#
public bool Replace(Span spanToReplace, string replaceText)
Parameters:spanToReplaceSpanreplaceTextstringReturns:

bool

ReplaceAllMatches(string, string, bool, bool, bool)

Replaces all matched strings of the given search text with the provided replace text.

C#
public int ReplaceAllMatches(string searchText, string replaceText, bool matchCase, bool useRegularExpression, bool matchWord = false)
Parameters:searchTextstringreplaceTextstringmatchCasebooluseRegularExpressionboolmatchWordboolReturns:

int

ReplaceNextMatch(string, int, string, bool, bool)

Replaces the next matched strings of the given search text with the provided replace text.

C#
public bool ReplaceNextMatch(string searchText, int startIndex, string replaceText, bool matchCase, bool useRegularExpression)
Parameters:searchTextstringstartIndexintreplaceTextstringmatchCasebooluseRegularExpressionboolReturns:

bool

Events

PreviewTextContentChanged

Occurs when text is about to be changed.

C#
public event EventHandler<TextContentChangedEventArgs> PreviewTextContentChanged

PreviewTextContentChanging

Occurs when text is about to be changing.

C#
public event EventHandler<TextContentChangingEventArgs> PreviewTextContentChanging

TextContentChanged

Occurs when text is changed.

C#
public event EventHandler<TextContentChangedEventArgs> TextContentChanged

TextContentChanging

Occurs when text is changing.

C#
public event EventHandler<TextContentChangingEventArgs> TextContentChanging
In this article
DefinitionConstructorsTextDocument()TextDocument(string)TextDocument(TextDocument)TextDocument(TextReader)PropertiesCurrentSnapshotHistoryMethodsDelete(Span)Find(string, int, bool, bool, bool)Find(string, int, bool, bool)Find(string, int, bool)Find(string, int)FindAll(string, bool, bool, bool)FindAll(string, bool)FindAll(string)FindPrevious(string, int, bool, bool, bool)FindPrevious(string, int, bool)Insert(int, string)OnPreviewTextContentChanged(TextContentChangedEventArgs)OnPreviewTextContentChanging(TextContentChangingEventArgs)OnTextContentChanged(TextContentChangedEventArgs)OnTextContentChanging(TextContentChangingEventArgs)Replace(Span, string)ReplaceAllMatches(string, string, bool, bool, bool)ReplaceNextMatch(string, int, string, bool, bool)EventsPreviewTextContentChangedPreviewTextContentChangingTextContentChangedTextContentChanging
Not finding the help you need?
Contact Support