# All Classes and Interfaces

Class
Description
AbstractScalarParameterHandle
Represents the abstract scalar parameter types.
AbstractScalarParameterHandleImpl
Represents the abstract scalar parameter types.
AbstractThemeHandle
Represents a abstract theme in the library.
AccessControlHandle
Deprecated.
Action
The Action structure defines a hyperlink.
ActionHandle
Represents an "action" (hyperlink) attached to an element.
ActivityStackEvent
This event class identifies that the activity stack changes.
ActivityStackListener
The interface receives events about activity stack changes.
AggregationArgument
AggregationArgument.
AggregationArgumentHandle
AggregationArgumentHandle.
AggregationDefn
ArgumentInfo
Represents the definition of argument.
ArgumentInfo
Represents the definition of argument.
ArgumentInfoList
Represents an optional argument list of a method.
ArgumentInfoList
Represents an optional argument list of a method.
AttributeEvent
Notification event that says that the attribute of the module is changed.
AutoTextHandle
Represents a autotext report item.
BasicLayoutStrategies
The strategy to recover the table from an invalid layout to a valid one.
BookmarkValidator
BundleFactory
The internal factory to find resources in the bundle.
CachedMetaData
Structure used to cache data set information that include output column information when it gets from databases, input/output parameter definitions.
CachedMetaDataHandle
Structure handle to deal with cached data set metadata informations.
CalculationArgument
CalculationArgument.
CalculationArgumentHandle
CalculationArgumentHandle.
CascadingParameterGroupHandle
Represents the group of cascading parameters.
CascadingParameterGroupHandleImpl
Represents the group of cascading parameters.
CascadingParameterTypeValidator
Validates that type of the parameters in a cascading parameter group should be "dynamic".
CellHandle
Represents a cell within a table or grid.
CellOverlappingValidator
Validates all cells in one row don't overlap each other.
ChoiceDefinition
Adapter class for the IChoiceDefinition class.
CircularExtendsException
An error indicates circular extension while setting the extends property of an element.
ClassInfo
Represents the script object definition.
ClassInfo
Represents the script object definition.
ColorHandle
Handle to work with a color property.
ColorUtil
Utility class to do color parsing or converting work.
ColumnBandData
Represents the data structure to store copied objects like the column and cells.
ColumnBindingUtil
The utility class for bound data columns migration.
ColumnHandle
Represents a column within a table.
ColumnHint
This class represents one column hint used by data sets.
ColumnHintHandle
Represents the handle of column hint.
CommandStack
Application-level interface into the Model's command stack.
CompatibilityStatus
Class that records some status after the report item checks the compatibilities.
CompatibilityUtil
Provides the backward compatibility for the user.
ComplexValueHandle
Abstract class for working with properties that have internal structure, such as a color, a dimension or a font.
ComputedColumn
Represents one computed column.
ComputedColumnHandle
Represents the handle of computed column.
ConfigVariable
This class represents a configuration variable in the report's config variable list.
ConfigVariableHandle
Represents the handle of configuration variable.
ConstructorInfo
Represents the method information for both class and element.
ContentElementHandle
ContentEvent
Notification event that says that the contents of a container have changed.
ContentException
Reports an error during a container operation.
ContentReplaceEvent
Notification event that says that one content of a container have been replaced by another one.
CopyUtil
The utility class for copy/paste.
CssEvent
Included css style sheet event
CssException
Included css style sheet exception
CssReloadedEvent
Included css style sheet reload event
CssSharedStyleHandle
Css shared style handle.
CssStyleSheetHandle
Represents an include style sheet in the module.
CubeHandle
Represents a cube.
CubeUtil
Utility class to provide some methods about cube.
CustomColor
Represents an custom color in the report's color palette.The use-defined color has a unique name and a valid RGB value for render.
CustomColorHandle
Represents the handle of custom color.
CustomMsgEvent
Notification event that says that the contents of user-defined message is added, dropped, or changed.
CustomMsgException
Reports an error during a user-defined message operation.
DataColumnNameValidator
Validates the result set column of the data item.
DataGroupHandle
DataItemHandle
Represents a data item element.
DataSetHandle
Abstract handle for data set elements.
DataSetNameRequiredValidator
Validates the data set name of scalar parameter is required.
DataSetNameRequiredValidatorImpl
Validates the data set name of scalar parameter is required.
DataSetParameter
Represents the parameter for ODA drivers.
DataSetParameterHandle
Represents the parameter for data set drivers.
DataSetRequiredValidator
Validates the data set of some special elements should be provided.
DataSetResultSetValidator
Deprecated.
since birt 2.2
DataSourceHandle
This abstract class represents a data source element: a connection to an external data provider such as an SQL database.
DataTypeConvertUtil
The utility class to convert values between parameter type choices and column data type choices.
DateFormatValue
The format value for the data.
DateTimeFormatValue
The format value for the data-time.
DefaultResourceLocator
The default implementation for interface `IResourceLocator`.
DerivedDataSetHandle
Provides API to operate a derived data set.
DesignChoiceConstants
This class collects commonly-used choice constants.
DesignConfig
Wraps around configuration settings for design engine.
DesignElementHandle
Base class for all report elements.
DesignEngine
Represents the BIRT design engine as a whole.
DesignEngineFactory
Factory pattern to create an instance of Design Engine
DesignEngineImpl
Implementation of DesignEngine.
DesignFileException
Signals that a fatal error occurred when opening a design file.
DesignVisitor
Applies logic customized to each type of report element.
DimensionCondition
The DimensionCondition structure defines a list of join conditions between cube and hierarchy.
DimensionConditionHandle
Represents the handle of the cube-dimension/hierarchy join condition.
DimensionHandle
Simplifies working with dimension properties.
DimensionHandle
Represents a dimension element in the cube element.
DimensionJoinCondition
Represents a dimension join condition in the DimensionCondition.
DimensionJoinConditionHandle
Represents a dimension join condition in the DimensionCondition.
DimensionUtil
Utility class to do conversions between units.
DimensionValue
Representation of a dimension property value.
DisposeEvent
Notification event that says that the module is disposed.
DocumentUtil
Utility class for the serialize a report design in which all the elements localize their property values from the referred external resources, such as library elements, library embedded images.
DynamicFilterParameterHandle
Represents the dynamic filter parameter types.
ElementCommand
Extension adapter class for the IElementCommand.
ElementDeletedEvent
Indicates that an element was deleted.
ElementDetailHandle
Abstract base class for property handles, slot handles, structure handles an other handles that provide detail about a report element.
ElementExportUtil
Represents the utility class to help export element and structure to library file.
ElementExportUtilImpl
Represents the utility class to help export element and structure to library file.
ElementExtendsValidator
Validates the element extends property.
ElementFactory
Creates a new report elements and returns handles to it.
ElementLocalizeEvent
Events indicating that the element is just localized.
ElementReferenceValidator
Validates the property whose type is element reference.
EmbeddedImage
Represents an embedded image.
EmbeddedImageHandle
Represents the handle of an embedded image.
EmptyGroupElementHandle
Implements an empty group element handle, which actually can do nothing.
EncryptionEvent
Identifies that the encryption of an element property changed.
EncryptionException
Indicates an error when setting the name of an element.
ErrorCodes
Implements to define the error codes that are exposed to api.
ErrorDetail
Provides detail information about errors found when opening a design file.
Expression
Represents the object for the expression.
ExpressionHandle
Simplifies working with expression properties.
ExpressionListHandle
Simplifies working with expression lists.
ExpressionType
Enumerates the expression types.
ExtendedElementException
Base class for all peer-provided exceptions.
ExtendedItemHandle
Represents an extended element.
ExtendedProperty
This class represents one Extended property.
ExtendedPropertyHandle
Represents the handle of Extended property.
ExtendsEvent
Indicates that the extends attribute of an element changed.
ExtendsException
Indicates an error while setting the extends property of an element.
ExtendsForbiddenException
An error indicates not supported extension while setting the extends property of an element.
ExtensionPropertyDefinitionEvent
Notification event to send when the dynamic property list is changed after setting an extension property value.
ExtensionValidator
Validates the extension is valid, which is provided by `IReportItem`.
FactoryElementHandle
Factory element handle class to retrieve some factory styles.
FactoryPropertyHandle
A specialized handle for use when creating the Factory data structures.
FillCellsStrategy
The strategy to fill empty areas with `LayoutCell`s and `Cell` elements.
FilterCondition
Represents one filter in the filter list of List, Table or their Groups.
FilterConditionElementHandle
FilterConditionHandle
Represents one filter in the filter list of List, Table or their Groups.
FilterExprDefinition
FilterExprDefinition
FontHandle
Simplifies working with the font family property.
FormatValue
The abstract value for the format of string, data-time and number.
FormatValueHandle
Represents a format value in the style or the highlight rule.
FreeFormHandle
Represents a free-form element.
GraphicMasterPageHandle
Represents a graphic master page in the design.
GridColumnBandAdapter
Represents an object of copied objects when do copy/paste operations between grids.
GridHandle
Represents a grid item in the design.
GridRowBandAdapter
Represents an object of copied objects when do copy/paste operations between grids.
GroupElementFactory
This class is a factory class to instantiate a group element handle.
GroupElementHandle
This class provides services to deal with a group of elements.
GroupHandle
Represents both list and table groups in the design.
GroupNameValidator
Validates the ducplicat group name in one table with data set.
GroupPropertyHandle
A handle for working with a top-level property of a collection of elements.
HideRule
Implements hide rules of a `ReportItem`.
HideRuleHandle
Represents the handle of visibility rule.
HierarchyHandle
Represents a Hierarchy.
HighlightRule
Represents a highlight rule that says how a data item should appear based on the value within it.
HighlightRuleHandle
Represents a highlight rule in the highlight property of a style.
IAbsoluteFontSizeValueProvider
Provides the absolute dimension value for absolute font size constant.
IAccessControl
Represents the visibility level of a module.
IAction
Script wrapper of `ActionHandle`
IActivityRecord
Application-level interface into the Model's activity record.
IAggregationDefn
IArgumentInfo
Represents the definition of argument.
IArgumentInfoList
Represents an optional argument list of a method.
IAttributeListener
Receives file name events after one attribute of the report design is changed.
IAutoText
Simple wrapper of AutoTextHandle
IBirtAggregationConstants
IBirtFilterOperatorConstants
IBirtFilterOperatorConstants
IBookmarkInfo
IBundleFactory
Retrieves resources in the Eclipse bundle.
ICell
Represents a the design of a Cell in the scripting environment
IChoice
Describes the options for a property value.
IChoiceDefinition
Defines a choice within a list of property choices defined by a peer extension.
IChoiceSet
Represents a set of choices on a predefined or user defined property type or property definition.
IClassInfo
Represents the script object definition.
IColor
IColorConstants
The interface for constants of colors used in BIRT.
IColumn
Script wrapper of ColumnHandle.
ICompatibleReportItem
Represents an instance of a extended report element that can work with the bound data columns.
IDataBinding
Represents the design of an DataBinding in the scripting environment
IDataItem
Represents a the design of a DataItem in the scripting environment
IDataSet
Script wrapper of OdaDataSetHandle
IDataSource
Script wrapper of OdaDataSourceHandle
IDesignConfig
IDesignElement
Interface for all the design elements.
IDesignElement
Script wrapper of DesignElementHandle
IDesignEngine
Represents the BIRT design engine as a whole.
IDesignEngineFactory
Factory class to create an instance of DesignEngine
IDisposeListener
Receives dispose events after one report design is disposed.
IDynamicText
Represents a the design of a multi line text item in the scripting environment
IElementCommand
Represents a extended element command that is integrated with the BIRT command stack.
IElementCopy
The copied object created from `CopyUtil.copy()`.
IElementDefn
Interface for a report element definition.
IElementPropertyDefn
Interface of the Meta-data information for an element property or an extension model property.
IEncryptionHelper
Defines the interface of encryption helper, which includes two methods for encryption and decryption.
IEventFilter
Class provides a event filter logic for a transaction.
IExpression
IExpressionType
IExtendedItem
Script wrapper of ExtendedItemHandle.
IFilterCondition
Represents the design of an FilterCondition in the scripting environment
IFilterConditionElement
IFilterExprDefinition
IFilterExprDefinition
IFont
IGrid
Represents a the design of a Grid in the scripting environment
IGroup
Script wrapper of GroupHandle
IHideRule
Represents the design of an HighRule in the scripting environment
IHighlightRule
Represents the design of an HighLightRule in the scripting environment
IImage
Represents a the design of an Image in the scripting environment
ILabel
Represents a the design of a Label in the scripting environment
IList
Represents the design of a List in the scripting environment
IListGroup
Script wrapper of ListGroupHandle
IListing
Represents the design of an Listing in the scripting environment
IllegalContentInfo
IllegalOperationException
Thrown to indicate that a method has been illegally called.
ILocalizableInfo
Represents the abstract definition which can be localized.
ImageDataValidator
If the image source is set, the corresponding image data should be set.
ImageHandle
Represents an image report item.
IMasterPage
Represents a master page in the scripting environment
IMemberInfo
Represents the definition of class member.
IMessages
The interface for getting localized messages from extension element.
IMetaDataDictionary
Global, shared dictionary of design meta data.
IMetaLogger
Interface to handle meta-data errors during initialization.
IMethodInfo
Represents the method information for both class and element.
IModuleModel
The interface for the root element to store the constants.
IModuleOption
Implements to define the keys to do some setting in a module.
IMultiRowItem
INameManager
Interface to do all managements about the element names.
IncludedCssStyleSheet
Included css style sheet structure
IncludedCssStyleSheetHandle
Represents a included css style sheet in report design and theme.
IncludedCssStyleSheetValidator
Validates whether the included css style sheet file is existed or not.
IncludedLibrary
This class represents one include library of report design.
IncludedLibraryHandle
Represents the handle of the included library.
IncludedLibraryValidator
Validates whether the included library file is existed or not.
IncludeScript
This class represents a include script.
IncludeScriptHandle
Represents the handle of the included script.
InconsistentColumnsValidator
Validates the column number in columns slot and the maximum column number in rows should be consistent.
InvalidParentException
An error indicates invalid parent while setting the extends property of an element.
IObjectDefn
Base Interface for methods common to elements and structures.
IODAFilterExprProvider
IPasteStatus
Interface to provide information for paste checks.
IPredefinedStyle
BIRT defines a fixed set of predefined styles.
IPropertyDefinition
Defines a property or structure member provided by an peer extension.
IPropertyDefn
Base Interface for both element property, extension model property and structure member definitions.
IPropertyType
Base class for the meta-data for property types.
IReportDesign
Script wrapper of ReportDesignHandle
IReportElement
Represents a the design of a report element in the scripting environment
IReportItem
Represents an instance of a extended report element.
IReportItem
Represents a the design of a report item in the scripting environment
IReportItemFactory
Represents the peer extension itself.
IReportItemMethodContext
Defines the method context that are available to the report item.
IResourceBundleProvider
Provides the resource bundle with the given locale.
IResourceChangeListener
This listener is notified of changes to resources in the resource path.
IResourceLocator
Implements this interface to provide a custom file search algorithm.
IResultSetColumn
Represents the design of an ResultSetColumn in the scripting environment
IRow
Represents a row in the scripting environment
IScriptableObjectClassInfo
ISimpleElementFactory
The factory class to create scriptable objects.
ISlotDefn
Interface for the definition of a slot within an element.
ISortCondition
Represents the design of an SortCondition in the scripting environment
ISortElement
The simple API class for the SortElementHandle.
IStructure
Interface for objects that appear in a property list.
IStructureDefn
Interface for the definition of a property structure: an object that is "managed" by the model to allow generic member access and undo/redo support for updates.
IStyle
Represents the design time style for a report element in the scripting environment
IStyleDeclaration
Interface to traverse all the style property values.
ITable
Represents the design of a Table in the scripting environment
ITableGroup
Script wrapper of TableGroupHandle
ITemplateMethodInfo
Represents the method information that can provide code template.
ITextItem
Represents a the design of a TextItem in the scripting environment
IValidationListener
Receives validation events after one element is validated.
IVersionInfo
Holds instrustions that inform the user if opening the old version design file may cause some auto-conversion to the original design file.
JoinCondition
Represents a condition used for joint data set.
JoinConditionHandle
Represents a handle of condition used for joint dataset.
JointDataSetHandle
Provides API to operate a joint data set.
LabelHandle
Represents a label report item.
LayoutCell
The minimal item in the table.
LayoutChangedEvent
Notification event that says that the layout of the table element has been changed.
LayoutGroup
The table group model for a `TableGroup` element.
LayoutHelper
An algorithm to support rowSpan, colSpan for BIRT table elements.
LayoutRow
Represents a row in table layout.
LayoutSlot
A slot in the table.
LayoutTable
The table model for the content layout.
LayoutTable.OverlappedArea
Represents an overlapped area of the cell element in the table.
LayoutTableModel
The table model for the UI render.
LayoutUtil
The utility class for `LayoutTable`.
LevelAttribute
This class represents one attribute of the level element.
LevelAttributeHandle
Represents the handle of one column in the result set.
LevelHandle
Represents a level element.
LibraryChangeEvent
Notification event that says that the module need refreshing.
LibraryEvent
Indicates that the library is added, dropped or shifted.
LibraryException
Indicates an error while operating with library.
LibraryHandle
Represents the handle of library element.
LibraryHandleImpl
LibraryReloadedEvent
Events indicating that the library is reloaded.
LineHandle
Represents the line item.
Listener
Receives events about a Design Element.
ListGroupHandle
Represents a group in a list.
ListHandle
Represents a list report item.
ListingHandle
Represents slots and common properties in the two list-oriented elements: table and list.
MapRule
This class represents a style mapping rule: a translation of a database value into a set of display values.
MapRuleHandle
Represents the handle of map rule.
MasterPageContextContainmentValidator
Validates the table/list is not allowed to appear in header/footer/contents slot of master page in any level.
MasterPageHandle
Represents a master page.
MasterPageMultiColumnValidator
Validates the multiple columns and content width should be consistent.
MasterPageRequiredValidator
Validates the report should have at least one master page.
MasterPageSizeValidator
Validates the page size is invalid.
MasterPageTypeValidator
Validates the page size against page type.
MeasureGroupHandle
Handle class for MeasureGroup.
MeasureHandle
This class represents a measure element.
MemberHandle
A handle to a member of a property structure.
MemberInfo
Represents the definition of class member.
MemberInfo
Represents the definition of class member.
MemberIterator
An iterator over the members of a structure.
MemberValueHandle
CrosstabMemberValueHandle
MetaDataConstants
Provides constants used in the meta-data package.
MetaDataReaderException
Exception thrown if an error occurs when reading the meta-data description file or the building the meta-data description.
MethodInfo
Represents the method information for both class and element.
MethodInfo
Represents the method information for both class and element.
ModelConstants
Defines various constants.
ModelException
Implementation of BirtException in model project.
ModuleHandle
Abstract module handle which provides the common functionalities of report design and library.
ModuleHandleImpl
Abstract module handle which provides the common functionalities of report design and library.
ModuleOption
Provide the way to do some setting about the module.
ModuleUtil
Provides some tool methods about the modules.
MultiLineDataHandle
Deprecated.
by `TextDataHandle`
MultiRowItem
Implements of multi row report item.
MultiViewsHandle
Represents a multiple view element.
NameEvent
Identifies that the name of an element changed.
NameException
Indicates an error when setting the name of an element.
NameSpaceEvent
Deprecated.
Since BIRT 2.1, there will no such event send by BIRT
NotificationEvent
The base class of the notification hierarchy.
NumberFormatValue
The format value for the number like integer, float, etc.
OdaAggregationHelper
OdaAggregationHelperImpl
OdaCubeHandle
Represents a cube.
OdaDataSetHandle
Represents an extended data set.
OdaDataSetParameter
Represents the parameter for ODA drivers.
OdaDataSetParameterHandle
Represents the parameter for ODA drivers.
OdaDataSourceHandle
Represents a extended data source.
OdaDesignerState
The structure of the Oda designer state.
OdaDesignerStateHandle
The structure handle of the Oda designer state.
OdaDimensionHandle
Represents a dimension element in the cube element.
OdaFilterExprHelper
OdaFilterExprHelper
ODAFilterExprProvider
ODAFilterExprProvider
OdaHierarchyHandle
Represents a Hierarchy.
OdaLevelAttribute
This class represents one attribute of the level element.
OdaLevelAttributeHandle
Represents the handle of one column in the oda result set.
OdaLevelHandle
Represents a level element.
OdaMeasureGroupHandle
Handle class for MeasureGroup.
OdaMeasureHandle
This class represents a measure element.
OdaResultSetColumn
OdaResultSetColumnHandle
Represents the handle of one column in the oda result set.
OperatorUtil
Represents the utility class to help compute level of operator.
ParamBinding
This class presents the parameter binding that bind data set input parameter to expression by position.
ParamBindingHandle
Represents the handle of parameter binding.
ParameterFormatValue
Represents the format for the default value of scalar parameter.
ParameterGroupHandle
Represents a group of parameters.
ParameterHandle
Represents the various parameter types.
ParameterValidationUtil
Validates the parameter value with the given data type and format pattern string.
Point
Represents a point in application units.
PrivateStyleHandle
Represents the "private style" for an element.
PropertyBinding
Represents the property binding structure.
PropertyBindingHandle
Represents the handle of property binding structure.
PropertyDefinition
Extension adapter class for the IPropertyDefintion.
PropertyEvent
Notification event to send when a property changes.
PropertyHandle
A handle for working with a top-level property of an element.
PropertyHandleImpl
A handle for working with a top-level property of an element.
PropertyMask
This class provides property masks of system or user defined properties.
PropertyMaskHandle
Represents the handle of property mask structure.
PropertyNameException
Exception thrown when a property name is invalid.
PropertyValueException
Indicates an invalid property value.
PropertyValueValidationUtil
Utility class to validate the property value.
Rectangle
Represents the position and size of a rectangle in application units.
RectangleHandle
Represents a rectangle element.
ReportDesignConstants
Defines constants for design element name.
ReportDesignHandle
Represents the overall report design.
ReportElementHandle
Abstract base class for working with all elements except the report design.
ReportItem
Extension adapter class for the IReportItem.
ReportItemFactory
Adapter class for the IReportItemFactory interface.
ReportItemHandle
Represents a report item: any element that can appear within a section of the report.
ReportItemHandleImpl
Abstract implementation class for the report item handle
ReportItemThemeHandle
Represents a report item theme in the library.
ResourceChangeEvent
Notification event that says that the module need refreshing.
ResultSetColumn
This class represents one column in the result set.
ResultSetColumnHandle
Represents the handle of one column in the result set.
RowBandAdapter
Represents an object for copy/paste in Gird/Table.
RowBandInsertAction
Does table row insert operation.
RowBandInsertAndPasteAction
Does table row insert and paste operation.
RowBandPasteAction
Does table row paste operation.
RowBandShiftAction
Does table row shift operation.
RowHandle
Represents one row in a Grid or Table.
RowOperationParameters
Prepares parameters for row operation , including copy , paste , insert and shift operation.
Rule
This class represents one rule.
RuleHandle
Represents a rule handle.
ScalarParameterHandle
Represents a scalar (single-value) report parameter.
ScriptableClassInfo
ScriptConstants
Constants for script
ScriptDataSetHandle
Represents a script data set item.
ScriptDataSourceHandle
Represents a script data source.
ScriptLib
Represents a jar file used for script handle event.
ScriptLibHandle
Represents a handle of jar file used for script handle event.
SearchKey
Structure for optional list of search criteria.
SearchKeyHandle
Represents the handle of key used for search.
SelectionChoice
This class is a structure for selection-list in ScalarParameter item.
SelectionChoiceHandle
Represents the handle of selection choice.
SemanticError
The class provides the error code and the element with semantic error.
SemanticException
Represents exceptions encountered during parsing the xml file, it will include a reference to the element which causes the error.
SessionHandle
Represents the design state -- a session for a user.
SharedStyleHandle
Represents a named, shared style.
SimpleElementFactory
The factory class to create scriptable objects.
SimpleElementFactory
SimpleGroupElementHandle
Implements a simple group element handle, which has a non-empty selection element list and root module.
SimpleListValidator
Validates one list property of element.
SimpleMasterPageHandle
Represents a simple master page.
SimpleRowItem
Implements of simple item that has no data rows.The constructor in sub class must call super(ExtendedItemHandle).
SimpleValueHandle
Abstract base class that represents a handle for the value to either a property or a structure member.
SlotHandle
Represents a "slot" within an element.
SlotIterator
An Iterator over the elements in a slot.
SortedSlotIterator
An sorted iterator over the elements in a slot.
SortElementHandle
SortHint
This class represents a sort hint.
SortHintHandle
This class represents sort hint handle.
SortKey
This class represents a sort entry for a table or list item, it defines the column and sort direction pair.
SortKeyHandle
Represents the handle of sort key structure.
StringFormatValue
The format value for the string type.
StringUtil
Collection of string utilities.
StructureFactory
Provides the factory method to create empty structures.
StructureHandle
Handle to a structure within a list property.
StructureListValidator
Validates one list property of element.
StructureReferenceValidator
Validates the property whose type is structure reference.
StructureValidator
Validates a structure property of element.
StyleEvent
Notifies that the style of an element has changed.
StyleException
Indicates an error while setting the style of an element.
StyleHandle
Represents the style properties for either a shared style or an element with a IStyleModel.
StyleIterator
Iterates over the styles of an include style sheet.
StyleReferenceValidator
Validates the style reference value for `StyledElement`.
StyleRule
Base class for highlight and map rules in the style.
StyleRuleHandle
Represents the handle of style rule.
StyleSheetException
Exception thrown if an error occurs when reading an external style sheet.
StyleSheetParserException
Exception thrown if an error occurs when translating an external style sheet to our own `CssStyleSheet`.
StyleUtil
Utility class to provide some methods about the style element, styled element and style properties.
TableColumnBandAdapter
Represents an object of copied objects when do copy/paste operations between tables.
TableGroupHandle
Represent a handle to a table group.
TableHandle
Represents a table element.
TableHeaderContextContainmentValidator
Validates the element is not allowed to appear in the specific slot of the given container type in any level.
TableRowBandAdapter
Represents an object of copied objects when do copy/paste operations between tables.
TabularCubeHandle
Represents a cube.
TabularDimensionHandle
Represents a dimension element in the cube element.
TabularHierarchyHandle
Represents a Hierarchy.
TabularLevelHandle
Represents a level element.
TabularMeasureGroupHandle
Handle class for MeasureGroup.
TabularMeasureHandle
This class represents a measure element.
TemplateDataSetHandle
Handle for template data sets.
TemplateElementHandle
Abstract handle for template elements.
TemplateException
Reports an error during a template related operation.
TemplateMethodInfo
Represents the method information that can provide code snippet as the template.
TemplateParameterDefinitionHandle
Represents a template parameter definition element.
TemplateReportItemHandle
Handle for template report items.
TemplateTransformEvent
Notification event that says that transformation betweem a template element and a report item or data set occurs.
TextDataHandle
Represents a multi-line data item element.
TextItemHandle
Represents a text data item.
ThemeEvent
Notifies that the style of an element has changed.
ThemeException
Indicates an error while setting the style of an element.
ThemeHandle
Represents a theme in the library.
ThemeReferenceValidator
Validates the theme reference in the module.
ThemeStyleNameValidator
Validates the ducplicat style name in the theme.
TimeFormatValue
The format value for the time.
TimeInterval
Time interval structure.
TimeIntervalHandle
The structure handle of time interval.
TOC
The TOC structure defines a TOC.
TOCHandle
Represents an "TOC" attached to an element.Obtain an instance of this class by calling the `getTOCHandle` method on the handle of an element that defines an action.
TransactionOption
Class provided to set some options for the transaction.
TranslationHandle
Represents a translation message in the design.
UndefinedPropertyInfo
Class that provides the information for undefined properties set in extended items.
UnicodeUtil
The utility class to handle Unicode encoding and signatures.
UnsupportedElementValidator
Validates whether the element is unsupported in the current release.
URIUtil
Utility class to handle URI.
UserChoice
Describes the user defined choices for a user defined property.
UserPropertyDefn
Represents a user-defined property.
UserPropertyDefnHandle
Represents a top-level user-defined property of an element.
UserPropertyEvent
Indicates a change to a user-defined property.
UserPropertyException
Reports an error during a user property operation.
ValidationEvent
Notification event that says that the validation is performed and whether error exists.
ValidationValueException
Indicates an invalid validation value.
ValueAccessControlHandle
Deprecated.
ValueHandle
Abstract base class for value-based handles.
ValueRequiredValidator
Validates the property value is required.
VariableElementHandle
Represents a variable.
ViewsContentEvent
Notification event that says that multiple views of a container have changed.
WrongTypeException
An error indicates wrong type while setting the extends property of an element.
XPathUtil
The XPath string helps user locate this element in design file.