com.aspose.words

Class PhoneticGuide

java.lang.Object

com.aspose.words.PhoneticGuide

public class PhoneticGuide
extends java.lang.Object

Represents Phonetic Guide.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getBaseText() Gets base text of the phonetic guide.
java.lang.String	getRubyText() Gets ruby text of the phonetic guide.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getBaseText

public java.lang.String getBaseText()

Gets base text of the phonetic guide.

Examples:

Shows how to get properties of the phonetic guide.

 
 Document doc = new Document(getMyDir() + "Phonetic guide.docx");

 RunCollection runs = doc.getFirstSection().getBody().getFirstParagraph().getRuns();
 // Use phonetic guide in the Asian text.
 Assert.assertEquals(true, runs.get(0).isPhoneticGuide());

 PhoneticGuide phoneticGuide = runs.get(0).getPhoneticGuide();
 Assert.assertEquals("base", phoneticGuide.getBaseText());
 Assert.assertEquals("ruby", phoneticGuide.getRubyText());
 
 

Returns:

Base text of the phonetic guide.

getRubyText

public java.lang.String getRubyText()

Gets ruby text of the phonetic guide.

Examples:

Shows how to get properties of the phonetic guide.

 
 Document doc = new Document(getMyDir() + "Phonetic guide.docx");

 RunCollection runs = doc.getFirstSection().getBody().getFirstParagraph().getRuns();
 // Use phonetic guide in the Asian text.
 Assert.assertEquals(true, runs.get(0).isPhoneticGuide());

 PhoneticGuide phoneticGuide = runs.get(0).getPhoneticGuide();
 Assert.assertEquals("base", phoneticGuide.getBaseText());
 Assert.assertEquals("ruby", phoneticGuide.getRubyText());
 
 

Returns:

Ruby text of the phonetic guide.