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


public interface IReportFormatOptions

This interface allows you to set the export format type for a report and retrieve specific export objects to set more detailed format options.


Nested Class Summary
static interface IReportFormatOptions.CeReportFormat
           Specifies the Report Format Type for scheduling the export of a report.
 
Method Summary
 int getFormat()
           Returns the export format type of this report.
 java.lang.Object getFormatInterface()
           Returns the specific format interface.
 boolean isUseExportOptionsInReport()
           Returns a boolean that indicates if the report uses export options.
 void setFormat(int FormatType)
           Sets the export format type of this report.
 void setUseExportOptionsInReport(boolean value)
           Sets a boolean that indicates if the report uses export options.
 

Method Detail

getFormat

public int getFormat()

Returns the export format type of this report.

Returns:
An int specifying the export format type of this report. This will be of type CeReportFormat.
See Also:
IReportFormatOptions.CeReportFormat

setFormat

public void setFormat(int FormatType)
               throws SDKException

Sets the export format type of this report.

Parameters:
FormatType - An int of type CeReportFormat specifying the export format type of this report.
Throws:
SDKException - This is thrown if the process is unsuccessful.

getFormatInterface

public java.lang.Object getFormatInterface()
                                    throws SDKException

Returns the specific format interface. This interface allows modification of Excel and Text formats.

Returns:
An Object containing the format specific interface. This can be one of the following ITextFormatCharacterSeparated, ITextFormatTabSeparated, ITextFormatPaginated, ITextFormatPlain, IExcelFormat, IExcelDataOnlyFormat, IRichTextFormat, IRichTextFormatEditable, IWordFormat or IPDFFormat.
Throws:
SDKException - This is thrown if the process is unsuccessful.
See Also:
ITextFormatCharacterSeparated, ITextFormatTabSeparated, ITextFormatPaginated, ITextFormatPlain, IExcelFormat, IExcelDataOnlyFormat, IRichTextFormat, IRichTextFormatEditable, IWordFormat, IPDFFormat

isUseExportOptionsInReport

public boolean isUseExportOptionsInReport()
                                   throws SDKException

Returns a boolean that indicates if the report uses export options.

Returns:
true if the report uses export options, and false otherwise.
Throws:
SDKException - This is thrown if the process is unsuccessful.

setUseExportOptionsInReport

public void setUseExportOptionsInReport(boolean value)

Sets a boolean that indicates if the report uses export options.

Parameters:
value - A boolean that indicates if the report uses export options.