Class: RubyOSBXL::Dto::HyperlinkObject

Inherits:
Object
  • Object
show all
Defined in:
lib/rubyosbxl.rb

Overview

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

Instance Method Summary collapse

Constructor Details

#initialize ⇒ void

コンストラクタ

インスタンスを作成します。

Instance Method Details

#getAddress ⇒ String

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

Returns:

  • (String) —

    メールアドレスや外部参照

#getEmailSubject ⇒ String

Email題名を取得します。

Returns:

  • (String) —

    Email題名

#getInDocAddress ⇒ String

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

Returns:

  • (String) —

    セル範囲(A1C1)

#getScreenTip ⇒ String

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

Returns:

  • (String) —

    表示スクリーンヒント

#getTextToDisplay ⇒ String

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

Returns:

  • (String) —

    画面表示値

#setAddress(address) ⇒ void

Note:

外部ブック参照を入力する際は、 ファイル名#シート名!セル範囲 の形式を設定します。(シート名およびセル範囲は任意項目で、ファイル名のみの場合は#、は不要です)

Note:

URLや外部ファイルを設定する際には、プロトコル名(https: //, file: ///等)を先頭に入力してください。

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

Parameters:

  • address (String) —

    外部参照(URLや外部ワークブックや外部ファイル)

#setEmailSubject(mailAddress, subject) ⇒ void

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

Parameters:

  • mailAddress (String) —

    メールアドレス

  • subject (String) —

    メール題名

#setInDocAddress(address) ⇒ void

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

Parameters:

  • address (String) —

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

#setScreenTip(screentip) ⇒ void

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

Parameters:

  • screentip (String) —

    スクリーンヒント

#setTextToDisplay(text) ⇒ void

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

Parameters:

  • text (String) —

    画面表示値