Interface ITypedItem

A typed object to access data. Previously Razor code always used dynamic IDynamicEntity objects. This had some disadvantages when working with LINQ or advanced toolbars.

Inherited Members
Namespace: ToSic.Sxc.Data
Assembly: ToSic.Sxc.dll
Syntax
[PublicApi]
public interface ITypedItem : ITyped, ICanBeItem
Remarks

Introduced in 2sxc 16.01

Properties

| Improve this Doc View Source

Dyn

A dynamic accessor for properties, to quickly get values when you don't care about type safety. This is often (but not always) a IDynamicEntity.

Example: Dyn.FirstName might just work - and return the first name or null if not found.

Declaration
dynamic Dyn { get; }
Property Value
Type Description
dynamic
| Improve this Doc View Source

Guid

The guid of the underlying entity.

Declaration
Guid Guid { get; }
Property Value
Type Description
Guid
Remarks

If the entity doesn't exist, it will return an empty guid

| Improve this Doc View Source

Id

The ID of the underlying entity. Use it for edit-functionality or just to have a unique number for this item.

Declaration
int Id { get; }
Property Value
Type Description
int
Remarks

If the entity doesn't exist, it will return 0

| Improve this Doc View Source

IsDemoItem

Many templates show demo data. If the template code must know if it's the demo item or real data, use .IsDemoItem.

Declaration
bool IsDemoItem { get; }
Property Value
Type Description
bool

True if this is the item configured in the view-settings, false if not.
| Improve this Doc View Source

Metadata

Metadata of the current item, with special features.

Declaration
IMetadata Metadata { get; }
Property Value
Type Description
IMetadata
Remarks

Added in 16.02

| Improve this Doc View Source

Presentation

The presentation item or null if it doesn't exist.

Declaration
ITypedItem Presentation { get; }
Property Value
Type Description
ITypedItem
| Improve this Doc View Source

Title

The title of this item. This is always available no matter what the underlying field for the title is.

Declaration
string Title { get; }
Property Value
Type Description
string

The title of the underlying entity. In rare cases where no title-field is known, it can be null. It can also be null if there is no underlying entity.
Remarks

This returns a string which is usually what's expected. In previous versions (before v15) 2sxc it returned an object.

| Improve this Doc View Source

Type

The Content-Type of the current entity.

Declaration
IContentType Type { get; }
Property Value
Type Description
IContentType

Methods

| Improve this Doc View Source

Child(string, string, bool?)

A single item from a field. If the field doesn't exist or is empty, will return null.

Declaration
ITypedItem Child(string name, string noParamOrder = "Params must be named (https://go.2sxc.org/named-params)", bool? required = null)
Parameters
Type Name Description
string name

Name of the field
string noParamOrder

see Convention: Named Parameters
bool? required

throw error if name doesn't exist, see Convention: Property Required Name Checks
Returns
Type Description
ITypedItem
| Improve this Doc View Source

Children(string, string, string, bool?)

A typed list of sub-items. Important for LINQ style querying or just working with various lists. Note that for getting child items of this item you can just use the properties, like content.Authors.
But using Children("Authors", typeName) gives you the ability to restrict to a type.
Please check the tutorials on 2sxc.org/dnn-tutorials/ for more info.

Declaration
IEnumerable<ITypedItem> Children(string field = null, string noParamOrder = "Params must be named (https://go.2sxc.org/named-params)", string type = null, bool? required = null)
Parameters
Type Name Description
string field

Optional field filter - would only return items that point to the current item in a specific field name.
string noParamOrder

see Convention: Named Parameters
string type

Optional type filter - would only return items of this type.
bool? required

throw error if name doesn't exist, see Convention: Property Required Name Checks
Returns
Type Description
IEnumerable<ITypedItem>

A list of all items pointing here (filtered), converted to DynamicEntity for convenience.
Remarks

Note that the parameter-order is reversed to the Parents()

| Improve this Doc View Source

Field(string, string, bool?)

Get a special info-object describing a specific field in this item. This is a rich object used by other operations which need a lot of context about the item and the field.

Declaration
IField Field(string name, string noParamOrder = "Params must be named (https://go.2sxc.org/named-params)", bool? required = null)
Parameters
Type Name Description
string name

Name of the property
string noParamOrder

see Convention: Named Parameters
bool? required

throw error if name doesn't exist, see Convention: Property Required Name Checks
Returns
Type Description
IField
| Improve this Doc View Source

File(string, string, bool?)

Get the file of the current field. There are a few scenarios:

  1. If it's a file/hyperlink field pointing to a file such as file:27 it will retrieve the file itself.
  2. If it's a file/hyperlink field pointing to a url such as http://xyz it will return null.
  3. If it's a library field, it will just take the first file, as there is no value referencing a specific field
  4. If it's any other field, will return null
Declaration
IFile File(string name, string noParamOrder = "Params must be named (https://go.2sxc.org/named-params)", bool? required = null)
Parameters
Type Name Description
string name

property name
string noParamOrder

see Convention: Named Parameters
bool? required

throw error if name doesn't exist, see Convention: Property Required Name Checks
Returns
Type Description
IFile
Remarks

