com.crystaldecisions.sdk.occa.report.definition
Interface IFieldObject

All Superinterfaces:
IClone, IReportObject
All Known Implementing Classes:
FieldObject

public interface IFieldObject
extends IReportObject

This interface represents a field found in a report (for example, special field, database field, parameter field, and so on). This interface provides methods for formatting information for a field in your report. A FieldObject object is obtained from the ReportObjects collection.

Thus, a FieldObject object is used to provide a visual representation for some kind of field on the report. As such, every FieldObject object is attached to a field that provides data to be displayed when the report is viewed.

For example, if a FieldObject object is added to the report and its DataSource property contains the FormulaForm (that is, its unique name) of a DBField object, when the report is run, the Crystal Reports Print Engine (CRPE) will retrieve data from the database and format the page according to the information and properties found in the FieldObject.

You can attach many different kinds of fields to a FieldObject object including:

That is, these objects can all act as a data source for the FieldObject object. To attach a field to this object, use setDataSource(String dataSource) to set the DataSource equal to the field's FormulaForm.


Method Summary
 java.lang.String getDataSource()
          Deprecated. As of Version 10, it was replaced with the getDataSourceName method in order to maintain consistency with the BlobFieldObject object.
 java.lang.String getDataSourceName()
           Returns the formula form of the field name.
 IFieldFormat getFieldFormat()
           Returns the format of the field object
 FieldValueType getFieldValueType()
           Returns the value type of the field.
 IFontColor getFontColor()
           Returns the font color properties for the field.
 void setDataSource(java.lang.String dataSource)
          Deprecated. As of Version 10, it was replaced with the setDataSourceName method in order to maintain consistency with the BlobFieldObject object.
 void setDataSourceName(java.lang.String dataSourceName)
           Sets the formula form of the field name.
 void setFieldFormat(IFieldFormat fieldFormat)
           Sets the format of the field object
 void setFieldValueType(FieldValueType fieldValueType)
          Deprecated.  
 void setFieldValueType(FieldValueType fieldValueType, java.util.Locale locale)
           Sets the value type of the field.
 void setFontColor(IFontColor fontColor)
           Sets the font color properties for the field.
 
Methods inherited from interface com.crystaldecisions.sdk.occa.report.definition.IReportObject
getBorder, getBorderMargins, getFormat, getHeight, getKind, getLeft, getLinkedURI, getName, getReplacementConditionFormulas, getReportPartBookmark, getSectionCode, getSectionName, getTop, getWidth, setBorder, setFormat, setHeight, setLeft, setLinkedURI, setName, setReplacementConditionFormulas, setReportPartBookmark, setSectionCode, setSectionName, setTop, setWidth
 

Method Detail

getDataSource

java.lang.String getDataSource()
Deprecated. As of Version 10, it was replaced with the getDataSourceName method in order to maintain consistency with the BlobFieldObject object.


getDataSourceName

java.lang.String getDataSourceName()

Returns the formula form of the field name.

Returns:
A String that specifies the formula form of the field name.

getFieldFormat

IFieldFormat getFieldFormat()

Returns the format of the field object

Returns:
An IFieldFormat object that specifies the format of the field object.

getFieldValueType

FieldValueType getFieldValueType()

Returns the value type of the field.

Returns:
A FieldValueType object that specifies the value type of the field.

getFontColor

IFontColor getFontColor()

Returns the font color properties for the field.

Returns:
An IFontColor object that specifies the font color properties for the field.

setDataSource

void setDataSource(java.lang.String dataSource)
Deprecated. As of Version 10, it was replaced with the setDataSourceName method in order to maintain consistency with the BlobFieldObject object.


setDataSourceName

void setDataSourceName(java.lang.String dataSourceName)

Sets the formula form of the field name.

Parameters:
dataSourceName - A String that specifies the formula form of the field name.

setFieldFormat

void setFieldFormat(IFieldFormat fieldFormat)

Sets the format of the field object

Parameters:
fieldFormat - An IFieldFormat object that specifies the format of the field object.

setFieldValueType

void setFieldValueType(FieldValueType fieldValueType)
Deprecated. 

Sets the value type of the field.

Parameters:
fieldValueType - A FieldValueType object that specifies the value type of the field.

setFieldValueType

void setFieldValueType(FieldValueType fieldValueType,
                       java.util.Locale locale)

Sets the value type of the field.

Parameters:
fieldValueType - A FieldValueType object that specifies the value type of the field.
locale - A Locale object.

setFontColor

void setFontColor(IFontColor fontColor)

Sets the font color properties for the field.

Parameters:
fontColor - An IFontColor object that specifies the font color properties for the field.