コマンドラインインターフェイス
コマンドラインインターフェイス
コマンドラインインターフェイスは単独の実行形式ファイルとして提供されます。Windows のバッチファイルから呼び出すことができます。
Word APIのコマンドラインインターフェイスは、ファイルを指定して動作させたり、標準入力からファイルを読み込み動作させることができます。
コマンドラインインターフェイスは、以下の環境にて動作します。
実行形式ファイル名は以下のとおりです。
| Windows | AHOOXMLDocxManagerCmd.exe |
|---|
これらを実行させるためには、いくつかの 環境変数 の設定が必要です。 インストール時にそれらが設定されています。
Word APIのコマンドラインインターフェイスは、以下の形式のコマンドを指定することによって、コマンドラインプログラムが実行されます。
[Install directory]/samples/cmdに各Subcommandのサンプルコマンドがいくつか含まれています。
Subcommandには、コマンドラインインターフェイスで実行するWord APIの機能を指定します。機能に対応するSubcommandは以下の通りです。
| パラメータ | 機能 |
|---|---|
| SimpleDataMerge | シンプル版の差し込み印刷機能で、後続のパラメータ部分には「差し込み印刷共通のパラメータ」、 「シンプル版のパラメータ」を指定します。 |
| CompoundDataMerge | 複合版の差し込み印刷機能で、後続のパラメータ部分には「差し込み印刷共通のパラメータ」、 「複合版に関するパラメータ」を指定します。 |
| NestedTableDataMerge | ネスト構造のテーブル版の差し込み印刷機能で、後続のパラメータ部分には「差し込み印刷共通のパラメータ」、 「ネスト構造のテーブル版に関するパラメータ」を指定します。 |
| GetDataMergeFields |
差し込み印刷テンプレートに定義されているフィールドを取得する機能で、後続のパラメータ部分には
「差し込み印刷テンプレートに定義されているフィールド取得に関するパラメータ」を指定します。 このパラメータが指定されている場合は、差し込み印刷処理は行いません。 |
| UnlinkedSubDocs | サブ文書のリンク解除をする機能で、後続のパラメータ部分には「サブ文書のリンク解除に関するパラメータ」を指定します。 |
| EmbedLinkedImage | リンク形式の画像の埋め込む機能で、後続のパラメータ部分には「リンク形式の画像の埋め込みに関するパラメータ」を指定します。 |
| CompareDocuments | 2つの文書の比較する機能で、後続のパラメータ部分には「文書の比較に関するパラメータ」を指定します。 |
| CreateComparativeTable | 新旧対照表を作成する機能で、後続のパラメータ部分には「新旧対照表の作成に関するパラメータ」を指定します。 |
| ParseChangedRatio | 変更割合を取得する機能で、後続のパラメータ部分には「変更割合の取得に関するパラメータ」を指定します。 |
| GetFormDatas | 「ラベル（項目名）-データ」を取得する機能で、後続のパラメータ部分には「データの取得に関するパラメータ」を指定します。 |
| ExecuteInspectDocument | ドキュメント検査を実行する機能で、後続のパラメータ部分には「ドキュメント検査に関するパラメータ」を指定します。 |
| RemoveMetaInformations | メタ情報の削除を実行する機能で、後続のパラメータ部分には「メタ情報の削除に関するパラメータ」を指定します。 |
コマンドラインインターフェイスのパラメータは以下の形式で指定します。
パラメータの指定文字と値の間は半角空白を入れてください。また、パス名を指定する場合など内容に空白が含まれるときはダブルクォートで囲んでください。
ダブルクォートでパスを囲む際に末尾が"\"の場合は"\\"としてください。
同一のパラメータ、あるいは背反するパラメータが指定された場合は、エラーになります。
各パラメータのパスは絶対パスまたはカレントディレクトリからの相対パスを指定することが可能です。
以下に各パラメータを記載いたします。
| パラメータ | 機能 |
|---|---|
| --help |
Verbを指定しないで、このパラメータが指定されている場合は、Verbの一覧を表示します。 Verbの後に、このパラメータが指定されている場合は、対象のVerbのパラメータの簡単な解説を表示します。 このとき、対象の機能は実行されません。 |
| --version | コマンドラインインターフェイスのバージョンや著作権を表示します。 このパラメータが指定されている場合は実際の変換処理は行いません。 |
| パラメータ | 機能 | 既定値 | 必須 |
|---|---|---|---|
|
--input_file_path テンプレートファイル -i テンプレートファイル |
差し込み印刷対象のテンプレートファイルのパスを指定します。 | 〇 | |
|
--merge_data_encoding 差し込み印刷データファイルの文字エンコード -e 差し込み印刷データファイルの文字エンコード |
差し込み印刷データファイルの文字エンコードを指定します。値には以下のいずれかの数字または文字列を指定してください。
|
〇 | |
| --input_image_directory 差し込み印刷画像ディレクトリ |
差し込み印刷画像のディレクトリのパスを指定します。 画像の差し込み印刷フィールドが存在するテンプレートの差し込み印刷の実行時に、パラメータが指定されていない場合はエラーになります。 |
||
| --executor 差し込み印刷実行者 |
差し込み印刷の実行者を指定します。 パラメータを指定しない場合、最終更新者を前回保存者から変更しません。 |
||
| --cell_overflow_rule セル内の制御ルール | セルへの差し込み印刷でセル幅をオーバーした際の制御を指定します。値には以下のいずれかの数字または文字列を指定してください。 | 0 | |
| --padding_string 埋め字 | セルへの差し込み印刷でセル幅をオーバーした際の制御を3（Padding）に指定したときの、埋める文字を指定します。 | # | |
|
--output_file_path 実行結果の出力ファイル -o 実行結果の出力ファイル |
実行結果の出力ファイルのパスを指定します。 | 〇 | |
| --file_add_column 出力ファイルへの追加文字のカラム名 |
出力ファイルに追加するデータに対応するカラム名を指定します。 複数ファイルが出力される際に、パラメータを指定しない場合は出力ファイル名に1から連番で数値が追加されます。 |
||
| --additional_filename_place 追加文字の位置 | 出力ファイル名への追加する文字の位置を指定します。値には以下のいずれかの数字または文字列を指定してください。 | 0 |
| パラメータ | 機能 | 既定値 | 必須 |
|---|---|---|---|
| --csv CSV形式の差し込み印刷データ |
差し込み印刷データがCSV形式の場合に、対象のファイルのパスを指定します。 --jsonと同時に指定することはできません。 |
〇 | |
| --json JSON形式の差し込み印刷データ |
差し込み印刷データがJSON形式の場合に、対象のファイルのパスを指定します。 --csvと同時に指定することはできません。 |
〇 | |
| --simple_outputmode シンプル版の出力ルール | シンプル版の差し込み印刷の複数レコードの際の出力方法を指定します。値には以下のいずれかの数字または文字列を指定してください。 | 0 |
| パラメータ | 機能 | 既定値 | 必須 |
|---|---|---|---|
| --csv CSV形式のメインの差し込み印刷データ |
複合版のメインの差し込み印刷データがCSV形式の場合に、対象のファイルのパスを指定します。 本オプションを指定時には、--detail_csvの指定も必須です。 --jsonと同時に指定することはできません。 |
〇 | |
| --detail_csv CSV形式のサブの差し込み印刷データ |
複合版のメインの差し込み印刷データがCSV形式の場合に、明細部のファイルのパスを指定します。 本オプションを指定時には、--csvの指定も必須です。 明細部のデータごとに、カンマ区切りまたは半角スペース区切りで、複数指定することが可能です。 --jsonと同時に指定することはできません。 |
〇 | |
| --json JSON形式の差し込み印刷データ |
差し込み印刷データがJSON形式の場合に、対象のファイルのパスを指定します。 --csvおよび--detail_csvと同時に指定することはできません。 |
〇 | |
| --compound_repeatingrows_pattern 複合版の明細行パターン | 複合版の明細部の行数パターンを指定します。値には以下のいずれかの数字または文字列を指定してください。 | 0 | |
| --compound_multiple_pages_style 複合版の複数ページのスタイル | 複合版の行数固定の明細表が複数ページに渡る場合のスタイルを指定します。値には以下のいずれかの数字または文字列を指定してください。 | 0 | |
| --compound_deleting_footerrule 複合版のフッター削除ルール | 複合版の行数固定のフッター部分の編集ルールを指定します。値には以下のいずれかの数字または文字列を指定してください。 | 0 | |
| --linking_key データで一意の値をもつカラム名 |
複合版のlinking keyを指定します。 データ形式がCSV：メインデータとサブデータの共通の項目名 データ形式がJSON：データで一意の値をもつ第一階層目のオブジェクトのキー を指定します。 |
〇 |
| パラメータ | 機能 | 既定値 | 必須 |
|---|---|---|---|
| --csv CSV形式の差し込み印刷データ |
ネスト構造のテーブル以外の差し込み印刷データがCSV形式の場合に、対象のファイルのパスを指定します。 --jsonと同時に指定することはできません。 |
〇 | |
| --json JSON形式の差し込み印刷データ |
ネスト構造のテーブル以外の差し込み印刷データがJSON形式の場合に、対象のファイルのパスを指定します。 --csvと同時に指定することはできません。 |
〇 | |
| --nested_json ネスト構造のテーブルの差し込み印刷データ |
ネスト構造のテーブルの差し込み印刷データのパスを指定します。 |
〇 | |
| --detail_table_type ネスト構造のテーブルの幅 | ネスト構造のテーブル版の差し込み印刷のテーブルの幅を指定します。値には以下のいずれかの数字または文字列を指定してください。 | 0 |
| パラメータ | 機能 | 既定値 | 必須 |
|---|---|---|---|
|
--input_file_path テンプレートファイル -i テンプレートファイル |
差し込み印刷対象のテンプレートファイルのパスを指定します。 | 〇 |
| パラメータ | 機能 | 既定値 | 必須 |
|---|---|---|---|
|
--input_file_path グループ文書ファイル -i グループ文書ファイル |
グループ文書のマスタ文書ファイルのパスを指定します。 | 〇 | |
|
--output_file_path 出力ファイル -o 出力ファイル |
実行結果の出力ファイルのパスを指定します。 | 〇 | |
| --duplicate_style スタイルが重複した場合の処理 | マスタ文書とサブ文書で、異なるスタイル定義で、スタイル名が同じ場合の処理を指定します。値には以下のいずれかの数字または文字列を指定してください。 | 0 | |
| --sub_docs_dir サブ文書格納ディレクトリ |
グループ文書のサブ文書が格納されているディレクトリのパスを指定します。 パラメータを指定しない場合は、マスタ文書ファイルのディレクトリからサブ文書を取得します。 |
| パラメータ | 機能 | 既定値 | 必須 |
|---|---|---|---|
|
--input_file_path ファイルパス -i ファイルパス |
リンク形式の画像の埋め込みを実行するファイルのパスを指定します。 | 〇 | |
|
--output_file_path 出力ファイル -o 出力ファイル |
実行結果の出力ファイルのパスを指定します。 | 〇 |
| パラメータ | 機能 | 既定値 | 必須 |
|---|---|---|---|
| --original_file_path 元の文書ファイル | 比較する元の文書ファイルのパスを指定します。 | 〇 | |
| --revised_file_path 変更された文書ファイル | 比較する変更された文書ファイルのパスを指定します。 | 〇 | |
|
--output_file_path 出力ファイル -o 出力ファイル |
実行結果の出力ファイルのパスを指定します。 | 〇 |
| パラメータ | 機能 | 既定値 | 必須 |
|---|---|---|---|
| --original_file_path 元の文書ファイル | 新旧対照表の改正前となる元の文書ファイルのパスを指定します。 | 〇 | |
| --revised_file_path 変更された文書ファイル | 新旧対照表の改正後となる変更された文書ファイルのパスを指定します。 | 〇 | |
|
--output_file_path 出力ファイル -o 出力ファイル |
新旧対照表の出力ファイルのパスを指定します。 | 〇 |
| パラメータ | 機能 | 既定値 | 必須 |
|---|---|---|---|
| --original_file_path 元の文書ファイル | 元の文書ファイルのパスを指定します。 | 〇 | |
| --revised_file_path 変更された文書ファイル | 変更された文書ファイルのパスを指定します。 | 〇 |
| パラメータ | 機能 | 既定値 | 必須 |
|---|---|---|---|
|
--template_file_path テンプレートファイル -t テンプレートファイル |
テンプレートファイルのパスを指定します。 | 〇 | |
|
--submitted_file_path 入力済みのファイル -s 入力済みのファイル |
入力済みのファイルのパスを指定します。 | 〇 |
| パラメータ | 機能 | 既定値 | 必須 |
|---|---|---|---|
|
--input_file_path 入力ファイル -i 入力ファイル |
ドキュメント検査を実施するファイルのパスを指定します。 | 〇 |
| パラメータ | 機能 | 既定値 | 必須 |
|---|---|---|---|
|
--input_file_path 入力ファイル -i 入力ファイル |
メタ情報の削除を実施するファイルのパスを指定します。 | 〇 | |
|
--output_file_path 実行結果の出力ファイル -o 実行結果の出力ファイル |
実行結果の出力ファイルのパスを指定します。 | 〇 | |
|
--document_properties -d |
プロパティ情報を削除する場合に指定します。 | ||
|
--personal_information -p |
個人情報を削除する場合に指定します。 | ||
|
--hidden_text -h |
隠し文字を削除する場合に指定します。 |
コマンドラインインターフェイスを実行して、成功した場合は0を、失敗した場合は対応するエラーコードを戻り値として処理を終えます。
--helpまたは--versionを指定した場合の戻り値は0です。