Skip to main content

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(sLangId);

expression - A variable that represents an ApiRangeTextPr class.

Parameters​

NameRequired/OptionalData typeDefaultDescription
sLangIdRequiredstringThe possible value for this parameter is a language identifier as defined by RFC 4646/BCP 47. Example: "en-CA".

Returns​

ApiTextPr

Example​

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

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

// Ensure correct spelling and grammar rules by setting the text language in a document.

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