Click or drag to resize
MacroSettings Class
MacroSettings class specifies basic features of a MacroResolver.
Inheritance Hierarchy

Namespace: CMS.MacroEngine
Assembly: CMS.MacroEngine (in CMS.MacroEngine.dll) Version: 9.0.0
public sealed class MacroSettings

The MacroSettings type exposes the following members.

Public methodMacroSettings
Initializes a new, empty instance of MacroSettings class.
Public propertyAllowContextMacros
If true, the properties from contexts are not resolved unless explicitly registered.
Public propertyAllowRecursion
If true, the recursion is allowed within the macro resolving. Default value is true.
Public propertyAvoidInjection
If true, the resolving of the macros should avoid SQL injection (escapes the apostrophes in output). Default value is false
Public propertyCacheDependencies
Outputs the cache dependencies collected during the processing.
Public propertyCulture
Culture used for the resolving.
Public propertyDisableContextMacros
If true, all the context macros are disabled (only base MacroResolver sources are checked).
Public propertyDisableContextObjectMacros
If true, context objects (such as ForumContext, CommunityContext, CMSContext, ...) will not be resolved.
Public propertyDisablePageContextMacros
If true, page context macros are not available (CurrentDocument, CurrentPageInfo).
Public propertyEncapsulateMacroObjects
If true, the object will be encapsulated to its macro representations.
Public propertyEncodeResolvedValues
If true, the resolved macro values are encoded to avoid XSS. Default value is false
Public propertyEvaluationTimeout
Expression evaluation timeout in milliseconds. If the evaluation time exceeds this time, evaluation will be aborted and the result will be null.
Public propertyExternalTimeoutChecker
Gets or sets the function used as timeout watchdog besides EvaluationTimeout setting. Returns true if timeout has occurred.
Public propertyFileCacheDependencies
Outputs the file cache dependencies collected during the processing.
Public propertyCheckIntegrity
If true, the integrity of security parameters is checked within macro evaluation.
Public propertyCheckSecurity
If true, the security is checked within macro evaluation.
Public propertyKeepUnresolvedMacros
If true, unresolved macros are kept in their original form.
Public propertyMaxRecursionlevel
Gets or sets the maximal recursion level.
Public propertyRelatedObject
Related object allows set object used for resolving in macro method. Used in web part properties.
Public propertyTrackCacheDependencies
If true, the resolving tracks cache dependencies. Default value is false.
Public propertyUserName
Gets or sets the name of the user which will be used to verify security when CheckIntegrity is false.
Public propertyVirtualMode
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 methodAddCacheDependencies
Adds the cache dependencies to the macro context.
Public methodAddFileCacheDependencies
Adds the cache dependencies to the macro context.
Public methodClone
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.
See Also