PhoneticRun Class

Phonetic Run.When the object is serialized out as xml, its qualified name is x:rPh.

Inheritance Hierarchy

System.Object
  DocumentFormat.OpenXml.OpenXmlElement
    DocumentFormat.OpenXml.OpenXmlCompositeElement
      DocumentFormat.OpenXml.Spreadsheet.PhoneticRun

Namespace:  DocumentFormat.OpenXml.Spreadsheet
Assembly:  DocumentFormat.OpenXml (in DocumentFormat.OpenXml.dll)

Syntax

声明
<ChildElementInfoAttribute(GetType(Text))> _
Public Class PhoneticRun _
    Inherits OpenXmlCompositeElement
用法
Dim instance As PhoneticRun
[ChildElementInfoAttribute(typeof(Text))]
public class PhoneticRun : OpenXmlCompositeElement

Remarks

The following table lists the possible child types:

  • Text <x:t>

[ISO/IEC 29500-1 第 1 个版本]

18.4.6 rPh (Phonetic Run)

This element represents a run of text which displays a phonetic hint for this String Item (si).

Phonetic hints are used to give information about the pronunciation of an East Asian language. The hints are displayed as text within the spreadsheet cells across the top portion of the cell.

Parent Elements

is (§18.3.1.53); si (§18.4.8); text (§18.7.7)

Child Elements

Subclause

t (Text)

§18.4.12

Attributes

Description

eb (Base Text End Index)

An integer used as a zero-based index representing the ending offset into the base text for this phonetic run. This represents the ending point in the base text the phonetic hint applies to.

This value shall be between 0 and the total length of the base text. The following condition shall be true: sb < eb.

It is recommended that the following condition also be satisfied:

That for any two consecutive phonetic runs, sb1 < eb1 <= sb2 < eb2 to avoid overlapping phonetic runs

The possible values for this attribute are defined by the W3C XML Schema unsignedInt datatype.

sb (Base Text Start Index)

An integer used as a zero-based index representing the starting offset into the base text for this phonetic run. This represents the starting point in the base text the phonetic hint applies to.

This value shall be between 0 and the total length of the base text. The following condition shall be true: sb < eb.

It is recommended that the following condition also be satisfied:

That for any two consecutive phonetic runs, sb1 < eb1 <= sb2 < eb2 to avoid overlapping phonetic runs.

The possible values for this attribute are defined by the W3C XML Schema unsignedInt datatype.

[Note: The W3C XML Schema definition of this element's content model (CT_PhoneticRun) is located in §A.2. end note]

© ISO/IEC29500: 2008. 以上摘要已经由 Microsoft(和/或其代理公司)从英语翻译为简体中文,ISO 对此翻译不承担任何责任。

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.

See Also

Reference

PhoneticRun Members

DocumentFormat.OpenXml.Spreadsheet Namespace