Class PropertyXhtmlTransform
Transform a PropertyXhtmlString property for the transfer functionality.
Inheritance
Inherited Members
Namespace: EPiServer.Core.Transfer
Assembly: EPiServer.dll
Version: 8.11.0Syntax
public class PropertyXhtmlTransform
Constructors
PropertyXhtmlTransform()
Declaration
public PropertyXhtmlTransform()
Methods
AddFileToContext(String, IContentTransferContext)
Adds the file to the transfer context.
Declaration
public static string AddFileToContext(string possibleFilePath, IContentTransferContext transferContext)
Parameters
Type | Name | Description |
---|---|---|
System.String | possibleFilePath | The possible file path. |
IContentTransferContext | transferContext | The transfer context. |
Returns
Type | Description |
---|---|
System.String | The path to the added file if it exists, else posibleFilePath unchanged |
AddFileToContext(String, IPageTransferContext)
Declaration
[Obsolete("Use string AddFileToContext(string possibleFilePath, IContentTransferContext transferContext)")]
public static string AddFileToContext(string possibleFilePath, IPageTransferContext transferContext)
Parameters
Type | Name | Description |
---|---|---|
System.String | possibleFilePath | |
IPageTransferContext | transferContext |
Returns
Type | Description |
---|---|
System.String |
ExportEventHandler(Object, TransformPropertyEventArgs)
Transform a PropertyXhtmlString property to an exportable format by changing the value of the PropertySource in the event args. If the result is handled by this method and should not be handled by the default handeling the event args property IsHandled has to be set.
Declaration
public static void ExportEventHandler(object sender, TransformPropertyEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
System.Object | sender | The sender has to inherit from a page transfer IPageTransfer object. |
TransformPropertyEventArgs | e | The TransformPropertyEventArgs instance containing the event data. |
ImportEventHandler(Object, TransformPropertyEventArgs)
Transform a PropertyXhtmlString property from a import format to a concrete property. This is done by take the PropertySource from the event args and stores the transformed result in the PropertyDestination property that is used to create the page. If the result is handled by this method and should not be handled by the default handeling the event args property IsHandled has to be set.
Declaration
public static void ImportEventHandler(object sender, TransformPropertyEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
System.Object | sender | The page transfer IPageTransfer object. |
TransformPropertyEventArgs | e | The TransformPropertyEventArgs instance containing the data to be transformed. |