このページの内容は最新ではありません。最新版の英語を参照するには、ここをクリックします。

mlreportgen.dom.PDFPageHeader クラス

名前空間: mlreportgen.dom

PDF ドキュメントのページ ヘッダー定義

このページをすべて展開する

説明

セクションの先頭ページ、奇数ページ、偶数ページ、またはその両方にヘッダーを追加します。

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

作成

説明

pdfHeader = PDFPageHeader は、既定の PDF テンプレートに基づいて空のページ ヘッダーを作成します。

pdfHeaderer = PDFPageHeader(pageType) は、既定の PDF テンプレートに基づいて、指定したタイプのページ (奇数、偶数、または先頭) のページ ヘッダーを作成します。

PageHeader = PDFPageHeader(pageType,templatePath) は、指定したテンプレートに基づいて、指定したタイプのページのページ ヘッダーを作成します。

pdfHeader = PDFPageHeader(pageType,templatePath,docPartTemplateName) は、指定したテンプレート内にある指定のドキュメント パーツ テンプレートに基づいて、指定したタイプのページのページ ヘッダーを作成します。

pdfHeader = PDFPageHeader(pageType,templateSrc,docPartTemplateName) は、指定したソースが使用する指定のドキュメント パーツ テンプレートに基づいて、指定したタイプのページのページ ヘッダーを作成します。ソースに指定できるのはドキュメントまたはドキュメント パーツです。

入力引数

すべて展開する

ヘッダーを表示するページのタイプ。次の値のいずれかとして指定します。

  • default — セクションの奇数ページのヘッダー、偶数ページのヘッダー (偶数ページのヘッダーを指定しない場合)、および先頭ページのヘッダー (先頭ページのヘッダーを指定しない場合)。

  • first — セクションの先頭ページのヘッダー。

  • even — セクション内の偶数ページのヘッダー。

たとえば、セクションの先頭ページに空のヘッダーを表示し、他のページに別のヘッダーを表示するには、2 つのヘッダーを定義します。1 つは pageType を first に設定し、もう 1 つは pageType を default に設定します。

ヘッダー テンプレートの絶対パス。string スカラーまたは文字ベクトルとして指定します。

データ型: char | string

このパーツのテンプレートの名前 (templatePath または templateSrc 引数で指定されたテンプレートに格納されている場合)。文字ベクトルまたは string スカラーとして指定します。

このドキュメント パーツのテンプレートを包含するテンプレートをもつドキュメントまたはドキュメント パーツのオブジェクト。ドキュメントの場合は mlreportgen.dom.Document オブジェクト、ドキュメント パーツの場合は mlreportgen.dom.DocumentPart オブジェクトとして指定します。

プロパティ

すべて展開する

ドキュメントのカレント ホールの ID。文字ベクトルまたは string スカラーとして指定します。

属性:

GetAccess
public
SetAccess
private
Transient
true
NonCopyable
true

データ型: char | string

カレント テンプレート ホールのタイプ。"Inline" または "Block" として指定します。

  • インライン ホールは、段落要素が含むことのできるドキュメント要素 (Text、Image、LinkTarget、ExternalLink、InternalLink、CharEntity、または AutoNumber) を対象とする。

  • ブロック ホールは、Paragraph、Table、OrderedList、UnorderedList、DocumentPart、または Group の要素を含むことができる。

属性:

GetAccess
public
SetAccess
private
Transient
true
NonCopyable
true

データ型: char | string

このドキュメントの現在のページ レイアウト。mlreportgen.dom.DOCXPageLayout オブジェクト、mlreportgen.dom.PDFPageLayout オブジェクト、または [] として指定します。このプロパティは、Word ドキュメントと PDF ドキュメントに適用されます。Word ドキュメントの場合、この値は現在のページ レイアウトを指定する DOCXPageLayout オブジェクトになります。PDF ドキュメントの場合、ドキュメントによってページ レイアウトが現在指定されていれば、この値は PDFPageLayout オブジェクトになります。HTML ドキュメントの場合、この値は常に [] になります。

属性:

GetAccess
public
SetAccess
private
Transient
true
NonCopyable
true

ヘッダーを表示するページのタイプ。次の値のいずれかとして指定します。

  • "default" — セクションの奇数ページのヘッダー、偶数ページのヘッダー (偶数ページのヘッダーを指定しない場合)、および先頭ページのヘッダー (先頭ページのヘッダーを指定しない場合)。

  • "first" — セクションの先頭ページのヘッダー。

  • "even" — セクション内の偶数ページのヘッダー。

たとえば、先頭ページに空のヘッダーを表示し、他のページに別のヘッダーを表示するには、2 つのヘッダーを定義します。1 つは pageType を "first" に設定し、もう 1 つは pageType を "default" に設定します。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

データ型: char | string

ヘッダー テンプレートの絶対パス。string スカラーまたは文字ベクトルとして指定します。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

データ型: char | string

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

属性:

GetAccess
public
SetAccess
private
NonCopyable
true

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

属性:

GetAccess
public
SetAccess
private
NonCopyable
true

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

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

データ型: char | string

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

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

データ型: char | string

メソッド

すべて展開する

バージョン履歴

R2016a で導入

参考

| | | |

トピック