Table of Contents

Class MacroSettings

Namespace
CMS.MacroEngine
Assembly
CMS.MacroEngine.dll

MacroSettings class specifies basic features of a MacroResolver.

public sealed class MacroSettings
Inheritance
object
MacroSettings
Extension Methods

Constructors

MacroSettings()

Initializes a new, empty instance of MacroSettings class.

public MacroSettings()

Properties

AllowContextMacros

If true, the properties from contexts are not resolved unless explicitly registered.

public bool AllowContextMacros { get; set; }

Property Value

bool

AllowRecursion

If true, the recursion is allowed within the macro resolving. Default value is false.

public bool AllowRecursion { get; set; }

Property Value

bool

AvoidInjection

If true, the resolving of the macros should avoid SQL injection (escapes the apostrophes in output). Default value is false

public bool AvoidInjection { get; set; }

Property Value

bool

CacheDependencies

Outputs the cache dependencies collected during the processing.

public List<string> CacheDependencies { get; }

Property Value

List<string>

CheckIntegrity

If true, the integrity of security parameters is checked within macro evaluation.

public bool CheckIntegrity { get; set; }

Property Value

bool

CheckSecurity

If true, the security is checked within macro evaluation.

public bool CheckSecurity { get; set; }

Property Value

bool

Culture

Culture used for the resolving.

public string Culture { get; set; }

Property Value

string

DisableContextMacros

If true, all the context macros are disabled (only base MacroResolver sources are checked).

public bool DisableContextMacros { get; set; }

Property Value

bool

DisableContextObjectMacros

If true, context objects (such as CMSContext, ...) will not be resolved.

public bool DisableContextObjectMacros { get; set; }

Property Value

bool

DisablePageContextMacros

If true, page context macros are not available (CurrentDocument, CurrentPageInfo).

public bool DisablePageContextMacros { get; set; }

Property Value

bool

EncapsulateMacroObjects

If true, the object will be encapsulated to its macro representations.

public bool EncapsulateMacroObjects { get; set; }

Property Value

bool

EncodeResolvedValues

If true, the resolved macro values are encoded to avoid XSS. Default value is false

public bool EncodeResolvedValues { get; set; }

Property Value

bool

EvaluationTimeout

Expression evaluation timeout in milliseconds. If the evaluation time exceeds this time, evaluation will be aborted and the result will be null.

public int EvaluationTimeout { get; set; }

Property Value

int

ExternalTimeoutChecker

Gets or sets the function used as timeout watchdog besides EvaluationTimeout setting. Returns true if timeout has occurred.

public Func<bool> ExternalTimeoutChecker { get; set; }

Property Value

Func<bool>

FileCacheDependencies

Outputs the file cache dependencies collected during the processing.

public List<string> FileCacheDependencies { get; }

Property Value

List<string>

IdentityOption

Gets or sets the identity option to be used to verify security when CheckIntegrity is false.

public MacroIdentityOption IdentityOption { get; set; }

Property Value

MacroIdentityOption

KeepUnresolvedMacros

If true, unresolved macros are kept in their original form.

public bool KeepUnresolvedMacros { get; set; }

Property Value

bool

MaxRecursionlevel

Gets or sets the maximal recursion level.

public int MaxRecursionlevel { get; set; }

Property Value

int

RelatedObject

Related object allows set object used for resolving in macro method. Used in web part properties.

public object RelatedObject { get; set; }

Property Value

object

TrackCacheDependencies

If true, the resolving tracks cache dependencies. Default value is false.

public bool TrackCacheDependencies { get; set; }

Property Value

bool

VirtualMode

If true, the virtual mode is enabled for the macro resolver, meaning that the resolver always tries to return non-null values. Instead, empty objects are provided.

public bool VirtualMode { get; set; }

Property Value

bool

Methods

AddCacheDependencies(IEnumerable<string>)

Adds the cache dependencies to the macro context.

public void AddCacheDependencies(IEnumerable<string> items)

Parameters

items IEnumerable<string>

Items to add

AddFileCacheDependencies(IEnumerable<string>)

Adds the cache dependencies to the macro context.

public void AddFileCacheDependencies(IEnumerable<string> files)

Parameters

files IEnumerable<string>

Files to add

Clone()

Creates a shallow copy of the MacroSettings.

public MacroSettings Clone()

Returns

MacroSettings