Term Definitions

SyntaxEditor is no small product. It has an enormous object model and feature set. While it's easy to get started using it, it also allows for developers to do some very advanced things.

In this topic, we provide the complete list of categorized terms found in this product. If you ever wonder what a term means, use this topic to find the definition.

Text (General) Terms

Term	Description
Case Sensitivity	Indicates how letter matching is performed when parsing and is represented by the CaseSensitivity enumeration.
Classification Type	A classification type (represented by the IClassificationType interface) is a categorization that can be applied to a range of text via an IClassificationTag tagger.
Classification Type Registry	A classification type registry (represented by the IClassificationTypeRegistry interface) provides a registry of IClassificationType instances.
Code Document	A code document (represented by the ICodeDocument interface) is a text document that also has a syntax language associated with it, providing additional functionality.
Example Text Provider	An example text provider (represented by the IExampleTextProvider interface) is an object that can stores a small code snippet showing many of the constructs for a specific language.
Line Commenter	A line commenter (represented by the ILineCommenter interface) is an object that has logic to comment out and uncomment lines of code using comment delimiters for a specific language.
Line Terminator	Indicates the character or characters used to end a line and is represented by the LineTerminator enumeration.
Normalized Text Snapshot Range Collection	A normalized text snapshot range collection (represented by the NormalizedTextSnapshotRangeCollection class) is a collection that ensures all contained ranges are for the same snapshot and are guaranteed to be sorted and non-overlapping.
Offset	An offset is a zero-based integer index that refers to the location of a character within text.
Syntax Language	A syntax language (represented by the ISyntaxLanguage interface) is an object that provides access to services and functionality related to the parsing of a code language, such as C#, VB, HTML, etc.
Text Buffer Reader	A text buffer reader (represented by the ITextBufferReader interface) allows you to do very low-level fast scanning over some sort of text source, such as a string or text snapshot.
Text Change	A text change (represented by the ITextChange interface) is a single transaction that modifies a document and creates a new text snapshot. It consists of one or more operations.
Text Change Operation	A text change operation (represented by the ITextChangeOperation interface) is a single atomic replace operation that is performed within a text change. It may replace text, delete text, or insert text.
Text Change Options	Text change options (represented by the ITextChangeOptions interface) provide configurable options to a text change.
Text Change Type	A text change type (represented by the ITextChangeType interface) represents the type of text change, such as `Typing`, `Paste`, etc. Custom types can be created.
Text Document	A text document (represented by the ITextDocument interface) represents a textual document. It always keeps a reference to its current text snapshot. Use the current snapshot to examine the contents of the document.
Text Formatter	A text formatter (represented by the ITextFormatter interface) is an object that has logic to adjust spacing and line terminators around the code for a specific language to beautify it.
Text Offset Tracking Mode	Text offset tracking modes (represented by the TextOffsetTrackingMode enumeration) indicate how an offset should be translated from one text snapshot to another.
Text Position	A text position (represented by the TextPosition structure) provides line and character information about a point in text.
Text Position Range	A text position range (represented by the TextPositionRange structure) represents a range of text positions, with a start and end value.
Text Range	A text range (represented by the TextRange structure) represents a range of offsets, with a start and end value.
Text Range Tracking Mode	Text range tracking modes (represented by the TextRangeTrackingModes enumeration) indicate how a text range should be translated from one text snapshot to another.
Text Snapshot	A text snapshot (represented by the ITextSnapshot interface) is an immutable copy of a document at a certain time. It can be scanned and parsed without the possibility of change via user edits. All reading of a document is done on a snapshot of the document. The ITextDocument.CurrentSnapshot property always provides the most recent snapshot.
Text Snapshot Line	A text snapshot line (represented by the ITextSnapshotLine interface) represents a text line within a snapshot.
Text Snapshot Offset	A text snapshot offset (represented by the TextSnapshotOffset structure) points to a specific offset within a snapshot. It can be easily translated to other snapshots.
Text Snapshot Range	A text snapshot range (represented by the TextSnapshotRange structure) points to a specific text range within a snapshot. It can be easily translated to other snapshots.
Text Snapshot Reader	A text snapshot reader (represented by the ITextSnapshotReader interface) is used to scan through a specific snapshot and has many useful methods for navigating by token, word, etc.
Text Snapshot Reader Options	Text snapshot reader options (represented by the ITextSnapshotReaderOptions interface) provides configurable options to a text snapshot reader.
Text Statistics	Text statistics (represented by the ITextStatistics interface) examine text and provide numerous statistics on the text such as number of lines, characters, etc.
Text Version	A text version (represented by the ITextVersion interface) is a numeric version that tracks the sequence of changes made to a document. Each snapshot is related to a certain version.
Text Version Range	A text version range (represented by the ITextVersionRange interface) is an object that internally stores a text range for a certain text version. This version range can be translated to any other version or snapshot to get the related text range in that context.
Word-Break Finder	A word-break finder (represented by the IWordBreakFinder interface) is used to locate word breaks for a particular syntax language.

Text (Exporters) Terms

Term	Description
Text Exporter	A text exporter (represented by the ITextExporter interface) is an object that can export text to other output formats, such as HTML or RTF.

Text (Lexing) Terms

