Class: RubyOSBXL::Dto::BordersObject

Inherits:

Object

• Object
• RubyOSBXL::Dto::BordersObject

Defined in:

lib/rubyosbxl.rb

Overview

枠線の書式を一括して取り扱うオブジェクトです。条件付き書式、カスタムセルスタイルは、外枠のみ設定可能です。

Instance Method Summary

• #clearBorder(borderindex) ⇒ void

  特定の枠線種類の枠線オブジェクトをクリアします(ワークシートの初期状態に戻します)。.

• #clearBorders ⇒ void

  全枠線種類の枠線オブジェクトをクリアします(ワークシートの初期状態に戻します)。.

• #getBorder(borderindex) ⇒ RubyOSBXL::Dto::ColorObject

  個別の枠線種類の設定情報を取得します。.

• #getBorders ⇒ Array<RubyOSBXL::Dto::BorderObject>

  全枠線種類の設定情報を一括して取得します（ユーザー設定していない枠線情報も取得されます）。.

• #initialize ⇒ void constructor

  コンストラクタ.

• #setBorder(border) ⇒ void

  特定の枠線種類の枠線オブジェクトをクリアします(ワークシートの初期状態に戻します)。.

• #setBorders(borders) ⇒ void

  全枠線種類の設定情報を一括して適用します。.

• #setOuterLineStyles(*args) ⇒ Object

Constructor Details

#initialize ⇒ void

コンストラクタ

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

Instance Method Details

#clearBorder(borderindex) ⇒ void

特定の枠線種類の枠線オブジェクトをクリアします(ワークシートの初期状態に戻します)。

Parameters:

• borderindex (RubyOSBXL::Enums::XlBordersIndex) —

  枠線種類

#clearBorders ⇒ void

全枠線種類の枠線オブジェクトをクリアします(ワークシートの初期状態に戻します)。

#getBorder(borderindex) ⇒ RubyOSBXL::Dto::ColorObject

個別の枠線種類の設定情報を取得します。

Parameters:

• borderindex (RubyOSBXL::Enums::XlBordersIndex) —

  枠線種類

Returns:

• (RubyOSBXL::Dto::ColorObject) —

  枠線書式オブジェクト

#getBorders ⇒ Array<RubyOSBXL::Dto::BorderObject>

全枠線種類の設定情報を一括して取得します（ユーザー設定していない枠線情報も取得されます）。

Returns:

• (Array<RubyOSBXL::Dto::BorderObject>) —

  Array<枠線書式オブジェクト>

#setBorder(border) ⇒ void

特定の枠線種類の枠線オブジェクトをクリアします(ワークシートの初期状態に戻します)。

Parameters:

• border (RubyOSBXL::Dto::BorderObject) —

  枠線種類

#setBorders(borders) ⇒ void

全枠線種類の設定情報を一括して適用します。

Parameters:

• borders (Array<RubyOSBXL::Dto::BorderObject>) —

  Array<枠線書式オブジェクト>

#setOuterLineStyles(linestyle) ⇒ void #setOuterLineStyles(linestyle, colorObject) ⇒ void

Overloads:

• #setOuterLineStyles(linestyle) ⇒ void

  外枠の枠線種類のオブジェクトに対して、一括して枠線スタイルを設定します。

  Parameters:

  • linestyle (RubyOSBXL::Enums::XlLineStyleBorderWeight) —

    枠線スタイル

• #setOuterLineStyles(linestyle, colorObject) ⇒ void

  外枠の枠線種類のオブジェクトに対して、一括して枠線スタイルを設定します。

  Parameters:

  • linestyle —

    — 枠線スタイル

  • colorObject (RubyOSBXL::Dto::ColorObject) —

    色オブジェクト