Microsoft Word コネクタのメソッド
Microsoft Word コネクタのメソッドを使用すると、Microsoft Word ドキュメントを使用してさまざまな日常のタスクを実行し、それらを自動化できます。たとえば、ページフッターを追加します。
オープン
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| Filepath | ローカルディスク内の Microsoft Word ファイルへのパスを指定します。 | データ入力 | 文字列 |
| Timeout | 処理がタイムアウトするまでの時間を指定します。 | データ入力 | 整数 |
| Password | ドキュメントがパスワードで保護されている場合は、パスワードを使用します。 | データ入力 | 文字列 |
| Return | 処理の結果を示すブール値を返します。True の場合、ファイルは開かれました。False の場合、ファイルは開けませんでした。 | データ出力 | ブーリアン |
Open メソッドに関連する問題の詳細については、『KB 記事 KB1123558』および『KB 記事 KB1123548』を参照してください。
AddFooter
指定されたフォントサイズで Microsoft Word ドキュメントにフッターを追加します。
このメソッドを使用するには、追加するテキストをテキストパラメーターに指定し、フッターテキストを表示するフォントサイズを FontSize パラメーターに指定します。FontSize パラメーターのデフォルト値は 12 です。
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| テキスト | フッターのテキストを指定します。 | データ入力 | 文字列 |
| FontSize | フッターのテキストのフォントサイズを指定します。デフォルト値は 12 です。 | データ入力 | 整数 |
入力するには、「ポートのプロパティを設定する」を参照してください。
AddHeader
指定したフォントサイズで Microsoft Word ドキュメントにヘッダーを追加します。
このメソッドを使用するには、追加するテキストをテキストパラメーターに指定し、ヘッダーテキストを表示するフォントサイズを FontSize パラメーターに指定します。FontSize パラメーターのデフォルト値は 12 です。
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| テキスト | ヘッダーのテキストを指定します。 | データ入力 | 文字列 |
| FontSize | ヘッダーのテキストのフォントサイズを指定します。デフォルト値は 12 です。 | データ入力 | 整数 |
CellCopy
Microsoft Wordドキュメント内のテーブルの行インデックスと列インデックスを使用して、識別されたテーブルセルの内容をコピーします。
このメソッドを使用するには、行インデックスを RowIndex パラメーターに、列インデックスを ColumnIndex パラメーターに指定します。RowIndex と ColumnIndex のデフォルト値は、それぞれ -1 です。
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| RowIndex | コピーする必要があるセルの行のインデックス。行インデックス値はゼロ以上である必要があります。デフォルト値は -1 で、使用可能なセルがないことを意味します。 | データ入力 | 整数 |
| ColumnIndex | コピーする必要があるセルの列のインデックス。列インデックスはゼロ以上である必要があります。デフォルト値は -1 で、使用可能なセルがないことを意味します。 | データ入力 | 整数 |
CellPaste
コピーしたテーブルセルの内容を、 Microsoft Word ドキュメント内のテーブルの行インデックスと列インデックスを使用して識別されるテーブルセルに貼り付けます。
このメソッドを使用するには、行インデックスを RowIndex パラメーターに、列インデックスを ColumnIndex パラメーターに指定します。RowIndex と ColumnIndex のデフォルト値は、それぞれ -1 です。
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| RowIndex | データを貼り付ける必要があるセルの行のインデックス。行インデックス値はゼロ以上である必要があります。デフォルト値は -1 で、データを貼り付けるための行がないことを意味します。 | データ入力 | 整数 |
| ColumnIndex | データを貼り付ける必要があるセルの列のインデックス。列インデックスはゼロ以上である必要があります。デフォルト値は -1 で、データを貼り付けるための列がないことを意味します。 | データ入力 | 整数 |
Close
最後に開いた Microsoft Word ドキュメントを閉じます。ドキュメントを閉じるときに、変更を保存するかどうかは任意です。
Word ドキュメントに加えられた変更を保存する必要がある場合は、saveChanges ブールパラメーターを True に設定し、それ以外の場合は False に設定します。デフォルトでは、saveChanges ブールパラメーターは True に設定されています。
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| saveChanges | 閉じる前に Word ドキュメントに加えた変更を保存するかどうかを指定します。デフォルトでは True に設定されており、閉じる前に変更が保存されることを意味します。閉じる前に変更を保存する必要がない場合は、False に設定します。 | データ入力 | ブーリアン |
DeleteColumn
Microsoft Word ドキュメント内の列の指定されたインデックス値に基づいて、テーブルから列を削除します。
このメソッドを使用するには、削除する必要がある列のインデックスを ColumnIndex パラメーターに指定します。デフォルト値は -1 です。
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| ColumnIndex | 削除する必要がある列のインデックス。列インデックスはゼロ以上である必要があります。デフォルト値は -1 で、削除できる列がないことを意味します。 | データ入力 | 整数 |
DeletePage
Microsoft Word ドキュメントから指定されたインデックス値に基づいて、ページを削除します。
このメソッドを使用するには、削除する必要があるページのインデックス値を PageIndex パラメーターに指定します。
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| PageIndex | 消去または削除する必要があるページのインデックス番号を指定します。 インデックス番号を指定しない場合、メソッドはデフォルトで最初のページを削除します。 |
データ入力 | 整数 |
DeleteRow
Microsoft Word ドキュメント内のテーブルから指定されたインデックス値に基づいて、行を削除します。
このメソッドを使用するには、削除する必要がある行のインデックスを RowIndex パラメーターに指定します。デフォルト値は -1 です。
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| RowIndex | 削除する必要がある行のインデックス。行インデックス値はゼロ以上である必要があります。デフォルト値は -1 で、削除できる行がないことを意味します。 | データ入力 | 整数 |
DeleteTable
Microsoft Word ドキュメントからテーブルを削除します。
ドキュメント内に複数のテーブルがある場合、メソッドはドキュメント内の最初のテーブルを削除します。
ExportToPDF
指定したパスで Microsoft Word ドキュメントを PDF ドキュメントにエクスポートします。
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| Filepath | Word ドキュメントが PDF にエクスポートされるフォルダパスを指定します。 | データ入力 | 文字列 |
Find
Microsoft Word ドキュメント内で指定されたテキストを検索し、ブール応答を返します。
このメソッドを使用するには、ドキュメント内で検索するテキストを Text パラメーターに指定します。
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| Text | Word ドキュメント内で検索するテキストです。 | データ入力 | 文字列 |
| Return | Word ドキュメント内でテキストが見つかったかどうかを示す true/false 値を返します。 | データ出力 | ブーリアン |
GetCellValueByIndex
Microsoft Word ドキュメント内のテーブルのセルの値を返します。
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| CellIndex | 値を取得するセルのインデックスです。 | データ入力 | 文字列 |
| Return | 必要なセルに存在する値を返します。 | データ出力 | 文字列 |
GetFooterText
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| Return | フッターテキストを文字列形式で返します。 | データ出力 | 文字列 |
GetHeaderText
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| Return | ヘッダーテキストを文字列形式で返します。 | データ出力 | 文字列 |
GetPageCount
Microsoft Word ドキュメントの総ページ数を返します。
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| Return | Word ドキュメントの合計ページ数の整数値または数値を返します。 | データ出力 | 整数 |
GetRowIndexByValue
行内のセルの指定された値に基づいて、その行のインデックス値を返します。
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| Table | Word ドキュメント内でさらにアクションを実行するための参照としてのテーブルオブジェクト。 | データ入力 | オブジェクト |
| Value | テーブル内の特定の行に対応するテキストを検索します。 | データ入力 | 文字列 |
GetTable
Microsoft Word ドキュメントのテーブルのデータを、テーブルオブジェクトおよびデータテーブルとして返します。ドキュメントに複数のテーブルが含まれている場合は、テーブルインデックスを指定してメソッドのテーブルを識別することができます。必要に応じてテーブルタイプを指定することもできます。
このメソッドを使用するには、想定されたテーブルのインデックスを TableIndex パラメーターに指定します。最初の行をヘッダーとして扱う必要がある場合は、FirstRowIsHeader パラメーターを True に設定し、それ以外の場合は False に設定します。
- メソッド設定アイコン (
) をクリックします。
- テーブルタイプを選択します。
- [OK] をクリックします。
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| データ入力 | |||
| TableIndex | Microsoft Word ドキュメント内のテーブルインデックスです。 | データ入力 | 文字列 |
| FirstRowIsHeader | メソッドが最初の行をテーブルのヘッダーとして扱うかどうかを示すブール値です。 デフォルトでは True に設定されており、最初の行がヘッダーと見なされます。最初の行がヘッダーでない場合は、このパラメーターを False に設定します。 |
データ入力 | ブーリアン |
| Table | テーブル内のデータをオブジェクトとして返します。 | データ出力 | オブジェクト |
| Data | テーブル内のデータを返します。 | データ出力 | Data |
GetTableCellValues
1 つまたは複数のテーブルセルの値を返します。
このメソッドを使用するには、値が必要なテーブルセルのインデックスを構成ウィンドウに入力します。
- メソッド設定アイコン (
) をクリックします。
- (
) をクリックします。
- セルのインデックス値を入力します。
- さらにインデックス値を追加するには、手順を繰り返します。
- [OK] をクリックします。
GetTableCount
Microsoft Word ドキュメントのテーブル数を返します。オプションで、メソッドが識別するテーブルのタイプを指定できます。
構成ウィンドウからテーブルタイプを選択します。Word ドキュメントでテーブルの合計数を受け取ることを想定する場合は、テーブルタイプを [デフォルト] に設定します。テーブルのセル内にネストされたテーブルの数を想定する場合は、テーブルタイプを [ネスト済み] に設定します。ネストされたテーブルを持つテーブルのインデックスを TableIndex パラメーターに、ネストされたテーブルの数が想定されるテーブルセルインデックスを CellIndex パラメーターに指定します。
- メソッド設定アイコン (
) をクリックします。
- テーブルタイプを選択します。
- [OK] をクリックします。
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| Return | Word ドキュメント内のテーブルの合計数の整数値を返します。 | データ入力 | 整数 |
GetTableRowData
- メソッド設定アイコン (
) をクリックします。
- インデックス値の追加アイコン (
) をクリックします 。
- セルのインデックス値を入力します。
- さらにインデックス値を追加するには、手順を繰り返します。
- [OK] をクリックします。
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| RowIndex | データを取得する必要がある行のインデックス。デフォルト値は 0 で、データは最初の行からフェッチされます。 | データ入力 | 整数 |
GetText
Microsoft Word ドキュメントのすべてのテキストコンテンツを返します。
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| Return | ドキュメント全体のテキストを文字列形式で返します。 | データ出力 | 文字列 |
InsertNewColumn
指定されたインデックス値に基づいて、ドキュメントの最初のテーブルに新しい列を挿入します。
このメソッドを使用するには、新しい列を挿入する必要があるインデックス番号を ColumnIndex パラメーターに指定します。デフォルト値は -1 で、これは列が最初の列の前に挿入されることを意味します。
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| ColumnIndex | 新しい列を挿入する必要があるインデックス。デフォルト値は -1 で、テーブルに列がないことを意味します。 | データ入力 | 整数 |
InsertNewRow
インデックス値に基づいて新しい行を挿入します。
このメソッドを使用するには、新しい列を挿入する必要があるインデックス番号を、RowIndex パラメーターに指定します。デフォルト値は -1 で、これは最初の行の前に行が挿入されることを意味します。
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| RowIndex | 新しい行を挿入する必要があるインデックスです。デフォルト値は -1 で、テーブルに行がないことを意味します。 | データ入力 | 整数 |
InsertPicture
特定のブックマークで指定されたファイルパスから Microsoft Wordドキュメントに画像を挿入します。
このメソッドを使用するには、挿入する必要がある画像のファイルパスを、ImageFilePath パラメーターに指定します。Word ドキュメント内で画像を挿入する必要がある識別場所を Bookmark パラメーターに指定します。
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| ImageFilePath | 挿入する必要がある画像へのシステムフォルダーパス。 | データ入力 | 文字列 |
| Bookmark | 画像を追加する必要があるポイント。 | データ入力 | 文字列 |
InsertTable
Microsoft Word ドキュメントにテーブルを挿入します。挿入する前に設定して、オプションでドキュメントをカスタマイズできます。
このメソッドを使用するには、テーブルを追加する必要があるポイントを Bookmark パラメーターに指定し、追加する必要があるテーブルを Data パラメーターに渡す必要があります。
- メソッド設定アイコン (
) をクリックします。
- [ヘッダーを含める (Include Headers)] を選択します。
- 境界線のスタイルと自動調整の動作を選択します。
- [空の行を含める (Include Empty Rows)] を選択します。
- 特定の列を無視するには、インデックス値の追加アイコン (
) をクリックします 。
- 列のインデックス値を入力します。
- [OK] をクリックします。
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| Bookmark | テーブルが挿入される Word ドキュメント内の特定の位置です。 テーブルを挿入する前に、ブックマークを追加する必要があります。 |
データ入力 | 文字列 |
| Data | ブックマークポイントに挿入されるテーブルデータ。 | データ入力 | データ |
InsertText
Microsoft Word ドキュメントの先頭にテキストを挿入します。
このメソッドを使用するには、挿入する必要がある値を text パラメーターに指定します。
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| text | 挿入する必要があるテキスト値。 | データ入力 | 文字列 |
IsOpen
Microsoft Word ドキュメントが開いているかどうかを確認します。
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| Filepath | Word ドキュメントまたはファイルへのシステムフォルダーパスです。 | データ入力 | 文字列 |
| Return | Word ドキュメントまたはファイルへのシステムフォルダーパスです。 | データ出力 | ブーリアン |
MergeByCellIndices
インデックス値の範囲の形式で指定されたセル範囲を結合します。
このメソッドを使用するには、開始セルのインデックス値を StartCellIndex パラメーターに指定し、終了セルのインデックス値を EndCellIndex パラメーターに指定します。
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| StartCellIndex | セルの結合を開始する開始セルポイントのインデックスです。 | データ入力 | 整数 |
| EndCellIndex | セルの結合を終了する終了セルポイントのインデックスです。 | データ入力 | 整数 |
MergeByRowCol
Microsoft Word ドキュメント内のテーブルのセル範囲を結合します。
このメソッドを使用するには、開始行インデックスを StartRowIndex パラメーターに、終了行インデックスを EndRowIndex パラメーターに、開始列インデックスを StartColIndex パラメーターに、終了列インデックスを EndColIndex パラメーターに指定します。
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| StartRowIndex | 開始行のインデックス。 | データ入力 | 整数 |
| StartColIndex | 開始列のインデックス。 | データ入力 | 整数 |
| EndRowIndex | 終了行のインデックス。 | データ入力 | 整数 |
| EndColIndex | 終了列のインデックス。 | データ入力 | 整数 |
ReplaceBookmark
Microsoft Word ドキュメント内のブックマークを指定されたテキストに置き換えます。
このメソッドを使用するには、ReplaceText パラメーターに指定された置換対象のテキストを使用して、Bookmark パラメーターに識別ブックマークを指定します。
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| Bookmark | Word ドキュメントの識別ブックマーク。 | データ入力 | 文字列 |
| ReplaceText | ブックマークされた場所のテキストを、指定された新しい値に置き換えます。 | データ入力 | 文字列 |
ReplaceBookmarks
Microsoft Word ドキュメント内の複数のブックマークを検索して、指定されたテキストに置き換えます。
このメソッドを使用するには、追加されたフィールドに値を指定します。この値は、ブックマークで置き換える必要があるテキストです。
- コンポーネントをダブルクリックします。
- [ラベル / ブックマークを指定 (PROVIDE LABELS/BOOKMARKS)] ダイアログボックスで、クリックしてラベルを追加アイコン (
) をクリックし、置き換えるためのブックマークを入力します。
さらにブックマークを追加するには、この手順を繰り返します。
- [OK] をクリックします。
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| Text | Microsoft Word ドキュメント内で置換されるテキスト。 | データ入力 | 文字列 |
ReplaceFooterText
Microsoft Word ドキュメント内のフッターテキストを検索して、指定されたテキストに置き換えます。
Word ドキュメントに存在する元のフッターテキスト値を FindText パラメーターに指定し、元のフッターテキストを置き換える必要があるテキストを ReplaceText パラメーターに指定します。
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| FindText | フッターに存在する現在の値。 | データ入力 | 文字列 |
| ReplaceText | フッターで FindText 値を置き換えるために必要な値。 | データ入力 | 文字列 |
ReplaceHeaderText
Microsoft Word ドキュメント内のヘッダーテキストを検索して、指定されたテキストに置き換えます。
Word ドキュメントに存在する元のヘッダーテキスト値を FindText パラメーターに指定し、元のヘッダーテキストを置き換える必要があるテキストを ReplaceText パラメーターに指定します。
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| FindText | ヘッダーに存在する現在の値。 | データ入力 | 文字列 |
| ReplaceText | ヘッダー内で FindText 値を置き換えるために必要な値。 | データ入力 | 文字列 |
ReplaceStaticText
Microsoft Word ドキュメント内のテキストを検索して、指定されたテキストに置き換えます。設定に基づいて、ブックマーク、見出し、または任意のテキストを置き換えます。
このメソッドを使用するには、追加されたフィールドに値を指定します。この値は、ラベル/ブックマークに置き換える必要があるテキストです。
- メソッド設定アイコン (
) をクリックします。
- テキスト追加アイコン (
) をクリックします。
- 置き換えるための見出し、ブックマーク、またはテキストを入力します。
- さらにテキストを入力するには、手順を繰り返します。
- [OK] をクリックします。
ReplaceText
Microsoft Word ドキュメント内のテキストを検索して、指定されたテキストに置き換えます。
Word ドキュメントに存在する元のテキスト値を FindText パラメーターに指定し、元のテキストを置き換える必要があるテキストを ReplaceText パラメーターに指定します。
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| FindText | Word ドキュメントに存在する現在の値。 | データ入力 | 文字列 |
| ReplaceText | Word ドキュメント内で FindText 値を置き換えるために必要な値。 | データ入力 | 文字列 |
Resize
Microsoft Word ドキュメントのウィンドウのサイズを、Left、Top、Width、Height のパラメータに従って変更します。
このメソッドを使用するには、コンテンツの Left マージンと Top マージン、および Width パラメーターと Height パラメーターを指定します。
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| Left | Word ドキュメントのコンテンツの左マージン。 | データ入力 | 整数 |
| Top | Word ドキュメントのコンテンツの上マージン。 | データ入力 | 整数 |
| Width | Word ドキュメントの幅。 | データ入力 | 整数 |
| Height | Word ドキュメントの高さ。 | データ入力 | 整数 |
Save
開いている Microsoft Word ドキュメントを保存します。
SaveAs
開いている Microsoft Word ドキュメントのコピーを、Filepath パラメーターで指定された場所に別の名前で保存します。
このメソッドを使用するには、 Microsoft Word ドキュメントを保存する必要がある新しい場所を Filepath パラメーターに指定します。ファイルをパスワードで保護する必要がある場合は、その値を Password パラメーターに渡します。
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| Filepath | Word ドキュメントまたはファイルへのシステムフォルダーパスです。 | データ入力 | 文字列 |
| Password | 指定されたパスワードを使用して、パスワードで保護された Word ドキュメントを開きます。デフォルト値は空です。 | データ入力 | 文字列 |
SetTable
Microsoft Word ドキュメントにテーブルを設定します。
このメソッドを使用するには、テーブルオブジェクトを Table パラメーターに渡す必要があります。
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| Table | Word ドキュメントに設定する必要があるテーブル。 | データ入力 | オブジェクト |
SetTableCellValues
Microsoft Word ドキュメント内のテーブルセルの内容を設定します。
このメソッドを使用するには、値を設定する必要があるテーブルセルのインデックスを構成ウィンドウで指定します。
- コンポーネントをダブルクリックします。
- [セルインデックスを指定 (PROVIDE CELL INDEXES)] ダイアログボックスで、クリックしてセルインデックスを追加アイコン (
) をクリックし、セルインデックスを入力して値タイプを選択します。
さらにセルインデックスと値タイプを追加するには、この手順を繰り返します。
- [OK] をクリックします。
SetTableRowData
Microsoft Word ドキュメントのテーブルの行の内容を設定します。
- 入力
- RowIndex 列インデックスを次のように指定します。
- コンポーネントをダブルクリックします。
- [列インデックスを指定 (PROVIDE COLUMN INDEXES)] ダイアログボックスで、クリックしてセルインデックスを追加アイコン (
) をクリックし、列インデックスを入力します。
- [OK] をクリックします。
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| RowIndex | データを設定する必要がある行のインデックス。デフォルト値は 0 で、データは最初の行に設定されます。 | データ入力 | 整数 |