Main Content

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

mlreportgen.dom.PageMargins クラス

名前空間: mlreportgen.dom

Microsoft Word および PDF ページ レイアウトのページ余白

説明

mlreportgen.dom.PageMargins クラスのオブジェクトを使用して、Microsoft® Word レポートまたは PDF レポート セクションのページ余白サイズを指定します。

ページのヘッダーとフッターの作成は、Word ドキュメントと PDF ドキュメントで異なります。たとえば、PDF ページのヘッダーとフッターはサイズが固定されています。Word のヘッダーとフッターは、コンテンツに合わせて拡張されます。したがって、同じ値を使用した上下のページ余白の外観は、出力タイプによって異なる場合があります。

また、出力タイプが異なると、上余白と下余白の処理も異なります。これらの違いにより、同じ余白設定でも改ページ位置が異なる場合があります。

  • PDF の場合、上余白の高さの合計は、このオブジェクトの Top プロパティの値に Header プロパティの高さを加えた値に等しくなります。本文テキストはヘッダーの下から始まります。Word ドキュメントの場合、ヘッダーと本文テキストがオーバーラップしないようにするために、上余白とヘッダーが拡張されます。

  • 同様に、PDF の下余白の高さの合計は、このオブジェクトの Bottom プロパティの値に Footer プロパティの高さを加えた値に等しくなります。本文テキストはフッターの上で終わります。Word ドキュメントの場合、本文テキストがオーバーラップしないようにするために、フッターが拡張されます。

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

クラス属性

HandleCompatible
true
ConstructOnLoad
true

クラス属性の詳細については、クラスの属性を参照してください。

作成

説明

pageMarginsObj = mlreportgen.dom.PageMargins() は、1 インチの上下左右の余白、0.5 インチのヘッダーとフッター、および 0 ピクセルのとじしろを指定するプロパティをもつ PageMargins オブジェクトを作成します。

プロパティ

すべて展開する

上余白のサイズ。数値とそれに続く測定単位の略語で構成される文字ベクトルまたは string スカラーとして指定します。たとえば、'1in' は 1 インチを指定します。有効な略語を以下に示します。

  • px — ピクセル (既定)

  • cm — センチメートル

  • in — インチ

  • mm — ミリメートル

  • pc — パイカ

  • pt — ポイント

下余白のサイズ。数値とそれに続く測定単位の略語で構成される文字ベクトルまたは string スカラーとして指定します。たとえば、'1in' は 1 インチを指定します。有効な略語を以下に示します。

  • px — ピクセル (既定)

  • cm — センチメートル

  • in — インチ

  • mm — ミリメートル

  • pc — パイカ

  • pt — ポイント

左余白のサイズ。数値とそれに続く測定単位の略語で構成される文字ベクトルまたは string スカラーとして指定します。たとえば、'1in' は 1 インチを指定します。有効な略語を以下に示します。

  • px — ピクセル (既定)

  • cm — センチメートル

  • in — インチ

  • mm — ミリメートル

  • pc — パイカ

  • pt — ポイント

右余白のサイズ。数値とそれに続く測定単位の略語で構成される文字ベクトルまたは string スカラーとして指定します。たとえば、'1in' は 1 インチを指定します。有効な略語を以下に示します。

  • px — ピクセル (既定)

  • cm — センチメートル

  • in — インチ

  • mm — ミリメートル

  • pc — パイカ

  • pt — ポイント

ヘッダーのサイズ。数値とそれに続く測定単位の略語で構成される文字ベクトルまたは string スカラーとして指定します。たとえば、'0.5in' は 0.5 インチを指定します。有効な略語を以下に示します。

  • px — ピクセル (既定)

  • cm — センチメートル

  • in — インチ

  • mm — ミリメートル

  • pc — パイカ

  • pt — ポイント

とじしろのサイズ。数値とそれに続く測定単位の略語で構成される文字ベクトルまたは string スカラーとして指定します。たとえば、'0px' は 0 ピクセルを指定します。有効な略語を以下に示します。

  • px — ピクセル (既定)

  • cm — センチメートル

  • in — インチ

  • mm — ミリメートル

  • pc — パイカ

  • pt — ポイント

このドキュメント要素の ID。文字ベクトルまたは string スカラーとして指定します。ドキュメント要素を作成するときに、DOM によってセッション固有 ID が生成されます。独自の ID を指定できます。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

データ型: char | string

このドキュメント要素のタグ。文字ベクトルまたは string スカラーとして指定します。

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

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

データ型: char | string

すべて折りたたむ

ドキュメント レイアウト オブジェクトに関連付けられた PageMargins オブジェクトで、0.5 インチの余白を指定します。

import mlreportgen.dom.*;
d = Document('myreport','docx');
open(d);
 
pageLayoutObj = d.CurrentPageLayout;
pageLayoutObj.PageMargins.Left  = '0.5in';
pageLayoutObj.PageMargins.Right = '0.5in';
append(d,'Left and right margins are 0.5 inches.');

close(d);
rptview(d);

mlreportgen.dom.PageMargins オブジェクトを使用して、0.5 インチの余白を指定します。オブジェクトをレポート レイアウト オブジェクトの PageMargins プロパティに割り当てます。

import mlreportgen.report.*;
import mlreportgen.dom.*;

rpt = Report('myreport','docx');
open(rpt);
 
pageMarginsObj = PageMargins();
pageMarginsObj.Left = '0.5in';
pageMarginsObj.Right = '0.5in';
rpt.Layout.PageMargins = pageMarginsObj;

append(rpt,'Left and right margins are 0.5 inches.');
close(rpt);
rptview(rpt);

バージョン履歴

R2016a で導入