View Source

Class ContentApp

Represents a content app.

Inheritance

System.Object

Namespace: Umbraco.Cms.Core.Models.ContentEditing

Assembly: Umbraco.Core.dll

Syntax

[DataContract(Name = "app", Namespace = "")]
public class ContentApp

Remarks

Content apps are editor extensions.

Properties

Active

Gets a value indicating whether the app is active.

Declaration

[DataMember(Name = "active")]
public bool Active { get; set; }

Property Value

Type	Description
System.Boolean

Remarks

Normally reserved for Angular to deal with but in some cases this can be set on the server side.

Alias

Gets the unique alias of the content app.

Declaration

[DataMember(Name = "alias")]
public string Alias { get; set; }

Property Value

Type	Description
System.String

Remarks

Must be a valid javascript identifier, ie no spaces etc.

Badge

Gets or sets the content app badge.

Declaration

[DataMember(Name = "badge")]
public ContentAppBadge Badge { get; set; }

Property Value

Type	Description
ContentAppBadge

Icon

Gets the icon of the content app.

Declaration

[DataMember(Name = "icon")]
public string Icon { get; set; }

Property Value

Type	Description
System.String

Remarks

Must be a valid helveticons class name (see http://hlvticons.ch/).

Name

Gets the name of the content app.

Declaration

[DataMember(Name = "name")]
public string Name { get; set; }

Property Value

Type	Description
System.String

View

Gets the view for rendering the content app.

Declaration

[DataMember(Name = "view")]
public string View { get; set; }

Property Value

Type	Description
System.String

ViewModel

The view model specific to this app

Declaration

[DataMember(Name = "viewModel")]
public object ViewModel { get; set; }

Property Value

Type	Description
System.Object

Weight

Gets or sets the weight of the content app.

Declaration

[DataMember(Name = "weight")]
public int Weight { get; set; }

Property Value

Type	Description
System.Int32

Remarks

Content apps are ordered by weight, from left (lowest values) to right (highest values).

Some built-in apps have special weights: listview is -666, content is -100 and infos is +100.

The default weight is 0, meaning somewhere in-between content and infos, but weight could be used for ordering between user-level apps, or anything really.