ITextDocument Interface

public interface ITextDocument

CharacterCasing AutoCharacterCasing { get; set; }

Property Value

CharacterCasing:

A CharacterCasing indicating the desired case of inserted text.

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.

ITextSnapshot CurrentSnapshot { get; }

Property Value

ITextSnapshot

string? FileName { get; set; }

Property Value

string

Remarks

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

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, Encoding?, LineTerminator?) overload is used that accepts a path matching the current FileName property value.

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.

int TabSize { get; set; }

Property Value

int:

The default value is 4 spaces.

IUndoHistory UndoHistory { get; }

Property Value

IUndoHistory

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

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

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

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

bool AppendText(ITextChangeType type, string text, ITextChangeOptions? options = null)

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 optional 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?)

ITextChange CreateTextChange(ITextChangeType type, ITextChangeOptions? options = null)

Parameter	Type	Description
type	ITextChangeType	An ITextChangeType specifying the type of change.
options	ITextChangeOptions	The optional 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.

bool DeleteText(ITextChangeType type, TextRange textRange, ITextChangeOptions? options = null)

Parameter	Type	Description
type	ITextChangeType	An ITextChangeType specifying the type of change.
textRange	TextRange	The TextRange of offsets to delete.
options	ITextChangeOptions	The optional 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?)

bool DeleteText(ITextChangeType type, int offset, int length, ITextChangeOptions? options = null)

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 optional 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?)

bool InsertText(ITextChangeType type, int offset, string text, ITextChangeOptions? options = null)

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 optional 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?)

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.

void 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.

void LoadFile(string path, Encoding? encoding = null)

Parameter	Type	Description
path	string	The full path of the file from which to load.
encoding	Encoding	The optional Encoding to use when loading the file, falling back to a default UTF-8 character encoding when not specified.

Remarks

This method updates the value of the FileName property.

void NormalizeLineTerminators(LineTerminator targetLineTerminator, ITextChangeOptions? options = null)

Parameter	Type	Description
targetLineTerminator	LineTerminator	The LineTerminator to use for normalization.
options	ITextChangeOptions	The optional ITextChangeOptions for the change.

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

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

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

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

ISearchResultSet ReplaceAll(ISearchOptions options)

Parameter	Type	Description
options	ISearchOptions	The ISearchOptions to use.

Returns

ISearchResultSet:

An ISearchResultSet that specifies the result of the operation.

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.

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.

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.

bool ReplaceText(ITextChangeType type, TextRange textRange, string text, ITextChangeOptions? options = null)

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 optional 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?)

bool ReplaceText(ITextChangeType type, int offset, int length, string text, ITextChangeOptions? options = null)

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 optional 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?)

void SaveFile(Stream stream, Encoding encoding, LineTerminator? lineTerminator = null)

Parameter	Type	Description
stream	Stream	The Stream to write to.
encoding	Encoding	The Encoding to use when loading the file.
lineTerminator	LineTerminator?	An optional LineTerminator specified when line ends should be normalized to a certain line terminator in the stream. Use a null value to preserve existing line terminators in the stream.

void SaveFile(string path, Encoding? encoding = null, LineTerminator? lineTerminator = null)

Parameter	Type	Description
path	string	The full path of the file of which to save.
encoding	Encoding	The optional Encoding to use when saving the file, falling back to a default UTF-8 character encoding when not specified.
lineTerminator	LineTerminator?	An optional LineTerminator specified when line ends should be normalized to a certain line terminator in the saved file. Use a null value to preserve existing line terminators in the saved file.

Remarks

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

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.

bool SetText(ITextChangeType type, string? text, ITextChangeOptions? options = null)

Parameter	Type	Description
type	ITextChangeType	An ITextChangeType specifying the type of change.
text	string	The text to insert. Pass null or an empty string to "clear" the snapshot text.
options	ITextChangeOptions	The optional 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?)

bool SetText(string? text)

Parameter	Type	Description
text	string	The text to insert. Pass null or 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, ITextChangeOptions?) method instead, add operations to the returned ITextChange, and then apply the text change.

See Also

• SetText(ITextChangeType, string?, ITextChangeOptions?)

event EventHandler<StringPropertyChangedEventArgs> FileNameChanged

Event Type

EventHandler<StringPropertyChangedEventArgs>

event EventHandler IsModifiedChanged

Event Type

EventHandler

event EventHandler IsReadOnlyChanged

Event Type

EventHandler

event EventHandler TabSizeChanged

Event Type

EventHandler

event EventHandler<TextSnapshotChangedEventArgs> TextChanged

Event Type

EventHandler<TextSnapshotChangedEventArgs>

event EventHandler<TextSnapshotChangingEventArgs> TextChanging

Event Type

EventHandler<TextSnapshotChangingEventArgs>