スクリプト-関数（グループ）

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



GetGroupCount 関数

グループ分割数を取得します。

<構文>

GetGroupCount( name As STRING ) As NUMBER

<引数>
引数 説明
name 情報を取得したいグループ名を指定します。


<戻り値>
指定グループの分割数を戻します。（1〜）

<使用例>

return GetGroupCount("Group1");



GetGroupFieldValueNA 関数

グループ範囲内の特定フィールドの値を数値配列で一括取得します。


<構文>

GetGroupFieldValueNA( group_name As STRING, field_name As STRING) As NUMBER_ARRAY


<引数>

引数 説明
group_name グループ名を指定します。
field_name フィールド名を指定します。


<戻り値>
指定したグループ範囲内の指定フィールドの値を全て数値配列で戻します。

<使用例>

GRAPH g;
g.AddItems(GetGroupFieldValueSA("Group_担当者", "年月"));
g.AddValue(TRUE, "売上");
g.Add(GetGroupFieldValueNA("Group_担当者", "売上"));
return g.GetGraphString();



GetGroupFieldValueSA 関数

グループ範囲内の特定フィールドの値を数値配列で一括取得します。


<構文>

GetGroupFieldValueSA( group_name As STRING, field_name As STRING) As STRING_ARRAY


<引数>

引数 説明
group_name グループ名を指定します。
field_name フィールド名を指定します。


<戻り値>
指定したグループ範囲内の指定フィールドの値を全て文字列配列で戻します。

<使用例>

GRAPH g;
g.AddItems(GetGroupFieldValueSA("Group_担当者", "年月"));
g.AddValue(TRUE, "売上");
g.Add(GetGroupFieldValueNA("Group_担当者", "売上"));
return g.GetGraphString();



GetGroupNo 関数

グループ分割番号を取得します。

<構文>

GetGroupNo( name As STRING ) As NUMBER


<引数>

引数 説明
name 情報を取得したいグループ名を指定します。


<戻り値>
指定グループの分割番号を戻します。（1〜）

<使用例>

return GetGroupNo("Group1");



GetGroupRecordCount 関数

グループ範囲でのレコード数を取得します。

<構文>

GetGroupRecordCount( name As STRING ) As NUMBER


<引数>

引数 説明
name 情報を取得したいグループ名を指定します。


<戻り値>
指定グループ範囲でのレコード数を戻します。（1〜）

<使用例>

return GetGroupRecordCount("Group1");



GetGroupRecordNo 関数

グループ範囲でのレコード番号を取得します。

<構文>

GetGroupRecordNo( name As STRING ) As NUMBER


<引数>

引数 説明
name 情報を取得したいグループ名を指定します。


<戻り値>
指定グループ範囲でのレコード番号を戻します。（1〜）

<使用例>

return GetGroupRecordNo("Group1");



GetGroupValue 関数

グループ値を取得します。

<構文>

GetGroupValue( name As STRING ) As STRING

<引数>
引数 説明
name 情報を取得したいグループ名を指定します。


<戻り値>
指定グループの値を文字列で戻します。

<使用例>

return GetGroupValue("Group1");



GetGroupRecordCountEx1 関数

グループ範囲でのレコード数を取得します。

セクションオブジェクトで「開始レコード」「終了レコード」が指定されている場合、その範囲内での情報を返します。

「開始レコード」「終了レコード」が指定されていない場合は、GetGroupRecordCount 関数と同じ結果を返します。

<構文>

GetGroupRecordCountEx1( name As STRING ) As NUMBER


<引数>

引数 説明
name 情報を取得したいグループ名を指定します。


<戻り値>
指定グループ範囲でのレコード数を戻します。（1〜）

<使用例>

return GetGroupRecordCountEx1("Group1");



GetGroupRecordNoEx1 関数

グループ範囲でのレコード番号を取得します。

セクションオブジェクトで「開始レコード」「終了レコード」が指定されている場合、その範囲内での情報を返します。

「開始レコード」「終了レコード」が指定されていない場合は、GetGroupRecordNo 関数と同じ結果を返します。

<構文>

GetRecordNoEx1( name As STRING ) As NUMBER

<引数>
引数 説明
name 情報を取得したいグループ名を指定します。


<戻り値>
指定グループ範囲でのレコード番号を戻します。（1〜）

<使用例>

return GetGroupRecordNoEx1("Group1");



GroupBreak 関数

GetGroupValueスクリプト中で、グループ範囲を区切る情報を取得します。
[version 1.1.17.3035以降で利用できます]

<構文>

GroupBreak( flags As NUMBER ) As STRING


<引数>

引数 説明
flags グループを区切る方法を指定します。

値 説明
0 このレコードではBreakしません。
1 このレコードの前でBreakします。
2 このレコードの後でBreakします。


<戻り値>
グループの区切り情報となる文字列を戻します。

<使用例>

if (GetS("Field1") == "合計") {
   return GroupBreak(2);
}
return GroupBreak(0);



IsGroupStart 関数

現在のレコードがグループ範囲の先頭か判定します。
[version 1.1.17.3036以降で利用できます]

GetGroupRecordNo("Group1") == 1
と同じ結果となります。

<構文>

IsGroupStart( name As STRING ) As NUMBER


<引数>

引数 説明
name 情報を取得したいグループ名を指定します。


<戻り値>
現在のレコードがグループ範囲の先頭の場合は TRUE を戻します。
それ以外は FALSE を戻します。

<使用例>

return IsGroupStart("Group1");



IsGroupEnd 関数

現在のレコードがグループ範囲の末尾か判定します。
[version 1.1.17.3036以降で利用できます]

GetGroupRecordNo("Group1") == GetGroupRecordCount("Group1")
と同じ結果となります。

<構文>

IsGroupEnd( name As STRING ) As NUMBER


<引数>

引数 説明
name 情報を取得したいグループ名を指定します。


<戻り値>
現在のレコードがグループ範囲の末尾の場合は TRUE を戻します。
それ以外は FALSE を戻します。

<使用例>

return IsGroupEnd("Group1");