Class Code14<TModel, TServiceKit>

Base class for v14 Dynamic Code files.

Will provide the ServiceKit specified by the type TServiceKit on property Kit.

Inheritance

object

ServiceBase

ServiceForDynamicCode

DynamicCodeBase

Code14<TModel, TServiceKit>

Code16

Implements

IHasCodeLog

IDynamicCode

ICreateInstance

IHasLog

Namespace: Custom.Hybrid.Advanced

Assembly: ToSic.Sxc.dll

Syntax

[InternalApi_DoNotUse_MayChangeWithoutNotice]
public abstract class Code14<TModel, TServiceKit> : DynamicCodeBase, IHasCodeLog, IDynamicCode, ICreateInstance, IHasLog where TModel : class where TServiceKit : ServiceKit

Type Parameters

Name	Description
TModel	not yet used - pls always use dynamic
TServiceKit	The ServiceKit provided on Kit - for now, use ServiceKit14

Remarks

Important: The property Convert which exited on Razor12 was removed. use Kit.Convert instead.

Constructors

Code14()

Main constructor. May never have parameters, otherwise inheriting code will run into problems.

Declaration

protected Code14()

Properties

App

A fully prepared IApp object letting you access all the data and queries in the current app.

Declaration

public IApp App { get; }

Property Value

Type	Description
IApp	The current app

CmsContext

The CmsContext tells you about the environment, like what page and module we're running in. It's supposed to replace the Dnn object in Razor and WebAPI code.

Declaration

public ICmsContext CmsContext { get; }

Property Value

Type	Description
ICmsContext

Remarks

New in v11.11

Content

The content object of the current razor view - IF the current view has content. If the view is a list, it will return the first item. Will be null otherwise. To tell if it's the demo/default item, use IsDemoItem.

Declaration

public dynamic Content { get; }

Property Value

Type	Description
dynamic	A IDynamicEntity object with the current content - or null.

Data

The data prepared for the current Code. Usually user data which was manually added to the instance, but can also be a query.

Declaration

public IContextData Data { get; }

Property Value

Type	Description
IContextData	An IContextData which is as IDataSource.

Edit

Helper commands to enable in-page editing functionality Use it to check if edit is enabled, generate context-json infos and provide toolbar buttons

Declaration

public IEditService Edit { get; }

Property Value

Type	Description
IEditService	An IEditService object.

Header

The header object of the current razor view, if it's a list and has a header object. If it's a list and doesn't have a header (and no default), it will return null. To tell if it's the demo/default item, use IsDemoItem.

Declaration

public dynamic Header { get; }

Property Value

Type	Description
dynamic	A IDynamicEntity object with the current content.

Remarks

Introduced in 2sxc 10.10 - previously it was called ListContent, now deprecated.

Kit

Declaration

public TServiceKit Kit { get; }

Property Value

Type	Description
TServiceKit

Link

Link helper object to create the correct links

Declaration

public ILinkService Link { get; }

Property Value

Type	Description
ILinkService	A ILinkService object.

Log

The logger for the current Razor / WebApi

Declaration

public ICodeLog Log { get; }

Property Value

Type	Description
ICodeLog

Resources

Resources for this Scenario. This is a dynamic object based on the IDynamicStack.

It will combine both the Resources of the View and the App. The View-Resources will have priority. In future it may also include some global Resources.

🪒 Use in Razor: @Resources.CtaButtonLabel

Declaration

public dynamic Resources { get; }

Property Value

Type	Description
dynamic

Remarks

New in 12.03

Settings

Settings for this Scenario. This is a dynamic object based on the IDynamicStack.

It will combine both the Settings of the View and the App. The View-Settings will have priority. In future it may also include some global Settings.

🪒 Use in Razor: @Settings.ItemsPerRow

Declaration

public dynamic Settings { get; }

Property Value

Type	Description
dynamic

Remarks

New in 12.03

Methods

AsAdam(ICanBeEntity, string)

Provides an Adam instance for this item and field

Declaration

public IFolder AsAdam(ICanBeEntity item, string fieldName)

Parameters

Type	Name	Description
ICanBeEntity	item	The item - an IEntity, IDynamicEntity, ITypedItem etc. often Content or similar
string	fieldName	The field name, like "Gallery" or "Pics"

Returns

Type	Description
IFolder	An Adam object for navigating the assets

AsDynamic(object)

Convert a dynamic entity and return itself again. This is so coders don't have to worry if the original object was an IEntity or a IDynamicEntity in the first place.

Declaration

public dynamic AsDynamic(object dynamicEntity)

Parameters

Type	Name	Description
object	dynamicEntity	the original object

Returns

Type	Description
dynamic	a dynamic object for easier coding

AsDynamic(params object[])

Convert one or many Entities and Dynamic entities into an IDynamicStack

