com.crystaldecisions.sdk.plugin.desktop.common
Interface IRichTextFormatEditable

All Superinterfaces:

IPageFormat

public interface IRichTextFormatEditable
extends IPageFormat

This interface allows you to set custom options for a report that is to be scheduled to a rich text format.

Method Summary

boolean	isPageBreakAfterEachReportPage() Returns a boolean that indicates whether the option of inserting a page break after each report page is turned on.
void	setPageBreakAfterEachReportPage(boolean value) Sets a boolean that indicates whether the option of inserting a page break after each report page is turned on.

Methods inherited from interface com.crystaldecisions.sdk.plugin.desktop.common.IPageFormat

getEndPageNumber, getStartPageNumber, isAllPagesExported, setAllPageExported, setEndPageNumber, setStartPageNumber

Method Detail

isPageBreakAfterEachReportPage

boolean isPageBreakAfterEachReportPage()
                                       throws SDKException

Returns a boolean that indicates whether the option of inserting a page break after each report page is turned on.

Returns:

true if the option is turned on, flase otherwise.

Throws:

SDKException - This is thrown if the property does not exist.

setPageBreakAfterEachReportPage

void setPageBreakAfterEachReportPage(boolean value)

Sets a boolean that indicates whether the option of inserting a page break after each report page is turned on.

Parameters:

value - true to turn on the option, false to turn off