command

OZ Viewerの情報を取得する命令語

ACCESSIBLE_PAGECONTENTS

現在ページの内容

スクリーンリーダープログラムが実行され、単一ページの場合、現在ページの内容がリターンされる

上記の場合ではない場合、空白がリターンされる

COMMENT_DRAWBORDER_COLOR

枠線描くで選択した枠の色

e-formでのみサポートされる

COMMENT_DRAWBORDER_TRANSPARENCY

枠線描くで選択した枠の透明度

e-formでのみサポートされる

COMMENT_DRAWBORDER_THICK

枠線描くで選択した枠の太さ

e-formでのみサポートされる

COMMENT_FILLBACKGROUND_COLOR

背景色の塗りつぶしで選択した色

e-formでのみサポートされる

COMMENT_FILLBACKGROUND_TRANSPARENCY

背景色の塗りつぶしで選択した透明度

e-formでのみサポートされる

COMMENT_HIGHLIGHTPEN_COLOR

蛍光ペンの色

RGB値で"Red/Green/Blue"対応でリターンされる

e-formでのみサポートされる

COMMENT_HIGHLIGHTPEN_THICK

蛍光ペンの太さ

e-formでのみサポートされる

COMMENT_HIGHLIGHTPEN_TRANSPARENCY

蛍光ペンの透明度

e-formでのみサポートされる

COMMENT_MODE

編集/コメントツール

編集ツールあるいはコメントツールの場合、"comment"、その他のモードの場合、"input"でリターン

e-formでのみサポートされる

COMMENT_PEN_COLOR

ペンの色

RGB値で"Red/Green/Blue"対応でリターンされる

e-formでのみサポートされる

COMMENT_PEN_THICK

ペンの太さ

e-formでのみサポートされる

COMMENT_SELECTEDPEN

選択したペンタイプ

選択したペンタイプがペンの場合は、"pen"、蛍光ペンの場合は、"highilghtpen"、消しゴムの場合は"eraser"、枠線描くの場合は、"drawborder"、背景色の塗りつぶしの場合は、"fillbackground"がリターンされる

e-formでのみサポートされる

CURRENT_PAGE

現在レポートのページ番号。ページ番号はone-based indexで返される

CURRENT_PAGE_AT=レポートのインデックス

指定したレポートの現在のページ番号。ページ番号はone-based indexで返される

CURRENT_REPORT_INDEX

現在レポートのインデックス。レポートのインデックスはzero-based indexで返される

DATA_INFO

現在レポートのデータツリーに追加されたデータ情報をJSON形式のテキストで取得します

データセット名、結果セットの行数、データフィールド名がデータツリーに表示された順番通りにリターンされます

データセットの"使い"属性の値が"はい"の場合のみリターンされます

マスター/ディテールの構成は維持された状態でリターンされ、マスタデータセットの"使い"属性の値が"いいえ"の場合は、マスタとディテールのデータセットはリターンされません

DATA_INFO_AT=レポートのインデックス

指定したレポートのデータツリーに追加されたデータ情報をJSON形式のテキストで取得します

データセット名、結果セットの行数、データフィールド名がデータツリーに表示された順番通りにリターンされます

データセットの"使い"属性の値が"はい"の場合のみリターンされます

マスター/ディテールの構成は維持された状態でリターンされ、マスタデータセットの"使い"属性の値が"いいえ"の場合は、マスタとディテールのデータセットはリターンされません

指定したレポートに追加されたデータがない場合や間違ったインデックスを設定した場合は"[]"でリターンされます

DISPLAYNAME

現在レポートの表示名

DISPLAYNAME_AT=現在レポートのインデックス

指定したレポートの表示名

INPUT_CHECK_VALIDITY

現在レポートに追加された最初のボタンのOnCheckValidityイベントに入力されたスクリプトの実行結果を取得する

実行に成功の場合は"valid"、失敗の場合は""で返される

ただし、最初のボタンのOnCheckValidityイベントにスクリプトがない場合には"valid"が返される

コマンドを実行する時、現在のレポートに編集している入力コンポーネントがある場合は、編集状態を終了する。その時、変更された内容がある場合、コンポーネントに値を適用し、フォーカスを返す（OnValueChanged、OnKillFocusイベントが呼び出される）

