class documentation

class Phonetics:

View In Hierarchy

フリガナを扱うクラスです。ワークシートのセル(A1)で使用します。

Method getFont フリガナのフォントオブジェクトの取得を行います。
Method getPhoneticAlignment フリガナの配置位置の取得を行います。
Method getPhoneticCharacterType フリガナの種類の取得を行います。
Method getText フリガナの取得を行います。
Method getVisible フリガナの可視の取得を行います。
Method remove セルのフリガナの削除を行います。
Method setFont フリガナのフォントオブジェクトの適用を行います。
Method setPhoneticAlignment フリガナの配置位置の設定を行います。
Method setPhoneticCharacterType フリガナの種類の設定を行います。
Method setText フリガナの設定を行います。
Method setVisible フリガナの可視の切り替えを行います。
def getFont(self) -> dto.FontObject:

フリガナのフォントオブジェクトの取得を行います。

Returns
FontObjectフリガナのフォントオブジェクト
def getPhoneticAlignment(self) -> enums.XlPhoneticAlignment:

フリガナの配置位置の取得を行います。

Returns
XlPhoneticAlignmentフリガナの配置位置
def getPhoneticCharacterType(self) -> enums.XlPhoneticCharacterType:

フリガナの種類の取得を行います。

Returns
XlPhoneticCharacterTypeフリガナの種類
def getText(self) -> str:

フリガナの取得を行います。

Returns
strフリガナ
def getVisible(self) -> bool:

フリガナの可視の取得を行います。

Returns
booltrue:可視 false:不可視
def remove(self):

セルのフリガナの削除を行います。

def setFont(self, fontObject: dto.FontObject):

フリガナのフォントオブジェクトの適用を行います。

Parameters
fontObject:FontObjectフリガナのフォントオブジェクト
def setPhoneticAlignment(self, alignment: enums.XlPhoneticAlignment):

フリガナの配置位置の設定を行います。

Parameters
alignment:XlPhoneticAlignmentフリガナの配置位置
def setPhoneticCharacterType(self, type: enums.XlPhoneticCharacterType):

フリガナの種類の設定を行います。

Parameters
type:XlPhoneticCharacterTypeフリガナの種類
def setText(self, phoneticText: str):

フリガナの設定を行います。

Parameters
phoneticText:strフリガナ
def setVisible(self, visible: bool):

フリガナの可視の切り替えを行います。

Parameters
visible:booltrue:可視 false:不可視