ig.excel.WorksheetTableStyle
依存関係
-
ig.excel.WorksheetTableStyle
コンストラクター- new $.ig.excel.WorksheetTableStyle( name:string );
カスタムの WorksheetTableStyle インスタンスを作成します。
- name
- タイプ:string
- 新しいスタイルの名前。
例外
例外 説明 ig.ArgumentNullException 名前は null または空です。 -
alternateColumnStripeWidth
- .alternateColumnStripeWidth( );
- 返却型:
- number
- 返却型の説明:
- 各隔列ストライプに収められる列の数。
各隔列ストライプに収められる列の数を取得します。
例外
例外 説明 ig.InvalidOperationException この値は設定されていて、WorksheetTableStyle.isCustom は False です。つまり、指定したスタイルは読み取り専用の標準テーブル スタイルです。 ig.ArgumentOutOfRangeException 1 未満または 9 よりも大きな値が指定されました。 備考
ストライプのサイズに指定できる値の範囲は 1 から 9 までです。
列ストライプは、テーブルの左から右に向かって、最初に列ストライプ、次に隔列ストライプという順番で交互に割り当てられていきます。
隔列ストライプの書式は、WorksheetTableStyle.areaFormats コレクションで定義され、WorksheetTableStyleArea.AlternateColumnStripe 値の参照キーが付けられます。
-
alternateColumnStripeWidth
- .alternateColumnStripeWidth( value:number );
- 返却型:
- number
- 返却型の説明:
- 各隔列ストライプに収められる列の数。
各隔列ストライプに収められる列の数を取得します。
- value
- タイプ:number
例外
例外 説明 ig.InvalidOperationException この値は設定されていて、WorksheetTableStyle.isCustom は False です。つまり、指定したスタイルは読み取り専用の標準テーブル スタイルです。 ig.ArgumentOutOfRangeException 1 未満または 9 よりも大きな値が指定されました。 備考
ストライプのサイズに指定できる値の範囲は 1 から 9 までです。
列ストライプは、テーブルの左から右に向かって、最初に列ストライプ、次に隔列ストライプという順番で交互に割り当てられていきます。
隔列ストライプの書式は、WorksheetTableStyle.areaFormats コレクションで定義され、WorksheetTableStyleArea.AlternateColumnStripe 値の参照キーが付けられます。
-
alternateRowStripeHeight
- .alternateRowStripeHeight( );
- 返却型:
- number
- 返却型の説明:
- 各隔行ストライプに収められる行の数。
各隔行ストライプに及ぶ行数。
例外
例外 説明 ig.InvalidOperationException この値は設定されていて、WorksheetTableStyle.isCustom は False です。つまり、指定したスタイルは読み取り専用の標準テーブル スタイルです。 ig.ArgumentOutOfRangeException 1 未満または 9 よりも大きな値が指定されました。 備考
ストライプのサイズに指定できる値の範囲は 1 から 9 までです。
行ストライプは、テーブルの上から下に向かって、最初に行ストライプ、次に隔行ストライプという順番で交互に割り当てられていきます。
隔行ストライプの書式は、WorksheetTableStyle.areaFormats コレクションで定義され、WorksheetTableStyleArea.AlternateRowStripe 値の参照キーが付けられます。
-
alternateRowStripeHeight
- .alternateRowStripeHeight( value:number );
- 返却型:
- number
- 返却型の説明:
- 各隔行ストライプに収められる行の数。
各隔行ストライプに及ぶ行数。
- value
- タイプ:number
例外
例外 説明 ig.InvalidOperationException この値は設定されていて、WorksheetTableStyle.isCustom は False です。つまり、指定したスタイルは読み取り専用の標準テーブル スタイルです。 ig.ArgumentOutOfRangeException 1 未満または 9 よりも大きな値が指定されました。 備考
ストライプのサイズに指定できる値の範囲は 1 から 9 までです。
行ストライプは、テーブルの上から下に向かって、最初に行ストライプ、次に隔行ストライプという順番で交互に割り当てられていきます。
隔行ストライプの書式は、WorksheetTableStyle.areaFormats コレクションで定義され、WorksheetTableStyleArea.AlternateRowStripe 値の参照キーが付けられます。
-
areaFormats
- .areaFormats( );
このスタイルが適用される WorksheetTable の各領域で使用される書式のコレクションを取得します。
備考
指定した領域書式は差分書式です。つまり、デフォルト以外の値に設定されているプロパティのみが該当セルに適用されます。領域書式で定義できるは、背景色またはフォント情報のみで、その書式はセルに適用されることになりますが、他の書式プロパティはすべて保持されます。
-
areaFormats
- .areaFormats( area:ig.excel.WorksheetTableStyleArea );
- 返却型:
- ig.excel.IWorksheetCellFormat
- 返却型の説明:
- 指定した領域の外観を説明する IWorksheetCellFormat インスタンス。
このスタイルが適用される WorksheetTable の各領域で使用される書式のコレクションを取得します。
- area
- タイプ:ig.excel.WorksheetTableStyleArea
- 書式を取得したい領域。
例外
例外 説明 ig.excel.InvalidEnumArgumentException 領域は定義されていません。 -
clone
- .clone( name:string );
- 返却型:
- ig.excel.WorksheetTableStyle
- 返却型の説明:
- スタイルの複製。
このスタイルを複製してディープ コピーを返します。
- name
- タイプ:string
- クローンされたスタイルに指定するための名前。
例外
例外 説明 ig.ArgumentNullException 名前は null または空です。 備考
複製したスタイルは、Workbook.customTableStyles コレクションに追加しないと、WorksheetTable に適用できません。
WorksheetTableStyle.isCustom 値だけは元のスタイルからクローンされません。標準スタイルを複製すると、同じスタイル設定値を備えたカスタムのスタイルが作成されます。スタイル設定値はあとで変更できます。
-
columnStripeWidth
- .columnStripeWidth( );
- 返却型:
- number
- 返却型の説明:
- 各列ストライプに収められる列の数。
各隔列ストライプに及ぶ列の数を取得します。
例外
例外 説明 ig.InvalidOperationException この値は設定されていて、WorksheetTableStyle.isCustom は False です。つまり、指定したスタイルは読み取り専用の標準テーブル スタイルです。 ig.ArgumentOutOfRangeException 1 未満または 9 よりも大きな値が指定されました。 備考
ストライプのサイズに指定できる値の範囲は 1 から 9 までです。
列ストライプは、テーブルの左から右に向かって、最初に列ストライプ、次に隔列ストライプという順番で交互に割り当てられていきます。
列ストライプの書式は、WorksheetTableStyle.areaFormats コレクションで定義され、WorksheetTableStyleArea.ColumnStripe 値の参照キーが付けられます。
-
columnStripeWidth
- .columnStripeWidth( value:number );
- 返却型:
- number
- 返却型の説明:
- 各列ストライプに収められる列の数。
各隔列ストライプに及ぶ列の数を取得します。
- value
- タイプ:number
例外
例外 説明 ig.InvalidOperationException この値は設定されていて、WorksheetTableStyle.isCustom は False です。つまり、指定したスタイルは読み取り専用の標準テーブル スタイルです。 ig.ArgumentOutOfRangeException 1 未満または 9 よりも大きな値が指定されました。 備考
ストライプのサイズに指定できる値の範囲は 1 から 9 までです。
列ストライプは、テーブルの左から右に向かって、最初に列ストライプ、次に隔列ストライプという順番で交互に割り当てられていきます。
列ストライプの書式は、WorksheetTableStyle.areaFormats コレクションで定義され、WorksheetTableStyleArea.ColumnStripe 値の参照キーが付けられます。
-
isCustom
- .isCustom( );
- 返却型:
- boolean
- 返却型の説明:
- このスタイルがカスタム テーブル スタイルである場合は True、このスタイルが読み取り専用の標準テーブル スタイルである場合は False。
このスタイルがカスタム スタイルであるかどうかを示す値を取得します。
-
name
- .name( );
- 返却型:
- string
- 返却型の説明:
- スタイルの名前です。
スタイルの名前を取得します。
例外
例外 説明 ig.InvalidOperationException この値は設定されていて、WorksheetTableStyle.isCustom は False です。つまり、指定したスタイルは読み取り専用の標準テーブル スタイルです。 ig.ArgumentException null、空の値、もしくは 255 文字を超える長さの値が指定されました。 ig.ArgumentException null、空の値、もしくは 255 文字を超える長さの値が指定されました。 -
name
- .name( value:string );
- 返却型:
- string
- 返却型の説明:
- スタイルの名前です。
スタイルの名前を取得します。
- value
- タイプ:string
例外
例外 説明 ig.InvalidOperationException この値は設定されていて、WorksheetTableStyle.isCustom は False です。つまり、指定したスタイルは読み取り専用の標準テーブル スタイルです。 ig.ArgumentException null、空の値、もしくは 255 文字を超える長さの値が指定されました。 ig.ArgumentException null、空の値、もしくは 255 文字を超える長さの値が指定されました。 -
rowStripeHeight
- .rowStripeHeight( );
- 返却型:
- number
- 返却型の説明:
- 各行ストライプに収められる行の数。
各隔行ストライプに及ぶ行数を取得します。
例外
例外 説明 ig.InvalidOperationException この値は設定されていて、WorksheetTableStyle.isCustom は False です。つまり、指定したスタイルは読み取り専用の標準テーブル スタイルです。 ig.ArgumentOutOfRangeException 1 未満または 9 よりも大きな値が指定されました。 備考
ストライプのサイズに指定できる値の範囲は 1 から 9 までです。
行ストライプは、テーブルの上から下に向かって、最初に行ストライプ、次に隔行ストライプという順番で交互に割り当てられていきます。
行ストライプの書式は、WorksheetTableStyle.areaFormats コレクションで定義され、WorksheetTableStyleArea.RowStripe 値の参照キーが付けられます。
-
rowStripeHeight
- .rowStripeHeight( value:number );
- 返却型:
- number
- 返却型の説明:
- 各行ストライプに収められる行の数。
各隔行ストライプに及ぶ行数を取得します。
- value
- タイプ:number
例外
例外 説明 ig.InvalidOperationException この値は設定されていて、WorksheetTableStyle.isCustom は False です。つまり、指定したスタイルは読み取り専用の標準テーブル スタイルです。 ig.ArgumentOutOfRangeException 1 未満または 9 よりも大きな値が指定されました。 備考
ストライプのサイズに指定できる値の範囲は 1 から 9 までです。
行ストライプは、テーブルの上から下に向かって、最初に行ストライプ、次に隔行ストライプという順番で交互に割り当てられていきます。
行ストライプの書式は、WorksheetTableStyle.areaFormats コレクションで定義され、WorksheetTableStyleArea.RowStripe 値の参照キーが付けられます。