e-formでのみサポートされる

INPUT_CHECK_VALIDITY_AT=レポートのインデックス

指定したレポートに追加された最初のボタンのOnCheckValidityイベントに入力されたスクリプトの実行結果を取得する

実行に成功の場合は"valid"で返される

実行の失敗または誤ったレポートのインデックスを設定した場合、""でリターン

ただし、最初のボタンのOnCheckValidityイベントにスクリプトがない場合には"valid"が返される

コマンドを実行する時、指定したレポートに編集している入力コンポーネントがある場合は、編集状態を終了する。その時、変更された内容がある場合、コンポーネントに値を適用し、フォーカスを返す（OnValueChanged、OnKillFocusイベントが呼び出される）

e-formでのみサポートされる

INPUT_CHECK_VALIDITY_AT=レポートのインデックス,PAGE_AT=ページのインデックス

指定したレポートの特定ページに追加された最初のボタンのOnCheckValidityイベントに入力されたスクリプトの実行結果を取得する

実行に成功の場合は"valid"で返される

実行の失敗または誤ったレポートのインデックスとページインデックスを設定した場合、""でリターン

ただし、最初のボタンのOnCheckValidityイベントにスクリプトがない場合には"valid"が返される

ページインデックスはone-based indexで指定する必要がある

コマンドを実行する時、指定したレポートの特定のページに編集中の入力コンポーネントがある場合は、編集状態を終了する。その時、変更された内容がある場合、コンポーネントに値を適用し、フォーカスを返す（OnValueChanged、OnKillFocusイベントが呼び出される）

e-formでのみサポートされる

INPUT_CHECK_VALIDITY_CURRENT_PAGE

現在のページに追加された最初のボタンのOnCheckValidityイベントに入力されたスクリプトの実行結果を取得する

実行に成功の場合は"valid"、失敗の場合は""で返される

ただし、最初のボタンのOnCheckValidityイベントにスクリプトがない場合には"valid"が返される

コマンドを実行する時、現在のページで、編集中の入力コンポーネントがある場合は、編集状態を終了する。その時、変更された内容がある場合、コンポーネントに値を適用し、フォーカスを返す（OnValueChanged、OnKillFocusイベントが呼び出される）

e-formでのみサポートされる

INPUT_CHECK_VALIDITY_PAGE_AT=ページのインデックス

特定ページに追加された最初のボタンのOnCheckValidityイベントに入力されたスクリプトの実行結果を取得する

実行に成功の場合は"valid"で返される

実行の失敗または無効なページインデックスを設定した場合、""でリターン

ただし、最初のボタンのOnCheckValidityイベントにスクリプトがない場合には"valid"が返される

ページのインデックスはone-based indexで指定する必要があり、

マンドを実行する時、特定のページで、編集中の入力コンポーネントがある場合は、編集状態を終了する。その時、変更された内容がある場合、コンポーネントに値を適用し、フォーカスを返す（OnValueChanged、OnKillFocusイベントが呼び出される）

e-formでのみサポートする

INPUT_JSON

現在レポートの入力値をJSON形式のデータで取得する

e-formでのみサポートされる

INPUT_JSON_ALL

全体のレポートの入力値を纏めてひとつのJSON形式のテキストで取得する

e-formでのみサポートされる

INPUT_JSON_ALL_GROUP_BY_REPORT

レポート全体の入力値をレポート別に区分して、JSONフォーマットのテキストとして取得する

Root レポート別に{"ReportDisplayName":"レポートの表示名","Input":{"コンポーネントのFormID":"値",...}}の形でコンマ（,）を区切り記号としてリターンされる

e-formでのみサポートされる

INPUT_JSON_AT=レポートのインデックス,PAGE_AT=ページのインデックス

指定したレポートの指定したページで入力値をJSON形式のテキストで取得する

e-formでのみサポートされる

INPUT_JSON_CURRENT_PAGE

現在ページの入力値をJSON形式のテキストで取得する

e-formでのみサポートされる

INPUT_TRIGGER_CLICK

現在レポートに追加された最初のボタンのOnClickイベントに入力されたスクリプトの実行結果を取得する

