com.esri.arcgis.arcweb
Interface IArcWebReportOptions

All Superinterfaces:
Serializable
All Known Implementing Classes:
ArcWebReportOptions

public interface IArcWebReportOptions
extends Serializable

Provides access to members that control the format of an ArcWeb report.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.


Method Summary
 String getDataSource()
          The name of the data source used for creating a report.
 int getReportFormat()
          The format of the report (default is esriArcWebReportFormatPDF).
 IEnumArcWebKeyValue getReportHeader()
          The key/value pairs for the header of a report (default is null).
 void setDataSource(String dataSource)
          The name of the data source used for creating a report.
 void setReportFormat(int reportFormat)
          The format of the report (default is esriArcWebReportFormatPDF).
 void setReportHeader(IEnumArcWebKeyValue reportHeader)
          The key/value pairs for the header of a report (default is null).
 

Method Detail

getDataSource

String getDataSource()
                     throws IOException,
                            AutomationException
The name of the data source used for creating a report.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:
The dataSource
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDataSource

void setDataSource(String dataSource)
                   throws IOException,
                          AutomationException
The name of the data source used for creating a report.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
dataSource - The dataSource (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getReportFormat

int getReportFormat()
                    throws IOException,
                           AutomationException
The format of the report (default is esriArcWebReportFormatPDF).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:
A com.esri.arcgis.arcweb.esriArcWebReportFormat constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setReportFormat

void setReportFormat(int reportFormat)
                     throws IOException,
                            AutomationException
The format of the report (default is esriArcWebReportFormatPDF).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
reportFormat - A com.esri.arcgis.arcweb.esriArcWebReportFormat constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getReportHeader

IEnumArcWebKeyValue getReportHeader()
                                    throws IOException,
                                           AutomationException
The key/value pairs for the header of a report (default is null).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:
A reference to a com.esri.arcgis.arcweb.IEnumArcWebKeyValue
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setReportHeader

void setReportHeader(IEnumArcWebKeyValue reportHeader)
                     throws IOException,
                            AutomationException
The key/value pairs for the header of a report (default is null).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
reportHeader - A reference to a com.esri.arcgis.arcweb.IEnumArcWebKeyValue (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.