Try our conversational search powered by Generative AI!

AI OnAI Off

Class DataExporterExtensions

Inheritance
System.Object
DataExporterExtensions
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: EPiServer.Enterprise
Assembly: EPiServer.Enterprise.dll
Version: 11.20.7
Syntax
public static class DataExporterExtensions

Methods

AddCategory(IDataExporter, Category)

Adds a category to the list of categories to export.

Declaration
public static void AddCategory(this IDataExporter dataExporter, Category category)
Parameters
Type Name Description
IDataExporter dataExporter
Category category

AddContentLanguage(IDataExporter, CultureInfo)

Adds a language to the list of content languages to export.

Declaration
public static void AddContentLanguage(this IDataExporter dataExporter, CultureInfo contentLanguage)
Parameters
Type Name Description
IDataExporter dataExporter
System.Globalization.CultureInfo contentLanguage

AddContentType(IDataExporter, ContentType)

Adds a category to the list of categories to export.

Declaration
public static void AddContentType(this IDataExporter dataExporter, ContentType contentType)
Parameters
Type Name Description
IDataExporter dataExporter
ContentType contentType

AddDynamicProperty(IDataExporter, PropertyDefinition)

Adds a dynamic property definition to the list of dynamic properties to export.

Declaration
public static void AddDynamicProperty(this IDataExporter dataExporter, PropertyDefinition propertyDefinition)
Parameters
Type Name Description
IDataExporter dataExporter
PropertyDefinition propertyDefinition

AddFrame(IDataExporter, Frame)

Adds a frame to the list of frames to export.

Declaration
public static void AddFrame(this IDataExporter dataExporter, Frame frame)
Parameters
Type Name Description
IDataExporter dataExporter
Frame frame

AddTabDefinition(IDataExporter, TabDefinition)

Adds a tab definition to the list of tab definitions to export.

Declaration
public static void AddTabDefinition(this IDataExporter dataExporter, TabDefinition tabDefinition)
Parameters
Type Name Description
IDataExporter dataExporter
TabDefinition tabDefinition

AddVisitorGroup(IDataExporter, VisitorGroup)

Adds a visitor group to the list of visitor groups to export.

Declaration
public static void AddVisitorGroup(this IDataExporter dataExporter, VisitorGroup visitorGroup)
Parameters
Type Name Description
IDataExporter dataExporter
VisitorGroup visitorGroup

Export(IDataExporter, Stream)

Export the specified data to an export package specified by System.IO.Stream

Declaration
public static ITransferLog Export(this IDataExporter dataExporter, Stream stream)
Parameters
Type Name Description
IDataExporter dataExporter

The exporter that is being extended
System.IO.Stream stream

The stream to where the export packages is saved
Returns
Type Description
ITransferLog
Remarks

Potential errors and warnings are logged to returned logger

Continuous progress can be retreieved from Status.

Export(IDataExporter, Stream, ExportOptions)

Export the specified data to an export package specified by System.IO.Stream

Declaration
public static ITransferLog Export(this IDataExporter dataExporter, Stream stream, ExportOptions options)
Parameters
Type Name Description
IDataExporter dataExporter

The exporter that is being extended
System.IO.Stream stream

The stream to where the export packages is saved
ExportOptions options

Specify settings for how the export should be done
Returns
Type Description
ITransferLog
Remarks

Potential errors and warnings are logged to returned logger

Continuous progress can be retreieved from Status.

Export(IDataExporter, Stream, IList<ExportSource>)

Export the specified data to an export package specified by System.IO.Stream

Declaration
public static ITransferLog Export(this IDataExporter dataExporter, Stream stream, IList<ExportSource> sourceRoots)
Parameters
Type Name Description
IDataExporter dataExporter

The exporter that is being extended
System.IO.Stream stream

The stream to where the export packages is saved
System.Collections.Generic.IList<ExportSource> sourceRoots

The list of content roots to export
Returns
Type Description
ITransferLog
Remarks

Potential errors and warnings are logged to returned logger

Continuous progress can be retreieved from Status.