TextDocumentBase Class

public abstract class TextDocumentBase : ITextDocument

protected TextDocumentBase()

public CharacterCasing AutoCharacterCasing { get; set; }

Property Value

CharacterCasing:

A CharacterCasing indicating the desired case of inserted text.

public bool AutoConvertTabsToSpaces { get; set; }

Property Value

bool:

true if tabs should be converted to spaces when the Tab key is pressed or indenting occurs; otherwise, false. The default value is false.

Remarks

The number of spaces inserted is indicated by the TabSize property.

public ITextSnapshot CurrentSnapshot { get; }

Property Value

ITextSnapshot:

The ITextSnapshot that contains the current text of the document.

public string FileName { get; set; }

Property Value

string:

The name of the file currently loaded in the document.

Remarks

This property is automatically set whenever a LoadFile(string) overload is called that accepts a file path.

public bool IsModified { get; set; }

Property Value

bool:

true if the document has been modified; otherwise, false.

Remarks

This flag is reset to false when the ActiproSoftware.Text property is set, or when a SaveFile(string, LineTerminator) overload is used that accepts a path matching the current FileName property value.

public bool IsReadOnly { get; set; }

Property Value

bool:

true if the entire document is flagged as read-only; otherwise, false. The default value is false.

Remarks

When read-only, the document's contents should not be editable.

public int TabSize { get; set; }

Property Value

int:

The distance in spaces between tab stops. The default value is 4 spaces. The maximum tab size is 32.

public IUndoHistory UndoHistory { get; }

Property Value

IUndoHistory:

An IUndoHistory that provides access to undo and redo functionality for the document.

public void AddTextChangedEventHandler(EventHandler<TextSnapshotChangedEventArgs> handler, EventHandlerPriority priority)

Parameter	Type	Description
handler	EventHandler<TextSnapshotChangedEventArgs>	The delegate handler.
priority	EventHandlerPriority	A EventHandlerPriority specifying the priority level.

public void AddTextChangingEventHandler(EventHandler<TextSnapshotChangingEventArgs> handler, EventHandlerPriority priority)

Parameter	Type	Description
handler	EventHandler<TextSnapshotChangingEventArgs>	The delegate handler.
priority	EventHandlerPriority	A EventHandlerPriority specifying the priority level.

public bool AppendText(ITextChangeType type, string text)

Parameter	Type	Description
type	ITextChangeType	An ITextChangeType specifying the type of change.
text	string	The text to append to the current contents of the snapshot.

Returns

bool:

true if a text change was allowed to occur; otherwise, false.

Remarks

This method creates an ITextChange for the current snapshot, adds an append operation, and immediately applies it. If you will be executing multiple text change operations in a row, for improved performance it is recommended that you call the CreateTextChange(ITextChangeType) method instead, add operations to the returned ITextChange, and then apply the text change.

See Also

• DeleteText(ITextChangeType, int, int)
• InsertText(ITextChangeType, int, string)
• ReplaceText(ITextChangeType, int, int, string)
• SetText(ITextChangeType, string)

public bool AppendText(ITextChangeType type, string text, ITextChangeOptions options)

Parameter	Type	Description
type	ITextChangeType	An ITextChangeType specifying the type of change.
text	string	The text to append to the current contents of the snapshot.
options	ITextChangeOptions	The ITextChangeOptions for the change.

Returns

bool:

true if a text change was allowed to occur; otherwise, false.

Remarks

This method creates an ITextChange for the current snapshot, adds an append operation, and immediately applies it. If you will be executing multiple text change operations in a row, for improved performance it is recommended that you call the CreateTextChange(ITextChangeType, ITextChangeOptions) method instead, add operations to the returned ITextChange, and then apply the text change.

See Also

• DeleteText(ITextChangeType, int, int, ITextChangeOptions)
• InsertText(ITextChangeType, int, string, ITextChangeOptions)
• ReplaceText(ITextChangeType, int, int, string, ITextChangeOptions)
• SetText(ITextChangeType, string, ITextChangeOptions)

