Click or drag to resize
MacroSettings Class
Settings for resolving macros
Inheritance Hierarchy
SystemObject
  CMS.MacroEngineMacroSettings

Namespace: CMS.MacroEngine
Assembly: CMS.MacroEngine (in CMS.MacroEngine.dll) Version: 8.2.23
Syntax
C#
public class MacroSettings

The MacroSettings type exposes the following members.

Constructors
  NameDescription
Public methodMacroSettings
Constructor
Top
Methods
  NameDescription
Public methodAddCacheDependencies
Adds the cache dependencies to the macro context
Public methodAddFileCacheDependencies
Adds the cache dependencies to the macro context
Public methodClone
Returns the clone of the current context
Top
Extension Methods
  NameDescription
Public Extension MethodAsValue
Converts object to a query value which can be used as a query parameter
(Defined by QueryExtensions.)
Public Extension MethodGetAPIString
Gets the string by the specified resource key
(Defined by CoreExtensions.)
Public Extension MethodGetString
Gets the string by the specified resource key
(Defined by CoreExtensions.)
Public Extension MethodToBoolean
Returns the boolean representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToDateTime
Returns the DateTime representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToDouble
Returns the double representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToGuid
Returns the Guid representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToInteger
Returns the integer representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToString
Returns the string representation of an object or default value if not.
(Defined by CoreExtensions.)
Top
Properties
  NameDescription
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 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.
Top
See Also