Don't miss out Virtual Happy Hour this Friday (April 26).

Try our conversational search powered by Generative AI!

AI OnAI Off

Class DynamicDataTransferHandler

Handle transfering Dynamic Data (e.g. PropertySettingsWrapper Setting of PropertyDefinition and Pageobjects on page data are the DDS items) It register self to RegisterTransferHandlers when the system be starts by IInitializableModule (Initialize)

Inheritance
System.Object
TransferHandlerBase
DynamicDataTransferHandler
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
[InitializableModule]
public class DynamicDataTransferHandler : TransferHandlerBase, IConfigurableModule, IInitializableModule, IDynamicDataTransfer

Constructors

DynamicDataTransferHandler()

Initializes a new instance of the DynamicDataTransferHandler class.

Declaration
public DynamicDataTransferHandler()

Properties

ContentTransferContext

The context for the import or export.

Declaration
public IContentTransferContext ContentTransferContext { get; }
Property Value
Type Description
IContentTransferContext

IsInitialized

Declaration
public bool IsInitialized { get; set; }
Property Value
Type Description
System.Boolean

Methods

AddToExport(Guid, String)

Adds an item from dynamic data store to export package.

Declaration
public void AddToExport(Guid id, string storeName)
Parameters
Type Name Description
System.Guid id

The guid based identifier for the item
System.String storeName

Name of the store.

AddToExport(Guid, String, Boolean)

Adds an item from dynamic data store to export package without change identity.

Declaration
public void AddToExport(Guid id, string storeName, bool keepIdentity)
Parameters
Type Name Description
System.Guid id

The id.
System.String storeName

Name of the store.
System.Boolean keepIdentity

if set to true [keep identity].

ConfigureContainer(ServiceConfigurationContext)

Declaration
public void ConfigureContainer(ServiceConfigurationContext context)
Parameters
Type Name Description
ServiceConfigurationContext context

ContentTransfering(RawContent)

Try to collect DDS item on (e.g pageObject) on the RawPage object for exporting

Declaration
public override void ContentTransfering(RawContent content)
Parameters
Type Name Description
RawContent content

The page.
Overrides

ContentTypesTransfering(IEnumerable<ContentType>, Boolean)

If the transferPropertySettings parameter set to true then PropertySettings for each property definition on page types be transfered.

Declaration
public override void ContentTypesTransfering(IEnumerable<ContentType> contentTypes, bool transferPropertySettings)
Parameters
Type Name Description
System.Collections.Generic.IEnumerable<ContentType> contentTypes

The page types.
System.Boolean transferPropertySettings

if set to true [transfer property settings].
Overrides

DynamicPropertiesTransfering(IList<PropertyDefinition>, Boolean)

If the transferPropertySettings parameter set to true then PropertySettings for each property definition is transfered.

Declaration
public override void DynamicPropertiesTransfering(IList<PropertyDefinition> propertyDefinitions, bool transferPropertySettings)
Parameters
Type Name Description
System.Collections.Generic.IList<PropertyDefinition> propertyDefinitions

The property definitions.
System.Boolean transferPropertySettings

if set to true [transfer property settings].
Overrides

Initialize(InitializationEngine)

Declaration
public void Initialize(InitializationEngine context)
Parameters
Type Name Description
InitializationEngine context

OnDeserializedObject(Object, SerializationEventArgs)

Called when to raise event DeserializedObject

Declaration
protected void OnDeserializedObject(object sender, SerializationEventArgs eventArgs)
Parameters
Type Name Description
System.Object sender

The sender.
SerializationEventArgs eventArgs

The SerializationEventArgs instance containing the event data.

OnDeserializingFromXml(Object, DeserializingItemEventArgs)

Called to raise event DeserializingFromXml

Declaration
protected void OnDeserializingFromXml(object sender, DeserializingItemEventArgs e)
Parameters
Type Name Description
System.Object sender

The sender.
DeserializingItemEventArgs e

The DeserializingItemEventArgs instance containing the event data.

OnSerializingObject(Object, SerializationEventArgs)

Called to raise event SerializingObject

Declaration
protected void OnSerializingObject(object sender, SerializationEventArgs eventArgs)
Parameters
Type Name Description
System.Object sender

The sender.
SerializationEventArgs eventArgs

The SerializationEventArgs instance containing the event data.

OnSerializingToXml(Object, SerializingItemEventArgs)

Called to raise event SerializingToXml

Declaration
protected void OnSerializingToXml(object sender, SerializingItemEventArgs e)
Parameters
Type Name Description
System.Object sender

The sender.
SerializingItemEventArgs e

The SerializingItemEventArgs instance containing the event data.

Read(Stream)

Reads all serialized Dynamic Data objects and tries to deserailize and store them in Dynamic Data Store.

Declaration
public override void Read(Stream reader)
Parameters
Type Name Description
System.IO.Stream reader

The reader.
Overrides

Uninitialize(InitializationEngine)

Declaration
public void Uninitialize(InitializationEngine context)
Parameters
Type Name Description
InitializationEngine context

Write(Stream)

Serialize all Dynamic Data objects and write them to a stream Change the identity of the object.

Declaration
public override void Write(Stream writer)
Parameters
Type Name Description
System.IO.Stream writer

The writer.
Overrides

Events

DeserializedObject

Occurs when a DDS object is deserialized but not yet saved to DDS. An eventhandler has possibility to alter object or cancel save operation.

Declaration
public event EventHandler<SerializationEventArgs> DeserializedObject
Event Type
Type Description
System.EventHandler<SerializationEventArgs>

DeserializingFromXml

Occurs at deserilalization for items that has been modified by event SerializingToXml.

Declaration
public event EventHandler<DeserializingItemEventArgs> DeserializingFromXml
Event Type
Type Description
System.EventHandler<DeserializingItemEventArgs>
Remarks

This event is only raised when an objects serilization format has been relplace by an eventhandler to SerializingToXml.

ImportCompleted

Occurs when [import completed].

Declaration
public event EventHandler<EventArgs> ImportCompleted
Event Type
Type Description
System.EventHandler<System.EventArgs>

SerializingObject

Occurs when a DDS object is about to be serilaized to stream. An eventhandler has possibility to alter object or cancel save operation.

Declaration
public event EventHandler<SerializationEventArgs> SerializingObject
Event Type
Type Description
System.EventHandler<SerializationEventArgs>

SerializingToXml

Occurs when a DDS object or a object reference has been serialized. An eventhandler has possibility to replace the serialized format of the object. If an item is modified then an eventhandler to DeserializingFromXml must be registered to handle recreation of object.

Declaration
public event EventHandler<SerializingItemEventArgs> SerializingToXml
Event Type
Type Description
System.EventHandler<SerializingItemEventArgs>

Implements

Extension Methods