Class ConfigurationViewTransformer
ConfigurationViewTransformer is used to alter the default behaviour and components for a given view.
Inheritance
System.Object
ConfigurationViewTransformer
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.Shell.ViewComposition
Assembly: EPiServer.Shell.dll
Version: 9.12.2Syntax
[ViewTransformer]
public class ConfigurationViewTransformer : IViewTransformer, ISortable
Constructors
ConfigurationViewTransformer(EPiServerShellSection, IComponentManager)
Initializes a new instance of the ConfigurationViewTransformer class.
Declaration
public ConfigurationViewTransformer(EPiServerShellSection shellSection, IComponentManager componentManager)
Parameters
Type | Name | Description |
---|---|---|
EPiServerShellSection | shellSection | The configuration section. |
IComponentManager | componentManager | The component manager. |
Properties
Settings
Gets a collection of ViewTransformationSettingsCollection for each view that has settings.
Declaration
public Collection<ViewTransformationSettingsCollection> Settings { get; }
Property Value
Type | Description |
---|---|
System.Collections.ObjectModel.Collection<ViewTransformationSettingsCollection> | The settings. |
SortOrder
Used to select the order of execution when there are several IViewTransformers.
Declaration
public int SortOrder { get; }
Property Value
Type | Description |
---|---|
System.Int32 | ConfigurationViewTransformer has 100. |
Methods
LoadSettingsFromConfiguration(ViewElement)
Loads the settings from configuration.
Declaration
public void LoadSettingsFromConfiguration(ViewElement settingsElement)
Parameters
Type | Name | Description |
---|---|---|
ViewElement | settingsElement | The settings element. |
TransformView(ICompositeView, IPrincipal)
Transforms the view according to the given settings.
Declaration
public void TransformView(ICompositeView view, IPrincipal principal)
Parameters
Type | Name | Description |
---|---|---|
ICompositeView | view | The view. |
System.Security.Principal.IPrincipal | principal | The principal. |