Declaration

public dynamic AsDynamic(params object[] entities)

Parameters

Type	Name	Description
object[]	entities	one or more source object

Returns

Type	Description
dynamic	a dynamic object for easier coding

Remarks

New in 12.05

AsDynamic(string, string)

Take a json and provide it as a dynamic object to the code

Declaration

public dynamic AsDynamic(string json, string fallback = null)

Parameters

Type	Name	Description
string	json	the original json string
string	fallback	Alternate string to use, if the original json can't parse. Can also be null or the word "error" if you would prefer an error to be thrown.

Returns

Type	Description
dynamic	A dynamic object representing the original json. If it can't be parsed, it will parse the fallback, which by default is an empty empty dynamic object. If you provide null for the fallback, then you will get null back.

Remarks

Added in 2sxc 10.22.00

AsDynamic(IEntity)

Wraps an entity into a IDynamicEntity

Declaration

public dynamic AsDynamic(IEntity entity)

Parameters

Type	Name	Description
IEntity	entity	the original object

Returns

Type	Description
dynamic	a dynamic object for easier coding

AsEntity(object)

Unwraps a dynamic entity back into the underlying IEntity

Declaration

public IEntity AsEntity(object dynamicEntity)

Parameters

Type	Name	Description
object	dynamicEntity	the wrapped IEntity

Returns

Type	Description
IEntity	A normal IEntity

AsList(object)

Converts a list of IEntity objects into a list of IDynamicEntity objects.

Declaration

public IEnumerable<dynamic> AsList(object list)

Parameters

Type	Name	Description
object	list	typically a List/IEnumerable of Entities or DynamicEntities. Can also be a IDataSource in which case it uses the default stream.

Returns

Type	Description
IEnumerable<dynamic>	a list of IDynamicEntity objects

Remarks

Added in 2sxc 10.21.00

AsTyped(object, string, bool?)

Convert something to a ITypedItem. This works for all kinds of IEntitys, IDynamicEntitys as well as Lists/IEnumerables of those.

Will always return a single item. If a list is provided, it will return the first item in the list. If null was provided, it will return null.

Declaration

public ITypedItem AsTyped(object original, string noParamOrder = "Params must be named (https://go.2sxc.org/named-params)", bool? required = null)

Parameters

Type	Name	Description
object	original
string	noParamOrder	see Convention: Named Parameters
bool?	required

Returns

Type	Description
ITypedItem

Remarks

New in v16.01

AsTypedList(object, string, bool?, IEnumerable<ITypedItem>)

Declaration

public IEnumerable<ITypedItem> AsTypedList(object list, string noParamOrder = "Params must be named (https://go.2sxc.org/named-params)", bool? required = null, IEnumerable<ITypedItem> fallback = null)

Parameters

Type	Name	Description
object	list
string	noParamOrder	see Convention: Named Parameters
bool?	required
IEnumerable<ITypedItem>	fallback

Returns

Type	Description
IEnumerable<ITypedItem>

Remarks

New in v16.01

CreateInstance(string, string, string, string, bool)

Declaration

public dynamic CreateInstance(string virtualPath, string noParamOrder = "Params must be named (https://go.2sxc.org/named-params)", string name = null, string relativePath = null, bool throwOnError = true)

Parameters

Type	Name	Description
string	virtualPath
string	noParamOrder
string	name
string	relativePath
bool	throwOnError

Returns

Type	Description
dynamic

CreateSource<T>(IDataSource, ILookUpEngine)

Create a IDataSource which will process data from the given stream.

Declaration

public T CreateSource<T>(IDataSource inSource = null, ILookUpEngine configurationProvider = null) where T : IDataSource

Parameters

Type	Name	Description
IDataSource	inSource	The data source which will be the default In of the new data-source.
ILookUpEngine	configurationProvider	An alternate configuration provider for the DataSource

Returns

Type	Description
T	A typed DataSource object

Type Parameters

Name	Description
T	A data-source type - must be inherited from IDataSource

CreateSource<T>(IDataStream)

Create a IDataSource which will process data from the given stream.

Declaration

public T CreateSource<T>(IDataStream source) where T : IDataSource

Parameters

Type	Name	Description
IDataStream	source	The stream which will be the default In of the new data-source.

Returns

Type	Description
T	A typed DataSource object

Type Parameters

Name	Description
T	A data-source type - must be inherited from IDataSource

GetService<TService>()

Get a service from the EAV / 2sxc Dependency Injection.

Declaration

public TService GetService<TService>()

Returns

Type	Description
TService	An object of the type or interface requested

Type Parameters

Name	Description
TService	Interface (preferred) or Class which is needed

Remarks

Added in 2sxc 11.11

Implements

IHasCodeLog

IDynamicCode

ICreateInstance

IHasLog