MacroSettings Class

MacroSettings class specifies basic features of a MacroResolver.

Inheritance Hierarchy

System.Object
  CMS.MacroEngine.MacroSettings

Namespace: CMS.MacroEngine
Assembly: CMS.MacroEngine (in CMS.MacroEngine.dll) Version: 12.0.0

Syntax

public sealed class MacroSettings

The MacroSettings type exposes the following members.

Constructors

	Name	Description
Public method	MacroSettings	Initializes a new, empty instance of MacroSettings class.

Properties

	Name	Description
Public property	AllowContextMacros	If true, the properties from contexts are not resolved unless explicitly registered.
Public property	AllowRecursion	If true, the recursion is allowed within the macro resolving. Default value is false.
Public property	AvoidInjection	If true, the resolving of the macros should avoid SQL injection (escapes the apostrophes in output). Default value is false
Public property	CacheDependencies	Outputs the cache dependencies collected during the processing.
Public property	CheckIntegrity	If true, the integrity of security parameters is checked within macro evaluation.
Public property	CheckSecurity	If true, the security is checked within macro evaluation.
Public property	Culture	Culture used for the resolving.
Public property	DisableContextMacros	If true, all the context macros are disabled (only base MacroResolver sources are checked).
Public property	DisableContextObjectMacros	If true, context objects (such as ForumContext, CommunityContext, CMSContext, ...) will not be resolved.
Public property	DisablePageContextMacros	If true, page context macros are not available (CurrentDocument, CurrentPageInfo).
Public property	EncapsulateMacroObjects	If true, the object will be encapsulated to its macro representations.
Public property	EncodeResolvedValues	If true, the resolved macro values are encoded to avoid XSS. Default value is false
Public property	EvaluationTimeout	Expression evaluation timeout in milliseconds. If the evaluation time exceeds this time, evaluation will be aborted and the result will be null.
Public property	ExternalTimeoutChecker	Gets or sets the function used as timeout watchdog besides EvaluationTimeout setting. Returns true if timeout has occurred.
Public property	FileCacheDependencies	Outputs the file cache dependencies collected during the processing.
Public property	IdentityOption	Gets or sets the identity option to be used to verify security when CheckIntegrity is false.
Public property	KeepUnresolvedMacros	If true, unresolved macros are kept in their original form.
Public property	MaxRecursionlevel	Gets or sets the maximal recursion level.
Public property	RelatedObject	Related object allows set object used for resolving in macro method. Used in web part properties.
Public property	TrackCacheDependencies	If true, the resolving tracks cache dependencies. Default value is false.
Public property	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.

Methods

	Name	Description
Public method	AddCacheDependencies	Adds the cache dependencies to the macro context.
Public method	AddFileCacheDependencies	Adds the cache dependencies to the macro context.
Public method	Clone	Creates a shallow copy of the MacroSettings.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.