public ITextChange CreateTextChange(ITextChangeType type)

Parameter	Type	Description
type	ITextChangeType	An ITextChangeType specifying the type of change.

Returns

ITextChange:

The ITextChange that was created.

Remarks

The ITextChange.Apply() method must be called to apply the queued operations to the document.

public ITextChange CreateTextChange(ITextChangeType type, ITextChangeOptions options)

Parameter	Type	Description
type	ITextChangeType	An ITextChangeType specifying the type of change.
options	ITextChangeOptions	The ITextChangeOptions for the change.

Returns

ITextChange:

The ITextChange that was created.

Remarks

The ITextChange.Apply() method must be called to apply the queued operations to the document.

public bool DeleteText(ITextChangeType type, TextRange textRange)

Parameter	Type	Description
type	ITextChangeType	An ITextChangeType specifying the type of change.
textRange	TextRange	The TextRange of offsets to delete.

Returns

bool:

true if a text change was allowed to occur; otherwise, false.

Remarks

This method creates an ITextChange for the current snapshot, adds a delete operation, and immediately applies it. If you will be executing multiple text change operations in a row, for improved performance it is recommended that you call the CreateTextChange(ITextChangeType) method instead, add operations to the returned ITextChange, and then apply the text change.

See Also

• AppendText(ITextChangeType, string)
• InsertText(ITextChangeType, int, string)
• ReplaceText(ITextChangeType, TextRange, string)
• SetText(ITextChangeType, string)

public bool DeleteText(ITextChangeType type, TextRange textRange, ITextChangeOptions options)

Parameter	Type	Description
type	ITextChangeType	An ITextChangeType specifying the type of change.
textRange	TextRange	The TextRange of offsets to delete.
options	ITextChangeOptions	The ITextChangeOptions for the change.

Returns

bool:

true if a text change was allowed to occur; otherwise, false.

Remarks

This method creates an ITextChange for the current snapshot, adds a delete operation, and immediately applies it. If you will be executing multiple text change operations in a row, for improved performance it is recommended that you call the CreateTextChange(ITextChangeType, ITextChangeOptions) method instead, add operations to the returned ITextChange, and then apply the text change.

See Also

• AppendText(ITextChangeType, string, ITextChangeOptions)
• InsertText(ITextChangeType, int, string, ITextChangeOptions)
• ReplaceText(ITextChangeType, TextRange, string, ITextChangeOptions)
• SetText(ITextChangeType, string, ITextChangeOptions)

public bool DeleteText(ITextChangeType type, int offset, int length)

Parameter	Type	Description
type	ITextChangeType	An ITextChangeType specifying the type of change.
offset	int	The starting offset at which to delete.
length	int	The number of characters to delete.

Returns

bool:

true if a text change was allowed to occur; otherwise, false.

Remarks

This method creates an ITextChange for the current snapshot, adds a delete operation, and immediately applies it. If you will be executing multiple text change operations in a row, for improved performance it is recommended that you call the CreateTextChange(ITextChangeType) method instead, add operations to the returned ITextChange, and then apply the text change.

See Also

• AppendText(ITextChangeType, string)
• InsertText(ITextChangeType, int, string)
• ReplaceText(ITextChangeType, int, int, string)
• SetText(ITextChangeType, string)

public bool DeleteText(ITextChangeType type, int offset, int length, ITextChangeOptions options)

Parameter	Type	Description
type	ITextChangeType	An ITextChangeType specifying the type of change.
offset	int	The starting offset at which to delete.
length	int	The number of characters to delete.
options	ITextChangeOptions	The ITextChangeOptions for the change.

Returns

bool:

true if a text change was allowed to occur; otherwise, false.

Remarks

This method creates an ITextChange for the current snapshot, adds a delete operation, and immediately applies it. If you will be executing multiple text change operations in a row, for improved performance it is recommended that you call the CreateTextChange(ITextChangeType, ITextChangeOptions) method instead, add operations to the returned ITextChange, and then apply the text change.

