mlreportgen.utils.WordDoc クラス

名前空間: mlreportgen.utils

Microsoft Word ドキュメント ファイルのラップ

説明

このユーティリティは、Word ドキュメント ファイル (.docx または .rtf) をオブジェクトにラップします。その後、このユーティリティのメソッドを使用してオブジェクトを操作することができます。

mlreportgen.utils.WordDoc クラスは handle クラスです。

作成

説明

docobj = mlreportgen.utils.WordDoc(filename) は Word ドキュメント ファイルをラップし、Word ドキュメント オブジェクトとして返します。各 Word ドキュメント ファイルに対して存在できる WordDoc オブジェクトは 1 つだけです。

入力引数

filename — Word ドキュメント ファイルへのパス

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

Word ドキュメント ファイルへのパス。文字ベクトルまたは string スカラーとして指定します。

プロパティ

FileName — Word ドキュメント ファイルへのパス

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

Word ドキュメント ファイルへのパス。文字ベクトルまたは string スカラーとして指定します。

属性:

GetAccess	public
SetAccess	private

データ型: char | string

メソッド

パブリック メソッド

show	Word ドキュメントを表示可能にする show(wordDoc)
hide	Word ドキュメントを非表示にする hide(wordDoc)
close	Word ドキュメントを閉じる close(wordDoc) または close(wordDoc,true) は、未保存の変更がない場合にのみ Word ドキュメントを閉じる close(wordDoc,false) は、変更が保存されていない場合でも Word ドキュメントを閉じる
save	Word ドキュメントを保存する save(wordDoc)
update	Word ドキュメントのフィールドを更新する update(wordDoc) update(wordDoc,0) は、保存されていないドキュメント フィールドがあっても強制的に更新する
print	Word ドキュメントを印刷する print(wordDoc) は、A4 または 8.5×11 の用紙サイズに合わせてコンテンツをスケーリングすることなく、指定された Word ドキュメントを印刷する print(wordDoc,"ScaleToFitPaper", true) は、A4 または 8.5×11 の用紙サイズに合わせてコンテンツをスケーリングして、指定された Word ドキュメントを印刷する print(wordDoc,"ScaleToFitPaper", false) は、A4 または 8.5×11 の用紙サイズに合わせてコンテンツをスケーリングすることなく、指定された Word ドキュメントを印刷する
saveAsDoc	指定したファイル名で Word 文書を保存する saveAsDoc(wordDoc) は、同じファイル名でドキュメント ファイルを保存する docFullPath = saveAsDoc(wordDoc,docFileName) は、指定されたファイル名でドキュメント ファイルを保存する
exportToPDF	PDF ドキュメントにエクスポートする exportToPDF(wordDoc) は、同じファイル名で PDF ドキュメントにエクスポートする pdfFullPath = exportToPDF(wordDoc,pdfFileName) は、指定したファイル名で PDF ドキュメントにエクスポートする
unlinkFields	Word ドキュメントのフィールドからリンクを削除する unlinkFields(wordDoc) は、すべてのフィールドからリンクを削除する unlinkFields(wordDoc,fieldType1) は、fieldType1 フィールドのすべてのインスタンスからリンクを削除する。たとえば、unlinkFields(wordDoc,’wdHyperLink’) は、すべてのハイパーリンク フィールドを削除する unlinkFields(wordDoc,fieldType1,fieldType2) は、fieldType1 フィールドと fieldType2 フィールド両方のすべてのインスタンスからリンクを削除する Word フィールドの詳細については、Word FieldType 列挙を参照
unlinkSubdocuments	サブドキュメントへのリンクを削除し、サブドキュメントをメイン ドキュメントにコピーする unlinkSubdocuments(wordDoc)
isOpen	Word ドキュメントが開かれているかどうかをテストする isOpen(wordDoc)
isReadOnly	Word ドキュメントが読み取り専用かどうかをテストする isReadOnly(wordDoc)
isSaved	Word ドキュメントが保存済みかどうかをテストする isSaved(wordDoc)
isVisible	Word ドキュメントが表示可能かどうかをテストする isVisible(wordDoc)
netobj	.NET Word ドキュメント オブジェクトを返す。これにより、このオブジェクトで .NET インターフェイスを使用できます。 netobj(wordDoc)

例

WordDoc オブジェクトと .NET オブジェクトの作成

この例では、既存の MyWordDoc.docx ファイルから WordDoc オブジェクトを作成します。

docobj = mlreportgen.utils.WordDoc("MyWordDoc.docx");
netobj(docobj);

制限

• mlreportgen.utils.WordDoc は Microsoft^® Windows^® でのみ使用できます。

• mlreportgen.utils.WordDoc は MATLAB^® Web アプリではサポートされていません。

バージョン履歴

R2018b で導入

参考

mlreportgen.utils.word | mlreportgen.utils.WordApp

外部の Web サイト

• https://learn.microsoft.com/office/vba/api/overview/word