Interface IDynamicStack

This is a dynamic object which contains multiple dynamic objects (Sources). It will try to find a value inside each source in the order the Sources are managed.

Inherited Members

ICanDebug.Debug

Namespace: ToSic.Sxc.Data

Assembly: ToSic.Sxc.dll

Syntax

[PublicApi]
public interface IDynamicStack : ICanDebug

Remarks

New in 12.02

Properties

AnyBooleanProperty

A Dynamic Entity always contains an item of your data - a book, person, blog-post or a piece of content. Since the object is dynamic, you can just use .IsFemale or whatever other property your item has. If it's a true/false, it will just magically work and return a bool. If it doesn't exist, it will return null.

Declaration

bool AnyBooleanProperty { get; }

Property Value

Type	Description
bool

AnyChildrenProperty

A Dynamic Entity always contains an item of your data - a book, person, blog-post or a piece of content. Since the object is dynamic, you can just use .Tags or whatever other property your item has. If it's contains relationships, it will just magically work and return a list of further DynamicEntity objects. If it doesn't exist, it will return null.

Declaration

IEnumerable<IDynamicEntity> AnyChildrenProperty { get; }

Property Value

Type	Description
IEnumerable<IDynamicEntity>

Remarks

Very often you'll want to use LINQ to further sort or query these items. But the Razor compiler cannot know that it got a list, so using .Any() or similar fails. To fix this, put an AsList around it - a bit like AsList(myThing.Tags). Sometimes you'll also need to help a bit more with AsList(myThings.Tags as object). Now you can do things like var tags = AsList(myThings.Tags as object); if (myTags.Any()) {...} Read more about this in the Dnn LINQ Tutorials

AnyDateTimeProperty

A Dynamic Entity always contains an item of your data - a book, person, blog-post or a piece of content. Since the object is dynamic, you can just use .Birthday or whatever other property your item has. If it's a date/time, it will just magically work and return a DateTime. If it doesn't exist, it will return null.

Declaration

DateTime AnyDateTimeProperty { get; }

Property Value

Type	Description
DateTime

AnyLinkOrFileProperty

A Dynamic Entity always contains an item of your data - a book, person, blog-post or a piece of content. Since the object is dynamic, you can just use .Image or whatever other property your item has. If it's a link, it will just magically work and return a string. If it doesn't exist, it will return null.

Declaration

string AnyLinkOrFileProperty { get; }

Property Value

Type	Description
string

Remarks

Note that many internal references in the CMS use file:2742 or similar. This will automatically be resolved to the real link which your output needs.

AnyNumberProperty

A Dynamic Entity always contains an item of your data - a book, person, blog-post or a piece of content. Since the object is dynamic, you can just use .Length or whatever other property your item has. If it's a number, it will just magically work and return a double. If it doesn't exist, it will return null.

Declaration

decimal AnyNumberProperty { get; }

Property Value

Type	Description
decimal

AnyStringProperty

A Dynamic Entity always contains an item of your data - a book, person, blog-post or a piece of content. Since the object is dynamic, you can just use .FirstName or whatever other property your item has. If it's a string, it will just magically work. If it doesn't exist, it will return null.

Declaration

string AnyStringProperty { get; }

Property Value

Type	Description
string

Remarks

Remember to use @Html.Raw(...) if you want the html to be preserved and not cleaned when placed in the page.

Methods

Get(string)

Get a value of the entity. Usually you will prefer the quick access like @content.FirstName - which will give you the same things as content.Get("FirstName"). There are two cases to use this:

• when you dynamically assemble the field name in your code, like when using App.Resources or similar use cases.
• to access a field which has a conflicting name with this object, like Get("Parents")

Declaration

dynamic Get(string name)

Parameters

Type	Name	Description
string	name

Returns

Type	Description
dynamic	An object which can be either a string, number, boolean or List<IDynamicEntity>, depending on the field type. Will return null if the field was not found.

Get(string, string, string, bool, bool?)

Get a property using the string name. Only needed in special situations, as most cases can use the object.name directly

Declaration

dynamic Get(string name, string noParamOrder = "Params must be named (https://go.2sxc.org/named-params)", string language = null, bool convertLinks = true, bool? debug = null)

Parameters

Type	Name	Description
string	name	the property name like Image - or path like Author.Name (new v15)
string	noParamOrder	see Convention: Named Parameters
string	language	Optional language code - like "de-ch" to prioritize that language
bool	convertLinks	Optionally turn off if links like file:72 are looked up to a real link. Default is true.
bool?	debug	Set true to see more details in Insights how the value was retrieved.

Returns

Type	Description
dynamic	a dynamically typed result, can be string, bool, etc.

Get<TValue>(string)

Get a value using the name - and cast it to the expected strong type. For example to get an int even though it's stored as decimal.

Declaration

TValue Get<TValue>(string name)

Parameters

Type	Name	Description
string	name	the property name like Image - or path like Author.Name (new v15)

Returns

Type	Description
TValue	The typed value, or the default like null or 0 if casting isn't possible.

Type Parameters

Name	Description
TValue	The expected type, like string, int, etc.

Remarks

Added in v15

Get<TValue>(string, string, TValue)

Get a value using the name - and cast it to the expected strong type. For example to get an int even though it's stored as decimal.

Since the parameter fallback determines the type TValue you can just write this like `Content.Get("Title", fallback: "no title")

Declaration

TValue Get<TValue>(string name, string noParamOrder = "Params must be named (https://go.2sxc.org/named-params)", TValue fallback = default)

Parameters

Type	Name	Description
string	name	the property name like Image - or path like Author.Name (new v15)
string	noParamOrder	see Convention: Named Parameters
TValue	fallback	the fallback value to provide if not found

Returns

Type	Description
TValue	The typed value, or the default like null or 0 if casting isn't possible.

Type Parameters

Name	Description
TValue	The expected type, like string, int, etc. Note that you don't need to specify it, if you specify the fallback property.

Remarks

Added in v15