Microsoft Word コネクタのメソッド

  • リリースバージョン: Washingtondc
  • 更新日 2024年02月01日
  • 読む12読むのに数分

    • Microsoft Word コネクタのメソッドを使用すると、Microsoft Word ドキュメントを使用してさまざまな日常のタスクを実行し、それらを自動化できます。たとえば、ページフッターを追加します。

    オープン

    ローカルディスクに保存されている Microsoft Word ファイルを開きます。
    注:
    このメソッドは、Microsoft Word コネクタの他のメソッドの前に実行する必要があります。
    表 : 1. Open メソッドのパラメーター
    パラメーター 説明 データポートタイプ データタイプ デフォルト値 必須？
    Filepath ローカルディスク内の Microsoft Word ファイルへのパスを指定します。 データ入力 文字列 デフォルト値なし はい
    タイムアウト 処理がタイムアウトするまでの時間を指定します。 データ入力 整数 デフォルト値なし いいえ
    パスワード ドキュメントがパスワードで保護されている場合は、パスワードを使用します。 データ入力 文字列 なし いいえ
    戻る 処理の結果を示すブール値を返します。True の場合、ファイルは開かれました。False の場合、ファイルは開けませんでした。 データ出力 ブール 適用外 適用外

    Open メソッドに関連する問題の詳細については、『KB 記事 KB1123558』および『KB 記事 KB1123548』を参照してください。

    AddFooter

    Microsoft Word ドキュメントにフッターを追加します。
    注:
    このメソッドを実行する前に、Open メソッドを実行する必要があります。
    表 : 2. AddFooter メソッドのパラメーター
    パラメーター 説明 データポートタイプ データタイプ デフォルト値 必須？ メモ
    テキスト フッターのテキストを指定します。 データ入力 文字列 デフォルト値なし はい
    FontSize フッターのフォントサイズを指定します。 データ入力 整数 デフォルト値なし はい

    入力するには、「ポートのプロパティを設定する」を参照してください。

    AddHeader

    Microsoft Word ドキュメントにヘッダーを追加します。
    注:
    このメソッドを実行する前に、Open メソッドを実行する必要があります。
    表 : 3. AddHeader メソッドのパラメーター
    パラメーター 説明 データポートタイプ データタイプ デフォルト値 必須？ メモ
    テキスト ヘッダーのテキストを指定します。 データ入力 文字列 デフォルト値なし はい
    FontSize ヘッダーのフォントサイズを指定します。 データ入力 整数 デフォルト値なし はい

    CellCopy

    Microsoft Word ドキュメント内のテーブルセルの内容をコピーします。
    注:
    このメソッドを実行する前に、SetTable メソッドを実行する必要があります。
    入力
    RowIndex、ColumnIndex

    CellPaste

    Microsoft Word ドキュメント内のテーブルセルにコピーされたテーブルセルの内容を貼り付けます。
    注:
    このメソッドを実行する前に、CellCopy メソッドを実行する必要があります。
    入力
    RowIndex、ColumnIndex

    クローズ

    最後に開いた Microsoft Word ドキュメントを閉じます。
    注:
    このメソッドを実行する前に、Open メソッドを実行する必要があります。
    表 : 4. Close メソッドのパラメーター
    パラメーター 説明 データポートタイプ データタイプ デフォルト値 必須？ メモ
    saveChanges ドキュメントを保存するか、または変更を保存せずにドキュメントを閉じるかをブール値で指定します。True の場合、変更は保存されます。False の場合、変更は保存されません。 データ入力 ブール デフォルト値なし はい

    DeleteColumn

    Microsoft Word ドキュメント内の列の指定されたインデックス値に基づいて、テーブルから列を削除します。
    注:
    このメソッドを実行する前に、SetTable メソッドを実行する必要があります。
    入力
    ColumnIndex

    DeletePage

    Microsoft Word ドキュメントからページを削除します。
    注:
    このメソッドを実行する前に、Open メソッドを実行する必要があります。
    表 : 5. DeletePage メソッドのパラメーター
    パラメーター 説明 データポートタイプ データタイプ デフォルト値 必須？ メモ
    PageIndex メソッドが削除するページのインデックス番号を指定します。 データ入力 整数 デフォルト値なし いいえ インデックス番号を指定しない場合、メソッドはデフォルトで最初のページを削除します。

    DeleteRow

    Microsoft Word ドキュメント内の列の指定されたインデックス値に基づいて、テーブルから行を削除します。
    注:
    このメソッドを実行する前に、SetTable メソッドを実行する必要があります。
    入力
    RowIndex

    DeleteTable

    Microsoft Word ドキュメントからテーブルを削除します。

    ドキュメント内に複数のテーブルがある場合、メソッドはドキュメント内の最初のテーブルを削除します。

    注:
    このメソッドを実行する前に、SetTable メソッドを実行する必要があります。

    ExportToPDF

    Microsoft Word ドキュメントを PDF ドキュメントにエクスポートします。
    注:
    このメソッドを実行する前に、Open メソッドを実行する必要があります。
    表 : 6. ExportToPDF メソッドのパラメーター
    パラメーター 説明 データポートタイプ データタイプ デフォルト値 必須？ メモ
    Filepath Word ドキュメントが PDF にエクスポートされる場所へのパスを指定します。 データ入力 文字列 デフォルト値なし はい

    検索

    Microsoft Word ドキュメント内で指定されたテキストを検索し、ブール応答を返します。
    入力
    テキスト
    出力
    Return (Boolean)

    GetCellValueByIndex

    Microsoft Word ドキュメント内のテーブルのセルの値を返します。
    入力
    CellIndex

    GetFooterText

    Microsoft Word ドキュメント内のフッターの内容を返します。

    注:
    このメソッドを実行する前に、Open メソッドを実行する必要があります。
    出力
    Return (String)

    GetHeaderText

    Microsoft Word ドキュメント内のヘッダーの内容を返します。

    注:
    このメソッドを実行する前に、Open メソッドを実行する必要があります。
    出力
    Return (String)

    GetPageCount

    Microsoft Word ドキュメントのページ数を返します。

    出力
    Return (Integer)

    GetRowIndexByValue

    行の値に基づいて、その行のインデックス値を返します。
    注:
    このメソッドを実行する前に、GetTable メソッドおよび SetTable メソッドを実行する必要があります。
    入力
    Table、Value

    GetTable

    Microsoft Word ドキュメントのテーブルのデータを、テーブルオブジェクトおよびデータテーブルとして返します。ドキュメントに複数のテーブルが含まれている場合は、テーブルインデックスを指定してメソッドのテーブルを識別することができます。必要に応じてテーブルタイプを指定することもできます。

    テーブルの構造に応じて、オプションでメソッドのテーブルタイプを設定可能です。テーブルを設定するには、次の手順を実行します。
    1. メソッド設定アイコン (メソッド設定アイコン) をクリックします。
    2. テーブルタイプを選択します。
    3. [OK] をクリックします。
    入力
    TableIndex、FirstRowIsHeader
    出力
    Table (Object)
    Data (DataTable)

    GetTableCellValues

    1 つまたは複数のテーブルセルの値を返します。

    セルの数を指定するには、セルのインデックス値を設定する必要があります。設定するには、次の手順を実行します。
    1. メソッド設定アイコン (メソッド設定アイコン) をクリックします。
    2. (クリックしてセルインデックスを追加アイコン) をクリックします。
    3. セルのインデックス値を入力します。
    4. さらにインデックス値を追加するには、手順を繰り返します。
    5. [OK] をクリックします。
    出力
    Cell Index (Object)

    GetTableCount

    Microsoft Word ドキュメントのテーブル数を返します。オプションで、メソッドが識別するテーブルのタイプを指定できます。

    テーブルのタイプを設定するには、次の手順を実行します。
    1. メソッド設定アイコン (メソッド設定アイコン) をクリックします。
    2. テーブルタイプを選択します。
    3. [OK] をクリックします。
    出力
    Return (Integer)

    GetTableRowData

    Microsoft Word ドキュメントの行の 1 つまたは複数のセル内の値を返します。行のセルのインデックス値を指定できます。

    行内のセルのインデックス値を設定可能です。設定するには、次の手順を実行します。
    1. メソッド設定アイコン (メソッド設定アイコン) をクリックします。
    2. インデックス値の追加アイコン (インデックス値の追加アイコン) をクリックします 。
    3. セルのインデックス値を入力します。
    4. さらにインデックス値を追加するには、手順を繰り返します。
    5. [OK] をクリックします。
    出力
    Row index (Object)

    GetText

    Microsoft Word ドキュメントのすべてのテキストコンテンツを返します。

    表 : 7. GetText メソッドのパラメーター
    パラメーター 説明 データポートタイプ データタイプ デフォルト値 必須？ メモ
    戻る Word ドキュメントからテキストを返します。 データ出力 文字列 デフォルト値なし 適用外

    InsertNewColumn

    指定された列のインデックス値に基づいて、ドキュメントの最初のテーブルに新しい列を挿入します。
    入力
    ColumnIndex

    InsertNewRow

    インデックス値に基づいて新しい行を挿入します。
    入力
    RowIndex

    InsertPicture

    画像を挿入します。
    入力
    ImageFilePath
    ブックマーク

    InsertTable

    Microsoft Word ドキュメントにテーブルを挿入します。Microsoft ドキュメントにテーブルを挿入します。挿入する前に設定して、オプションでドキュメントをカスタマイズできます。

    注:
    このメソッドを実行する前に、GetTable メソッドおよび SetTable メソッドを実行する必要があります。
    挿入する前にテーブルをカスタマイズするには、次の手順を実行します。
    1. メソッド設定アイコン (メソッド設定アイコン) をクリックします。
    2. [ヘッダーを含める (Include Headers)] を選択します。
    3. 境界線のスタイルと自動調整の動作を選択します。
    4. [空の行を含める (Include Empty Rows)] を選択します。
    5. 特定の列を無視するには、インデックス値の追加アイコン (インデックス値の追加アイコン) をクリックします 。
    6. 列のインデックス値を入力します。
    7. [OK] をクリックします。
    入力
    ブックマーク
    データ

    InsertText

    Word ドキュメントの先頭にテキストを挿入します。

    表 : 8. InsertText メソッドのパラメーター
    パラメーター 説明 データポートタイプ データタイプ デフォルト値 必須？ メモ
    テキスト テキストを取得します。 データ入力 文字列 デフォルト値なし はい

    IsOpen

    Microsoft Word ドキュメントが開いているかどうかを確認します。

    出力
    Return (Boolean)

    MergeByCellIndices

    インデックス値の範囲の形式で指定されたセル範囲を結合します。
    入力
    StartCellIndex、EndCellIndex

    MergeByRowCol

    Microsoft Word ドキュメント内のテーブルのセル範囲を結合します。
    入力
    StartRowIndex、StartColIndex、EndRowIndex、EndColIndex

    ReplaceBookmark

    Microsoft Word ドキュメント内のブックマークを指定されたテキストに置き換えます。
    入力
    Bookmark、ReplaceText

    ReplaceBookmarks

    Microsoft Word ドキュメント内の複数のブックマークを探して指定されたテキストに置き換えます。
    入力
    テキスト
    置き換えるブックマークテキストの詳細を次のように指定します。
    1. コンポーネントをダブルクリックします。
    2. [ラベル / ブックマークを指定 (PROVIDE LABELS/BOOKMARKS)] ダイアログボックスで、クリックしてラベルを追加アイコン (クリックしてラベルを追加アイコン) をクリックし、置き換えるためのブックマークを入力します。

      さらにブックマークを追加するには、この手順を繰り返します。

    3. [OK] をクリックします。

    ReplaceFooterText

    Microsoft Word ドキュメント内のフッターテキストを検索して、指定されたテキストに置き換えます。
    入力
    FindText
    ReplaceText

    ReplaceHeaderText

    Microsoft Word ドキュメント内のヘッダーテキストを検索して、指定されたテキストに置き換えます。
    入力
    FindText
    ReplaceText

    ReplaceStaticText

    Microsoft Word ドキュメント内のテキストを検索して、指定されたテキストに置き換えます。設定に基づいて、ブックマーク、見出し、または任意のテキストを置き換えます。

    実行する前に、メソッドを設定する必要があります。設定するには、次の手順を実行します。
    1. メソッド設定アイコン (メソッド設定アイコン) をクリックします。
    2. テキスト追加アイコン (テキスト追加アイコン) をクリックします。
    3. 置き換えるための見出し、ブックマーク、またはテキストを入力します。
    4. さらにテキストを入力するには、手順を繰り返します。
    5. [OK] をクリックします。
    入力
    オブジェクト

    ReplaceText

    Microsoft Word ドキュメント内のテキストを検索して、指定されたテキストに置き換えます。
    入力
    FindText
    ReplaceText

    サイズを変更

    Microsoft Word ドキュメントのウィンドウのサイズを変更します。
    入力
    左
    Top
    幅
    高さ

    保存

    開いている Microsoft Word ドキュメントを保存します。

    SaveAs

    開いている Microsoft Word ドキュメントを指定されたファイル名で保存します。
    入力
    Filepath

    SetTable

    Microsoft Word ドキュメントにテーブルを設定します。
    入力
    テーブル

    SetTableCellValues

    Microsoft Word ドキュメント内のテーブルセルの内容を設定します。

    1 つまたは複数のセルインデックスと値タイプを次のように指定します。
    1. コンポーネントをダブルクリックします。
    2. [セルインデックスを指定 (PROVIDE CELL INDEXES)] ダイアログボックスで、クリックしてセルインデックスを追加アイコン ( クリックしてセルインデックスを追加アイコン) をクリックし、セルインデックスを入力して値タイプを選択します。

      さらにセルインデックスと値タイプを追加するには、この手順を繰り返します。

    3. [OK] をクリックします。

    SetTableRowData

    Microsoft Word ドキュメントのワークシート内のテーブル行の内容を設定します。
    入力
    RowIndex
    列インデックスを次のように指定します。
    1. コンポーネントをダブルクリックします。
    2. [列インデックスを指定 (PROVIDE COLUMN INDEXES)] ダイアログボックスで、クリックしてセルインデックスを追加アイコン ( クリックしてセルインデックスを追加アイコン) をクリックし、列インデックスを入力します。
    3. [OK] をクリックします。