Relativity.API.Foundation.MassOperations.IExportToFileParameters

IExportToFileParameters

public interface IExportToFileParameters

Parameters for the Export to File Mass Operation.

Documentation

Encoding Encoding { get; }

The encoding of the file.

bool EscapeFormulas { get; }

If true, the export will escape formulas. This is an export-to-excel only option.

Stream ExportResults { get; }

The stream the completed Mass Operation will write to.

IEnumerable<IFieldRef> Fields { get; }

The fields to export. If populated, will take precedence over View, and only fields specified in this property will be exported.

ExportToFileOptions FileOptions { get; }

ExportToFileOptions

IObjectTypeRef ObjectType { get; }

The object type of the mass operation.

Guid? ProcessIdentifier { get; }

Optional identifier for tracking the mass operation process state. If null, an identifier will be randomly generated when the mass operation executes.

ISearchProviderRef SearchProvider { get; }

The Search Provider, if any, to use.

IArtifactRef View { get; }

The selected view to export field metadata from. If no Fields are specified, all fields in this view will be exported.