See Also

• AppendText(ITextChangeType, string, ITextChangeOptions)
• InsertText(ITextChangeType, int, string, ITextChangeOptions)
• ReplaceText(ITextChangeType, int, int, string, ITextChangeOptions)
• SetText(ITextChangeType, string, ITextChangeOptions)

protected virtual IEnumerable<TagSnapshotRange<IReadOnlyRegionTag>> GetReadOnlyRegions(TextRange textRange)

Parameter	Type	Description
textRange	TextRange	The text range relative to the current snapshot for which to locate read-only regions.

Returns

IEnumerable<TagSnapshotRange<IReadOnlyRegionTag>>:

The collection of read-only region tag snapshot ranges.

protected virtual string GetTextReplacementInsertText(ITextChangeOperation operation)

Parameter	Type	Description
operation	ITextChangeOperation	The ITextChangeOperation containing default text to insert.

Returns

string:

The text to insert.

Remarks

This method can be overridden to scrub the text to insert, such as remove trailing whitespace, etc. By default it returns a null, meaning to use the unscrubbed InsertedText value.

public bool InsertText(ITextChangeType type, int offset, string text)

Parameter	Type	Description
type	ITextChangeType	An ITextChangeType specifying the type of change.
offset	int	The offset at which to insert.
text	string	The text to insert.

Returns

bool:

true if a text change was allowed to occur; otherwise, false.

Remarks

This method creates an ITextChange for the current snapshot, adds an insert operation, and immediately applies it. If you will be executing multiple text change operations in a row, for improved performance it is recommended that you call the CreateTextChange(ITextChangeType) method instead, add operations to the returned ITextChange, and then apply the text change.

See Also

• AppendText(ITextChangeType, string)
• DeleteText(ITextChangeType, int, int)
• ReplaceText(ITextChangeType, int, int, string)
• SetText(ITextChangeType, string)

public bool InsertText(ITextChangeType type, int offset, string text, ITextChangeOptions options)

Parameter	Type	Description
type	ITextChangeType	An ITextChangeType specifying the type of change.
offset	int	The offset at which to insert.
text	string	The text to insert.
options	ITextChangeOptions	The ITextChangeOptions for the change.

Returns

bool:

true if a text change was allowed to occur; otherwise, false.

Remarks

This method creates an ITextChange for the current snapshot, adds an insert operation, and immediately applies it. If you will be executing multiple text change operations in a row, for improved performance it is recommended that you call the CreateTextChange(ITextChangeType, ITextChangeOptions) method instead, add operations to the returned ITextChange, and then apply the text change.

See Also

• AppendText(ITextChangeType, string, ITextChangeOptions)
• DeleteText(ITextChangeType, int, int, ITextChangeOptions)
• ReplaceText(ITextChangeType, int, int, string, ITextChangeOptions)
• SetText(ITextChangeType, string, ITextChangeOptions)

public bool IsTextRangeReadOnly(TextRange textRange)

Parameter	Type	Description
textRange	TextRange	The TextRange to examine.

Returns

bool:

true if any character in the specified TextRange is flagged as read-only; otherwise, false.

public LineTerminator LoadFile(Stream stream, Encoding encoding)

Parameter	Type	Description
stream	Stream	The Stream from which to load.
encoding	Encoding	The Encoding to use when loading the file.

Returns

LineTerminator:

A LineTerminator indicating the line terminator of the file that was loaded.

public LineTerminator LoadFile(string path)

Parameter	Type	Description
path	string	The full path of the file from which to load.

Returns

LineTerminator:

A LineTerminator indicating the line terminator of the file that was loaded.

Remarks

This method updates the value of the FileName property.

public LineTerminator LoadFile(string path, Encoding encoding)

Parameter	Type	Description
path	string	The full path of the file from which to load.
encoding	Encoding	The Encoding to use when loading the file.

