# All Classes and Interfaces

Class
Description
CachedImage
Cached Image Created by the IHTMLImageHandler.
ComponentID
a class that wraps around an identifier for a report component
CompressionMode
Specify the compression mode to generate ooxml file.
DataExtractionFormatInfo
DataExtractionOption
Handle extended extraction options
DataID
the data id of the data used by an instance.
DataSetID
ID represent the data set.
DefaultStatusHandler
default implementation for a status handler.
DOCRenderContext
DocumentUtil
DocxRenderOption
Render option of docx output
EmitterInfo
The descriptor of the plugin emitter.
EngineConfig
Wraps around configuration settings for report engine.
EngineConstants
Defines various constants that engine host may need to use
EngineException
Define an engine exception that clients of the engine need to handle.
EXCELRenderOption
HTMLActionHandler
Defines a default action handler for HTML output format
HTMLCompleteImageHandler
Default implementation for writing images in a form that is compatible with a web browser's "HTML Complete" save option, i.e., writes images to a predefined folder.
HTMLEmitterConfig
Deprecated.
since 2.2, use HTMLRenderOption or RenderOption directly
HTMLImageHandler
HTMLRenderContext
Deprecated.
set the property to RenderOption directly.
HTMLRenderOption
output settings for HTML output format
HTMLServerImageHandler
Default implementation for writing images in a form that is used in a web-application.
IAction
Defines an interface that allows engine to pass hyperlink information to an emitter, if the emitter determines to customize the hyperlinks calculated in engine, or it wants to use a totally different hyperlink string
IAutoTextContent
Provides the interfaces for the AutoText Content.
IBandContent
Provides the interface for the Band Content.
IBaseResultSet
IBookmarkInfo
ICascadingParameterGroup
ICascadingParameterSelectionChoice
ICellContent
Provides the interfaces for Cell Content
IColumn
column definition used by table content.
IContainerContent
Provides the interface for container content in report.
IContent
object created by report generator.
IContentEmitter
used to pass the content object to following process.
IContentVisitor
Defines the visitor interface used mainly by a buffered emitter
IContentWrapper
ICubeExtractionResults
ICubeResultSet
IDataAction
Data Action is used to generate a URL used to reterive the data from the data base.
IDataContent
Provides the interface for the Data Content.
IDataExtractionExtension
An extension-point for data extraction.
IDataExtractionOption
IDataExtractionTask
an engine task that extracts data from a report.
IDataIterator
An iterator on a result set from a prepared and executed query.
IDatasetPreviewTask
IDocument
IDocumentWriter
IDrillThroughAction
Providers interface for the action process of drill through.
IDynamicFilterParameterDefn
IElement
Provides the interface of the element of the report.
IEmitterServices
Defines interface to supply emitters with necessary information
IEngineConfig
IEngineTask
defines common features for an engine task.
IExcelRenderOption
IExecutorContext
IExtendedItem
IExtendedItemFactory
IExtractionOption
IExtractionResults
A handle used to retrieve data stored in a report.
IExtractionTask
IForeignContent
The content of foreign object is not handle by report engine.
IGetParameterDefinitionTask
an engine task that retrieves parameter definitions from a report.
IGroupContent
Provides interfaces for Group Content.
IHTMLActionHandler
Defines an interface for action handler used in HTML format
IHTMLImageHandler
Defines the image handler interface for use in HTML format
IHTMLRenderOption
Interface of constants of the HTML Render Opitons.
IHyperlinkAction
Defines an interface that allows engine to pass hyperlink information to an emitter, if the emitter determines to customize the hyperlinks calculated in engine, or it wants to use a totally different hyperlink string
IImage
Defines an interface to communicate info about an image to image handler
IImageContent
Image content in the report.
IInlineStackingLayout
ILabelContent
Provides the interface for the Label Content.
IListBandContent
Provides the interface for the Band Content in List.
IListContent
Provides interfaces for List Content.
IListGroupContent
Provide the interfaces for the List Group Content.
Image
ImageLayout
Image layout hanlder
ImageReader
Image reader of pdf output
ImageSize
Class of image size
IMetadataFilter
InlineBlockLayout
InlineContainerLayout
InlineStackingLayout
InlineTextLayout
INode
Tree interface.
InstanceID
a class that wraps around an identifier for a report element instance
IOnCreateEvent
IOnPrepareEvent
IOnRenderEvent
IPage
Interface to define a page
IPageContent
Page instance.
IPageDevice
IPageHandler
An interface implemented by app developer to provide handler after each page is generated in factoery.
IParameterDefn
base interface for a BIRT report parameter
IParameterDefnBase
Captures properties shared by all types of parameters and parameter group, i.e., name, display name, help text and custom-defined properties.
IParameterGroupDefn
The interface for objects which visually groups report parameters.
IParameterSelectionChoice
defines one choice in a parameter selction value list
IPDFRenderOption
Defines render options for PDF emitter.
IPostscriptRenderOption
IPPTRenderOption
IPreparationContext
IProgressMonitor
This interface is to trace the progress of BIRT.
IQueryContext
IQueryResultSet
IRenderOption
Defines render options for emitters
IRenderTask
An engine task that renders a Report Document to one of the output formats supported by the engine.
IReportContent
The object represents the report content as a whole.
IReportDocument
A report document (i.e., not modifiable) that can be rendered to other formats in the BIRT presentation engine This is the high-level report document interface.
IReportDocumentHelper
IReportDocumentInfo
the interface used to access the traisent informations of a report document.
IReportDocumentLock
lock used to lock the report document.
IReportDocumentLockManager
IReportEngine
A report engine provides an entry point for reporting functionalities.
IReportEngineFactory
a factory used to create the Report Engine.
IReportEvent
IReportEventContext
IReportEventHandler
IReportItemExecutor
IReportItemGeneration
Represents the extended item generation extension, which processes the report item at report geenration time.
IReportItemGenerationInfo
IReportItemPreparation
IReportItemPreparation is initially designed for extended item, which handles its nested items.
IReportItemPreparationInfo
IReportItemPresentation
Represents the extended item presentation time extension.
IReportItemPresentationInfo
IReportItemQuery
Defines the extended item query extension, which handles report query preparation.
IReportPart
Base interface that provides accessible information for a report part
IReportRunnable
A runnable report design (i.e., not modifiable) that can be run in the BIRT engine
IResultMetaData
Describes the metadata of a detail row in an IResultIterator.
IResultSetItem
IRowContent
Provides the interfaces for the Row AbstractContent
IRowMetaData
Defines a row that the extension might receive.
IRowSet
defines an interface that wraps around a row set.
IRunAndRenderTask
an engine task that runs a report and renders it to one of the output formats supported by the engine.
IRunnable
IRunTask
An engine task that runs a report and generates a report document.
IScalarParameterDefn
Defines a scalar parameter
IStatusHandler
Interface that defines several status handler callback functions.
IStyle
Provides the interfaces for the ROM style the properties must be string as the user may change them in script.
IStyledElement
Interface of styled element
ITableBandContent
Provides the interfaces for the Table Band Content
ITableContent
Provides the interfaces for the Table Content
ITableGroupContent
Provide the interfaces for the Table Group Content.
ITaskOption
Define the interface of task options
ItemExecutorWrapper
ITextContent
Provides the interfaces for the Text Content Text content contains several paragraphs which shares the same style properties.
ITOCTree
Represents a whole TOC tree.
PDFRenderContext
Deprecated.
set the option to RenderOption directly.
PDFRenderOption
Defines render options for emitters
RenderOption
Settings for rendering a report to an output format.
RenderOptionBase
Deprecated.
use RenderOption instead
ReportEngine
This is a wrapper class for the IReportEngine.
ReportParameterConverter
Utilites class to convert report paramete value between object and string.
ReportRunner
Defines a standalone reporting application that uses `StandaloneReportEngine` class.
TaskOption
Define the class of task options
TOCNode
A node that wraps around a TOC entry.
TOCStyle
Definition of the TOC styles
UnsupportedFormatException