View Source

Class MacroDisplay

The macro display model

Inheritance

System.Object

EntityBasic

Namespace: Umbraco.Cms.Core.Models.ContentEditing

Assembly: Umbraco.Core.dll

Syntax

public class MacroDisplay : EntityBasic, INotificationModel

Constructors

MacroDisplay()

Initializes a new instance of the MacroDisplay class.

Declaration

public MacroDisplay()

Properties

CacheByPage

Gets or sets a value indicating whether the macro should be cached by page

Declaration

public bool CacheByPage { get; set; }

Property Value

Type	Description
System.Boolean

CacheByUser

Gets or sets a value indicating whether the macro should be cached by user

Declaration

public bool CacheByUser { get; set; }

Property Value

Type	Description
System.Boolean

CachePeriod

Gets or sets the cache period.

Declaration

public int CachePeriod { get; set; }

Property Value

Type	Description
System.Int32

Notifications

This is used to add custom localized messages/strings to the response for the app to use for localized UI purposes.

Declaration

public List<BackOfficeNotification> Notifications { get; }

Property Value

Type	Description
List<BackOfficeNotification>

Parameters

Gets or sets the parameters.

Declaration

public IEnumerable<MacroParameterDisplay> Parameters { get; set; }

Property Value

Type	Description
IEnumerable<MacroParameterDisplay>

RenderInEditor

Gets or sets a value indicating whether the macro should be rendered a rich text editor.

Declaration

public bool RenderInEditor { get; set; }

Property Value

Type	Description
System.Boolean

UseInEditor

Gets or sets a value indicating whether the macro can be used in a rich text editor.

Declaration

public bool UseInEditor { get; set; }

Property Value

Type	Description
System.Boolean

View

Gets or sets the view.

Declaration

public string View { get; set; }

Property Value

Type	Description
System.String