com.crystaldecisions.sdk.occa.report.exportoptions
Interface IXMLExportFormat

All Superinterfaces:
IClone
All Known Implementing Classes:
XMLExportFormat

public interface IXMLExportFormat
extends IClone

Represents a custom XML export format type saved in the report. And set a custom XML export format.

An XMLExportFormat object represents a schema or DTD that a user can export a report to. Each report contains a default Crystal Reports schema. Report designers can create and save additional schemas to the report by importing an XSL that will transform the default schema of the report to another format when exporting. In addition to the XSL transform associated with the custom XML format, there is a name, description, and file type associated with each format to uniquely identify it. For more information on importing XML schemas and managing XML export formats, see the Crystal Reports User's Guide.

A new XMLExportFormat object can be created and properties set for the name, description, and file type, there is support for applying XSL transforms and programmatically saving new custom XML export formats back to the report. The RAS SDK supports retrieving existing export formats from the report (represented as XMLExportFormat objects) via the PrintOutputController.getStoredXMLExportFormats method. This list of existing formats can be used to provide the user with options for programmatic export to XML.


Method Summary
 java.lang.String getDescription()
           Gets the description of the XML export format.
 boolean getExportBlobField()
           Gets a value indicating whether to export images and binary data fields (BLOBs) from the report.
 java.lang.String getFileExtension()
           Gets the file extension the report is saved as when exporting to the XML export format.
 java.lang.String getGuid()
          For internal use only
 java.lang.String getName()
           Gets the name of the XML export format.
 java.lang.String getXsltContent()
          For internal use only
 void setDescription(java.lang.String _description)
          For internal use only
 void setExportBlobField(boolean _exportBlobField)
          For internal use only
 void setFileExtension(java.lang.String _fileExtension)
          For internal use only
 void setGuid(java.lang.String _guid)
          For internal use only
 void setName(java.lang.String _name)
          For internal use only
 void setXsltContent(java.lang.String _xsltContent)
          For internal use only
 

Method Detail

getName

java.lang.String getName()

Gets the name of the XML export format.

Returns:
A String object that contains the name of the XML export format.

getDescription

java.lang.String getDescription()

Gets the description of the XML export format.

Returns:
A String object that contains the description of the XML export format.

getFileExtension

java.lang.String getFileExtension()

Gets the file extension the report is saved as when exporting to the XML export format.

Returns:
A String object that contains the file extension of the report is saved as.

getExportBlobField

boolean getExportBlobField()

Gets a value indicating whether to export images and binary data fields (BLOBs) from the report.

Returns:
true if images and binary data fields are exported, and false otherwise.

getGuid

java.lang.String getGuid()
For internal use only


getXsltContent

java.lang.String getXsltContent()
For internal use only


setName

void setName(java.lang.String _name)
For internal use only


setDescription

void setDescription(java.lang.String _description)
For internal use only


setFileExtension

void setFileExtension(java.lang.String _fileExtension)
For internal use only


setExportBlobField

void setExportBlobField(boolean _exportBlobField)
For internal use only


setGuid

void setGuid(java.lang.String _guid)
For internal use only


setXsltContent

void setXsltContent(java.lang.String _xsltContent)
For internal use only