Package com.crystaldecisions.sdk.occa.report.definition

This package is used to manipulate the appearance of the report objects that you see on the report.

See:
          Description

Interface Summary
IArea This interface manipulates an area in a report.
IAreaFormat This interface enables you to specify the format of the area dynamically when the report is displayed.
IBlobFieldObject This interface defines a BLOB field, which is a large binary object.
IBooleanFieldFormat This interface defines how a boolean field shown by a FieldObject should be formatted if the FieldObject is being used to display boolean fields.
IBorder This interface defines the color and the line styles of a report object's border.
IBoxObject This interface defines a box object, which is the only object aside from a line that can span several sections.
IChartDefinition This interface specifies the type of chart that appears on the report and defines the fields that are being charted on.
IChartObject This is the main interface for determining how a chart will look when it appears on the report.
IChartStyle This interface specifies the chart type (for example, a bar chart or pie chart) that appears on the report and gives you access to the text options for the chart title, subtitle, and footnote.
IChartTextOptions This interface allows you to set and get the text options for the chart title, subtitle, and footnote.
ICommonFieldFormat This interface provides the formatting options that are common to all ReportObjects.
IConditionFormula This interface enables you to set the condition formula for each of the attributes for a selected area, section, or report object, thus offering you full conditional control over the appearance of the report object and its area and section.
ICrossTabGridLineOptions This interface allows you to modify formatting options of grid lines use in cross-tab objects.
ICrossTabObject This interface enables you to get and set the grid format for a CrossTabObject.
IDateFieldFormat This interface is used to specify the format of the date field or the date part of the DateTimeField in the report object.
IDateTimeFieldFormat This interface describes how a DateTime value shown by a FieldObject object should be formatted if the FieldObject object is being used to display dates and/or times.
IDetailAreaFormat This interface enables you to get and set the formatting behaviour of a detail area.
IDrawingObject This interface is used to draw an object in your report object.
IFieldFormat This interface enables you to specify the format of the field, including the date and time format, the numeric format, the string format, and so on.
IFieldHeadingObject This interface is used to specify the field heading for the report object.
IFieldObject This interface represents a field found in a report (for example, special field, database field, parameter field, and so on).
IFlashObject This interface defines a Flash object.
IFont This interface allows you to retrieve or set options for the font used in the report object.
IFontColor This interface allows you to retrieve font information and specify the font color used in the report object.
IGraphicObject This interface is used to set the properties of the graphic for your report object.
IGroupAreaFormat This interface enables you to get and set behavior for printing the group header and the group area.
IIndentAndSpacingFormat This interface is used to set the indent and spacing for your report object.
ILineObject This interface represents a line drawn on a report.
IMapObject This interface represents a geographic map object in a report.
IMultiColumnArea This interface defines an area containing multiple columns in a report.
INumericFieldFormat This interface describes how a NumericFormat property shown by a FieldObject object should be formatted if the FieldObject object is being used to display numeric data.
IObjectFormat This interface is used to format different kinds of ReportObject objects.
IOlapGridObject This interface represents an OLAP object in a report.
IPageAreaFormat This interface enables you to get and set the formatting behaviour of a page header or page footer area.
IParagraph This interface enables you to set the paragraph formatting.
IParagraphElement This interface is used to specify the paragraph elements.
IParagraphFieldElement This interface defines text from a field object.
IParagraphTextElement This interface enables you to display static text in one of the TextObject object's paragraphs.
IPictureFormat This interface is used to crop the graphic (by cropping any or all of the four sides of the picture: the top, the bottom, the left, and/or the right).
IPictureObject This interface is used to specify the particular graphic you wish to copy or modify in your report object.
IReportDefinition This interface is used to get and set the values that define a particular report.
IReportObject This interface is used to get and set values for how an object looks when it appears on the report.
IReportPartBookmark This interface is used to get and set the report part ID and URI used to navigate report parts.
IReportPartID This interface is used to identify a report part within the report.
ISection This interface is used to get and set information and formatting for a section of the report.
ISectionAreaFormat The base interface for section and area format settings.
ISectionFormat This interface is used to specify the formatting for a section.
IStringFieldFormat This interface enables you to get and set how a FieldObject containing Strings is formatted.
ISubreportLink This interface is used to access a link between a subreport and the main report.
ISubreportObject Use this interface to get or set a subreport name.
ITabStop This interface enables you to get and set tab stop values for a paragraph object.
ITextObject This interface is used to manipulate the TextObject.
ITimeFieldFormat This interface is used to get and set how the time format shown by a FieldObject should be formatted if the FieldObject is being used to display time.
 

