SetLanguage

Specifies the languages which will be used to check spelling and grammar (if requested) when processing the contents of the text run.

Inherited from ApiTextPr.SetLanguage.

Syntax

expression.SetLanguage(langId);

expression - A variable that represents an ApiRun class.

Parameters

Name	Required/Optional	Data type	Default	Description
langId	Required	string | null		The possible value for this parameter is a language identifier as defined by RFC 4646/BCP 47. Example: "en-CA". Pass null to remove the language.

Returns

ApiTextPr

Example

Assign a spell-check language to a text run in a document.

// How do I tell the editor which language to use when checking a run of text in a document?

// Target a specific locale for grammar and spelling validation in a document.

let doc = Api.GetDocument();
let paragraph = doc.GetElement(0);
let run = Api.CreateRun();
run.AddText("This is just a sample text. ");
paragraph.AddElement(run);
run = Api.CreateRun();
run.SetLanguage("en-CA");
run.AddText("This is a text run with the text language set to English (Canada).");
paragraph.AddElement(run);