Class DefaultPageTransferContext

The default page transfer context is the context used to transfer pages (the copy functionality)

Inheritance

System.Object

DefaultPageTransferContext

Implements

IPageTransferContext

ITransferHandlerContext

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.Core.Transfer

Assembly: EPiServer.dll

Version: 8.11.0

Syntax

[Obsolete("The Type no longer used.")]
public class DefaultPageTransferContext : IPageTransferContext, ITransferHandlerContext

Constructors

DefaultPageTransferContext(DecoratedClassFactory, ExportSource, SaveAction)

Initializes a new instance of the DefaultPageTransferContext class.

Declaration

public DefaultPageTransferContext(DecoratedClassFactory factory, ExportSource sourceRoot, SaveAction saveAction)

Parameters

Type	Name	Description
EPiServer.Implementation.DecoratedClassFactory	factory	The factory to create transfer object from.
ExportSource	sourceRoot	The root to tranfer pages from.
SaveAction	saveAction	The save action for the copy pages.

DefaultPageTransferContext(DecoratedClassFactory, ExportSource, SaveAction, TypeOfTransfer)

Initializes a new instance of the DefaultPageTransferContext class.

Declaration

public DefaultPageTransferContext(DecoratedClassFactory factory, ExportSource sourceRoot, SaveAction saveAction, TypeOfTransfer transferType)

Parameters

Type	Name	Description
EPiServer.Implementation.DecoratedClassFactory	factory	The factory to create transfer object from.
ExportSource	sourceRoot	The root to tranfer pages from.
SaveAction	saveAction	The save action for the copy pages.
TypeOfTransfer	transferType	The transfer type.

DefaultPageTransferContext(DecoratedClassFactory, IList<ExportSource>, SaveAction)

Initializes a new instance of the DefaultPageTransferContext class.

Declaration

public DefaultPageTransferContext(DecoratedClassFactory factory, IList<ExportSource> sourceRoots, SaveAction saveAction)

Parameters

Type	Name	Description
EPiServer.Implementation.DecoratedClassFactory	factory	The factory to create transfer object from.
System.Collections.Generic.IList<ExportSource>	sourceRoots	The roots to tranfer pages from.
SaveAction	saveAction	The save action for the copy pages.

DefaultPageTransferContext(DecoratedClassFactory, IList<ExportSource>, SaveAction, TypeOfTransfer)

Initializes a new instance of the DefaultPageTransferContext class.

Declaration

public DefaultPageTransferContext(DecoratedClassFactory factory, IList<ExportSource> sourceRoots, SaveAction saveAction, TypeOfTransfer transferType)

Parameters

Type	Name	Description
EPiServer.Implementation.DecoratedClassFactory	factory	The factory to create transfer object from.
System.Collections.Generic.IList<ExportSource>	sourceRoots	The roots to tranfer pages from.
SaveAction	saveAction	The save action for the copy pages.
TypeOfTransfer	transferType	The transfer type.

Properties

ClassFactory

Gets the class factory for the transfer functionality.

Declaration

public DecoratedClassFactory ClassFactory { get; }

Property Value

Type	Description
EPiServer.Implementation.DecoratedClassFactory	The class factory.

ContentTypesMap

Gets the look up table between incoming content type names and existing content type GUIDs.

Declaration

public IDictionary<string, Guid> ContentTypesMap { get; protected set; }

Property Value

Type	Description
System.Collections.Generic.IDictionary<System.String, System.Guid>	The map content type name from package and existing content type GUID.

CopiedPageLink

Gets or sets the the page link used as root of the copied pages.

Declaration

public PageReference CopiedPageLink { get; set; }

Property Value

Type	Description
PageReference

DestinationRoot

Gets or sets the destination root for the transfer.

Declaration

public PageReference DestinationRoot { get; set; }

Property Value

Type	Description
PageReference	The destination root.

FileTransfer

Gets the file transfer functionality.

Declaration

public IFileTransfer FileTransfer { get; }

Property Value

Type	Description
IFileTransfer	The object used to transfer files.

ForceNewIdentitiesOnExport

Gets or sets a value indicating whether to force new page identifiers for the mirrored pages.

Declaration

public bool ForceNewIdentitiesOnExport { get; set; }

Property Value

Type	Description
System.Boolean	`true` if [force new identities]; otherwise, `false`.

IgnorePageHierarchy

Gets a value indicating if the page hierarchy shoud be ignored for the destination pages (all pages will be stored below the destination root).

