View Source

Class Macro

Represents a Macro

Inheritance

System.Object

BeingDirtyBase

EntityBase

Namespace: Umbraco.Cms.Core.Models

Assembly: Umbraco.Core.dll

Syntax

[DataContract(IsReference = true)]
public class Macro : EntityBase, IMacro, IEntity, IDeepCloneable, IRememberBeingDirty, ICanBeDirty

Constructors

Macro(IShortStringHelper)

Declaration

public Macro(IShortStringHelper shortStringHelper)

Parameters

Type	Name	Description
IShortStringHelper	shortStringHelper

Macro(IShortStringHelper, Int32, Guid, Boolean, Int32, String, String, Boolean, Boolean, Boolean, String)

Creates an item with pre-filled properties

Declaration

public Macro(IShortStringHelper shortStringHelper, int id, Guid key, bool useInEditor, int cacheDuration, string alias, string name, bool cacheByPage, bool cacheByMember, bool dontRender, string macroSource)

Parameters

Type	Name	Description
IShortStringHelper	shortStringHelper
System.Int32	id
Guid	key
System.Boolean	useInEditor
System.Int32	cacheDuration
System.String	alias
System.String	name
System.Boolean	cacheByPage
System.Boolean	cacheByMember
System.Boolean	dontRender
System.String	macroSource

Macro(IShortStringHelper, String, String, String, Boolean, Boolean, Boolean, Boolean, Int32)

Creates an instance for persisting a new item

Declaration

public Macro(IShortStringHelper shortStringHelper, string alias, string name, string macroSource, bool cacheByPage = false, bool cacheByMember = false, bool dontRender = true, bool useInEditor = false, int cacheDuration = 0)

Parameters

Type	Name	Description
IShortStringHelper	shortStringHelper
System.String	alias
System.String	name
System.String	macroSource
System.Boolean	cacheByPage
System.Boolean	cacheByMember
System.Boolean	dontRender
System.Boolean	useInEditor
System.Int32	cacheDuration

Properties

Alias

Gets or sets the alias of the Macro

Declaration

[DataMember]
public string Alias { get; set; }

Property Value

Type	Description
System.String

CacheByMember

Gets or sets a boolean indicating whether the Macro should be Cached Personally

Declaration

[DataMember]
public bool CacheByMember { get; set; }

Property Value

Type	Description
System.Boolean

CacheByPage

Gets or sets a boolean indicating whether the Macro should be Cached by Page

Declaration

[DataMember]
public bool CacheByPage { get; set; }

Property Value

Type	Description
System.Boolean

CacheDuration

Gets or sets the Cache Duration for the Macro

Declaration

[DataMember]
public int CacheDuration { get; set; }

Property Value

Type	Description
System.Int32

DontRender

Gets or sets a boolean indicating whether the Macro should be rendered in an Editor

Declaration

[DataMember]
public bool DontRender { get; set; }

Property Value

Type	Description
System.Boolean

MacroSource

Gets or set the path to the Partial View to render

Declaration

[DataMember]
public string MacroSource { get; set; }

Property Value

Type	Description
System.String

Name

Gets or sets the name of the Macro

Declaration

[DataMember]
public string Name { get; set; }

Property Value

Type	Description
System.String

Properties

Gets or sets a list of Macro Properties

Declaration

[DataMember]
public MacroPropertyCollection Properties { get; }

Property Value

Type	Description
MacroPropertyCollection

UseInEditor

Gets or sets a boolean indicating whether the Macro can be used in an Editor

Declaration

[DataMember]
public bool UseInEditor { get; set; }

Property Value

Type	Description
System.Boolean

Methods

PerformDeepClone(Object)

Declaration

protected override void PerformDeepClone(object clone)

Parameters

Type	Name	Description
System.Object	clone

ResetDirtyProperties(Boolean)

Declaration

public override void ResetDirtyProperties(bool rememberDirty)

Parameters

Type	Name	Description
System.Boolean	rememberDirty