IOutliningManager Interface
Provides outlining functionality.
Namespace: Microsoft.VisualStudio.Text.Outlining
Assembly: Microsoft.VisualStudio.Text.UI (in Microsoft.VisualStudio.Text.UI.dll)
Syntax
'Declaration
Public Interface IOutliningManager _
Inherits IDisposable
public interface IOutliningManager : IDisposable
public interface class IOutliningManager : IDisposable
type IOutliningManager =
interface
interface IDisposable
end
public interface IOutliningManager extends IDisposable
The IOutliningManager type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
Enabled | Determines whether outlining is enabled. |
Top
Methods
| Name | Description | |
|---|---|---|
.gif "Public method") |
CollapseAll | Collapses all the regions in the specified span that match the specified predicate. |
|
Dispose | Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from IDisposable.) |
|
Expand | Expands the collapsible span. |
|
ExpandAll | Expands all the regions in the specified span 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(SnapshotSpan) | Gets all the regions that intersect the given span, 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, 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(SnapshotSpan) | Gets all the collapsed regions that intersect the given span. |
|
GetCollapsedRegions(NormalizedSnapshotSpanCollection, Boolean) | Gets all the collapsed regions that intersect the given collection of spans. |
|
GetCollapsedRegions(SnapshotSpan, Boolean) | Gets all the collapsed regions that intersect the given span. |
|
TryCollapse | Tries to collapse a given region. |
Top
Events
| Name | Description | |
|---|---|---|
.gif "Public event") |
OutliningEnabledChanged | Occurs when outlining has been enabled or disabled. |
|
RegionsChanged | Occurs when there are changes in the set of ICollapsible regions on the corresponding elision buffer. |
|
RegionsCollapsed | Occurs when an ICollapsible region is collapsed. |
|
RegionsExpanded | Occurs when an ICollapsed region is expanded. |
Top
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. This outlining manager is provided by the IOutliningManagerService.