IOutliningManager Interface

Reference

Definition

Namespace:: Microsoft.VisualStudio.Text.Outlining

Assembly:: Microsoft.VisualStudio.Text.UI.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Provides outlining functionality.

public interface class IOutliningManager : IDisposable

public interface IOutliningManager : IDisposable

type IOutliningManager = interface
    interface IDisposable

Public Interface IOutliningManager
Implements IDisposable

Implements: IDisposable

Remarks

Any methods that take SnapshotSpan objects are spans of the edit buffer in the view model of a view. This buffer can also be retrieved from the TextBuffer property of an ITextView.

This outlining manager is provided by IOutliningManagerService.

Properties

Enabled

Determines whether outlining is enabled.

Methods

CollapseAll(SnapshotSpan, Predicate<ICollapsible>)	Collapses all regions that match the specified predicate.
Expand(ICollapsed)	Expands the collapsible span.
ExpandAll(SnapshotSpan, Predicate<ICollapsed>)	Expands all the regions that match the specified predicate.
GetAllRegions(NormalizedSnapshotSpanCollection)	Gets all the regions that intersect the given collection of spans, whether or not they are collapsed.
GetAllRegions(NormalizedSnapshotSpanCollection, Boolean)	Gets all the regions that intersect the given collection of spans, whether or not they are collapsed.
GetAllRegions(SnapshotSpan)	Gets all the regions that intersect the given span, whether or not they are collapsed.
GetAllRegions(SnapshotSpan, Boolean)	Gets all the regions that intersect the given span, whether or not they are collapsed.
GetCollapsedRegions(NormalizedSnapshotSpanCollection)	Gets all the collapsed regions that intersect the given collection of spans.
GetCollapsedRegions(NormalizedSnapshotSpanCollection, Boolean)	Gets all the collapsed regions that intersect the given collection of spans.
GetCollapsedRegions(SnapshotSpan)	Gets all the collapsed regions that intersect the given span.
GetCollapsedRegions(SnapshotSpan, Boolean)	Gets all the collapsed regions that intersect the given span.
TryCollapse(ICollapsible)	Tries to collapse a given region.

Events

OutliningEnabledChanged	Occurs when outlining has been enabled or disabled.
RegionsChanged	Occurs when the set of ICollapsible regions on the corresponding elision buffer changes.
RegionsCollapsed	Occurs when an ICollapsible region is collapsed.
RegionsExpanded	Occurs when an ICollapsed region is expanded.

Applies to