実行に成功の場合は"true"、失敗の場合は"false"で返される

ただし、最初のボタンのOnClickイベントにスクリプトがない場合には"false"が返される

e-formでのみサポートされる

INPUT_TRIGGER_CLICK_AT=レポートのインデックス

指定したレポートに追加された最初のボタンのOnClickイベントに入力されたスクリプトの実行結果を取得する

実行に成功の場合は"true"、失敗の場合は"false"で返される

ただし、最初のボタンのOnClickイベントにスクリプトがない場合には"false"が返される

e-formでのみサポートされる

INPUT_TRIGGER_CLICK_CURRENT_PAGE

現在のページに追加された最初のボタンのOnClickイベントに入力されたスクリプトの実行結果を取得する

実行に成功の場合は"true"、失敗の場合は"false"で返される

ただし、最初のボタンのOnClickイベントにスクリプトがない場合には"false"が返される

e-formでのみサポートされる

INPUT_TRIGGER_CLICK_PAGE_AT=ページのインデックス

特定ページに追加された最初のボタンのOnClickイベントに入力されたスクリプトの実行結果を取得する

実行に成功の場合は"true"、失敗の場合は"false"で返される

ただし、最初のボタンのOnClickイベントにスクリプトがない場合には"false"が返される

ページインデックスはone-based indexで指定する必要がある

e-formでのみサポートされる

INPUT_XML

現在のレポートの入力値をXML形式のテキストで取得する

1番目のElementがお互い異なる場合、Root Elementはozformで設定され、その下に追加される

e-formでのみサポートされる

INPUT_XML_ALL

全体レポートの入力値を合わせて1つのXML形式のテキストで取得する

1番目のElementがお互い異なる場合、Root Elementはozformで設定され、その下に追加される

e-formでのみサポートされる

INPUT_XML_ALL_GROUP_BY_REPORT

レポート全体の入力値をレポート別に区分して、XMLフォーマットのテキストとして取得する

Root Elementはozformで設定され、その下にreportでレポートを区別して、名前属性にレポートの表示名が設定される

e-formでのみサポートされる

INPUT_XML_AT=レポートのインデックス,PAGE_AT=ページのインデックス

指定したレポートの指定したページで入力値をXML形式のテキストで取得する

e-formでのみサポートされる

INPUT_XML_CURRENT_PAGE

現在ページの入力値をXML形式のテキストで取得する

e-formでのみサポートされる

INVALID_INFO_JSON

現在のレポートで必須入力属性の値が"はい"で設定された入力コンポーネントの中、値が入力されていない入力コンポーネントの情報をJSON形式のデータで取得する

e-formでのみサポートされる

INVALID_INFO_JSON_AT=レポートのインデックス

指定したレポートで必須入力属性の値が"はい"で設定された入力コンポーネントの中、値が入力されていない入力コンポーネントの情報をJSON形式のデータで取得する

e-formでのみサポートされる

MEMO_DATA

現在の報告書に追加されたメモデータを取得

メモだけではなく画像、注釈、コールアウト図形を全て含んで引用します

MEMO_DATA_AT=レポートのインデックス

指定した報告書に追加されたメモデータを取得

メモだけではなく画像、注釈、コールアウト図形を全て含んで引用します

MEMO_JSON

現在のレポートのメモテキストをJSON形式のテキストとしてインポートする

メモIDはメモが追加された順に「memoシリアル番号」の形式で生成される

e-formでのみサポートされる

MEMO_JSON_ALL

レポート全体のメモテキストを一括して一つのJSON形式のテキストとしてインポートする

メモIDはメモが追加された順に「memoシリアル番号」の形式で生成される

ただし、複数のレポートにメモが追加されている場合には、メモIDがツリーペインに表示されているレポートの順で生成される

e-formでのみサポートされる

MEMO_JSON_ALL_GROUP_BY_REPORT

レポート全体のメモテキストをレポートごとに区分してJSON形式のテキストとしてインポートする

メモIDはメモが追加された順に「memoシリアル番号」の形式で生成される

ただし、複数のレポートにメモが追加されている場合には、メモIDがツリーペインに表示されているレポートの順で生成される

