Table of Contents

Class MacroProcessingSettings

Namespace
CMS.DataEngine
Assembly
CMS.DataEngine.dll

Determines how the system processes macros in the object's fields.

public class MacroProcessingSettings
Inheritance
object
MacroProcessingSettings
Extension Methods

Remarks

Use in the MacroSettings property of ObjectTypeInfo.

Constructors

MacroProcessingSettings(ObjectTypeInfo)

Constructor

public MacroProcessingSettings(ObjectTypeInfo objectTypeInfo)

Parameters

objectTypeInfo ObjectTypeInfo

Related type information

Properties

ColumnAdapters

Registers column adapters for fields, which value cannot be processed by macro engine right away and requires additional operations (decode, decrypt, etc.).

public IDictionary<string, IMacroProcessingColumnAdapter> ColumnAdapters { get; set; }

Property Value

IDictionary<string, IMacroProcessingColumnAdapter>

ContainsMacros

Indicates whether the object type has fields that can contain macro expressions in their values. Determines if objects are processed when resigning macros in the system. True by default. You can set the value to False to optimize the performance of the resigning process (during manual resigning and upgrades). Does not affect the resolving of macros.

public bool ContainsMacros { get; set; }

Property Value

bool

MacroCollectionName

Gets or sets name of object collection used for the object type's data in the macro engine. If not set, the ObjectClassName is used by default.

public string MacroCollectionName { get; set; }

Property Value

string

Remarks

Should be set when info object belongs to MainObjectTypes and has more than 1 ObjectTypeInfo.

If MacroCollectionName is set to 'cms.role' then macro intellisense supplies hint for user as 'Roles' because of GetNicePropertyName(string) method used internally by InfoObjectRepository<TCollection, TObject, TSettings>.

Value of this property is used in Kentico macro engine for acquiring objects of given type, e.g. SiteObjects.Roles or GlobalObjects.Roles.