Interface IMacro
Defines a Macro
Namespace:System.Dynamic.ExpandoObject
Assembly:Umbraco.Core.dll
Syntax
public interface IMacro : IAggregateRoot, IDeletableEntity, IEntity, IDeepCloneable, IRememberBeingDirty, ICanBeDirty
Properties
Alias
Gets or sets the alias of the Macro
Declaration
[DataMember]
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]
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]
bool CacheByPage { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
CacheDuration
Gets or sets the Cache Duration for the Macro
Declaration
[DataMember]
int CacheDuration { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 |
ControlAssembly
Gets or sets the name of the assembly, which should be used by the Macro
Declaration
[DataMember]
string ControlAssembly { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Will usually only be filled if the ScriptFile is a Usercontrol
ControlType
Gets or sets the path to user control or the Control Type to render
Declaration
[DataMember]
string ControlType { get; set; }
Property Value
Type | Description |
---|---|
System.String |
DontRender
Gets or sets a boolean indicating whether the Macro should be rendered in an Editor
Declaration
[DataMember]
bool DontRender { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
Name
Gets or sets the name of the Macro
Declaration
[DataMember]
string Name { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Properties
Gets or sets a list of Macro Properties
Declaration
[DataMember]
MacroPropertyCollection Properties { get; }
Property Value
Type | Description |
---|---|
MacroPropertyCollection |
ScriptPath
Gets or set the path to the Python file in use
Declaration
[DataMember]
string ScriptPath { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Optional: Can only be one of three Script, Python or Xslt
UseInEditor
Gets or sets a boolean indicating whether the Macro can be used in an Editor
Declaration
[DataMember]
bool UseInEditor { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
XsltPath
Gets or sets the path to the Xslt file in use
Declaration
[DataMember]
string XsltPath { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Optional: Can only be one of three Script, Python or Xslt