Returns

LineTerminator:

A LineTerminator indicating the line terminator of the file that was loaded.

Remarks

This method updates the value of the FileName property.

protected void NotifyPropertyChanged(string name)

Parameter	Type	Description
name	string	The name of the property.

protected virtual void OnFileNameChanged(StringPropertyChangedEventArgs e)

Parameter	Type	Description
e	StringPropertyChangedEventArgs	An StringPropertyChangedEventArgs that contains the event data.

protected virtual void OnIsModifiedChanged(EventArgs e)

Parameter	Type	Description
e	EventArgs	An EventArgs that contains the event data.

protected virtual void OnIsReadOnlyChanged(EventArgs e)

Parameter	Type	Description
e	EventArgs	An EventArgs that contains the event data.

protected virtual void OnTabSizeChanged(EventArgs e)

Parameter	Type	Description
e	EventArgs	An EventArgs that contains the event data.

protected virtual void OnTextChanged(TextSnapshotChangedEventArgs e)

Parameter	Type	Description
e	TextSnapshotChangedEventArgs	A TextSnapshotChangedEventArgs that contains the event data.

protected virtual void OnTextChanging(TextSnapshotChangingEventArgs e)

Parameter	Type	Description
e	TextSnapshotChangingEventArgs	A TextSnapshotChangingEventArgs that contains the event data.

public void RemoveTextChangedEventHandler(EventHandler<TextSnapshotChangedEventArgs> handler, EventHandlerPriority priority)

Parameter	Type	Description
handler	EventHandler<TextSnapshotChangedEventArgs>	The delegate handler.
priority	EventHandlerPriority	A EventHandlerPriority specifying the priority level.

public void RemoveTextChangingEventHandler(EventHandler<TextSnapshotChangingEventArgs> handler, EventHandlerPriority priority)

Parameter	Type	Description
handler	EventHandler<TextSnapshotChangingEventArgs>	The delegate handler.
priority	EventHandlerPriority	A EventHandlerPriority specifying the priority level.

public ISearchResultSet ReplaceAll(ISearchOptions options)

Parameter	Type	Description
options	ISearchOptions	The ISearchOptions to use.

Returns

ISearchResultSet:

An ISearchResultSet that specifies the result of the operation.

public ISearchResultSet ReplaceAll(ISearchOptions options, params TextRange[] searchTextRanges)

Parameter	Type	Description
options	ISearchOptions	The ISearchOptions to use.
searchTextRanges	TextRange[]	The TextRange array of offsets to search. If everything should be searched, specify the range 0 to the length of the document's current snapshot.

Returns

ISearchResultSet:

An ISearchResultSet that specifies the result of the operation.

public ISearchResultSet ReplaceNext(ISearchOptions options, int startOffset, bool canWrap)

Parameter	Type	Description
options	ISearchOptions	The ISearchOptions to use.
startOffset	int	The offset at which to start the search.
canWrap	bool	Whether the search can wrap at the end of the search text range.

Returns

ISearchResultSet:

An ISearchResultSet that specifies the result of the operation.

public ISearchResultSet ReplaceNext(ISearchOptions options, int startOffset, bool canWrap, TextRange searchTextRange)

Parameter	Type	Description
options	ISearchOptions	The ISearchOptions to use.
startOffset	int	The offset at which to start the search.
canWrap	bool	Whether the search can wrap at the end of the search text range.
searchTextRange	TextRange	The TextRange of offsets to search. If all should be searched, specify the range 0 to the length of the ITextSnapshot.

Returns

ISearchResultSet:

An ISearchResultSet that specifies the result of the operation.

public bool ReplaceText(ITextChangeType type, TextRange textRange, string text)

Parameter	Type	Description
type	ITextChangeType	An ITextChangeType specifying the type of change.
textRange	TextRange	The TextRange of offsets to delete.
text	string	The text to insert.

Returns

bool:

true if a text change was allowed to occur; otherwise, false.