Lexer	A lexer (represented by the ILexer interface) scans text and tokenizes it, meaning that a series of tokens are assigned to text ranges that identifies in detail what the text represents.
Lexical Target	A lexical target (represented by the ILexerTarget interface) is an object that is passed to a lexer and is updated by the lexer during its execution to provide lexing results.
Lexical Scope	A lexical scope (represented by the ILexicalScope interface) defines how a parent lexical state can transition to another child lexical state and back.
Lexical State	A lexical state (represented by the ILexicalState interface) is a context in which certain text can be parsed into a set of tokens.
Lexical State ID Provider	A lexical state ID provider (represented by the ILexicalStateIdProvider interface) is a class that is useful for providing all the lexical state IDs for a language.
Lexical State Transition	A lexical state transition (represented by the ILexicalStateTransition interface) specifies a transition that can occur from one lexical state to another, typically in a separate language (i.e., HTML to CSS).
Mergable Lexer	A mergable lexer (represented by the IMergableLexer interface) is a lexer that supports transitioning into other languages that have mergable lexers.
Mergable Lexical Result	A mergable lexer result (represented by the MergableLexerResult class) provides information for the next token that has been read by a mergable lexer.
Mergable Token	A mergable token (represented by the IMergableToken interface) is a token that is created by a mergable lexer.
Mergable Token Lexer Data	Mergable token lexical parse data (represented by the IMergableTokenLexerData interface) is part of a mergable lexical parse result and gets assigned to mergable tokens.
Token	A token (represented by the IToken interface) is a span of text that has some sort of lexical parse data associated with it.
Token ID Provider	A token ID provider (represented by the ITokenIdProvider interface) is a class that is useful for providing all the token IDs for a language.
Token Set	A token set (represented by the ITokenSet interface) is a group of tokens that are returned by an token tagger.

Text (Parsing) Terms

Term	Description
Ambient Parse Request Dispatcher Provider	An ambient parse request dispatcher provider (represented by the AmbientParseRequestDispatcherProvider class) specifies an object that provides the default IParseRequestDispatcher to use, which allows for multi-threaded parsing.
Parse Data	Parse data (represented by the IParseData interface) specifies the data that is returned by an IParser to a document when parsing is completed.
Parse Error	A parse error (represented by the IParseError interface) specifies an error that was encountered when performing parsing.
Parse Error Level	A parse error level (represented by the ParseErrorLevel enumeration) specifies the severity of a parse error.
Parse Error Provider	A parse error provider (represented by the IParseErrorProvider interface) specifies an object that can return parse errors for a parsing operation. This interface is typically implemented by parse data objects.
Parser	A parser (represented by the IParser interface) specifies an object that can perform syntax and/or semantic parsing.
Parse Request	A parse request (represented by the IParseRequest interface) specifies an object that designates a request for a parsing operation, and can be queued by a parse request dispatcher
Parse Request Dispatcher	A parse request dispatcher (represented by the IParseRequestDispatcher interface) specifies an object that is capable of queuing up parse requests and performing them on worker threads.
Parse Error State	A parse error state (represented by the ParseRequestState enumeration) specifies the current state of a parse request, such as whether it is queued, executing, etc.
Parse Target	A parse target (represented by the IParseTarget interface) specifies an object that is notified with parse data results when a parsing operation completes.

Text (Regular Expressions) Terms

Term	Description
Character Class	A character class (represented by the CharClass class) specifies a set of character ranges.
Character Interval	A character interval (represented by the CharInterval structure) specifies a range of characters.

Text (Searching) Terms

Term	Description
Search Capture	A search capture (represented by the ISearchCapture interface) denotes a single regular expression capture made during a find operation.
Search Options	Search options (represented by the ISearchOptions interface) contains the settings used during find/replace operations, such as the text to find, whether to match case, etc.
Search Pattern Provider	A search pattern provider (represented by the ISearchPatternProvider interface) is an object that converts find/replace pattern syntax to a format that is compatible with the search engine. Built-it search pattern providers include normal, regular expression, wildcard, etc.
Search Result	A search result (represented by the ISearchResult interface) is a single result from a search operation that is included within a result set.
Search Result Set	A search result set (represented by the ISearchResultSet interface) is an object that provides the results of a search operation.
Search Operation Type	Indicates a type of search operation, such as find next or replace all, and is represented by the SearchOperationType enumeration.

Text (Tagging) Terms

Term	Description
Classification Tag	A classification tag (represented by the IClassificationTag interface) is a tag that specifies an IClassificationType, and when used in an editor, tells the editor how to syntax highlight text based on related highlighting styles.
Tag	A tag (represented by the ITag interface) is an object that can store data and be applied over a range of text via a tagger.
Tag Aggregator	A tag aggregator (represented by the ITagAggregator interface) collects tags of a certain type from all the available taggers.
Tag Snapshot Range	A tag snapshot range (represented by the TagSnapshotRange structure) specifies a text snapshot range and an ITag that is applied over the range.
Tag Version Range	A tag version range (represented by the TagVersionRange structure) specifies a text version range and an ITag that is applied over the range.
Tagger	A tagger (represented by the ITagger interface) provides tag snapshot ranges that are within specified snapshot ranges.
Tagger Provider	A tagger provider (represented by the ICodeDocumentTaggerProvider and ITextViewTaggerProvider interfaces) is a language service that can create taggers for documents/views that use the language.
Token Tag	A token tag (represented by the ITokenTag interface) is a tag that specifies an IToken.
Token Tagger	A token tagger (represented by the TokenTagger interface) is a special tagger that provides incremental lexing capabilities to an ILexer.

Text (Undo) Terms

Term	Description
Save Point Change Type	Indicates the save point change type (none, unsaved changes, or saved changes) for a line within the current snapshot of a document, and is represented by the SavePointChangeType enumeration.
Undoable Text Change	An undoable text change (represented by the IUndoableTextChange interface) is used to track information for an ITextChange that has been placed into the undo history.
Undoable Text Change Stack	An undoable text change stack (represented by the IUndoableTextChangeStack interface) is a stack that stores IUndoableTextChange entries for either the undo or redo stacks.
Undo History	An undo history (represented by the IUndoHistory interface) provides access to all the undo/redo functionality for an ITextDocument.

In This Article