isPhoneticGuide property

Run.isPhoneticGuide property

Gets a boolean value indicating either the run is a phonetic guide.

get isPhoneticGuide(): boolean

Examples

Shows how to get properties of the phonetic guide.

let doc = new aw.Document(base.myDir + "Phonetic guide.docx");

let runs = doc.firstSection.body.firstParagraph.runs;
// Use phonetic guide in the Asian text.
expect(runs.at(0).isPhoneticGuide).toEqual(true);
expect(runs.at(0).phoneticGuide.baseText).toEqual("base");
expect(runs.at(0).phoneticGuide.rubyText).toEqual("ruby");

See Also

Run constructor Run.nodeType property