Remarks

This method creates an ITextChange for the current snapshot, adds a replace operation, and immediately applies it. If you will be executing multiple text change operations in a row, for improved performance it is recommended that you call the CreateTextChange(ITextChangeType) method instead, add operations to the returned ITextChange, and then apply the text change.

See Also

• AppendText(ITextChangeType, string)
• DeleteText(ITextChangeType, TextRange)
• InsertText(ITextChangeType, int, string)
• SetText(ITextChangeType, string)

public bool ReplaceText(ITextChangeType type, TextRange textRange, string text, ITextChangeOptions options)

Parameter	Type	Description
type	ITextChangeType	An ITextChangeType specifying the type of change.
textRange	TextRange	The TextRange of offsets to delete.
text	string	The text to insert.
options	ITextChangeOptions	The ITextChangeOptions for the change.

Returns

bool:

true if a text change was allowed to occur; otherwise, false.

Remarks

This method creates an ITextChange for the current snapshot, adds a replace operation, and immediately applies it. If you will be executing multiple text change operations in a row, for improved performance it is recommended that you call the CreateTextChange(ITextChangeType, ITextChangeOptions) method instead, add operations to the returned ITextChange, and then apply the text change.

See Also

• AppendText(ITextChangeType, string, ITextChangeOptions)
• DeleteText(ITextChangeType, TextRange, ITextChangeOptions)
• InsertText(ITextChangeType, int, string, ITextChangeOptions)
• SetText(ITextChangeType, string, ITextChangeOptions)

public bool ReplaceText(ITextChangeType type, int offset, int length, string text)

Parameter	Type	Description
type	ITextChangeType	An ITextChangeType specifying the type of change.
offset	int	The offset at which to insert.
length	int	The number of characters to delete before inserting the text.
text	string	The text to insert.

Returns

bool:

true if a text change was allowed to occur; otherwise, false.

Remarks

This method creates an ITextChange for the current snapshot, adds a replace operation, and immediately applies it. If you will be executing multiple text change operations in a row, for improved performance it is recommended that you call the CreateTextChange(ITextChangeType) method instead, add operations to the returned ITextChange, and then apply the text change.

See Also

• AppendText(ITextChangeType, string)
• DeleteText(ITextChangeType, int, int)
• InsertText(ITextChangeType, int, string)
• SetText(ITextChangeType, string)

public bool ReplaceText(ITextChangeType type, int offset, int length, string text, ITextChangeOptions options)

Parameter	Type	Description
type	ITextChangeType	An ITextChangeType specifying the type of change.
offset	int	The offset at which to insert.
length	int	The number of characters to delete before inserting the text.
text	string	The text to insert.
options	ITextChangeOptions	The ITextChangeOptions for the change.

Returns

bool:

true if a text change was allowed to occur; otherwise, false.

Remarks

This method creates an ITextChange for the current snapshot, adds a replace operation, and immediately applies it. If you will be executing multiple text change operations in a row, for improved performance it is recommended that you call the CreateTextChange(ITextChangeType, ITextChangeOptions) method instead, add operations to the returned ITextChange, and then apply the text change.

See Also

• AppendText(ITextChangeType, string, ITextChangeOptions)
• DeleteText(ITextChangeType, int, int, ITextChangeOptions)
• InsertText(ITextChangeType, int, string, ITextChangeOptions)
• SetText(ITextChangeType, string, ITextChangeOptions)

public void SaveFile(Stream stream, Encoding encoding, LineTerminator lineTerminator)

Parameter	Type	Description
stream	Stream	The Stream to write to.
encoding	Encoding	The Encoding to use when loading the file.
lineTerminator	LineTerminator	A LineTerminator specifying the output format.

public void SaveFile(string path, LineTerminator lineTerminator)

Parameter	Type	Description
path	string	The full path of the file of which to save.
lineTerminator	LineTerminator	A LineTerminator specifying the output format.

Remarks