Added in 16.02

| Improve this Doc View Source

Folder(string, string, bool?)

Get the ADAM (Automatic Digital Asset Manager) for this field. This is a folder which contains all the files and possibly folders which are uploaded on exactly this field.

Declaration
IFolder Folder(string name, string noParamOrder = "Params must be named (https://go.2sxc.org/named-params)", bool? required = null)
Parameters
Type Name Description
string name

property name
string noParamOrder

see Convention: Named Parameters
bool? required

throw error if name doesn't exist, see Convention: Property Required Name Checks
Returns
Type Description
IFolder

The Folder object
Remarks

Added in 16.02

| Improve this Doc View Source

Html(string, string, object, bool?, object, bool?, bool)

Show a field in the expected / best possible way. As of now it's meant for WYSIWYG fields with Very-Rich Text. See DynamicEntity / TypedItem .Html(...) Method new v16.01

Declaration
IHtmlTag Html(string name, string noParamOrder = "Params must be named (https://go.2sxc.org/named-params)", object container = null, bool? toolbar = null, object imageSettings = null, bool? required = null, bool debug = false)
Parameters
Type Name Description
string name

the field name
string noParamOrder

see Convention: Named Parameters
object container

A wrapper tag for the result. It's either a RazorBlade tag such as Kit.HtmlTag.Div(), a string such as span or an empty string `` to indicate no container. If not set it will default to to a div-tag. See docs
bool? toolbar

Override default toolbar behavior on this field. See docs
object imageSettings

Settings for resizing. Default is Wysiwyg but it can also be Content or a settings object.
bool? required

throw error if name doesn't exist, see Convention: Property Required Name Checks
bool debug

Activate debug visualization to better see alignments and such.
Returns
Type Description
IHtmlTag
Remarks
  • Added in 2sxc 16.01
  • Only works on Razor files inheriting from Hybrid14 or newer
| Improve this Doc View Source

Parents(string, string, string)

A typed list of entities which point to this item. Important for LINQ style querying or just working with various lists. Note that for getting child items of this item you can just use the properties, like content.Authors.
Please check the tutorials on 2sxc.org/dnn-tutorials/ for more info.

Declaration
IEnumerable<ITypedItem> Parents(string noParamOrder = "Params must be named (https://go.2sxc.org/named-params)", string type = null, string field = null)
Parameters
Type Name Description
string noParamOrder

see Convention: Named Parameters
string type

Optional type filter - would only return items of this type.
string field

Optional field filter - would only return items that point to the current item in a specific field name.
Returns
Type Description
IEnumerable<ITypedItem>

A list of all items pointing here (filtered), converted to DynamicEntity for convenience.
Remarks

Note that the parameter-order is reversed to the Children()

| Improve this Doc View Source

Picture(string, string, object, object, object, string, string, string, object, object)

Get a Responsive Picture object which you can then either just show, or use to construct a more customized output as you need it.

The resulting object can just be added to the html, like @pic or you can work with sub-properties as specified in the IResponsivePicture.

Important: This call only allows you to set the most common parameters factor and width. For other parameters like height, aspectRatio, quality etc. create typed Settings Settings(object, string, object, object, object, object, string, string, string, object, string, object) and pass them in.

Note

This is the similar as using the Picture(object, object, string, object, object, string, string, string, object, object) just a bit simpler.

An important difference is that it returns null if the field does not exist or is empty, allowing you to just show nothing or use ...Picture(...) ?? someFallback;

Declaration
IResponsivePicture Picture(string name, string noParamOrder = "Params must be named (https://go.2sxc.org/named-params)", object settings = null, object factor = null, object width = null, string imgAlt = null, string imgAltFallback = null, string imgClass = null, object toolbar = null, object recipe = null)
Parameters
Type Name Description
string name

Name of a field
string noParamOrder

see Convention: Named Parameters
object settings
  • The name of a settings configuration, like "Content", "Screen", "Square", etc.
  • A standardized Image-Settings object like Settings.Child("Images.Content") - see https://go.2sxc.org/settings
  • A dynamic object containing settings properties (this can also be a merged custom + standard settings)
  • A strictly typed IResizeSettings object containing all settings created using ResizeSettings
object factor

An optional multiplier, usually used to create urls which resize to a part of the default content-size. Eg. 0.5.
object width

An optional, fixed width of the image
string imgAlt

Optional alt attribute on the created img tag for SEO etc. If supplied, it takes precedence to the alt-description in the image metadata which the editor added themselves. If you want to provide a fallback value (in case the metadata has no alt), use imgAltFallback
string imgAltFallback

Optional alt attribute which is only used if the imgAlt or the alt-text in the metadata are empty.
string imgClass

Optional class attribute on the created img tag
object toolbar

Provide a custom toolbar or false to not show a toolbar
object recipe

Optional recipe = instructions how to create the various variants of this link. Can be any one of these:

  • string containing variants
  • Rule object

TODO: DOCS not quite ready
Returns
Type Description
IResponsivePicture
Remarks
  • Added to ITypedItem in v16.03
  • We have this Picture method but no Img method, as we don't recommended that in responsive HTML5