PEGroupOptions

PEGroupOptions contains information about report group options. This information is used by PEGetGroupOptions to retrieve current options and by PESetGroupOptions to pass new options.

C Syntax
typedef struct PEGroupOptions {
    WORD StructSize;
    short condition;
    char fieldName [PE_FIELD_NAME_LEN];
    short sortDirection;
    short repeatGroupHeader;
    short keepGroupTogether;
    short topOrBottomNGroups;
    char topOrBottomNSortFieldName [PE_FIELD_NAME_LEN];
    short nTopOrBottomGroups;
    short discardOtherGroups;
    short hierarchicalSorting;
    char instanceIDField [PE_FIELD_NAME_LEN];
    char parentIDField [PE_FIELD_NAME_LEN];
    long groupIndent;
} PEGroupOptions;
Members

StructSize

Specifies the size of the PEGroupOptions structure. Initialize to PE_SIZEOF_GROUP_OPTIONS.

condition

Specifies the condition setting for the selected group section. When getting, use PE_GC_TYPEMASK and PE_GC_CONDITIONMASK to decode the condition. When setting, pass a PE_GC_XXX Group Condition Constants, or PE_UNCHANGED for no change.

fieldName

Specifies the field name of the group field (of length PE_FIELD_NAME_LEN = 512). Use formula form or leave empty for no change.

sortDirection

Specifies one of the Sort Order Constants or PE_UNCHANGED for no change.

repeatGroupHeader

TRUE, FALSE, or PE_UNCHANGED for no change.

keepGoupTogether

TRUE, FALSE, or PE_UNCHANGED for no change.

topOrBottomNGroups

Use one of the following PE_GO_TBN_XXX constants or PE_UNCHANGED for no change.


Constant Description


PE_GO_TBN_ALL_GROUPS_
UNSORTED

There is no group sorting or Top/Bottom N for this level of grouping.


PE_GO_TBN_ALL_GROUPS_
SORTED

There is group sorting, but not Top/Bottom N.


PE_GO_TBN_TOP_N_GROUPS

Top N groups will be selected.


PE_GO_TBN_BOTTOM_N_GROUPS

Bottom N groups will be selected.

topOrBottomNSort
FieldName

Specifies the field name (of length PE_FIELD_NAME_LEN = 512) of the summary field by which the groups are ordered. Use formula form or leave empty for no change.

nTopOrBottomGroups

Specifies the number of groups to keep. Use 0 to keep all groups and PE_UNCHANGED for no change.

discardOtherGroups

Determines whether the remaining groups are collected into an Others group or discarded. TRUE, FALSE, or PE_UNCHANGED for no change.

hierarchicalSorting

Specifies whether or not sorting is hierarchical. TRUE, FALSE, or PE_UNCHANGED for no change.

instanceIDField

Specifies the instance ID field (of length PE_FIELD_NAME_LEN = 512) for hierarchical sorting

parentIDField

Specifies the parent ID field (of length PE_FIELD_NAME_LEN = 512) for hierarchical sorting

groupIndent

Specifies the indent for hierarchical group sorting, in twips.

Remarks

If topOrBottomNGroups is PE_GO_TBN_TOP_N_GROUPS or PE_GO_TBN_BOTTOM_N_GROUPS, all the group sort fields related to this group will be deleted. A new group sort field will be added with the sort direction of descending or ascending. The group sort field will be sorted by specifying topOrBottomNSortFieldName if it is not empty. It will be sorted by the first group sort field name related to this group (before it is deleted) if topOrBottomNSortFieldName is empty.

VB Type Listing
Type PEGroupOptions
    StructSize As Integer
    condition As Integer
    fieldName As String * PE_FIELD_NAME_LEN
    sortDirection As Integer
    repeatGroupHeader As Integer
    keepGroupTogether As Integer
    topOrBottomNGroups As Integer * PE_FIELD_NAME_LEN
    topOrBottomNSortFieldName As String * PE_FIELD_NAME_LEN
    nTopOrBottomGroups As Integer
    discardOtherGroups As Integer
    hierarchicalSorting As Integer
    instanceIDField As String * PE_FIELD_NAME_LEN
    parentIDField As String * PE_FIELD_NAME_LEN
    groupIndent As Long
End Type
Delphi Record Listing
type 
    PEFieldNameType = array[0..PE_FIELD_NAME_LEN-1] of char;
    PEGroupOptions = record
        StructSize: Word;
        condition: smallint;
        fieldName: PEFieldNameType;
        sortDirection: smallint;
        repeatGroupHeader: smallint;
        keepgroupTogether: smallint;
        topOrBottomNGroups: smallint;
        topOrBottomNSortFieldName: PEFieldNameType;
        nTopOrBottomGroups: smallint;
        discardOtherGroups: smallint
    end;


Seagate Software IMG Holdings, Inc.
http://www.seagatesoftware.com
Support services:
http://support.seagatesoftware.com