is_phonetic_guide property

Run.is_phonetic_guide property

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

@property
def is_phonetic_guide(self) -> bool:
    ...

Examples

Shows how to get properties of the phonetic guide.

doc = aw.Document(file_name=MY_DIR + 'Phonetic guide.docx')
runs = doc.first_section.body.first_paragraph.runs
# Use phonetic guide in the Asian text.
self.assertEqual(True, runs[0].is_phonetic_guide)
self.assertEqual('base', runs[0].phonetic_guide.base_text)
self.assertEqual('ruby', runs[0].phonetic_guide.ruby_text)

See Also