Package com.crystaldecisions.sdk.plugin.desktop.common

This package allows you to gather and set processing information on a Crystal report, Desktop Intelligence document, or Web Intelligence document before or after scheduling it.

See:
Description

Interface Summary

ICacheServerGroupInfo	This interface defines a set of information about the cache server group.
IExcelDataOnlyFormat	The IExcelDataOnlyFormat interface allows you to set the options for a report that is to be exported as an Excel spreadsheet.
IExcelFormat	The IExcelFormat interface allows you to set the options for a report that is to be scheduled as an Excel spreadsheet.
IExcelFormat.CeReportExportHeaderFooterOption	Specifies the way page header and footer are exported.
IExcelFormat.SectionType	Specifies the section to base the column width on when exporting to Excel.
IPageFormat	This abstract interface is used by other exporting sub-classes to set how the pages of a report will be exported.
IPDFFormat	The IPDFFormat interface allows you to set the options for a report that is to be scheduled to a pdf format.
IProcessingExtension	This interface allows you to retrieve information about a processing extension contained in the ProcessingExtensions Collection.
IProcessingExtensions	This collection allows you to add, delete, and manage customized processing extensions.
IProcessingServerGroupInfo	This interface defines a set of information about the processing server group.
IReportAlert	This interface allows you to specify the alert information that is displayed in an alert notification email.
IReportAlerts	This collection contains the list of alerts defined in a given report.
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.
IReportFormatOptions.CeReportFormat	Specifies the Report Format Type for scheduling the export of a report.
IReportHyperlink	This interface provides the support necessary to use the report hyperlink object within reports.
IReportHyperlink.CeHyperlinkType	Specifies the hyperlink type, used when retrieving a hyperlink for export.
IReportLogon	The IReportLogon interface contains logon information for a database the report must retrieve data from.
IReportLogon.CeReportServerType	Specifies the Report Database Server Type.
IReportParameter	The IReportParameter interface represents a single parameter for a particular report.
IReportParameter.ParameterPickListSortMethod	Deprecated.
IReportParameter.ReportVariableValueType	The type of the parameter value.
IReportParameterRangeValue	The IReportParameterRangeValue interface stores detailed information about the parameter value if it is a range value.
IReportParameterSingleValue	The IReportParameterSingleValue interface stores detailed information about the parameter value itself, if it is a single value.
IReportParameterValue	The IReportParameterValue interface enables you to examine any one of the default or current values of a parameter.
IReportParameterValue.DateFormat	This interface is used to specify the date parse format.
IReportParameterValues	The IReportParameterValues interface returns a collection of IReportParameterValue objects that represent the value, or values, for a specified parameter.
IReportPrinterOptions	This interface allows you to set the printer options for a report.
IReportPrinterOptions.CePageSize	Specified Report Page Size.
IReportPrinterOptions.CePrintCollateType	Specifies the report print collation.
IReportPrinterOptions.CeReportLayout	Specifies Report Layout.
IReportProcessingExtension	This interface allows you to retrieve information about a processing extension contained in the IReportProcessingExtensions collection.
IReportProcessingExtensions	This collection allows you to add, delete, and manage customized processing extensions that are applied to the report.
IReportProcessingInfo	This interface is used to gather and set processing information on a report, or a report instance, before or after running the report.
IReportRefreshOptions	This interface is used for setting the report refresh options used when refreshing report properties.
IReportRefreshOptions.CeRefreshOption	Specifies the report refresh options.
IReportTablePrefix	The IReportTablePrefix interface allows you to change the table prefix template.
IRichTextFormat	The IRichTextFormat interface allows you to set the options for a report that is to be scheduled to a rich text format.
IRichTextFormatEditable	This interface allows you to set custom options for a report that is to be scheduled to a rich text format.
ITextFormatCharacterSeparated	This interface allows you to set the options when during the export of a report to a text file with character separated values.
ITextFormatPaginated	This interface allows you to set the options when exporting a report to a paginated text file.
ITextFormatPlain	This interface allows you to set the options when exporting a report to a plain text file.
ITextFormatSeparated	This interface defines a text format.
ITextFormatSeparated.CeExportMode	This interface defines the available export modes for the text format object.
ITextFormatSeparated.CeGroupSectionsOption	This interface defines the available options for group sections.
ITextFormatSeparated.CeReportSectionsOption	This interface defines the available report section options for the text format object.
ITextFormatTabSeparated	This interface allows you to set the options when exporting a report to a text file with tab separated values.
ITextFormatTabSeparatedText	The ITextFormatTabSeparatedText interface allows you to set the options for a report that is to be scheduled to a text format with a set of data records, layout is not exported.
IViewingServerGroupInfo
IWordFormat	The IWordFormat interface allows you to set the options for a report that is to be scheduled to a word format.

Package com.crystaldecisions.sdk.plugin.desktop.common Description

This package allows you to gather and set processing information on a Crystal report, Desktop Intelligence document, or Web Intelligence document before or after scheduling it. It allows export format options, processing extensions, logon information, as well as report parameters to be retrieved or set. To access more basic report information from a report plugin object, use the IReport interface.

Retrieving desktop plugins

Each object that is created with a desktop plugin is stored in either the CI_INFOOBJECTS or the CI_SYSTEMOBJECTS category in the CMS InfoStore, and is marked with a programmatic identifier (SI_KIND). Using SI_KIND, you can query the CMS InfoStore for a collection of objects.

Example

The following query selects the names and IDs of all Report objects in the CMS:

IInfoObjects objs = iStore.query("SELECT SI_NAME, SI_ID FROM CI_INFOOBJECTS WHERE SI_KIND='CrystalReport'");

The query method returns a collection of InfoObjects, which in this case are report plugin objects. Like other InfoObjects, these objects are uniquely represented by their ID property. For each object in the collection, you can access general InfoObject properties, such as the SI_NAME property, SI_DESCRIPTION property, and SI_ID property.

To access the IReportProcessingInfo object returned by the query, the resulting IInfoObjects need to be cast. This example demonstrates how to cast the returned IInfoObjects as IReportProcessingInfo objects.

for ( int i = 0; i < objs.size(); i++ )
{
    IInfoObject obj = (IInfoObject) objs.get( i );
    IReportProcessingInfo processingInfo = (IReportProcessingInfo) obj;
}

Note: The IReportProcessingInfo object can be cast as an IReport object to set more basic methods if the object is a report plugin. However, all report format objects, such as IExcel, IPDF, IRTF, ITxt, and IWord can be cast as IReportProcessingInfo objects, but not IReport objects.

Related Documentation

• Object Model Diagram

See Also:

IReport