mlreportgen.dom.TableHeaderEntry クラス

名前空間: mlreportgen.dom
スーパークラス: mlreportgen.dom.TableEntry

テーブル ヘッダーのエントリ

説明

テーブル ヘッダー エントリを指定します。

このクラスは、主に HTML テーブルの作成をサポートすることを目的としています。これは、HTML ドキュメントで th (テーブル ヘッダー セル) 要素としてレンダリングされます。この要素を使用すると、テーブル ヘッダー エントリを明示的に書式設定する必要がなくなります。TableHeaderEntry オブジェクトは、ブラウザーの機能を使用してヘッダー エントリを適切にレンダリングします。Microsoft^® Word 出力および PDF 出力では、TableHeaderEntry は TableEntry と同じように動作します。

mlreportgen.dom.TableHeaderEntry クラスは handle クラスです。

作成

説明

entryObj = TableHeaderEntry() は、空のテーブル ヘッダー エントリを作成します。

プロパティ

Border — 描画する境界線のタイプ

"solid" | "single" | "dashed" | "none" | ... | ...

描画する境界線のタイプ。次の表のいずれかの値として指定します。

境界線の値	説明	サポートされる出力タイプ
"dashed"	破線	HTML、PDF、Word
"dashdotstroked"	斜めの破線と点が交互に入った線	Word
"dashsmallgap"	破線間に小さい隙間がある破線	Word
"dotted"	点線	HTML、PDF、Word
"dotdash"	点と破線が交互に入った線	Word
"dotdotdash"	2 つの点と 1 本の破線が交互に入った線	Word
"double"	二重線	HTML、PDF、Word
"doublewave"	二重波線	Word
"groove"	3D 効果溝付き線	HTML、PDF
"hidden"	線なし 境界線タイプ "none" も線を生成しません。ただし、競合する境界線の処理が、"hidden" タイプと "none" タイプで異なります。境界線タイプ "hidden" は、競合する境界線タイプよりも優先されます。競合する境界線タイプは、"none" タイプよりも優先されます。	HTML、PDF
"inset"	3D 効果線	HTML、PDF、Word
"none"	線なし 境界線タイプ "hidden" も線を生成しません。ただし、競合する境界線の処理が、"hidden" タイプと "none" タイプで異なります。境界線タイプ "hidden" は、競合する境界線タイプよりも優先されます。競合する境界線タイプは、"none" タイプよりも優先されます。	HTML、PDF、Word
"outset"	3D 効果線	HTML、PDF、Word
"ridge"	3D 効果突起付き線	HTML、PDF
"single"	一重線	Word
"solid"	一重線	HTML、PDF
"thick"	太い線	Word
"thickthinlargegap"	太い破線と細い破線が交互に入った隙間の大きい破線	Word
"thickthinmediumgap"	太い破線と細い破線が交互に入った隙間が中程度の破線	Word
"thickthinsmallgap"	太い破線と細い破線が交互に入った隙間の小さい破線	Word
"thinthicklargegap"	細い破線と太い破線が交互に入った隙間が中程度の破線	Word
"thinthickmediumgap"	細い破線と太い破線が交互に入った隙間が中程度の破線	Word
"thinthicksmallgap"	細い破線と太い破線が交互に入った隙間の小さい破線	Word
"thinthickthinlargegap"	細い破線と太い破線が交互に入った隙間の大きい破線	Word
"thinthickthinmediumgap"	細い破線と太い破線が交互に入った隙間が中程度の破線	Word
"thinthickthinsmallgap"	細い破線と太い破線が交互に入った隙間の小さい破線	Word
"threedemboss"	エンボス加工した効果線	Word
"threedengrave"	彫り込み効果線	Word
"triple"	三重線	Word
"wave"	波線	Word

属性:

NonCopyable

true

データ型: char | string

BorderColor — 境界線の色

[] (既定値) | 文字ベクトル | string スカラー

