Groupdocs API References – com.groupdocs.metadata.export

Nodejs-Java: CsvExportOptions

Mon, 01 Jan 0001 00:00:00 +0000

Inheritance: java.lang.Object, com.groupdocs.metadata.export.ExportOptions

public class CsvExportOptions extends ExportOptions

Creates an export options of xml file.

Constructors

Constructor	Description
CsvExportOptions()	Initializes a new instance of the CsvExportOptions class.

CsvExportOptions()

public CsvExportOptions()

Initializes a new instance of the CsvExportOptions class.

Nodejs-Java: ExcelExportOptions

Mon, 01 Jan 0001 00:00:00 +0000

Inheritance: java.lang.Object, com.groupdocs.metadata.export.ExportOptions

public class ExcelExportOptions extends ExportOptions

Creates an export options of excel file.

Constructors

Constructor	Description
ExcelExportOptions()	Initializes a new instance of the ExcelExportOptions class.
ExcelExportOptions(boolean groupCells)	Initializes a new instance of the ExcelExportOptions class.

Methods

Method	Description
getGroupCells()	This flag determines whether it is necessary to group rows when exporting to Excel format
setGroupCells(boolean value)	This flag determines whether it is necessary to group rows when exporting to Excel format

ExcelExportOptions()

public ExcelExportOptions()

Initializes a new instance of the ExcelExportOptions class.

ExcelExportOptions(boolean groupCells)

public ExcelExportOptions(boolean groupCells)

Initializes a new instance of the ExcelExportOptions class.

Parameters:

Parameter	Type	Description
groupCells	boolean	Group flag.

getGroupCells()

public final boolean getGroupCells()

This flag determines whether it is necessary to group rows when exporting to Excel format

Value: If the flag is true, the lines will be grouped, otherwise not

Returns: boolean

setGroupCells(boolean value)

public final void setGroupCells(boolean value)

This flag determines whether it is necessary to group rows when exporting to Excel format

Value: If the flag is true, the lines will be grouped, otherwise not

Parameters:

Parameter	Type	Description
value	boolean

Nodejs-Java: ExportManager

Mon, 01 Jan 0001 00:00:00 +0000

Inheritance: java.lang.Object

public class ExportManager

Provides a row of methods allowing the user to export metadata properties to various formats.

Constructors

Constructor	Description
ExportManager(Iterable properties)	Initializes a new instance of the ExportManager class.

Methods

Method	Description
export(String filePath, ExportFormat format, ExportOptions exportOptions)	Exports the metadata properties to a file.
export(OutputStream document, ExportFormat format, ExportOptions exportOptions)	Exports the metadata properties to a stream.
export(String filePath, ExportFormat format)	Exports the metadata properties to a file.
export(OutputStream document, ExportFormat format)	Exports the metadata properties to a stream.

ExportManager(Iterable properties)

public ExportManager(Iterable<MetadataProperty> properties)

Initializes a new instance of the ExportManager class.

Parameters:

Parameter	Type	Description
properties	java.lang.Iterable<com.groupdocs.metadata.core.MetadataProperty>	A collection of metadata properties to be exported.

export(String filePath, ExportFormat format, ExportOptions exportOptions)

public final void export(String filePath, ExportFormat format, ExportOptions exportOptions)

Exports the metadata properties to a file.

Parameters:

Parameter	Type	Description
filePath	java.lang.String	The full name of the output file.
format	ExportFormat	The format of the output file.
exportOptions	ExportOptions

export(OutputStream document, ExportFormat format, ExportOptions exportOptions)

public final void export(OutputStream document, ExportFormat format, ExportOptions exportOptions)

Exports the metadata properties to a stream.

Parameters:

Parameter	Type	Description
document	java.io.OutputStream	The full name of the output file.
format	ExportFormat	The format of the output file.
exportOptions	ExportOptions

export(String filePath, ExportFormat format)

public final void export(String filePath, ExportFormat format)

Exports the metadata properties to a file.

Parameters:

Parameter	Type	Description
filePath	java.lang.String	The full name of the output file.
format	ExportFormat	The format of the output file.

export(OutputStream document, ExportFormat format)

