Outliner

An outliner returns a language-specific outlining source for a particular ITextSnapshot when requested by an outlining manager. Having an outliner service registered on a language is what tells SyntaxEditor that the language supports automatic outlining.

Basic Concepts

Outliners are classes implementing IOutliner that provide outlining manager with IOutliningSource objects upon request. Each outliner designated whether the automatic outlining should be performed in the main UI thread when any text change occurs, or if it should be performed in response to a parse data update.

See the Outlining Sources and Outliners topic for details on how to create and work with outlining sources and outliners.

When an outliner is associated with a syntax language, SyntaxEditor knows that the language supports automatic outlining.

Registering with a Language

Any object that implements IOutliner can be associated with a syntax language by registering it as an IOutliner service on the language.

This code creates an outliner for a TokenOutliningSourceBase-based outlining source named JavascriptOutliningSource, and registers it with the syntax language that is already declared in the language variable:

TokenOutliner<JavascriptOutliningSource> source = new TokenOutliner<JavascriptOutliningSource>();
language.RegisterOutliner(source);