PhoneticProperties Class
Phonetic Properties.When the object is serialized out as xml, its qualified name is x:phoneticPr.
Inheritance Hierarchy
System.Object
DocumentFormat.OpenXml.OpenXmlElement
DocumentFormat.OpenXml.OpenXmlLeafElement
DocumentFormat.OpenXml.Spreadsheet.PhoneticProperties
Namespace: DocumentFormat.OpenXml.Spreadsheet
Assembly: DocumentFormat.OpenXml (in DocumentFormat.OpenXml.dll)
Syntax
'Declaration
Public Class PhoneticProperties _
Inherits OpenXmlLeafElement
'Usage
Dim instance As PhoneticProperties
public class PhoneticProperties : OpenXmlLeafElement
Remarks
[ISO/IEC 29500-1 1st Edition]
18.4.3 phoneticPr (Phonetic Properties)
This element represents a collection of phonetic properties that affect the display of phonetic text for this String Item (si).
Phonetic text is used to give hints as to the pronunciation of an East Asian language, and the hints are displayed as text within the spreadsheet cells across the top portion of the cell. Since the phonetic hints are text, every phonetic hint is expressed as a phonetic run (rPh), and these properties specify how to display that phonetic run.
[Example:
<si> <t>課きく 毛こ</t> <rPh sb="0" eb="1"> <t>カ</t> </rPh> <rPh sb="4" eb="5"> <t>ケ</t> </rPh> <phoneticPr fontId="1"/> </si>
The above example shows a String Item that displays some Japanese text "課きく 毛こ." It also displays some phonetic text across the top of the cell. The phonetic text character, "カ" is displayed over the "課" character and the phonetic text "ケ" is displayed above the "毛" character, using the font record in the style sheet at index 1. end example]
Parent Elements |
|---|
is (§18.3.1.53); si (§18.4.8); text (§18.7.7); worksheet (§18.3.1.99) |
Attributes |
Description |
|---|---|
alignment (Alignment) |
Specifies how the text for the phonetic run is aligned across the top of the cells, with respect to the main text in the body of the cell. The possible values for this attribute are defined by the ST_PhoneticAlignment simple type (§18.18.56). |
fontId (Font Id) |
An integer that is a zero-based index into the font record in the style sheet. Represents the font to be used to display this phonetic run. If this index is out of bounds, then the default font of the Normal style should be used in its place. This default font should be at index 0. The possible values for this attribute are defined by the ST_FontId simple type (§18.18.32). |
type (Character Type) |
An enumeration which specifies which East Asian character set should be used to display the phonetic run The possible values for this attribute are defined by the ST_PhoneticType simple type (§18.18.57). |
[Note: The W3C XML Schema definition of this element’s content model (CT_PhoneticPr) is located in §A.2. end note]
© ISO/IEC29500: 2008.
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.