net.windward.xmlreport

Interface ProcessOpenXmlAPI

All Superinterfaces:

ProcessReportAPI, ProcessReportAPIBase

All Known Subinterfaces:

ProcessDocxAPI, ProcessPptxAPI, ProcessXlsxAPI

All Known Implementing Classes:

ProcessDocx, ProcessOpenXml, ProcessPptx, ProcessXlsx

public interface ProcessOpenXmlAPI
extends ProcessReportAPI

This class is a subclass of ProcessReportAPI specifically for creating an output in any of the OpneXML formats. "This product may incorporate intellectual property owned by Microsoft Corporation. The terms and conditions upon which Microsoft is licensing such intellectual property may be found at http://msdn.microsoft.com/library/en-us/odcXMLRef/html/odcXMLRefLegalNotice.asp."

Version:

9.0

Field Summary

Fields inherited from interface net.windward.xmlreport.ProcessReportAPI

CHARSET_DEFAULT, CHARSET_RTF, CHARSET_UNICODE, COPY_METADATA_ALWAYS, COPY_METADATA_IF_NO_DATASOURCE, COPY_METADATA_NEVER, DATA_MODE_ALL_ATTRIBUTES, DATA_MODE_DATA, DATA_MODE_EMBED, DATA_MODE_INCLUDE_BITMAPS, DATA_MODE_SELECT, ERROR_HANDLING_ALL, ERROR_HANDLING_NONE, ERROR_HANDLING_TRACK_ERRORS, ERROR_HANDLING_VERIFY, HIDDEN_IGNORE_PRINT_RANGE, HIDDEN_SHOW_ALL_ROWS_COLUMNS, HIDDEN_SHOW_HIDDEN_SHEETS, HIDDEN_SHOW_NO_PRINT, HYPHENATE_OFF, HYPHENATE_ON, HYPHENATE_TEMPLATE, LOCALE_DEFAULT, LOCALE_SYSTEM, RENDER_EXTENT_ALL, RENDER_EXTENT_CROP_CONTENT, RENDER_EXTENT_CROP_MARGINS, TAG_STYLE_CONTROL_2007, TAG_STYLE_FIELD, TAG_STYLE_FIELD_2007, TAG_STYLE_TEXT, TYP_CSV, TYP_DOCX, TYP_HTML, TYP_IMAGE, TYP_PDF, TYP_PPTX, TYP_PRINTER, TYP_PS, TYP_RTF, TYP_TXT, TYP_XLSX

Method Summary

Modifier and Type	Method and Description
boolean	isChartsAsCharts() true if chart tags that are in the template as a chart, will be rendered as charts in the generated report.
boolean	isCopyDrawings() True if drawings are to be copied to output.
boolean	isCopyShapes() True if shapes are to be copied to output.
boolean	isRecalculateOnOpen() true if the document is to perform recalculation when first opened.
void	setChartsAsCharts(boolean writeAsChart) true if chart tags that are in the template as a chart, will be rendered as charts in the generated report.
void	setCopyDrawings(boolean copyDrawings) True if drawings are to be copied to output.
void	setCopyShapes(boolean copyShapes) True if shapes are to be copied to output.
void	setRecalculateOnOpen(boolean recalc) true if the document is to perform recalculation when first opened.

Methods inherited from interface net.windward.xmlreport.ProcessReportAPIBase

batchNext, batchSetup, buildSchema, close, duplicate, findPodsUsed, getBaseDirectory, getCharset, getCopyMetadata, getDataMode, getDataStream, getDescription, getDrillDownInfo, getErrorInfo, getEventHandler, getHiddenMode, getHyphenate, getImportInfo, getKeywords, getLocale, getNumPages, getOutputBuilderData, getParameters, getRenderExtent, getRenderPages, getReport, getReportType, getReportTypeString, getSubject, getTemplateVersion, getTimeout, getTitle, getWriteTags, isCopyEmbeddedObjects, isDebugMode, isLayoutDocument, isPageBasedReport, isPreservePodFraming, isRemoveUnusedFormats, isReportTypeExcel, isReportTypeWord, isTrackImports, isUseExternalOutputBuilder, process, processComplete, processData, processData, processSetup, processSetup, setBaseDirectory, setCharset, setCopyEmbeddedObjects, setCopyMetadata, setDataMode, setDataStream, setDebugMode, setDescription, setDrillDownInfo, setEventHandler, setHiddenMode, setHyphenate, setKeywords, setLayoutDocument, setLocale, setOutputBuilderData, setParameters, setPreservePodFraming, setRemoveUnusedFormats, setRenderExtent, setRenderPages, setSubject, setTemplateVersion, setTimeout, setTitle, setTrackErrors, setTrackImports, setUseExternalOutputBuilder, setWriteTags, updatePods

Method Detail

isCopyDrawings

boolean isCopyDrawings()

True if drawings are to be copied to output. Drawings are only copied for DOCX -> DOCX and XLSX -> XLSX. Default is true.

Returns:

true if drawings are to be copied to output.

setCopyDrawings

void setCopyDrawings(boolean copyDrawings)

True if drawings are to be copied to output. Drawings are only copied for DOCX -> DOCX and XLSX -> XLSX. Default is true.

Parameters:

copyDrawings - true if drawings are to be copied to output.

isCopyShapes

boolean isCopyShapes()

True if shapes are to be copied to output. Shapes are only copied for DOCX -> DOCX and XLSX -> XLSX. Default is true.

Returns:

true if shapes are to be copied to output.

setCopyShapes

void setCopyShapes(boolean copyShapes)

True if shapes are to be copied to output. Shapes are only copied for DOCX -> DOCX and XLSX -> XLSX. Default is true.

Parameters:

copyShapes - true if shapes are to be copied to output.

isChartsAsCharts

boolean isChartsAsCharts()

true if chart tags that are in the template as a chart, will be rendered as charts in the generated report. If false, then charts will be generated as bitmaps. This setting is only for chart tags that are stored in the template as a chart. It is only relevant for output to OpenXML formats.

Returns:

true if chart tags will be rendered as charts, false otherwise.

setChartsAsCharts

void setChartsAsCharts(boolean writeAsChart)

true if chart tags that are in the template as a chart, will be rendered as charts in the generated report. If false, then charts will be generated as bitmaps. This setting is only for chart tags that are stored in the template as a chart. It is only relevant for output to OpenXML formats.

Parameters:

writeAsChart - true if chart tags will be rendered as charts, false otherwise.

isRecalculateOnOpen

boolean isRecalculateOnOpen()

true if the document is to perform recalculation when first opened. Default is true for XLSX, false for other formats.

Returns:

true if the document is to perform recalculation when first opened.

setRecalculateOnOpen

void setRecalculateOnOpen(boolean recalc)

true if the document is to perform recalculation when first opened. Default is true for XLSX, false for other formats.

Parameters:

recalc - true if the document is to perform recalculation when first opened.