-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update file(s) "/." from "aspose-words/Aspose.Words-API-References"
- Loading branch information
Showing
1,087 changed files
with
5,816 additions
and
1,470 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
54 changes: 54 additions & 0 deletions
54
...nt/sites/aspose/words/english/net/aspose.words.ai/checkgrammaroptions/_index.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
| --- | ||
| title: CheckGrammarOptions Class | ||
| linktitle: CheckGrammarOptions | ||
| articleTitle: CheckGrammarOptions | ||
| second_title: Aspose.Words for .NET | ||
| description: Aspose.Words.AI.CheckGrammarOptions class. Allows to specify various options while checking grammar of a document using AI in C#. | ||
| type: docs | ||
| weight: 40 | ||
| url: /net/aspose.words.ai/checkgrammaroptions/ | ||
| --- | ||
| ## CheckGrammarOptions class | ||
|
|
||
| Allows to specify various options while checking grammar of a document using AI. | ||
|
|
||
| ```csharp | ||
| public class CheckGrammarOptions | ||
| ``` | ||
|
|
||
| ## Constructors | ||
|
|
||
| | Name | Description | | ||
| | --- | --- | | ||
| | [CheckGrammarOptions](checkgrammaroptions/)() | The default constructor. | | ||
|
|
||
| ## Properties | ||
|
|
||
| | Name | Description | | ||
| | --- | --- | | ||
| | [ImproveStylistics](../../aspose.words.ai/checkgrammaroptions/improvestylistics/) { get; set; } | Allows to specify either AI will try to improve stylistics of the text being proofed. Default value is `false`. | | ||
| | [MakeRevisions](../../aspose.words.ai/checkgrammaroptions/makerevisions/) { get; set; } | Allows to specify either final or revised document to be returned with proofed text. Default value is `false`. | | ||
| | [PreserveFormatting](../../aspose.words.ai/checkgrammaroptions/preserveformatting/) { get; set; } | Allows to specify either [`CheckGrammar`](../iaimodeltext/checkgrammar/) will try to preserve layout and formatting of the original document, or not. Default value is `true`. | | ||
|
|
||
| ## Examples | ||
|
|
||
| Shows how to check the grammar of a document. | ||
|
|
||
| ```csharp | ||
| Document doc = new Document(MyDir + "Big document.docx"); | ||
|
|
||
| string apiKey = Environment.GetEnvironmentVariable("API_KEY"); | ||
| // Use OpenAI generative language models. | ||
| IAiModelText model = (IAiModelText)AiModel.Create(AiModelType.Gpt4OMini).WithApiKey(apiKey); | ||
|
|
||
| CheckGrammarOptions grammarOptions = new CheckGrammarOptions(); | ||
| grammarOptions.ImproveStylistics = true; | ||
|
|
||
| Document proofedDoc = model.CheckGrammar(doc, grammarOptions); | ||
| proofedDoc.Save("AI.AiGrammar.docx"); | ||
| ``` | ||
|
|
||
| ### See Also | ||
|
|
||
| * namespace [Aspose.Words.AI](../../aspose.words.ai/) | ||
| * assembly [Aspose.Words](../../) |
23 changes: 23 additions & 0 deletions
23
...s/english/net/aspose.words.ai/checkgrammaroptions/checkgrammaroptions/_index.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| --- | ||
| title: CheckGrammarOptions | ||
| linktitle: CheckGrammarOptions | ||
| articleTitle: CheckGrammarOptions | ||
| second_title: Aspose.Words for .NET | ||
| description: CheckGrammarOptions constructor. The default constructor in C#. | ||
| type: docs | ||
| weight: 10 | ||
| url: /net/aspose.words.ai/checkgrammaroptions/checkgrammaroptions/ | ||
| --- | ||
| ## CheckGrammarOptions constructor | ||
|
|
||
| The default constructor. | ||
|
|
||
| ```csharp | ||
| public CheckGrammarOptions() | ||
| ``` | ||
|
|
||
| ### See Also | ||
|
|
||
| * class [CheckGrammarOptions](../) | ||
| * namespace [Aspose.Words.AI](../../../aspose.words.ai/) | ||
| * assembly [Aspose.Words](../../../) |
23 changes: 23 additions & 0 deletions
23
...rds/english/net/aspose.words.ai/checkgrammaroptions/improvestylistics/_index.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| --- | ||
| title: CheckGrammarOptions.ImproveStylistics | ||
| linktitle: ImproveStylistics | ||
| articleTitle: ImproveStylistics | ||
| second_title: Aspose.Words for .NET | ||
| description: CheckGrammarOptions ImproveStylistics property. Allows to specify either AI will try to improve stylistics of the text being proofed. Default value is false in C#. | ||
| type: docs | ||
| weight: 20 | ||
| url: /net/aspose.words.ai/checkgrammaroptions/improvestylistics/ | ||
| --- | ||
| ## CheckGrammarOptions.ImproveStylistics property | ||
|
|
||
| Allows to specify either AI will try to improve stylistics of the text being proofed. Default value is `false`. | ||
|
|
||
| ```csharp | ||
| public bool ImproveStylistics { get; set; } | ||
| ``` | ||
|
|
||
| ### See Also | ||
|
|
||
| * class [CheckGrammarOptions](../) | ||
| * namespace [Aspose.Words.AI](../../../aspose.words.ai/) | ||
| * assembly [Aspose.Words](../../../) |
23 changes: 23 additions & 0 deletions
23
...e/words/english/net/aspose.words.ai/checkgrammaroptions/makerevisions/_index.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| --- | ||
| title: CheckGrammarOptions.MakeRevisions | ||
| linktitle: MakeRevisions | ||
| articleTitle: MakeRevisions | ||
| second_title: Aspose.Words for .NET | ||
| description: CheckGrammarOptions MakeRevisions property. Allows to specify either final or revised document to be returned with proofed text. Default value is false in C#. | ||
| type: docs | ||
| weight: 30 | ||
| url: /net/aspose.words.ai/checkgrammaroptions/makerevisions/ | ||
| --- | ||
| ## CheckGrammarOptions.MakeRevisions property | ||
|
|
||
| Allows to specify either final or revised document to be returned with proofed text. Default value is `false`. | ||
|
|
||
| ```csharp | ||
| public bool MakeRevisions { get; set; } | ||
| ``` | ||
|
|
||
| ### See Also | ||
|
|
||
| * class [CheckGrammarOptions](../) | ||
| * namespace [Aspose.Words.AI](../../../aspose.words.ai/) | ||
| * assembly [Aspose.Words](../../../) |
27 changes: 27 additions & 0 deletions
27
...ds/english/net/aspose.words.ai/checkgrammaroptions/preserveformatting/_index.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| --- | ||
| title: CheckGrammarOptions.PreserveFormatting | ||
| linktitle: PreserveFormatting | ||
| articleTitle: PreserveFormatting | ||
| second_title: Aspose.Words for .NET | ||
| description: CheckGrammarOptions PreserveFormatting property. Allows to specify either CheckGrammar will try to preserve layout and formatting of the original document or not. Default value is true in C#. | ||
| type: docs | ||
| weight: 40 | ||
| url: /net/aspose.words.ai/checkgrammaroptions/preserveformatting/ | ||
| --- | ||
| ## CheckGrammarOptions.PreserveFormatting property | ||
|
|
||
| Allows to specify either [`CheckGrammar`](../../iaimodeltext/checkgrammar/) will try to preserve layout and formatting of the original document, or not. Default value is `true`. | ||
|
|
||
| ```csharp | ||
| public bool PreserveFormatting { get; set; } | ||
| ``` | ||
|
|
||
| ## Remarks | ||
|
|
||
| When the option is set to `false`, the quality of grammar checking is higher than when this option is set to `true`. However, the original formatting of the text is not preserved in this case. | ||
|
|
||
| ### See Also | ||
|
|
||
| * class [CheckGrammarOptions](../) | ||
| * namespace [Aspose.Words.AI](../../../aspose.words.ai/) | ||
| * assembly [Aspose.Words](../../../) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
52 changes: 52 additions & 0 deletions
52
...es/aspose/words/english/net/aspose.words.ai/iaimodeltext/checkgrammar/_index.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| --- | ||
| title: IAiModelText.CheckGrammar | ||
| linktitle: CheckGrammar | ||
| articleTitle: CheckGrammar | ||
| second_title: Aspose.Words for .NET | ||
| description: IAiModelText CheckGrammar method. Checks grammar of the provided document. This operation leverages the connected AI model for checking grammar of document in C#. | ||
| type: docs | ||
| weight: 10 | ||
| url: /net/aspose.words.ai/iaimodeltext/checkgrammar/ | ||
| --- | ||
| ## IAiModelText.CheckGrammar method | ||
|
|
||
| Checks grammar of the provided document. This operation leverages the connected AI model for checking grammar of document. | ||
|
|
||
| ```csharp | ||
| public Document CheckGrammar(Document sourceDocument, CheckGrammarOptions options = null) | ||
| ``` | ||
|
|
||
| | Parameter | Type | Description | | ||
| | --- | --- | --- | | ||
| | sourceDocument | Document | The document being checked for grammar. | | ||
| | options | CheckGrammarOptions | Optional settings to control how grammar will be checked. | | ||
|
|
||
| ### Return Value | ||
|
|
||
| A new [`Document`](../../../aspose.words/document/) with checked grammar. | ||
|
|
||
| ## Examples | ||
|
|
||
| Shows how to check the grammar of a document. | ||
|
|
||
| ```csharp | ||
| Document doc = new Document(MyDir + "Big document.docx"); | ||
|
|
||
| string apiKey = Environment.GetEnvironmentVariable("API_KEY"); | ||
| // Use OpenAI generative language models. | ||
| IAiModelText model = (IAiModelText)AiModel.Create(AiModelType.Gpt4OMini).WithApiKey(apiKey); | ||
|
|
||
| CheckGrammarOptions grammarOptions = new CheckGrammarOptions(); | ||
| grammarOptions.ImproveStylistics = true; | ||
|
|
||
| Document proofedDoc = model.CheckGrammar(doc, grammarOptions); | ||
| proofedDoc.Save("AI.AiGrammar.docx"); | ||
| ``` | ||
|
|
||
| ### See Also | ||
|
|
||
| * class [Document](../../../aspose.words/document/) | ||
| * class [CheckGrammarOptions](../../checkgrammaroptions/) | ||
| * interface [IAiModelText](../) | ||
| * namespace [Aspose.Words.AI](../../../aspose.words.ai/) | ||
| * assembly [Aspose.Words](../../../) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.