Main Content

mlreportgen.dom.DOCXSubDoc クラス

パッケージ: mlreportgen.dom

外部 Microsoft Word ドキュメントへの参照

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

説明

mlreportgen.dom.DOCXSubDoc クラスのオブジェクトを使用して、Word、PDF、または HTML のドキュメント内で外部 Microsoft® Word ドキュメントへの参照を作成します。参照ドキュメント ("サブ文書" とも呼ばれる) へのリンクは、DOCXSubDoc オブジェクトを追加する親文書に挿入されます。

Word で親文書を最初に開くと、コンテンツではなくサブ文書へのリンクが表示されます。リンクをコンテンツに置き換えるには、Word ツールストリップの [表示] タブの [アウトライン] タブから [サブ文書の展開] を選択します。rptview コマンドは、Word ドキュメントを開くときにサブ文書を展開します。docview を使用して、サブ文書を展開およびリンク解除することもできます。

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

クラス属性

ConstructOnLoad
true
HandleCompatible
true

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

作成

説明

docxSubDocObj = mlreportgen.dom.DOCXSubDoc() は空のドキュメント参照を作成します。

例

docxSubDocObj = mlreportgen.dom.DOCXSubDoc(path) は、指定されたパスで Word ドキュメントへの参照を作成し、Target プロパティを path に設定します。

プロパティ

すべて展開する

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

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

この DOM API オブジェクトのタグ。文字ベクトルまたは string スカラーとして指定します。

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

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

この参照の対象となるドキュメントのパス。文字ベクトルまたは string スカラーとして指定します。ASCII 文字を使用します。マッピング済みのドライブを含めて絶対パスを指定するには、次の形式を使用します。

'file:///C:/UserPath/FileName.docx'

属性:

GetAccess
public
SetAccess
immutable
Transient
true
NonCopyable
true

メソッド

すべて展開する

例

すべて折りたたむ

スクリプトを開く
import mlreportgen.dom.*

info = Document('CompanyInfo','docx');
append(info,'XYZ, Inc., makes widgets.');
close(info);

infoPath = info.OutputPath;

rpt = Document('Report','docx');
open(rpt);

append(rpt,Paragraph('About XYZ, Inc.'));

append(rpt,DOCXSubDoc(infoPath));

close(rpt);
rptview(rpt.OutputPath);

代替機能

mlreportgen.dom.EmbeddedObject

別のドキュメントに Word ドキュメント以外のドキュメントを挿入するには、mlreportgen.dom.EmbeddedObject クラスのオブジェクトを使用します。

別のドキュメントに Word ドキュメントを挿入するには、DOCXSubDoc クラスまたは EmbeddedObject クラスのオブジェクトを使用できます。使用するクラスを決定するには、次のガイドラインを考慮してください。

  • 親文書に最初にサブ文書へのリンクを表示する場合は、DOCXSubDoc オブジェクトを使用します。アウトライン ビューで親文書がサブ文書のセットにリンクしているときに、最初にリンクを表示したい場合があります。サブ文書のコンテンツを親文書に表示する場合は、親文書を Word で開くか rptview を使用して開くかに関係なく、EmbeddedObject オブジェクトを使用します。

  • サブ文書を移動せずに親文書を移動する場合は、EmbeddedObject オブジェクトを使用します。

バージョン履歴

R2014b で導入

参考

| | |