Interface DocumentRangeFormattingEditProvider

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

interface DocumentRangeFormattingEditProvider {
    displayName?: string;
    provideDocumentRangeFormattingEdits(
        model: ITextModel,
        range: Range,
        options: FormattingOptions,
        token: CancellationToken,
    ): ProviderResult<src/components/monaco/bin/monaco.languages.TextEdit[]>;
    provideDocumentRangesFormattingEdits?(
        model: ITextModel,
        ranges: Range[],
        options: FormattingOptions,
        token: CancellationToken,
    ): ProviderResult<src/components/monaco/bin/monaco.languages.TextEdit[]>;
}

Index

Properties

Methods

provideDocumentRangeFormattingEdits provideDocumentRangesFormattingEdits?

Properties

`Optional` `Readonly`displayName

displayName?: string

Methods

provideDocumentRangeFormattingEdits

provideDocumentRangeFormattingEdits(
    model: ITextModel,
    range: Range,
    options: FormattingOptions,
    token: CancellationToken,
): ProviderResult<src/components/monaco/bin/monaco.languages.TextEdit[]>
Provide formatting edits for a range in a document.

The given range is a hint and providers can decide to format a smaller or larger range. Often this is done by adjusting the start and end of the range to full syntax nodes.
Parameters
- model: ITextModel
- range: Range
- options: FormattingOptions
- token: CancellationToken
Returns ProviderResult<src/components/monaco/bin/monaco.languages.TextEdit[]>
- Defined in src/components/monaco/bin/monaco.d.ts:8125

`Optional`provideDocumentRangesFormattingEdits

provideDocumentRangesFormattingEdits?(
    model: ITextModel,
    ranges: Range[],
    options: FormattingOptions,
    token: CancellationToken,
): ProviderResult<src/components/monaco/bin/monaco.languages.TextEdit[]>
Parameters
- model: ITextModel
- ranges: Range[]
- options: FormattingOptions
- token: CancellationToken
Returns ProviderResult<src/components/monaco/bin/monaco.languages.TextEdit[]>
- Defined in src/components/monaco/bin/monaco.d.ts:8126