NanoXLSX.Extensions.PhoneticRun Class Reference

Represents a phonetic run that provides pronunciation guidance for text. More...

Public Types
enum	PhoneticType { HalfwidthKatakana , FullwidthKatakana , Hiragana , NoConversion }
	Enumeration for phonetic text types. More...
enum	PhoneticAlignment { NoControl , Left , Center , Distributed }
	Enumeration for phonetic text alignment. More...

Public Member Functions
	PhoneticRun (string text, uint startBase, uint endBase)
	Constructor to create a phonetic run.
PhoneticRun	Copy ()
	Creates a copy of the current phonetic run.
override bool	Equals (object obj)
	Equals method to compare two phonetic runs.
override int	GetHashCode ()
	Hash code of the current object.

Properties
string	Text [get, set]
	The phonetic text to be displayed (Ruby text,like Furigana, Pinyin or Zhuyin).
uint	StartBase [get, set]
	The start index of the base text (character where the Ruby text starts).
uint	EndBase [get, set]
	The end index of the base text (character where the Ruby text ends).

Detailed Description

Represents a phonetic run that provides pronunciation guidance for text.

Definition at line 17 of file PhoneticRun.cs.

Member Enumeration Documentation

PhoneticAlignment

enum NanoXLSX.Extensions.PhoneticRun.PhoneticAlignment

Enumeration for phonetic text alignment.

Enumerator
NoControl	Each phonetic character is left justified without respect to the base text (so it is not per word).
Left	Each phonetic character is left justified with respect to the base text., per word.
Center	Center the phonetic characters over the base word, per word.
Distributed	Each phonetic character is distributed above each base word character, per word.

Definition at line 39 of file PhoneticRun.cs.

PhoneticType

enum NanoXLSX.Extensions.PhoneticRun.PhoneticType

Enumeration for phonetic text types.

Enumerator
HalfwidthKatakana	Half-width Katakana characters for phonetic text.
FullwidthKatakana	Full-width Katakana characters for phonetic text.
Hiragana	Hiragana characters for phonetic text.
NoConversion	No conversion for phonetic text.

Definition at line 24 of file PhoneticRun.cs.

Constructor & Destructor Documentation

PhoneticRun()

NanoXLSX.Extensions.PhoneticRun.PhoneticRun	(	string	text,
		uint	startBase,
		uint	endBase )

Constructor to create a phonetic run.

Parameters

text	The phonetic text to be displayed (Ruby text,like Furigana, Pinyin or Zhuyin)
startBase	The start index of the base text (character where the Ruby text starts)
endBase	The end index of the base text (character where the Ruby text ends)

Exceptions

FormatException

Thrown when the text is null or empty

Definition at line 87 of file PhoneticRun.cs.

Member Function Documentation

Copy()

PhoneticRun NanoXLSX.Extensions.PhoneticRun.Copy

(

)

Creates a copy of the current phonetic run.

Returns

Deep copy of the phonetic run

Definition at line 98 of file PhoneticRun.cs.

Equals()

override bool NanoXLSX.Extensions.PhoneticRun.Equals

(

object

obj

)

Equals method to compare two phonetic runs.

Parameters

obj	Other object to compare

Returns

True, if other object is equal

Definition at line 108 of file PhoneticRun.cs.

GetHashCode()

override int NanoXLSX.Extensions.PhoneticRun.GetHashCode

(

)

Hash code of the current object.

Returns

Hash code of the current object

Definition at line 120 of file PhoneticRun.cs.

Property Documentation

EndBase

uint NanoXLSX.Extensions.PhoneticRun.EndBase

getset

The end index of the base text (character where the Ruby text ends).

Definition at line 78 of file PhoneticRun.cs.

StartBase

uint NanoXLSX.Extensions.PhoneticRun.StartBase

getset

The start index of the base text (character where the Ruby text starts).

Definition at line 74 of file PhoneticRun.cs.

Text

string NanoXLSX.Extensions.PhoneticRun.Text

getset

The phonetic text to be displayed (Ruby text,like Furigana, Pinyin or Zhuyin).

Exceptions

FormatException

Thrown when the text is null or empty

Definition at line 59 of file PhoneticRun.cs.

---

The documentation for this class was generated from the following file:

• PhoneticRun.cs