Back to Devexpress

IAIDocProcessingService.ProofreadAsync(DocumentRange, CultureInfo, CancellationToken) Method

officefileapi-devexpress-dot-aiintegration-dot-docs-dot-iaidocprocessingservice-dot-proofreadasync-x28-documentrange-cultureinfo-cancellationtoken-x29.md

latest3.3 KB
Original Source

IAIDocProcessingService.ProofreadAsync(DocumentRange, CultureInfo, CancellationToken) Method

Reviews the text for spelling, grammar, punctuation, and style errors.

Namespace : DevExpress.AIIntegration.Docs

Assembly : DevExpress.AIIntegration.Docs.v25.2.dll

NuGet Package : DevExpress.AIIntegration.Docs

Declaration

csharp
Task ProofreadAsync(
    DocumentRange documentRange,
    CultureInfo culture,
    CancellationToken cancellationToken = default(CancellationToken)
)
vb
Function ProofreadAsync(
    documentRange As DocumentRange,
    culture As CultureInfo,
    cancellationToken As CancellationToken = Nothing
) As Task

Parameters

NameTypeDescription
documentRangeDocumentRange

The document range which text should be reviewed.

| | culture | CultureInfo |

An object that specifies culture settings applied during proofreading.

|

Optional Parameters

NameTypeDefaultDescription
cancellationTokenCancellationTokennull

The token that cancels the task.

|

Returns

TypeDescription
Task

The response that contains AI-generated text.

|

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the ProofreadAsync(DocumentRange, CultureInfo, CancellationToken) method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

office-file-api-ai-implementation/CS/Controllers/ProofreadController.cs#L38

csharp
var pageRange = wordProcessor.Document.CreateRange(fixedRange.Start, fixedRange.Length); // Translate the first page
await docProcessingService.ProofreadAsync(pageRange, cultureInfo);

See Also

IAIDocProcessingService Interface

IAIDocProcessingService Members

DevExpress.AIIntegration.Docs Namespace