IExportSettings Interface

Interface for ExportSettings.

Namespace: Vovin.CmcLibNet.Export
Assembly: Vovin.CmcLibNet (in Vovin.CmcLibNet.dll) Version: 1.0.7729.42686

Syntax

public interface IExportSettings

Public Interface IExportSettings

The IExportSettings type exposes the following members.

Properties

	Name	Description
	Canonical	Return data in a canonical format. Default is false.
	CSSFile	External CSS file to be linked with an HTML export. Location is the output path. Only applies to HTML exports. Default is empty (no CSSFile).
	CustomHeaders	Use custom columnheaders.
	CustomRootNode	Custom root node for Xml, Json, Excel.
	DeleteExcelFileBeforeExport	Obsolete. Delete and recreate Excel file when exporting. Only applies to Excel. Default is true.
	ExportFormat	Data format the export engine should generate. Default is Xml.
	HeaderMode	Headermode, i.e. what to use for columnames (Text, Html, Excel) or nodenames (Xml, Json). Default is Fieldname.
	HeadersOnFirstRow	Use headers on the first row in table-like exports (like Text, Html, Excel). Default is true.
	IncludeConnectionInfo	Include additional connection information. Only applies to Json. Default is true.
	ISO8601Format	Make dates return in ISO8601 format.
	MaxFieldSize	Maximum number of characters to retrieve from fields. This includes connected fields. The default is ~500.000, skabout five times the Commence default.
	NestConnectedItems	Only applies to Json. Splits connection information into distinct elements/nodes.
	NumRows	Specify the number of rows to export at a time. Default is 1024.
	PreserveAllConnections	Include all connected items. Supported only for Xml, Json, Excel Overrides Canonical, ISO8601Format, SkipConnectedItems, SplitConnectedItems, ExcelUpdateOptions.
	ReadCommenceDataAsync	Read Commence data in an asynchronous way. Async can be slightly faster, but it depends on a number of things, such as NumRows and MaxFieldSize. When you export to Excel or use PreserveAllConnections there is a performance gain. Default is true.
	RemoveCurrencySymbol	Used in conjunction with Canonical, allows removal of the currency symbol that Commence will include when numeric fields were set to 'Display as currency' Default is false.
	SkipConnectedItems	Ignore connected items.
	SplitConnectedItems	Split connected values into separate nodes/elements. Only applies to Json and Xml. Default is true. If set to false, connected values are not split and you will get the data as Commence returns them.
	TextDelimiter	Text-delimiter used in a Text export. Only applies to Text and Html exports. Default is tab character.
	TextDelimiterConnections	Text-delimiter used for connected values. Only applies to Text and Html exports. Default is newline character (same as Commence uses).
	TextQualifier	Text-qualifier. Only applies to Text and Html exports. Default is " (double-quote).
	UseDDE	Make Commence use DDE calls to retrieve data. WARNING: extremely slow!
	UseThids	Include additional column holding the item's THID and return THIDs instead of Name field values for connected items. (XML and Json). For text-based exports, connected items are not returned as thids. Default is false.
	WriteSchema	Get serialized XML with a XmlSchema (XSD). Only applies to PreserveAllConnections in combination with Xml. Default is false.
	XlUpdateOptions	Update options when exporting to Microsoft Excel. See ExcelUpdateOptions.

Top

Remarks

Some setttings will negate others or be ignored when not applicable or be manipulated internally. This is not always fully documented.

You should NOT create code that relies on the settings you provided. For example: if you set both MaxFieldSize and NumRows to a huge number, the assembly will balance them out so as to prevent out-of-memory exceptions.

Reference

Vovin.CmcLibNet.Export Namespace