2.5.122 RichStr
The RichStr structure specifies a rich string.
|
|
|
|
|
|
|
|
|
|
1 |
|
|
|
|
|
|
|
|
|
2 |
|
|
|
|
|
|
|
|
|
3 |
|
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
A |
B |
unused1 |
str (variable) |
||||||||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
|
dwSizeStrRun (4 bytes) |
|||||||||||||||||||||||||||||||
|
rgsStrRun (variable) |
|||||||||||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
|
phoneticStr (variable) |
|||||||||||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
|
dwPhoneticRun (4 bytes) |
|||||||||||||||||||||||||||||||
|
rgsPhRun (variable) |
|||||||||||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
A - fRichStr (1 bit): A bit that specifies whether dwSizeStrRun and rgsStrRun exist.
B - fExtStr (1 bit): A bit that specifies whether phoneticStr, dwPhoneticRun, and rgsPhRun exist.
unused1 (6 bits): Undefined. This value MUST be ignored.
str (variable): An XLWideString (section 2.5.169) structure that specifies the string. The number of Unicode characters MUST be less than or equal to 0x7FFF.
dwSizeStrRun (4 bytes): An unsigned integer that specifies the number of StrRun (section 2.5.144) in rgsStrRun. MUST be less than or equal to 0x7FFF.
rgsStrRun (variable): An array of StrRun. Each StrRun specifies formatting that is applied to a text run of characters within str. Every StrRun, except the last StrRun in the array, specifies formatting for a text run that begins with the character specified by the ich field of the StrRun and that ends with the character that precedes the character specified by the ich field of the subsequent StrRun in the array. The last StrRun in the array specifies formatting for a text run that begins with the character specified by its ich field and ends with the last character in str. The value of each ich field of a StrRun in the array MUST be less than the ich field of the subsequent StrRun in the array.
phoneticStr (variable): An XLWideString structure that specifies the phonetic string.
dwPhoneticRun (4 bytes): An unsigned integer that specifies the number of PhRun (section 2.5.103) in rgsPhRun. This value MUST be less than or equal to 0x7FFF.
rgsPhRun (variable): An array of PhRun. Each PhRun specifies a phonetic text run within phoneticStr that is displayed above a text run within str. The first character in the phonetic text run is the character specified by the ichFirst field of PhRun. The first character in the str that the phonetic text run appears above is specified by the ichMom field of PhRun. The number of characters in the str that phonetic text run appears above is specified by the cchMom field of PhRun. The value of each ichMom field of a PhRun in the array MUST be less than the ichMom field of the subsequent PhRun in the array. The value of each ichFirst field of a PhRun in the array MUST be less than the ichFirst field of the subsequent PhRun in the array. The sum of the cchMom fields of all PhRun in the array MUST be less than or equal to the number of characters in str.