スクリプト-関数一覧

スクリプトでサポートしている関数は次の通りです。

文字列
 数値
 日付・時刻
 リンクデータ
 データ
 変数
 ページ・レコード
 グループ
 プログラム連携
 その他

文字列

文字列を操作する関数です。

関数	説明
Str	数値(NUMBER)や日付(DATE)を文字列に変換します。
StrSearch	文字列の中から特定の文字列を検索し、その個数を返します。
StrChange	文字列を置き換えます。
StrCmb	文字配列を指定した区切り文字と引用符で連結します。
StrComp	文字列を比較します。
StrCopy	文字列の特定範囲をコピーします。
StrFormat	文字列を書式変換します。
StrLen	文字数を取得します。
StrSep	文字列は指定した区切り文字と引用符で分割します。
StrTrim	文字列前後のスペースや改行を削除します。

数値

数値を操作する関数です。

関数	説明
IsNum	文字列が数値か判定します。
Num	文字列を数値に変換します。
NumRevise	文字列を数値に変換します。全角数値や桁区切り（カンマ）があっても変換することができます。
Round	小数点以下を四捨五入します。
RoundDown	小数点以下を切り捨てます。
RoundOff	小数点以下を切り上げます。

日付・時刻

日付・時刻を操作する関数です。

関数	説明
Date	文字列をDATE型に変換します。
DateComp	日付文字列を比較します。
GetDateNow	現在の日付時刻を文字列で取得します。
IsDate	文字列が有効な日付か判定します。

[version 4.1以降]

セクションにリンクしているデータのカレントレコードの値を取得する関数です。
対象のセクションで関数名が異なりますが利用方法は同じです。

＜親セクションの値を取得＞
GetS( )など

＜フォームのデータセクションの値を取得＞
FORM_GetS( )など

＜レポートのマスターセクションの値を取得＞
MASTER_GetS( )など

＜指定セクションの値を取得＞
SECTION_GetS( )など

※
「FORM_*」、「MASTER_*」、「SECTION_*」のカレントレコードは、改フォームグループ範囲の先頭レコードとなります。

関数	説明
GetS FORM_GetS MASTER_GetS SECTION_GetS	カレントレコードのフィールド値を文字列(STRING)として取得します。
GetN FORM_GetN MASTER_GetN SECTION_GetN	カレントレコードのフィールド値を数値(NUMBER)として取得します。
GetM FORM_GetM MASTER_GetM SECTION_GetM	カレントレコードのフィールド値を画像(IMAGE)として取得します。
GetSA FORM_GetSA MASTER_GetSA SECTION_GetSA	カレントレコードの指定範囲のフィールド値を文字列配列(STRING_ATTRY)として取得します。
GetNA FORM_GetNA MASTER_GetNA SECTION_GetNA	カレントレコードの指定範囲のフィールド値を数値配列(NUMBER_ATTRY)として取得します。
GetSum FORM_GetSum MASTER_GetSum SECTION_GetSum	フィールドの合計を取得します。
GetCum FORM_GetCum MASTER_GetCum SECTION_GetCum	フィールドの累計を取得します。
GetMax FORM_GetMax MASTER_GetMax SECTION_GetMax	フィールドの最大値を取得します。
GetMin FORM_GetMin MASTER_GetMin SECTION_GetMin	フィールドの最小値を取得します。
GetAve FORM_GetAve MASTER_GetAve SECTION_GetAve	フィールドの平均値を取得します。
GetRecordNo FORM_GetRecordNo MASTER_GetRecordNo SECTION_GetRecordNo	カレントレコード番号を取得します。
GetRecordCount FORM_GetRecorCount MASTER_GetRecordCount SECTION_GetRecordCount	レコード数を取得します。
GetGroup FORM_GetGroup MASTER_GetGroup SECTION_GetGroup	カレントレコードのグループ情報を取得します。
Set FORM_Set MASTER_Set SECTION_Set	カレントレコードのフィールド値を設定します。
SetM FORM_SetM MASTER_SetM SECTION_SetM	カレントレコードのフィールド値を設定します。（画像）

データの直接参照

[version 4.1以降]

任意のデータの値を取得する関数です。
DATAオブジェクトを使わずに任意のデータの値を取得することができます。
旧バージョンでの利用を考慮しない場合、こちらの関数を使ったほうが効率的です。

