mlreportgen.utils.word クラス

名前空間: mlreportgen.utils

Microsoft Word および Word ドキュメントの操作

説明

mlreportgen.utils.word クラスの静的メソッドを使用して、Microsoft^® Word アプリケーションおよび Word ドキュメントを操作します。これらのメソッドは、Microsoft .NET Framework への MATLAB^® インターフェイスを使用して Word と通信します。

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

クラス属性

HandleCompatible

true

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

メソッド

パブリック メソッド

mlreportgen.utils.word.start	wordApp = mlreportgen.utils.word.start() は、Word アプリケーションがまだ開始されていない場合はそれを開始して、mlreportgen.utils.WordApp オブジェクトを返します。WordApp オブジェクトは、Word エディターをラップする .NET オブジェクトをラップします。Word アプリケーションは表示されません。
mlreportgen.utils.word.load	wordDoc = mlreportgen.utils.word.load(filename) は、filename で指定された既存の Word ドキュメント ファイルを読み込み、mlreportgen.utils.WordDoc オブジェクトを返します。WordDoc オブジェクトは、Word ドキュメントをラップする .NET オブジェクトをラップします。 filename を文字ベクトルまたは string スカラーとして指定します。
mlreportgen.utils.word.open	wordDoc = mlreportgen.utils.word.open(filename) は、filename で指定された Word ドキュメントを読み込み、それを表示し、mlreportgen.utils.WordDoc オブジェクトを返します。 WordDoc オブジェクトは、Word ドキュメントをラップする .NET オブジェクトをラップします。 filename を文字ベクトルまたは string スカラーとして指定します。
mlreportgen.utils.word.close	次の構文は、Word アプリケーションを閉じます。また、アプリケーションが閉じられる場合は true を、アプリケーションが開いたままになる場合は false を返します。 tf = mlreportgen.utils.word.close() は、未保存の Word ドキュメントがない場合にのみ Word アプリケーションを閉じます。 tf = mlreportgen.utils.word.close(true) は、未保存の Word ドキュメントがない場合、または MATLAB の外部で開いている Word ドキュメントがない場合にのみ、Word アプリケーションを閉じます。 tf = mlreportgen.utils.word.close(false) は、未保存の Word ドキュメントまたは MATLAB の外部で開かれている Word ドキュメントがある場合でも、Word アプリケーションを閉じます。 次の構文は、filename で指定された Word ドキュメントを閉じます。Word ドキュメントが閉じられる場合は true を返し、Word ドキュメントが開いたままになる場合は false を返します。また、開いている Word ドキュメントがない場合は Word アプリケーションを非表示にします。 tf = mlreportgen.utils.word.close(filename) は、未保存の変更がない場合にのみ、指定された Word ドキュメント ファイルを閉じます。 tf = mlreportgen.utils.word.close(filename,true) は、未保存の変更がない場合にのみ、指定された Word ドキュメント ファイルを閉じます。 tf = mlreportgen.utils.word.close(filename,false) は、未保存の変更がある場合でも、指定された Word ドキュメント ファイルを閉じます。 filename を文字ベクトルまたは string スカラーとして指定します。
mlreportgen.utils.word.closeAll	次の構文は、開いているすべての Word ドキュメントを閉じます。すべての Word ドキュメントが閉じられる場合は true を返し、Word ドキュメントが開いたままになる場合は false を返します。また、開いている Word ドキュメントがない場合は Word アプリケーションを非表示にします。 tf = mlreportgen.utils.word.closeAll() は、すべての Word ドキュメント ファイルを閉じます。 tf = mlreportgen.utils.word.closeAll(true) は、未保存の変更がない場合にのみ、すべての Word ドキュメント ファイルを閉じます。 tf = mlreportgen.utils.word.closeAll(false) は、未保存の変更がない場合でも、すべての Word ドキュメント ファイルを閉じます。 filename を文字ベクトルまたは string スカラーとして指定します。
mlreportgen.utils.word.show	wordApp = mlreportgen.utils.word.show() は、Word アプリケーションを表示し、関連付けられた mlreportgen.utils.WordApp オブジェクトを返します。 wordApp = mlreportgen.utils.word.show(filename) は、filename で指定された Word ドキュメント ファイルを表示し、関連付けられた mlreportgen.utils.WordDoc オブジェクトを返します。 filename を文字ベクトルまたは string スカラーとして指定します。
mlreportgen.utils.word.hide	wordApp = mlreportgen.utils.word.hide() は、Word アプリケーションを非表示にし、アプリケーションに関連付けられた mlreportgen.utils.WordApp オブジェクトを返します。 wordApp = mlreportgen.utils.word.hide(filename) は、filename で指定された Word ドキュメント ファイルを非表示にし、関連付けられた mlreportgen.utils.WordDoc オブジェクトを返します。 filename を文字ベクトルまたは string スカラーとして指定します。
mlreportgen.utils.word.filenames	files = mlreportgen.utils.word.filenames() は、開いている Word ドキュメントのファイル名を string 配列として返します。
mlreportgen.utils.word.isAvailable	tf = mlreportgen.utils.word.isAvailable() は、Word が使用できる場合は true を返し、Word が使用できない場合は false を返します。
mlreportgen.utils.word.isStarted	tf = mlreportgen.utils.word.isStarted() は、Word アプリケーションが開始されている場合は true を返し、Word アプリケーションが開始されていない場合は false を返します。
mlreportgen.utils.word.isLoaded	tf = mlreportgen.utils.word.isLoaded(filename) は、filename で指定された Word ドキュメントが読み込まれている場合は true を返し、読み込まれていない場合は false を返します。 filename を文字ベクトルまたは string スカラーとして指定します。
mlreportgen.utils.word.wordapp	wordApp = mlreportgen.utils.word.wordapp() は、Word アプリケーションに関連付けられた mlreportgen.utils.WordApp オブジェクトを返します。また、アプリケーションが開始されていない場合はエラーを返します。
mlreportgen.utils.word.worddoc	wordDoc = mlreportgen.utils.word.worddoc(filename) は、filename で指定された Word ドキュメント ファイルに関連付けられた mlreportgen.utils.WordDoc オブジェクトを返します。また、Word ドキュメント ファイルが開かれていない場合はエラーを返します。 filename を文字ベクトルまたは string スカラーとして指定します。

例

Word ドキュメントを開く

Word ファイルの test.docx と test1.docx が C: ドライブの mydocs という名前のフォルダーにあるとします。mlreportgen.utils.word.open を使用してファイルを開きます。

wordDoc = mlreportgen.utils.word.open("test")
wordDoc1 = mlreportgen.utils.word.open("test1") 

wordDoc = 

  WordDoc with properties:

    FileName: "C:\mydocs\test.docx"


wordDoc1 = 

  WordDoc with properties:

    FileName: "C:\mydocs\test1.docx"

ドキュメント ファイル名の取得

Word ファイル test.docx および test1.docx が C: ドライブの mydocs という名前のフォルダーにあり、mlreportgen.utils.word.open を使用してそれらを開いたとします。

mlreportgen.utils.word.filenames を使用して、開いている Word ドキュメント ファイルのファイル名を取得します。

files = mlreportgen.utils.word.filenames()

files = 

  1×2 string array

    "C:\mydocs\test.docx"    "C:\mydocs\test1.docx"

制限

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

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

バージョン履歴

R2018b で導入

参考

mlreportgen.utils.WordDoc | mlreportgen.utils.WordApp

トピック

• Microsoft .NET の利用開始