Class Summary
Alignment This class specifies the paragraph alignment.
AMPMFormat This class specifies the position of the AM or PM symbol in time formats.
Area This object implements an area in a report.
AreaFormat This object enables you to specify the format of the area dynamically when the report is displayed.
Areas This object stores a collection of Area objects that specifies the areas used for a report object.
AreaSectionKind This class specifies the area in the report in which the chart is located.
BlobFieldObject This object implements a BLOB field, which is a large binary object.
BooleanFieldFormat This object defines how a boolean field shown by a FieldObject should be formatted if the FieldObject is being used to display a BooleanField.
BooleanFieldFormatConditionFormulas This object defines a collection that enables you to specify the format of the condition formulas in the BooleanField.
BooleanFieldFormatConditionFormulaType This class is used to specify the condition formula type for BooleanField formatting.
BooleanOutputFormat This class is used to specify the format of BooleanField values.
Border This object defines the color and the line styles of a report object's border.
BorderConditionFormulas This object defines a collection used to specify the condition formulas for properties of the Border object.
BorderConditionFormulaType This class is used to specify the border condition formula type.
BorderMargins Represents the size of the border around a ReportObject.
BoxObject This object implements a box object, which is the only object aside from a line that can span several sections.
ChartDefinition This object implements the type of chart that appears on the report and defines the fields that are being charted on.
ChartGroupType This class is used to specify chart group type.
ChartObject This object is used to determine how a chart will look when it appears on the report.
ChartStyle This object is used to specify the chart type (for example, a bar chart or pie chart) that appears on the report and gives you access to the text options for the chart title, subtitle, and footnote.
ChartStyleSubtype Defines a chart style sub-type.
ChartStyleType This class is used to specify the area in the report in which the chart is located.
ChartTextOptions This object allows you to set and get the text options for the chart title, subtitle, and footnote.
ChartType This class is used to specify the area in the report in which the chart is located.
CommonFieldFormat This object provides the formatting options that are common to all ReportObjects.
CommonFieldFormatConditionFormulas This collection is used to specify the condition formulas for the CommonFieldFormat object.
CommonFieldFormatConditionFormulaType This class is used to specify the condition formula type for common field formatting.
ConditionFormula This object enables you to set the condition formula for each of the attributes for a selected area, section, or report object, thus offering you full conditional control over the appearance of the report object and its area and section.
CrossTabGridLineOptions This class holds formatting options of grid lines used in cross-tab objects.
CrossTabGroupFormats A collection of ICrossTabGroupFormat objects.
CrossTabObject This object enables you to get and set the grid format for a CrossTabObject.
CurrencyPositionFormat This class is used to specify the position of the currency symbol for negative values.
CurrencySymbolType This class is used to specify how to display the currency symbol.
DateCalendarType This class is used to specify the calendar type.
DateEraType This class is used to specify how to display the era or period in the date.
DateFieldFormat This object is used to specify the format of the date field or the date part of the DateTimeField in the report object.
DateFieldFormatConditionFormulas This object defines a collection used to specify the condition formulas for the DateFieldFormat object.
DateFieldFormatConditionFormulaType This object is used to specify the condition formula type for date field formatting.
DateOrder This class is used to specify the order of the elements in the date.
DateSystemDefaultType This class is used to specify how to use the system date format.
DateTimeFieldFormat This object describes how a DateTime value shown by a FieldObject object should be formatted if the FieldObject object is being used to display dates and/or times.
DateTimeFieldFormatConditionFormulas This object is used to specify the condition formulas for the DateTimeFieldFormat object.
DateTimeFieldFormatConditionFormulaType This object is used to specify the condition formula type for DateTime field formatting.
DateTimeOrder This class is used to specify the order of the elements in the DateTime field.
DayFormat This class is used to specify how to display the day.
DayOfWeekEnclosure This class is used to specify the enclosing characters of the name of a day of the week in a formatted date string.
DayOfWeekPosition This class is used to specify where to display the name of the day in the date.
DayOfWeekType This class is used to specify how to display the name of the day in the date.
DetailAreaFormat This class enables you to get and set the formatting behaviour of a detail area.
DetailPrintDirection Defines the types of detail print directions, which specifies whether detail data should first be printed across or down the page, when multi-column formatting is enabled.
DrawingObject This object is used to draw an object in your report object.
FieldFormat This object enables you to specify the format of the field, including the date and time format, the numeric format, the string format, and so on.
FieldHeadingObject This object is used to specify the field heading for the report object.
FieldObject This object implements a field found in a report (for example, special field, database field, parameter field, and so on).
FlashObject This class defines a Flash object.
Font This object allows you to retrieve or set options for the font used in the report object.
FontColor This object allows you to retrieve font information and specify the font color used in the report object.
FontColorConditionFormulas This object defines a collection used to specify the condition formulas for the FontColor object.
FontColorConditionFormulaType This class is used to specify the condition formula types for font.
FontStyle Defines styles that can be applied to a Font, such as bold and italic.
GraphicObject This object is used to set the properties of the graphic for your report object.
GridType Description: GridType Enum Creation date: (13/09/2001 10:02:26 AM)
GroupAreaFormat This object defines the formatting for a group area.
HourFormat This class is used to specify the hour format.
HyperlinkType This class is used to specify the type of hyperlink.
IndentAndSpacingFormat This object is used to set the indent and spacing for your report object.
LineObject This object represents a line drawn on a report.
LineSpacingType This class is used to specify the line spacing style.
LineStyle This class is used to specify a border's line style.
MapObject This object defines a geographic map object in a report.
MinuteFormat This class is used to specify the minute format.
MonthFormat This class is used to specify how to display the month.
MultiColumnArea This object defines an area containing multiple columns in a report.
NegativeType This class is used to specify how to display negative numbers.
NumberFormat Description: NumberFormat Enum Creation date: (13/09/2001 10:32:40 AM)
NumericFieldFormat This object describes how a NumericFormat property shown by a FieldObject object should be formatted if the FieldObject object is being used to display numeric data.
NumericFieldFormatConditionFormulas This object is used to specify the condition formulas for the NumericFieldFormat object.
NumericFieldFormatConditionFormulaType This class is used to specify the condition formula type for numeric field formatting.
ObjectFormat This object is used to format different kinds of ReportObject objects.
ObjectFormatConditionFormulas Use this collection to specify the condition formulas for the ObjectFormat object.
ObjectFormatConditionFormulaType This class is used to specify the condition formula type for section or area formatting.
ObjectReplacementConditionFormulas A map of ObjectReplacementConditionFormulaType to IConditionFormula objects.
ObjectReplacementConditionFormulaType This class contains constants that specify the condition formula type for ReportObject property replacement.
OlapGridObject This object represents an OLAP object in a report.
PageAreaFormat This class enables you to get and set the formatting behaviour of a page header or page footer area.
Paragraph This object is used to set the paragraph formatting.
ParagraphElement This object is used to specify the paragraph elements.
ParagraphElementKind This class is used to specify paragraph element kind.
ParagraphElements This object defines a collection used to add, modify, and remove paragraph elements.
ParagraphFieldElement This object defines text from a field object.
Paragraphs This object defines a collection used to add, modify, and remove paragraph elements.
ParagraphTextElement This object enables you to display static text in one of the TextObject object's paragraphs.
PictureFormat This object is used to crop the graphic (by cropping any or all of the four sides of the picture: the top, the bottom, the left, and/or the right).
PictureFormatConditionFormulaType This class contains constants that specify the condition formula type for PictureObject format properties.
PictureObject This object is used to specify the particular graphic you wish to copy or modify in your report object.
PictureType This class is used to specify the file format of a picture.
ReadingOrder This class is used to specify the reading order.
ReportDefinition This object defines a particular report.
ReportObject This object specifies how an object looks when it appears on the report.
ReportObjects A collection of report objects.
ReportPartBookmark This object is used when navigating to report parts.
ReportPartID This object is used to identify a report part within the report.
ReportPartIDs Stores a collection of ReportPartID objects that specify the ReportPartIDs used for a report object.
RoundingType This class is used to specify the number of decimal places to round to.
SecondFormat This object specifies the second format.
Section This object defines a section of the report.
SectionAreaFormatConditionFormulas This object defines a collection used to specify the condition formulas for the SectionFormat object properties.
SectionAreaFormatConditionFormulaType This class is used to specify the condition formula type for section or area formatting.
SectionFormat This object defines the formatting for a section.
Sections This object defines a collection of Section objects.
StringFieldFormat This object describes how the StringFormat property shown by a FieldObject should be formatted if the FieldObject is being used to display strings.
StringFieldFormatConditionFormulas A collection of conditional formatting formulas for displaying a string field.
StringFieldFormatConditionFormulaType Defines the conditional formatting formula types for string fields.
SubreportLink This object specifies a link between a subreport and the main report.
SubreportLinks This object defines a collection of links between the subreport or subreports, and the main report.
SubreportObject This object represents a subreport placed in a report.
SubreportObjectConditionFormulas A collection of conditional formatting formulas for a subreport.
SubreportObjectConditionFormulaType Defines the types of conditional formatting formulas that can be applied to a SubreportObject.
SummarizedFieldDirection Defines summary field direction options.
TabStop This object contains tab stop values for a paragraph object.
TabStops This object defines a collection used to add or remove tab stops.
TextFormat This class is used to specify text format.
TextObject This object represents a text object that is found in a report.
TextRotationAngle This class is used to specify text rotation angle.
TimeBase This class is used to specify the time base.
TimeFieldFormat This object describes how the time format shown by a FieldObject should be formatted if the FieldObject is being used to display time.
TimeFieldFormatConditionFormulas This object defines a collection used to specify the condition formulas for the TimeFieldFormat object properties.
TimeFieldFormatConditionFormulaType This class is used to specify the condition formula type for time field formatting.
YearFormat This class is used to specify how to display the year.
ZoomMode Defines zoom modes that can be used to view a report.
 

Package com.crystaldecisions.sdk.occa.report.definition Description

This package is used to manipulate the appearance of the report objects that you see on the report. Report objects are the visible entities that define a report. That is, they store information such as size, position, and color, all of which form a blueprint that is used by the report engine to construct a formatted report. The functionality to apply formatting options to report objects is implemented in this package.

Report objects require a data source from where the report objects can retrieve the proper information to populate specified fields in the report. The data package is used to provide a definition for the report's data. Thus, the data package provides the data source and the definition package then defines the structure and format of the report.

For example, a report can consist of a TextObject, which displays either static text or text (information) that is taken from a data source (for example, from the DBField object).