com.esri.arcgis.arcmap
Interface IReportTemplate

All Superinterfaces:

Serializable

All Known Implementing Classes:

Report

public interface IReportTemplate
extends Serializable

Provides access to template members of a report.

Product Availability

Available with ArcGIS Desktop.

Method Summary

boolean	fieldMapping(String templateFieldList, String sourceFieldList) Sets the field mapping from the report template to the new fields.
String	getReportTitle() Indicates the title for the report.
int	getStartingPageNumber() Indicates the starting page number for the report.
boolean	loadReportTemplate(String templateFilePath) Loads the report template file.
boolean	relatedReportMapping(String relatedReportName, IRelationshipClass pSourceRelationshipClass, String templateFieldList, String sourceFieldList) Sets the mapping information for a related report.
boolean	saveReportTemplate(String templateFilePath) Saves the report as a template file.
void	setReportTitle(String pReportTitle) Indicates the title for the report.
void	setStartingPageNumber(int pStartingPageNumber) Indicates the starting page number for the report.

Method Detail

getStartingPageNumber

int getStartingPageNumber()
                          throws IOException,
                                 AutomationException

Indicates the starting page number for the report.

Product Availability

Available with ArcGIS Desktop.

Returns:

The pStartingPageNumber

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStartingPageNumber

void setStartingPageNumber(int pStartingPageNumber)
                           throws IOException,
                                  AutomationException

Indicates the starting page number for the report.

Product Availability

Available with ArcGIS Desktop.

Parameters:

pStartingPageNumber - The pStartingPageNumber (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getReportTitle

String getReportTitle()
                      throws IOException,
                             AutomationException

Indicates the title for the report.

Product Availability

Available with ArcGIS Desktop.

Returns:

The pReportTitle

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReportTitle

void setReportTitle(String pReportTitle)
                    throws IOException,
                           AutomationException

Indicates the title for the report.

Product Availability

Available with ArcGIS Desktop.

Parameters:

pReportTitle - The pReportTitle (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

fieldMapping

boolean fieldMapping(String templateFieldList,
                     String sourceFieldList)
                     throws IOException,
                            AutomationException

Sets the field mapping from the report template to the new fields.

Product Availability

Available with ArcGIS Desktop.

Parameters:

templateFieldList - The templateFieldList (in)

sourceFieldList - The sourceFieldList (in)

Returns:

The pResult

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

relatedReportMapping

boolean relatedReportMapping(String relatedReportName,
                             IRelationshipClass pSourceRelationshipClass,
                             String templateFieldList,
                             String sourceFieldList)
                             throws IOException,
                                    AutomationException

Sets the mapping information for a related report.

Product Availability

Available with ArcGIS Desktop.

Parameters:

relatedReportName - The relatedReportName (in)

pSourceRelationshipClass - A reference to a com.esri.arcgis.geodatabase.IRelationshipClass (in)

templateFieldList - The templateFieldList (in)

sourceFieldList - The sourceFieldList (in)

Returns:

The pResult

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

loadReportTemplate

boolean loadReportTemplate(String templateFilePath)
                           throws IOException,
                                  AutomationException

Loads the report template file.

Product Availability

Available with ArcGIS Desktop.

Parameters:

templateFilePath - The templateFilePath (in)

Returns:

The pResult

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

saveReportTemplate

boolean saveReportTemplate(String templateFilePath)
                           throws IOException,
                                  AutomationException

Saves the report as a template file.

Product Availability

Available with ArcGIS Desktop.

Parameters:

templateFilePath - The templateFilePath (in)

Returns:

The pResult

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.