Formatter Class

Definition

Namespace:

Microsoft.CodeAnalysis.Formatting

Assembly:

Microsoft.CodeAnalysis.Workspaces.dll

Package:

Microsoft.CodeAnalysis.Workspaces.Common v4.9.2

Source:

Formatter.cs

Formats whitespace in documents or syntax trees.

public ref class Formatter abstract sealed

public static class Formatter

type Formatter = class

Public Class Formatter

Inheritance

Object

Formatter

Properties

Annotation

The annotation used to mark portions of a syntax tree to be formatted.

Methods

Format(SyntaxNode, IEnumerable<TextSpan>, Workspace, OptionSet, CancellationToken)	Formats the whitespace in areas of a syntax tree identified by multiple non-overlapping spans.
Format(SyntaxNode, SyntaxAnnotation, Workspace, OptionSet, CancellationToken)	Formats the whitespace in areas of a syntax tree corresponding to annotated nodes.
Format(SyntaxNode, TextSpan, Workspace, OptionSet, CancellationToken)	Formats the whitespace in areas of a syntax tree identified by a span.
Format(SyntaxNode, Workspace, OptionSet, CancellationToken)	Formats the whitespace of a syntax tree.
FormatAsync(Document, IEnumerable<TextSpan>, OptionSet, CancellationToken)	Formats the whitespace in areas of a document corresponding to multiple non-overlapping spans.
FormatAsync(Document, OptionSet, CancellationToken)	Formats the whitespace in a document.
FormatAsync(Document, SyntaxAnnotation, OptionSet, CancellationToken)	Formats the whitespace in areas of a document corresponding to annotated nodes.
FormatAsync(Document, TextSpan, OptionSet, CancellationToken)	Formats the whitespace in an area of a document corresponding to a text span.
GetFormattedTextChanges(SyntaxNode, IEnumerable<TextSpan>, Workspace, OptionSet, CancellationToken)	Determines the changes necessary to format the whitespace of a syntax tree.
GetFormattedTextChanges(SyntaxNode, TextSpan, Workspace, OptionSet, CancellationToken)	Determines the changes necessary to format the whitespace of a syntax tree.
GetFormattedTextChanges(SyntaxNode, Workspace, OptionSet, CancellationToken)	Determines the changes necessary to format the whitespace of a syntax tree.
OrganizeImportsAsync(Document, CancellationToken)	Organizes the imports in the document.