レポートごとに{"ReportDisplayName":"レポートの表示名","memo":{"メモID":"テキスト",...}}の形でコンマ（,）を区切り文字にして返す

e-formでのみサポートされる

MEMO_JSON_AT=レポートのインデックス,PAGE_AT=ページのインデックス

指定したレポートの特定のページからメモテキストをJSON形式のテキストとしてインポートする

メモIDはメモが追加された順に「memoシリアル番号」の形式で生成される

e-formでのみサポートされる

MEMO_JSON_CURRENT_PAGE

現在のページのメモテキストをJSON形式のテキストとしてインポートする

メモIDはメモが追加された順に「memoシリアル番号」の形式で生成される

e-formでのみサポートされる

MEMO_XML

現在のページのメモテキストをXML形式のテキストとしてインポートする

メモIDはメモが追加された順に「memoシリアル番号」の形式で生成される

Root Elementにはozmemoを設定し、その配下に追加する

e-formでのみサポートされる

MEMO_XML_ALL

レポート全体のメモテキストを一括して一つのXML形式のテキストとしてインポートする

メモIDはメモが追加された順に「memoシリアル番号」の形式で生成される

ただし、複数のレポートにメモが追加されている場合には、メモIDがツリーペインに表示されているレポートの順で生成される

Root Elementにはozmemoを設定し、その配下に追加する

e-formでのみサポートされる

MEMO_XML_ALL_GROUP_BY_REPORT

レポート全体のメモテキストをレポートごとに区分してJSON形式のテキストとしてインポートする

メモIDはメモが追加された順に「memoシリアル番号」の形式で生成される

ただし、複数のレポートにメモが追加されている場合には、メモIDがツリーペインに表示されているレポートの順で生成される

Root Elementにはozmemoを設定し、その配下にreportを置いてレポートを区分し、name属性にレポートの表示名を設定する

e-formでのみサポートされる

MEMO_XML_AT=レポートのインデックス,PAGE_AT=ページのインデックス

指定したレポートの特定のページからメモテキストをXML形式のテキストとしてインポートする

メモIDはメモが追加された順に「memoシリアル番号」の形式で生成される

e-formでのみサポートされる

MEMO_XML_CURRENT_PAGE

現在のページのメモテキストをXML形式のテキストとしてインポートする

メモIDはメモが追加された順に「memoシリアル番号」の形式で生成される

e-formでのみサポートされる

ODIPARAM

現在のレポートのデータツリーに追加されているODIパラメータフィールド名をJSON形式のテキストとしてインポートする

ODIPARAM_AT=レポートのインデックス

指定したレポートのデータツリーに追加されているODIパラメータフィールド名をJSON形式のテキストとしてインポートする

OZFORMPARAM

現在のレポートのデータツリーに追加されているフォームパラメータフィールド名をJSON形式のテキストとしてインポートする

OZFORMPARAM_AT=レポートのインデックス

指定したレポートのデータツリーに追加されているフォームパラメータフィールド名をJSON形式のテキストとしてインポートする

REPORT_COUNT

レポートの総数

REPORTINDEX_BY_DISPLAYNAME=表示名ｼ

指定した表示名のレポートインデックス。レポートのインデックスはzero-based indexで返される

表示名が重複しているレポートの場合は、レポートツリーの表示順でインデックスをリターンする

TOTAL_PAGE

全体ページ数

TOTAL_PAGE_AT=レポートのインデックス

指定したレポートの全体ページ数

TOTAL_PAGE_OF_REPORT_FILE_AT=レポートファイルのインデックス

レポートファイル別に全体のページ数を取得する

レポートファイルとは、 connection.reportnameまたはconnection.openfileで指定したファイルの単位です。つまり、複数のレポートを1つのozdで保存した場合、ozdに保存したレポートの数に関係なく1つのレポートインデックスで適用されます。そのため、レポートファイルのインデックスをozdファイルに設定した場合、ozdファイルに保存された全てのレポートの全体ページ数を取得します

Viewerバインディングが完了され後、リンク関数またはCreateReportなどで追加されたレポートは、ページの数を取得することができません

ZOOM

現在レポートの拡大/縮小倍率

ZOOM_AT=レポートのインデックス

指定したレポートの拡大/縮小倍率