com.crystaldecisions.sdk.occa.report.definition
Interface IPageAreaFormat

All Superinterfaces:
IAreaFormat, IClone, ISectionAreaFormat
All Known Implementing Classes:
PageAreaFormat

public interface IPageAreaFormat
extends IAreaFormat

This interface enables you to get and set the formatting behaviour of a page header or page footer area.


Method Summary
 boolean getEnableReserveMinimumPageFooter()
          Gets whether the page footer areas will be minimized to use less space.
 void setEnableReserveMinimumPageFooter(boolean b)
          Sets whether the page footer areas should be minimized to use less space.
 
Methods inherited from interface com.crystaldecisions.sdk.occa.report.definition.IAreaFormat
getEnableHideForDrillDown, setEnableHideForDrillDown
 
Methods inherited from interface com.crystaldecisions.sdk.occa.report.definition.ISectionAreaFormat
getBackgroundColor, getConditionFormulas, getEnableKeepTogether, getEnableNewPageAfter, getEnableNewPageBefore, getEnablePrintAtBottomOfPage, getEnableResetPageNumberAfter, getEnableSuppress, setBackgroundColor, setConditionFormulas, setEnableKeepTogether, setEnableNewPageAfter, setEnableNewPageBefore, setEnablePrintAtBottomOfPage, setEnableResetPageNumberAfter, setEnableSuppress
 

Method Detail

getEnableReserveMinimumPageFooter

boolean getEnableReserveMinimumPageFooter()
Gets whether the page footer areas will be minimized to use less space. See getEnableReserveMinimumPageFooter() for more information about this option.

Returns:
true if the reserved space for page footer areas will be minimized, or false otherwise.
See Also:
getEnableReserveMinimumPageFooter()

setEnableReserveMinimumPageFooter

void setEnableReserveMinimumPageFooter(boolean b)
Sets whether the page footer areas should be minimized to use less space.

This option enables you to minimize the space reserved for Page Footer sections, thereby maximizing the space available for report information on each page. This option only affects a Page Footer area with multiple sections.

By default, space is reserved at the bottom of each page for your Page Footer sections. This space is reserved whether or not the Page Footer sections are conditionally suppressed. Normally, the space reserved is equivalent to the combined height of all Page Footer sections that are shown or conditionally suppressed.

You can, however, minimize the space reserved. To do so, first conditionally suppress individual Page Footers as desired. Then use the Reserve Minimum Page Footer option to only reserve space on each page for the tallest of your Page Footer sections.

Parameters:
b - Use true to indicate that the reserved space for page footer areas should be minimized.