Interface DocumentFormattingEditProvider

The document formatting provider interface defines the contract between extensions and the formatting-feature.

Hierarchy

DocumentFormattingEditProvider

Index

Properties

displayName?

Methods

provideDocumentFormattingEdits

Properties

`Optional` `Readonly` displayName

displayName?: string

Methods

provideDocumentFormattingEdits

provideDocumentFormattingEdits(model: ITextModel, options: FormattingOptions, token: CancellationToken): ProviderResult<TextEdit[]>
Provide formatting edits for a whole document.
Parameters
- model: ITextModel
- options: FormattingOptions
- token: CancellationToken
Returns ProviderResult<TextEdit[]>
- Defined in editor.api.d.ts:7605

Interface DocumentFormattingEditProvider

Hierarchy

Index

Properties

Methods

Properties

`Optional` `Readonly` displayName

Methods

provideDocumentFormattingEdits

Parameters

model: ITextModel

options: FormattingOptions

token: CancellationToken

Returns ProviderResult<TextEdit[]>

Settings

Member Visibility

Theme

Interface DocumentFormattingEditProvider

Hierarchy

Index

Properties

Methods

Properties

Optional Readonly displayName

Methods

provideDocumentFormattingEdits

Parameters

model: ITextModel

options: FormattingOptions

token: CancellationToken

Returns ProviderResult<TextEdit[]>

Settings

Member Visibility

Theme

`Optional` `Readonly` displayName