Formatter.FormatAsync Méthode

Définition

Espace de noms:

Microsoft.CodeAnalysis.Formatting

Assembly:

Microsoft.CodeAnalysis.Workspaces.dll

Paquet:

Microsoft.CodeAnalysis.Workspaces.Common v4.13.0

Surcharges

FormatAsync(Document, OptionSet, CancellationToken)	Met en forme l’espace blanc dans un document.
FormatAsync(Document, SyntaxAnnotation, OptionSet, CancellationToken)	Met en forme l’espace blanc dans les zones d’un document correspondant aux nœuds annotés.
FormatAsync(Document, TextSpan, OptionSet, CancellationToken)	Met en forme l’espace blanc dans une zone d’un document correspondant à une étendue de texte.
FormatAsync(Document, IEnumerable<TextSpan>, OptionSet, CancellationToken)	Met en forme l’espace blanc dans les zones d’un document correspondant à plusieurs étendues qui ne se chevauchent pas.

FormatAsync(Document, OptionSet, CancellationToken)

Source:

Formatter.cs

Met en forme l’espace blanc dans un document.

public static System.Threading.Tasks.Task<Microsoft.CodeAnalysis.Document> FormatAsync(Microsoft.CodeAnalysis.Document document, Microsoft.CodeAnalysis.Options.OptionSet? options = default, System.Threading.CancellationToken cancellationToken = default);

static member FormatAsync : Microsoft.CodeAnalysis.Document * Microsoft.CodeAnalysis.Options.OptionSet * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.CodeAnalysis.Document>

Public Shared Function FormatAsync (document As Document, Optional options As OptionSet = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Document)

Paramètres

document

Document

Document à mettre en forme.

options

OptionSet

Ensemble facultatif d’options de mise en forme. Si ces options ne sont pas fournies l’ensemble actuel d’options de l’espace de travail du document sera utilisé.

cancellationToken

CancellationToken

Jeton d’annulation facultatif.

Retours

Task<Document>

Document mis en forme.

FormatAsync(Document, SyntaxAnnotation, OptionSet, CancellationToken)

Source:

Formatter.cs

Met en forme l’espace blanc dans les zones d’un document correspondant aux nœuds annotés.

public static System.Threading.Tasks.Task<Microsoft.CodeAnalysis.Document> FormatAsync(Microsoft.CodeAnalysis.Document document, Microsoft.CodeAnalysis.SyntaxAnnotation annotation, Microsoft.CodeAnalysis.Options.OptionSet? options = default, System.Threading.CancellationToken cancellationToken = default);

static member FormatAsync : Microsoft.CodeAnalysis.Document * Microsoft.CodeAnalysis.SyntaxAnnotation * Microsoft.CodeAnalysis.Options.OptionSet * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.CodeAnalysis.Document>

Public Shared Function FormatAsync (document As Document, annotation As SyntaxAnnotation, Optional options As OptionSet = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Document)

Paramètres

document

Document

Document à mettre en forme.

annotation

SyntaxAnnotation

Annotation utilisée pour rechercher sur les nœuds pour identifier les étendues à mettre en forme.

options

OptionSet

Ensemble facultatif d’options de mise en forme. Si ces options ne sont pas fournies l’ensemble actuel d’options de l’espace de travail du document sera utilisé.

cancellationToken

CancellationToken

Jeton d’annulation facultatif.

Retours

Task<Document>

Document mis en forme.

FormatAsync(Document, TextSpan, OptionSet, CancellationToken)

Source:

Formatter.cs

Met en forme l’espace blanc dans une zone d’un document correspondant à une étendue de texte.

public static System.Threading.Tasks.Task<Microsoft.CodeAnalysis.Document> FormatAsync(Microsoft.CodeAnalysis.Document document, Microsoft.CodeAnalysis.Text.TextSpan span, Microsoft.CodeAnalysis.Options.OptionSet? options = default, System.Threading.CancellationToken cancellationToken = default);

static member FormatAsync : Microsoft.CodeAnalysis.Document * Microsoft.CodeAnalysis.Text.TextSpan * Microsoft.CodeAnalysis.Options.OptionSet * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.CodeAnalysis.Document>

Public Shared Function FormatAsync (document As Document, span As TextSpan, Optional options As OptionSet = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Document)

Paramètres

document

Document

Document à mettre en forme.

span

TextSpan

Étendue du texte du document à mettre en forme.

options

OptionSet

Ensemble facultatif d’options de mise en forme. Si ces options ne sont pas fournies l’ensemble actuel d’options de l’espace de travail du document sera utilisé.

cancellationToken

CancellationToken

Jeton d’annulation facultatif.

Retours

Task<Document>

Document mis en forme.

FormatAsync(Document, IEnumerable<TextSpan>, OptionSet, CancellationToken)

Source:

Formatter.cs

Met en forme l’espace blanc dans les zones d’un document correspondant à plusieurs étendues qui ne se chevauchent pas.

public static System.Threading.Tasks.Task<Microsoft.CodeAnalysis.Document> FormatAsync(Microsoft.CodeAnalysis.Document document, System.Collections.Generic.IEnumerable<Microsoft.CodeAnalysis.Text.TextSpan>? spans, Microsoft.CodeAnalysis.Options.OptionSet? options = default, System.Threading.CancellationToken cancellationToken = default);

static member FormatAsync : Microsoft.CodeAnalysis.Document * seq<Microsoft.CodeAnalysis.Text.TextSpan> * Microsoft.CodeAnalysis.Options.OptionSet * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.CodeAnalysis.Document>

Public Shared Function FormatAsync (document As Document, spans As IEnumerable(Of TextSpan), Optional options As OptionSet = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Document)

Paramètres

document

Document

Document à mettre en forme.

spans

IEnumerable<TextSpan>

Étendues du texte du document à mettre en forme.

options

OptionSet

Ensemble facultatif d’options de mise en forme. Si ces options ne sont pas fournies l’ensemble actuel d’options de l’espace de travail du document sera utilisé.

cancellationToken

CancellationToken

Jeton d’annulation facultatif.

Retours

Task<Document>

Document mis en forme.