pyosbxl.dto.HyperlinkObject

class documentation

class HyperlinkObject:

ハイパーリンクを取り扱うオブジェクトです。

Method	`__init__`	コンストラクタ。インスタンスを作成します。
Method	`getAddress`	設定したメールアドレスや外部参照(URLや外部ワークブックや外部ファイル)を取得します。
Method	`getEmailSubject`	Email題名を取得します。
Method	`getInDocAddress`	同一ドキュメント内のセル参照を取得します。
Method	`getScreenTip`	表示スクリーンヒントを取得します。
Method	`getTextToDisplay`	画面表示値を取得します。
Method	`setAddress`	外部参照(URLや外部ワークブックや外部ファイル)を設定します。
Method	`setEmailSubject`	メールアドレスを設定します。ハイパーリンクは、mailto://形式となります。
Method	`setInDocAddress`	同一ドキュメント内のセル参照を設定します。
Method	`setScreenTip`	表示スクリーンヒントを設定します。
Method	`setTextToDisplay`	画面表示値を設定します。

def __init__(self): ¶

コンストラクタ。インスタンスを作成します。

def getAddress(self) -> str: ¶

設定したメールアドレスや外部参照(URLや外部ワークブックや外部ファイル)を取得します。

Returns
`str`	アドレス

def getEmailSubject(self) -> str: ¶

Email題名を取得します。

Returns
`str`	Email題名

def getInDocAddress(self) -> str: ¶

同一ドキュメント内のセル参照を取得します。

Returns
`str`	セル範囲(A1C1)

def getScreenTip(self) -> str: ¶

表示スクリーンヒントを取得します。

Returns
`str`	スクリーンヒント

def getTextToDisplay(self) -> str: ¶

画面表示値を取得します。

Returns
`str`	画面表示値

def setAddress(self, address: str): ¶

外部参照(URLや外部ワークブックや外部ファイル)を設定します。

外部ブック参照を入力する際は、ファイル名#シート名!セル範囲の形式を設定します。(シート名およびセル範囲は任意項目で、ファイル名のみの場合は、#は不要です) URLや外部ファイルを設定する際には、プロトコル名(https://,file:///等)を先頭に入力してください。

Parameters
address:`str`	外部参照(URLや外部ワークブックや外部ファイル)

def setEmailSubject(self, mailAddress: str, subject: str): ¶

メールアドレスを設定します。ハイパーリンクは、mailto://形式となります。

def setInDocAddress(self, address: str): ¶

同一ドキュメント内のセル参照を設定します。

Parameters
address:`str`	同一ドキュメント内のセル参照(A1C1範囲または、定義されている名前つき範囲)

def setScreenTip(self, screentip: str): ¶

表示スクリーンヒントを設定します。

Parameters
screentip:`str`	スクリーンヒント

def setTextToDisplay(self, text: str): ¶

画面表示値を設定します。

Parameters
text:`str`	画面表示値