CompilationUnitManager.Formatting Method

Reference

Definition

Namespace:: Microsoft.Quantum.QsCompiler.CompilationBuilder

Assembly:: Microsoft.Quantum.QsCompilationManager.dll

Package:: Microsoft.Quantum.Compiler v0.25.218240

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.

Returns the edits to format the file according to the specified settings.

public Microsoft.VisualStudio.LanguageServer.Protocol.TextEdit[]? Formatting (Microsoft.VisualStudio.LanguageServer.Protocol.TextDocumentIdentifier? textDocument, bool format = true, bool update = true, int timeout = 3000);

member this.Formatting : Microsoft.VisualStudio.LanguageServer.Protocol.TextDocumentIdentifier * bool * bool * int -> Microsoft.VisualStudio.LanguageServer.Protocol.TextEdit[]

Public Function Formatting (textDocument As TextDocumentIdentifier, Optional format As Boolean = true, Optional update As Boolean = true, Optional timeout As Integer = 3000) As TextEdit()

Parameters

textDocument: TextDocumentIdentifier

format: Boolean

update: Boolean

timeout: Int32

Returns

TextEdit[]

Remarks

Returns null if some parameters are unspecified (null), or if the specified file is not listed as source file

Applies to