PESectionOptions

PESectionOptions contains specifications for formatting selected report sections and areas. This information is used by the PEGetSectionFormat and PEGetAreaFormat to retrieve current settings and PESetSectionFormat and PESetAreaFormat to pass new settings.

C Syntax
typedef struct PESectionOptions {
    WORD    StructSize;
    WORD    short visible;
    WORD    newPageBefore;
    WORD    newPageAfter;
    WORD    keepTogether;
    WORD    suppressBlankSection;
    WORD    resetPageNAfter;
    WORD    printAtBottomOfPage;
    COLORREF backgroundColor;
    short     underlaySection;
    short     showArea;
    short     freeFormPlacement;
    short     reserveMinimumPageFooter;
} PESectionOptions;
Members

StructSize

Specifies the size of the PESectionOptions structure. Initialize to PE_SIZEOF_SECTION_OPTIONS.

visible

Specifies whether or not the selected section is to be visible. Pass TRUE to keep the section visible, FALSE to hide the section, or PE_UNCHANGED for no change.

newPageBefore

Specifies whether or not the program is to insert a page break before the section is printed. Pass TRUE to insert a page break, FALSE to not insert a page break, or PE_UNCHANGED for no change.

newPageAfter

Specifies whether or not the program is to insert a page break after the section is printed. Pass TRUE to insert a page break, FALSE to not insert a page break, or PE_UNCHANGED for no change.

keepTogether

Specifies whether or not the program is to keep the section together, either on the current page (if there is room) or on the next (if not). Pass TRUE to keep the section together, FALSE to allow the program to split the section data from one page to the next if necessary, or PE_UNCHANGED for no change.

suppressBlank
Section

Specifies whether or not the program is to eliminate blank sections from your report. A section must be completely empty before the program suppresses it. Pass TRUE to eliminate the blank sections, FALSE to retain them, or PE_UNCHANGED for no change.

resetPageNAfter

Specifies whether or not the program is to reset the page number to one (1) for the following page, after it prints a group total. Pass TRUE to reset the page number, FALSE to retain the standard numbering, or PE_UNCHANGED for no change.

printAtBottomOf
Page

Specifies whether or not the program is to cause each group value to print only at the bottom of a page; FALSE to have the values print in their normal position, or PE_UNCHANGED for no change.

backgroundColor

Specifies the RGB color value contained in the COLORREF value, for section formats only. Use PE_UNCHANGED_COLOR to preserve the existing color or PE_NO_COLOR for no color.

underlaySection

Indicates whether or not the specified section is to underlay the following section(s). TRUE, FALSE, or PE_UNCHANGED for no change.

showArea

Specifies TRUE to show an area, FALSE to hide an area, or PE_UNCHANGED for no change. The user can drill down on a hidden area.

freeFormPlacement

Design time flag. If set to TRUE, an object can be placed anywhere in a section. Use PE_UNCHANGED for no change

reserveMinimum
PageFooter

Used to reduce unnecessary white space in the page footer area containing more than one conditionally formatted section. When set to TRUE, the space required to display only one section (the tallest) is reserved. When set to FALSE (default), the maximum height necessary to display every section in the page footer area at full height will be reserved. See Remarks below.

Remarks
VB Type Listing
Type PESectionOptions
    StructSize As Integer
    Visible As Integer
    NewPageBefore As Integer
    NewPageAfter As Integer
    KeepTogether As Integer
    SuppressBlankSection As Integer
    ResetPageNAfter As Integer
    PrintAtBottomOfPage As Integer
    BackgroundColor As Long
    UnderlaySection As Integer
    ShowArea As Integer
    FreeFormPlacement As Integer
    reserveMinimumPageFooter As Integer
End Type
Delphi Record Listing
type
    PESectionOptions = record
        StructSize: Word;
        visible: Smallint;
        newPageBefore: Smallint;
        newPageAfter: Smallint;
        keepTogether: Smallint;
        suppressBlankSection: Smallint;
        resetPageNAfter: Smallint;
        printAtBottomOfPage: Smallint;
        backgroundColor: COLORREF;
        underlaySection: Smallint;
        showArea: Smallint;
        freeFormPlacement: Smallint;
    end;


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