public final void export(OutputStream document, ExportFormat format)

Exports the metadata properties to a stream.

Parameters:

Parameter	Type	Description
document	java.io.OutputStream	The output file stream.
format	ExportFormat	The format of the output file.

Nodejs-Java: ExportOptions

Mon, 01 Jan 0001 00:00:00 +0000

Inheritance: java.lang.Object

public abstract class ExportOptions

Abstract class export options.

Constructors

Constructor	Description
ExportOptions()	Initializes a new instance of the ExportOptions class.

ExportOptions()

public ExportOptions()

Initializes a new instance of the ExportOptions class.

Nodejs-Java: JsonExportOptions

Mon, 01 Jan 0001 00:00:00 +0000

Inheritance: java.lang.Object, com.groupdocs.metadata.export.ExportOptions

public class JsonExportOptions extends ExportOptions

Creates an export options of xml file.

Constructors

Constructor	Description
JsonExportOptions()	Initializes a new instance of the JsonExportOptions class.

JsonExportOptions()

public JsonExportOptions()

Initializes a new instance of the JsonExportOptions class.

Nodejs-Java: XmlExportOptions

Mon, 01 Jan 0001 00:00:00 +0000

Inheritance: java.lang.Object, com.groupdocs.metadata.export.ExportOptions

public class XmlExportOptions extends ExportOptions

Creates an export options of xml file.

Constructors

Constructor	Description
XmlExportOptions()	Initializes a new instance of the XmlExportOptions class.

XmlExportOptions()

public XmlExportOptions()

Initializes a new instance of the XmlExportOptions class.

Nodejs-Java: ExportFormat

Mon, 01 Jan 0001 00:00:00 +0000

Inheritance: java.lang.Object, java.lang.Enum

All Implemented Interfaces: com.groupdocs.metadata.core.IEnumValue

public enum ExportFormat extends Enum<ExportFormat> implements IEnumValue

Defines file formats to which you can export metadata properties.

Fields

Field	Description
Xls	Represents the .XLS Excel format.
Xlsx	Represents the .XLSX Excel format.
Xml	Represents the .XML format.
Csv	Represents the .CSV format.
Json	Represents the .JSON format.

Methods

Method	Description
values()
valueOf(String name)
getByRawValue(int rawValue)
getFirst()
getAllValues()
getEnumValueByRawValue(int rawValue)
getEnumValueByName(String name)
getRawValueType()
getRawValue()

Xls

public static final ExportFormat Xls

Represents the .XLS Excel format.

Xlsx

public static final ExportFormat Xlsx

Represents the .XLSX Excel format.

Xml

public static final ExportFormat Xml

Represents the .XML format.

Csv

public static final ExportFormat Csv

Represents the .CSV format.

Json

public static final ExportFormat Json

Represents the .JSON format.

values()

public static ExportFormat[] values()

Returns: com.groupdocs.metadata.export.ExportFormat[]

valueOf(String name)

public static ExportFormat valueOf(String name)

Parameters:

Parameter	Type	Description
name	java.lang.String

Returns: ExportFormat

getByRawValue(int rawValue)

public static ExportFormat getByRawValue(int rawValue)

Parameters:

Parameter	Type	Description
rawValue	int

Returns: ExportFormat

getFirst()

public static IEnumValue getFirst()

Returns: IEnumValue

getAllValues()

public Object[] getAllValues()

Returns the array of all values defined in the class.

Returns: java.lang.Object[]

getEnumValueByRawValue(int rawValue)

public IEnumValue getEnumValueByRawValue(int rawValue)

Returns the enumeration value by the raw value associated with it.

Parameters:

Parameter	Type	Description
rawValue	int

Returns: IEnumValue

getEnumValueByName(String name)

public IEnumValue getEnumValueByName(String name)

Returns the enumeration value by its name.

Parameters:

Parameter	Type	Description
name	java.lang.String

Returns: IEnumValue

getRawValueType()

public RawIntegerType getRawValueType()

Returns the underlying type of the raw value of this enumeration value.

Returns: RawIntegerType

getRawValue()

public int getRawValue()

Returns the raw value of this enumeration value.

Returns: int