境界線の色。CSS の色名 (https://www.w3.org/wiki/CSS/Properties/color/keywordsを参照) または #RRGGBB 形式の 16 進数の RGB (トゥルーカラー) 値で構成される文字ベクトルまたは string スカラーとして指定します。

例: 'blue'

例: '#0000ff'

属性:

NonCopyable

true

データ型: char | string

BorderWidth — テーブルの境界線幅

"px" | "cm" | "in" | ...

テーブルの境界線幅。valueUnits の形式で指定します。ここで、Units は単位の略語です。有効な略語を以下に示します。

• "px" — ピクセル

• "cm" — センチメートル

• "in" — インチ

• "mm" — ミリメートル

• "pc" — パイカ

• "pt" — ポイント

例: "2pt"

属性:

NonCopyable

true

データ型: char | string

ColSpan — テーブル エントリの範囲に含まれるテーブル列の数

double

テーブル エントリの範囲に含まれるテーブル列の数。double として指定します。

データ型: double

InnerMargin — エントリ周囲の内側の余白 (パディング)

文字ベクトル

内側の余白。valueUnits 形式。ここで、Units は単位の略語です。有効な略語を以下に示します。

• "px" — ピクセル

• "cm" — センチメートル

• "in" — インチ

• "mm" — ミリメートル

• "pc" — パイカ

• "pt" — ポイント

RowSpan — テーブル エントリの範囲に含まれるテーブル行の数

double

テーブル エントリの範囲に含まれるテーブル行の数。double として指定します。

データ型: double

VAlign — テーブル セルのコンテンツの垂直方向の配置

'top' | 'bottom' | 'middle'

テーブル セルのコンテンツの垂直方向の配置。以下のいずれかの値として指定します。

• 'top'

• 'bottom'

• 'middle'

StyleName — 要素のスタイルシート定義スタイル名

[] (既定値) | 文字ベクトル | string スカラー

スタイル名。文字ベクトルまたは string スカラーとして指定します。スタイル名は、この要素を追加するドキュメントまたはドキュメント パーツのスタイル シートで指定したスタイルの名前です。指定されたスタイルは、この要素の Style プロパティで指定された書式によってオーバーライドされない限り、出力ドキュメントでのこの要素の外観を定義します。スタイル シートの使用の詳細については、スタイル シートのスタイルの使用を参照してください。

メモ

Microsoft Word 出力ではスタイル名が無視されます。

属性:

NonCopyable

true

データ型: char | string

Style — 書式指定

{} (既定値) | 書式オブジェクトの配列

このドキュメント要素オブジェクトの書式指定。書式オブジェクトの配列として指定します。このプロパティで指定された書式は、この要素の StyleName プロパティで指定された対応する書式をオーバーライドします。この要素に適用されない書式は無視されます。

属性:

NonCopyable

true

データ型: cell

CustomAttributes — ドキュメント要素のカスタム属性

[] (既定値) | mlreportgen.dom.CustomAttribute オブジェクトの配列

このドキュメント要素のカスタム属性。mlreportgen.dom.CustomAttribute オブジェクトの配列として指定します。カスタム属性は、このオブジェクトが追加されるドキュメント要素の出力形式でサポートされていなければなりません。

属性:

NonCopyable

true

Parent — mlreportgen.dom.TableHeaderEntry オブジェクトの親

ドキュメント要素オブジェクト

mlreportgen.dom.TableHeaderEntry オブジェクトの親。ドキュメント要素オブジェクトとして指定します。ドキュメント要素の親は 1 つでなければなりません。

属性:

SetAccess	private
NonCopyable	true

Children — mlreportgen.dom.TableHeaderEntry オブジェクトの子

ドキュメント要素オブジェクトの配列

mlreportgen.dom.TableHeaderEntry オブジェクトの子。ドキュメント要素オブジェクトの配列として指定します。このプロパティには、append メソッドを使用して追加されたドキュメント要素オブジェクトが含まれます。

属性:

SetAccess	private
NonCopyable	true

Tag — mlreportgen.dom.TableHeaderEntry オブジェクトのタグ

文字ベクトル | string スカラー

mlreportgen.dom.TableHeaderEntry オブジェクトのタグ。文字ベクトルまたは string スカラーとして指定します。DOM API は、このオブジェクトを作成するときに、セッション固有タグを生成します。生成されるタグの形式は CLASS:ID という形式です。ここで、CLASS はオブジェクト クラスです。ID はオブジェクトの Id プロパティの値です。独自のタグ値を指定すると、ドキュメント生成中に問題が発生したときにどこを確認すればよいかを特定しやすくなります。

属性:

NonCopyable

true

データ型: char | string

Id — mlreportgen.dom.TableHeaderEntry オブジェクトの識別子

文字ベクトル | string スカラー

mlreportgen.dom.TableHeaderEntry オブジェクトのオブジェクト識別子。文字ベクトルまたは string スカラーとして指定します。DOM API は、ドキュメント要素オブジェクトの作成時にセッション固有識別子を生成します。Id には独自の値を指定できます。

属性:

NonCopyable

true

データ型: char | string

メソッド

パブリック メソッド

TableHeaderEntry.append メソッドおよび TableHeaderEntry.clone メソッドは、Paragraph.append および Paragraph.clone と同じ方法で使用します。

メソッド	目的
append	テキスト、段落、イメージ、テーブル、および他の要素をこのエントリに追加します。
clone	このテーブル ヘッダー エントリをクローンします。

バージョン履歴

R2014b で導入

参考

mlreportgen.dom.TableHeader | mlreportgen.dom.TableFooter | mlreportgen.dom.FormalTable | mlreportgen.dom.TableBody | mlreportgen.dom.TableRow

トピック

• 略式テーブルの作成