The IsModified property is set to false if the specified file path is the same as the FileName property's current value.

public void SaveFile(string path, Encoding encoding, LineTerminator lineTerminator)

Parameter	Type	Description
path	string	The full path of the file of which to save.
encoding	Encoding	The Encoding to use when saving the file.
lineTerminator	LineTerminator	A LineTerminator specifying the output format.

Remarks

The IsModified property is set to false if the specified file path is the same as the FileName property's current value.

public bool SetHeaderAndFooterText(string headerText, string footerText)

Parameter	Type	Description
headerText	string	The new header text value.
footerText	string	The new footer text value.

Returns

bool:

true if a text change was allowed to occur; otherwise, false.

public bool SetText(ITextChangeType type, string text)

Parameter	Type	Description
type	ITextChangeType	An ITextChangeType specifying the type of change.
text	string	The text to insert. Pass an empty string to "clear" the snapshot text.

Returns

bool:

true if a text change was allowed to occur; otherwise, false.

Remarks

This method creates an ITextChange for the current snapshot, adds a set text operation, and immediately applies it. If you will be executing multiple text change operations in a row, for improved performance it is recommended that you call the CreateTextChange(ITextChangeType) method instead, add operations to the returned ITextChange, and then apply the text change.

See Also

• AppendText(ITextChangeType, string)
• DeleteText(ITextChangeType, int, int)
• InsertText(ITextChangeType, int, string)
• ReplaceText(ITextChangeType, int, int, string)

public bool SetText(ITextChangeType type, string text, ITextChangeOptions options)

Parameter	Type	Description
type	ITextChangeType	An ITextChangeType specifying the type of change.
text	string	The text to insert. Pass an empty string to "clear" the snapshot text.
options	ITextChangeOptions	The ITextChangeOptions for the change.

Returns

bool:

true if a text change was allowed to occur; otherwise, false.

Remarks

This method creates an ITextChange for the current snapshot, adds a set text operation, and immediately applies it. If you will be executing multiple text change operations in a row, for improved performance it is recommended that you call the CreateTextChange(ITextChangeType, ITextChangeOptions) method instead, add operations to the returned ITextChange, and then apply the text change.

See Also

• AppendText(ITextChangeType, string, ITextChangeOptions)
• DeleteText(ITextChangeType, int, int, ITextChangeOptions)
• InsertText(ITextChangeType, int, string, ITextChangeOptions)
• ReplaceText(ITextChangeType, int, int, string, ITextChangeOptions)

public bool SetText(string text)

Parameter	Type	Description
text	string	The text to insert. Pass an empty string to "clear" the snapshot text.

Returns

bool:

true if a text change was allowed to occur; otherwise, false.

Remarks

A programmatic text replacement means that the undo history will be cleared, and any attached editors will reset the caret to offset 0.

This method creates an ITextChange for the current snapshot, adds a set text operation, and immediately applies it. If you will be executing multiple text change operations in a row, for improved performance it is recommended that you call the CreateTextChange(ITextChangeType) method instead, add operations to the returned ITextChange, and then apply the text change.

See Also

• SetText(ITextChangeType, string)
• SetText(ITextChangeType, string, ITextChangeOptions)

public event EventHandler<StringPropertyChangedEventArgs> FileNameChanged

Event Type

EventHandler<StringPropertyChangedEventArgs>

public event EventHandler IsModifiedChanged

Event Type

EventHandler

public event EventHandler IsReadOnlyChanged

Event Type

EventHandler

public event PropertyChangedEventHandler PropertyChanged

Event Type

PropertyChangedEventHandler

public event EventHandler TabSizeChanged

Event Type

EventHandler

public event EventHandler<TextSnapshotChangedEventArgs> TextChanged

Event Type

EventHandler<TextSnapshotChangedEventArgs>

public event EventHandler<TextSnapshotChangingEventArgs> TextChanging

Event Type

EventHandler<TextSnapshotChangingEventArgs>