関数	説明
DATA_GetS	指定データからデータ値を文字列（STRING）として取得します。
DATA_GetN	指定データのデータ値を数値（NUMBER）として取得します。
DATA_GetM	指定データからデータ値を画像（IMAGE）として取得します。
DATA_GetSA	指定データからデータ値を文字配列（STRING_ARRAY）で取得します。
DATA_GetNA	指定データからデータ値を数値配列（NUMBER_ARRAY）で取得します。
DATA_GetSum	指定データのフィールド値の合計を取得します。
DATA_GetCum	指定データのフィールド値の累計を取得します。
DATA_GetMax	指定データのフィールド値の最大値を取得します。
DATA_GetMin	指定データのフィールド値の最小値を取得します。
DATA_GetAve	指定データのフィールド値の平均値を取得します。
DATA_GetRecordCount	指定データのレコード数を取得します。
DATA_GetGroup	指定データのグループ情報を取得します。
DATA_Find	指定データのフィールド値を検索し、レコード番号を取得します。
DATA_FindGet	指定データのフィールド値を検索し、対象レコードの値を取得します。
DATA_Set	指定データのフィールド値を設定します。
DATA_SetM	指定データのフィールド値を設定します。（画像）

＜編集中も先頭レコード以外の値を表示したい場合＞
エディタのレイアウトウインドウでは通常、データのテスト値（編集用レコードの値）が使用されます。
この状態で上記関数でレコード番号に1以上を使用すると欠損値が戻ることになります。

実際の状況（データ値）を見ながら編集する場合は、データウインドウで対象のデータを「リアルモード」に設定します。

変数

変数値を操作する関数です。

関数	説明
ExportVar	変数値をファイルに出力(新規)します。
GetVarN	変数値を数値(NUMBER)として取得します。
GetVarM	変数値を画像(IMAGE)として取得します。
GetVarS	変数値を文字列(STRING)として取得します。
ImportVar	変数値をファイルから入力します。
SetVar	変数値を変更します。
SetVarM	変数値を変更します。（画像）
UpdateVar	変数値をファイルに出力(追加)します。

ページ/レコード

ページ番号・レコード番号を操作する関数です。

関数	説明
GetPageCount	ページ数を取得します。
GetPageDetailsNo	ページ内の「詳細」ユニットのNoを取得します。
GetPageNo	ページ番号を取得します。
GetPageRecordNo	ページ内のレコード番号を取得します。
GetRecordCount	レコード数を取得します。
GetRecordNo	レコード番号を取得します。
GetSectionPageCount	セクションのページ数（段組数）を取得します。
GetSectionPageNo	セクションのページ番号（段組番号）を取得します。

グループ

グループ情報を操作する関数です。

関数	説明
GetGroupCount	グループ分割数を取得します。
GetGroupFieldValueNA	グループ範囲内の特定フィールドの値を数値配列で一括取得します。
GetGroupFieldValueSA	グループ範囲内の特定フィールドの値を文字列配列で一括取得します。
GetGroupNo	グループ分割番号を取得します。
GetGroupRecordCount	グループ範囲でのレコード数を取得します。
GetGroupRecordNo	グループ範囲でのレコード番号を取得します。
GetGroupValue	グループ値を取得します。
GetGroupRecordCountEx1	グループ範囲でのレコード数を取得します。セクションオブジェクトで「開始レコード」「終了レコード」が指定されている場合、その範囲内での情報を返します。
GetGroupRecordNoEx1	グループ範囲でのレコード番号を取得します。セクションオブジェクトで「開始レコード」「終了レコード」が指定されている場合、その範囲内での情報を返します。
GroupBreak	GetGroupValueスクリプト中で、グループ範囲を区切る情報を取得します。
IsGroupStart	現在のレコードがグループ範囲の先頭か判定します。
IsGroupEnd	現在のレコードがグループ範囲の末尾か判定します。

プログラム実行

外部プログラムと連携するための関数です。

関数	説明
CallDllN	数値を返すDll関数を呼び出します。
CallDllS	文字列を返すDll関数を呼び出します。
CallEvent	Eventを発行します。
CallExe	外部プログラムを実行します。

その他

様々な機能を提供する関数です。

関数	説明
CorrectPath	フォルダ区切り文字をファイルの場所（ローカル/URL）に合わせて修正します。
FileDlg	ファイルダイアログを表示します。
GetBarcodeInfo	自アイテムより前に描画されたバーコードの品質情報を取得します。
GetData	データオブジェクトを取得します。
GetDeviceInfo	出力デバイスの情報を取得します。
GetFontList	使用可能なフォントのリストを取得します。
GetName GetReportName GetFormName GetSectionName GetUnitName	自身、あるいは親のオブジェクト名を取得します。
GetPath	オープンしている帳票が所属するローカルパス（あるいはURLパス）を取得します。
GetTempFile	一時ファイル名を取得します。
GetTestValue	テスト値を取得します。
IsEdit	コントロールの入力できるか確認します。
IsPrint	印刷モード/プレビューモードの判定を行います。
JapanPost	郵便番号・住所情報を検索・解析します。
MsgBox	メッセージダイアログを表示します。
Order	レコードを昇順/降順に並べ替えます。
PdfOut	PDFに出力します。
PrintOut	印刷を実行します。
PopupMenu	ポップアップメニューを表示します。
Scroll	指定ページの指定座標を表示（スクロール）します。
ScrollEx	指定セクションの指定レコードが表示を表示（スクロール）します。
ViewDlg	ダイアログに別帳票を表示します。