Package com.mendix.modules.exportmanager.excel

Class ExcelExporter

java.lang.Object

com.mendix.modules.exportmanager.excel.ExcelExporter

public class ExcelExporter
extends java.lang.Object

Represents an exporter for Excel documents.

Constructor Summary

Constructors

Constructor	Description
ExcelExporter()

Method Summary

Modifier and Type	Method	Description
static IExcelGrid	createExcelGrid()	Deprecated. since 9.8.0, use createExcelGrid(IContext) instead
static IExcelGrid	createExcelGrid(IContext context)	Creates a new Excel grid.
static IMendixObject	generateXLS(IContext context, IMendixObject fileObject, java.lang.String fileName, java.util.List<IExcelGrid> grids)	Generates an Excel file from the given grids.
static IMendixObject	generateXLS(IContext context, IMendixObject fileObject, java.lang.String fileName, java.util.List<java.lang.String> oqlQueries, boolean autoSizeColumns, java.util.List<java.lang.String> headerNames)	Generates an Excel file from the given OQL queries.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ExcelExporter

public ExcelExporter()

Method Detail

generateXLS

public static IMendixObject generateXLS(IContext context,
                                        IMendixObject fileObject,
                                        java.lang.String fileName,
                                        java.util.List<IExcelGrid> grids)
                                 throws CoreException

Generates an Excel file from the given grids.

Parameters:

context - the context to use for access control

fileObject - the FileDocument object

fileName - the file name

grids - the grids to be converted

Returns:

the resulting FileDocument object containing the report

Throws:

CoreException - if generated the Excel file failed

generateXLS

public static IMendixObject generateXLS(IContext context,
                                        IMendixObject fileObject,
                                        java.lang.String fileName,
                                        java.util.List<java.lang.String> oqlQueries,
                                        boolean autoSizeColumns,
                                        java.util.List<java.lang.String> headerNames)
                                 throws CoreException

Generates an Excel file from the given OQL queries.

Parameters:

context - the context to use for access control

fileObject - the FileDocument object

fileName - the file name

oqlQueries - the OQL queries

autoSizeColumns - indicates whether to size columns automatically

headerNames - the column names

Returns:

the resulting FileDocument object containing the report

Throws:

CoreException - if generating the Excel file failed

createExcelGrid

@Deprecated
public static IExcelGrid createExcelGrid()

Deprecated.

since 9.8.0, use createExcelGrid(IContext) instead

Creates a new Excel grid.

Returns:

the Excel grid

createExcelGrid

public static IExcelGrid createExcelGrid(IContext context)

Creates a new Excel grid.

Parameters:

context - the context to use for access control

Returns:

the Excel grid