NanoXLSX.Extensions.PhoneticProperties Class Reference

Represents phonetic properties, applied to the phonetic runs of a formatted text. More...

Public Member Functions
	PhoneticProperties (Font fontReference)
	Default constructor to create phonetic properties, using the specified font reference.
PhoneticProperties	Copy ()
	Creates a copy of the current phonetic properties.
override bool	Equals (object obj)
	Equals override to compare phonetic properties.
override int	GetHashCode ()
	HashCode override for phonetic properties.

Properties
Font	FontReference [get, set]
	Font reference that is used to render the Ruby text.
int	FontId [get, set]
	Internal Id of the font used for phonetic text.
PhoneticRun.PhoneticType	Type = PhoneticRun.PhoneticType.FullwidthKatakana [get, set]
	The type of phonetic text representation. Default is FullwidthKatakana.
PhoneticRun.PhoneticAlignment	Alignment = PhoneticRun.PhoneticAlignment.Left [get, set]
	Alignment of the phonetic text relative to the base text. Default is Left.

Detailed Description

Represents phonetic properties, applied to the phonetic runs of a formatted text.

Definition at line 16 of file PhoneticProperties.cs.

Constructor & Destructor Documentation

PhoneticProperties()

NanoXLSX.Extensions.PhoneticProperties.PhoneticProperties

(

Font

fontReference

)

Default constructor to create phonetic properties, using the specified font reference.

Parameters

fontReference

Font reference. If null, a default font reference number will be selected, probably 0

Definition at line 40 of file PhoneticProperties.cs.

Member Function Documentation

Copy()

PhoneticProperties NanoXLSX.Extensions.PhoneticProperties.Copy

(

)

Creates a copy of the current phonetic properties.

Returns

Copy of the phonetic properties

Definition at line 49 of file PhoneticProperties.cs.

Equals()

override bool NanoXLSX.Extensions.PhoneticProperties.Equals

(

object

obj

)

Equals override to compare phonetic properties.

Parameters

obj	Other object to compare

Returns

True, if the other object is equal

Definition at line 63 of file PhoneticProperties.cs.

GetHashCode()

override int NanoXLSX.Extensions.PhoneticProperties.GetHashCode

(

)

HashCode override for phonetic properties.

Returns

Hash code of the current object

Definition at line 76 of file PhoneticProperties.cs.

Property Documentation

Alignment

PhoneticRun.PhoneticAlignment NanoXLSX.Extensions.PhoneticProperties.Alignment = PhoneticRun.PhoneticAlignment.Left

getset

Alignment of the phonetic text relative to the base text. Default is Left.

Definition at line 34 of file PhoneticProperties.cs.

FontId

int NanoXLSX.Extensions.PhoneticProperties.FontId

getset

Internal Id of the font used for phonetic text.

Remarks

This ID will be resolved automatically, when the workbook is saved, according to PhoneticProperties.FontReference

Definition at line 26 of file PhoneticProperties.cs.

FontReference

Font NanoXLSX.Extensions.PhoneticProperties.FontReference

getset

Font reference that is used to render the Ruby text.

Definition at line 21 of file PhoneticProperties.cs.

Type

PhoneticRun.PhoneticType NanoXLSX.Extensions.PhoneticProperties.Type = PhoneticRun.PhoneticType.FullwidthKatakana

getset

The type of phonetic text representation. Default is FullwidthKatakana.

Definition at line 30 of file PhoneticProperties.cs.

---

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

• PhoneticProperties.cs