Click or drag to resize

DataExportHelper Methods

The DataExportHelper type exposes the following members.

Methods
  NameDescription
Public methodStatic memberCleanExportFiles
Clean up the exported files for the given FilePath.
Public methodStatic memberConvertAndTransmitFile
Convert a given mapper's content to a Data type as specified by the DataExportService, and then write the file out to the browser
Public methodStatic memberConvertFile
Convert a given file / XML content to a file defined by the DataExportService.
Public methodStatic memberDoExport
Do the export for a given DataExportService. The results are written to the browser.
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodStatic memberExport
Perform the export for a given mapper / DataExportService combo.
Public methodStatic memberExportIsCancelled(IMapper)
Checks whether the export has been cancelled by the user
Public methodStatic memberExportIsCancelled(IAppContext, Int32)
Checks whether the export has been cancelled by the user
Public methodStatic memberExportIsCancelled(IAppContext, Int32, Int32)
Checks whether the export has been cancelled by the user
Public methodStatic memberExportUnderSmartThreshold
Calculates the expected duration of the excel export and compares that against the threshold for offline execution. If the estimated duration is below the system threshold, it returns false (typically meaning the export will occur online)
Protected methodFinalize
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
Public methodStatic memberGenFilename
Generate the Data filename.
Public methodStatic memberGetDefaultExportExtension
Get the default Export file Extension.
Public methodStatic memberGetDocStorage(IMapper)
Gets the DocStorageService for the Offline Export task.
Public methodStatic memberGetDocStorage(IAppContext, Properties)
Gets the DocStorageService for the Offline Export task.
Public methodStatic memberGetExportLife
Determines the amount of days an export can remain in the database after performing an Offline Export
Public methodStatic memberGetExportMode(IAppContext, IDataExportService, Boolean)
Inspects the feature property DataExportMode to determine the behavior for executing Data exports.
Public methodStatic memberGetExportMode(IMapper, IDataExportService, Boolean)
Inspects the feature property ExcelExportMode to determine the behavior for executing excel exports.
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodStatic memberGetRelatedDocMapper(IMapper)
Gets a reldoc mapper ready for insert. the person calling this method is reponsible to close the mapper once finished
Public methodStatic memberGetRelatedDocMapper(IAppContext, Properties)
Gets a reldoc mapper ready for insert. the person calling this method is reponsible to close the mapper once finished
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodStatic memberLogExportMetric(IMapper, NullableExcelExportStatus, NullableInt32, NullableInt32, NullableInt64, String, String, NullableExcelExportAttrs, NullableExcelExportOfflineReasons)
Logs metrics for data exporting.
Public methodStatic memberLogExportMetric(IAppContext, Int32, ExcelExportStatus, NullableInt32, NullableInt32, NullableInt64, String, String, NullableExcelExportAttrs, NullableExcelExportOfflineReasons)
Logs metrics for data exporting.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodStatic memberNotifyRecipient
Notifies the recipient on completion of export
Public methodStatic memberPerformExport
Perform the export.
Public methodStatic memberSaveToDocStorage
Saves the exported file to doc storage
Public methodToString
Returns a String that represents the current Object.
(Inherited from Object.)
Top
Extension Methods
  NameDescription
Public Extension MethodEqualValue
Determines if the object value is equal to another object. If the two objects are null, then this returns true. There is special handling for guid comparisons (since a guid could be a string formatted in up to 3 different ways). If the special guid handling is not performed, then the object.Equals method is used.
(Defined by EAPUtil.)
Top
See Also