Click or drag to resize

ExportSettings Class

Class to hold export settings for export engine.
Inheritance Hierarchy
SystemObject
  Vovin.CmcLibNet.ExportExportSettings

Namespace:  Vovin.CmcLibNet.Export
Assembly:  Vovin.CmcLibNet (in Vovin.CmcLibNet.dll) Version: 1.0.7729.42686
Syntax
public class ExportSettings : IExportSettings

The ExportSettings type exposes the following members.

Constructors
  NameDescription
Public methodExportSettings
Initializes a new instance of the ExportSettings class
Top
Properties
  NameDescription
Public propertyCanonical
Return data in a canonical format. Default is false.
Public propertyCSSFile
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).
Public propertyCustomHeaders
Use custom columnheaders.
Public propertyCustomRootNode
Custom root node for Xml, Json, Excel.
Public propertyDeleteExcelFileBeforeExport Obsolete.
Delete and recreate Excel file when exporting. Only applies to Excel. Default is true.
Public propertyExportFormat
Data format the export engine should generate. Default is Xml.
Public propertyHeaderMode
Headermode, i.e. what to use for columnames (Text, Html, Excel) or nodenames (Xml, Json). Default is Fieldname.
Public propertyHeadersOnFirstRow
Use headers on the first row in table-like exports (like Text, Html, Excel). Default is true.
Public propertyIncludeConnectionInfo
Include additional connection information. Only applies to Json. Default is true.
Public propertyISO8601Format
Make dates return in ISO8601 format.
Public propertyMaxFieldSize
Maximum number of characters to retrieve from fields. This includes connected fields. The default is ~500.000, skabout five times the Commence default.
Public propertyNestConnectedItems
Only applies to Json. Splits connection information into distinct elements/nodes.
Public propertyNumRows
Specify the number of rows to export at a time. Default is 1024.
Public propertyPreserveAllConnections
Include all connected items. Supported only for Xml, Json, Excel Overrides Canonical, ISO8601Format, SkipConnectedItems, SplitConnectedItems, ExcelUpdateOptions.
Public propertyReadCommenceDataAsync
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.

Public propertyRemoveCurrencySymbol
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.
Public propertySkipConnectedItems
Ignore connected items.
Public propertySplitConnectedItems
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.
Public propertyTextDelimiter
Text-delimiter used in a Text export. Only applies to Text and Html exports. Default is tab character.
Public propertyTextDelimiterConnections
Text-delimiter used for connected values. Only applies to Text and Html exports. Default is newline character (same as Commence uses).
Public propertyTextQualifier
Text-qualifier. Only applies to Text and Html exports. Default is " (double-quote).
Public propertyUseDDE
Make Commence use DDE calls to retrieve data. WARNING: extremely slow!
Public propertyUseThids
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.
Public propertyWriteSchema
Get serialized XML with a XmlSchema (XSD). Only applies to PreserveAllConnections in combination with Xml. Default is false.
Public propertyXlUpdateOptions
Update options when exporting to Microsoft Excel. See ExcelUpdateOptions.
Top
Methods
  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
See Also