5.1.2. IOWebDOC（iod）定義 （ 複数ページ定義 ）¶
5.1.2.1. 入力値¶
outputFile <storage> *
docInfo <object>
├─ title <string>
├─ subTitle <string>
├─ author <string>
└─ application <string>
security <object>
├─ openPassword <string>
├─ securityPassword <string>
├─ allowPrint <boolean>
├─ allowEdit <boolean>
├─ allowCopy <boolean>
└─ allowAnnotate <boolean>
reportData <object>
├─ global <object>
│ ├─ id <storage、または、string>
│ ...
└─ rows#1_n <object[]>
├─ id <storage、または、string>
...
| 項目名 | 必須/任意 | 型 | 配列/リスト | 説明 | ||
|---|---|---|---|---|---|---|
| outputFile | 必須 | storage | なし | 出力ファイル
必ずマッピングしてください。
指定する拡張子によって出力形式が異なります。
ファイルの拡張子が「.iod」の場合はIODファイル、「.pdf」の場合はPDFファイルが出力されます。
上記拡張子以外、または、拡張子が未指定の場合は、PDFファイルが出力されます。
|
||
| docInfo | 任意 | object | なし | PDF文書情報 | ||
| title | 任意 | string | なし | タイトル | ||
| subTitle | 任意 | string | なし | サブタイトル | ||
| author | 任意 | string | なし | 作成者 | ||
| application | 任意 | string | なし | アプリケーション | ||
| security | 任意 | object | なし | PDFセキュリティ情報 | ||
| openPassword | 任意 | string | なし | 文書を開くパスワード | ||
| securityPassword | 任意 | string | なし | セキュリティパスワード | ||
| allowPrint | 任意 | boolean | なし | true：印刷を許可する
false：印刷を許可しない
|
||
| allowEdit | 任意 | boolean | なし | true：編集を許可する
false：編集を許可しない
|
||
| allowCopy | 任意 | boolean | なし | true：転載を許可する
false：転載を許可しない
|
||
| allowAnnotate | 任意 | boolean | なし | true：注釈追加・変更を許可する
false：注釈追加・変更を許可しない
|
||
| reportData | 任意 | object | なし | 帳票データ | ||
| global | 任意 | object | なし | 固定データ | ||
| id | 任意 | storage 、または、 string | なし | 識別子番号を持たない帳票項目
このプロパティは帳票レイアウトファイルの、識別子番号を持たない識別子毎に生成され、識別子名が項目名になります。
帳票項目がイメージボックスの場合は storage 、イメージボックス以外の場合は string になります。
|
||
| rows#1_n | 任意 | object | 配列 | 行データ
項目名の末尾に、1ページごとの最大行数が追加されます。
例えば、1ページに15行存在する帳票レイアウトファイルの場合、「rows#1_15」という項目名になります。
配列の要素1が1行目、要素2が2行目という形で対応します。
|
||
| id | 任意 | storage 、または、 string | なし | 識別子番号を持つ帳票項目
このプロパティは帳票レイアウトファイルの、識別子番号を持つ識別子毎に生成され、識別子番号を除外した識別子名が項目名になります。
帳票項目がイメージボックスの場合は storage 、イメージボックス以外の場合は string になります。
|
コラム
識別子番号とは、識別子の末尾に「#数値」と番号付けされたものを指します。
例えば「no#1」の場合は、「#1」が識別子番号となります。
識別子番号は、連票形式のデータとして、同じ列の項目に同じ名前の識別子を設定する際に使用します。
1行目は「no#1」、2行目は「no#2」のように行数に合わせて番号付けします。
注意
ユーザ定義を作成する際、次の帳票レイアウトファイルを使用するとエラーが発生します。
各列の行数が一律でない場合
識別子番号が「#1」からの連番でない場合
- 例1：no#1, no#50, no#100
- 例2：no#2, no#3, no#4
注意
ユーザ定義を作成する際、次の識別子は、末尾が識別子番号として認識されないため、「reportData.global.id」の項目として扱われます。
- 末尾の数値部分の先頭が「0」の場合（例：no#01, no#02, no#03）
- 末尾に「#」と「数値」以外が含まれている場合（例：no#A, no#A2, no#3A）
注意
「reportData.rows#1_n」にデータを指定する際、自由に行数分のデータ（要素数）を指定することが可能です。
n（1ページごとの最大行数分）より多い行数（要素数）を指定した場合、超過した分のデータは2ページ目以降に出力されます。
「reportData.global」の値は、2ページ目以降も同じ値が出力されます。
注意
IODの形式で出力する際に、「docInfo」、および、「security」を設定しても、その中間IODファイルからのPDFファイル作成時には設定が引き継がれません。
上記設定は、「 帳票作成（中間IOD結合）タスク 」にてPDFファイルを作成する際に設定してください。
5.1.2.2. 返却値¶
outputFile <storage>
| 項目名 | 型 | 配列/リスト | 説明 |
|---|---|---|---|
| outputFile | storage | なし | 出力ファイル
ファイルの拡張子が「.iod／.pdf」以外、または、拡張子が未指定の場合は、末尾に「.pdf」が追加されたパスとなります。
|