Declaration

public bool IgnorePageHierarchy { get; set; }

Property Value

Type	Description
System.Boolean	`true` if the page hierarchy should be ]; otherwise, `false`.

ImplicitContents

Gets the contents that have been implicitly added to package.

Declaration

public Queue<ExportSource> ImplicitContents { get; }

Property Value

Type	Description
System.Collections.Generic.Queue<ExportSource>	The implicit contents.

Remarks

The typical case for an implicitly added content is when a page references a global block. In that case the global block is implicitly added to the export package.

IsAborting

Gets a value indicating whether the transfer is aborting.

Declaration

public bool IsAborting { get; }

Property Value

Type	Description
System.Boolean	`true` if the transfer is aborting; otherwise, `false`.

IsCopyByReference

Allow pages to be synchronized using the PageLookup during import operation.

Declaration

public bool IsCopyByReference { get; set; }

Property Value

Type	Description
System.Boolean

IsDone

Gets or sets a value indicating whether the transfer is done.

Declaration

public bool IsDone { get; set; }

Property Value

Type	Description
System.Boolean	`true` if the transfer is done; otherwise, `false`.

LinkGuidMap

Gets the lock up table between page Guids and its page links.

Declaration

public IDictionary<Guid, Guid> LinkGuidMap { get; }

Property Value

Type	Description
System.Collections.Generic.IDictionary<System.Guid, System.Guid>	The map old GUID new link.

Log

Gets the logger for the context.

Declaration

public TransferLogger Log { get; }

Property Value

Type	Description
TransferLogger	The logger.

PageLanguages

Gets the page languages to transfer, if no list of languages is in the list all languages is transfered.

Declaration

public IList<string> PageLanguages { get; }

Property Value

Type	Description
System.Collections.Generic.IList<System.String>	The page languages to be transfered.

SaveAction

Gets the save action for the copied pages.

Declaration

public SaveAction SaveAction { get; }

Property Value

Type	Description
SaveAction	The save action for the copy pages

SourceRoots

Gets the roots to tranfer pages from..

Declaration

public IList<ExportSource> SourceRoots { get; }

Property Value

Type	Description
System.Collections.Generic.IList<ExportSource>	A list of source roots.

TransferHandlers

Gets the transfer handlers.

Declaration

public IEnumerable<TransferHandlerBase> TransferHandlers { get; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<TransferHandlerBase>	The transfer handlers.

TransferType

Gets or sets the type of the transfer.

Declaration

public TypeOfTransfer TransferType { get; set; }

Property Value

Type	Description
TypeOfTransfer	The type of the transfer.

Methods

Abort()

Aborts the transfer.

Declaration

public void Abort()

OnExportProperty(TransformPropertyEventArgs)

Raises the ExportPropertyEvent when a property is to be exported.

Declaration

public void OnExportProperty(TransformPropertyEventArgs e)

Parameters

Type	Name	Description
TransformPropertyEventArgs	e	The TransformPropertyEventArgs instance containing the event data.

OnImportProperty(TransformPropertyEventArgs)

Raises the ImportPropertyEvent event when a property is about to be imported.

Declaration

public void OnImportProperty(TransformPropertyEventArgs e)

Parameters

Type	Name	Description
TransformPropertyEventArgs	e	The TransformPropertyEventArgs instance containing the event data.

RegisterTransferHandlers()

Registers the transfer handlers.

Declaration

protected void RegisterTransferHandlers()

Events

ExportPropertyEvent

Event raised when a property is exported. An event handler has the opportunity to transfer the property value before the value is saved to export package.

Declaration

public static event EventHandler<TransformPropertyEventArgs> ExportPropertyEvent

Event Type

Type	Description
System.EventHandler<TransformPropertyEventArgs>

ImportPropertyEvent

Event raised when a property is imported. An event handler has the opportunity to transfer the property value before the value is saved.

Declaration

public static event EventHandler<TransformPropertyEventArgs> ImportPropertyEvent

Event Type

Type	Description
System.EventHandler<TransformPropertyEventArgs>

Implements

IPageTransferContext

ITransferHandlerContext

Extension Methods

IdentityObjectExtensions.GetIdentity(Object)

IdentityObjectExtensions.SetIdentity(Object, Identity)

PropertyBagObjectsExtensions.ToPropertyBag(Object)

PropertyBagObjectsExtensions.ToPropertyBag(Object, IEnumerable<String>)

RuntimeModelExtensions.GetOriginalType(Object)