MacroResolver Class

Class to resolve the macros, provides data to the resolving process.

Inheritance Hierarchy

System.Object
  CMS.MacroEngine.MacroResolver

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

Syntax

public class MacroResolver : IMacroResolver, 
	INotCopyThreadItem

The MacroResolver type exposes the following members.

Constructors

	Name	Description
Public method	MacroResolver	Obsolete. Constructor

Fields

	Name	Description
Public field Static member	UNRESOLVED_RETURN_VALUE	Represents unresolved keyword.

Properties

	Name	Description
Public property	Culture	Culture for the resolving
Public property Code example	ResolverName	Resolver name used for context specific resolving.
Public property	Settings	Macro resolver settings.
Public property	ShowOnlyPrioritized	If true, only prioritized properties are shown in Macro components (IntelliSense, MacroSelector, ...). Influences only visual part of the components, resolver will still be able to resolve all the others as well.
Public property	SourceObject	Object with source data - To pass parameters to Custom macro function.

Methods

	Name	Description
Public method	AddAnonymousSourceData	Adds new anonymous data source of general type to the resolver.
Public method	AddSourceAlias	Adds alternative source expression.
Public method	CheckDataSources	Checks all the data sources for the value. Returns true if given data member was found within supported data sources.
Public method	CheckObjectPermissions	Checks whether given identity option has Read permissions for given object type.
Public method	CreateChild	Creates new instance of MacroResolver as a child resolver that loads the data from the parent resolver by default.
Public method Static member	EncapsulateObject	Encapsulates object if needed (DataSet, DataRow, DataTable to their Container equivalent).
Protected method	FinalizeResult	Finalizes the result (makes the result string).
Public method	GetAnonymousSources	Returns list of all aggregated anonymous sources (from the whole resolver hierarchy).
Public method	GetHiddenRegisteredDataNames	Returns set of registered hidden named data sources (including all hidden named data sources registered in the parent(s) of the resolver, it's an union of keys through the whole hierarchy). Includes only hidden sources (which are tracked only in DevelopmentMode)
Public method Static member	GetInstance	Creates new instance of MacroResolver.
Public method	GetNamedSourceData	Gets the named source data by the given selector.
Public method	GetObjectValue(Object, Int32, EvaluationContext)	Gets the object value at given index (this is called when indexer [(int)] is used in the expression).
Public method	GetObjectValue(Object, String, EvaluationContext)	Gets the object value of specified name.
Public method	GetPrioritizedDataNames	Returns set of prioritized named data sources (including all prioritized named data sources registered in the parent(s) of the resolver, it's an union of keys through the whole hierarchy). DOES NOT include non-prioritized keys (call GetRegisteredDataNames to get those).
Public method	GetRegisteredDataNames	Returns set of registered named data sources (including all named data sources registered in the parent(s) of the resolver, it's an union of keys through the whole hierarchy). DOES NOT include prioritized keys (call GetPrioritizedDataNames to get those).
Public method	GetSourceAlias	Gets the named source data by the given selector.
Public method	IsDataItemAvailable	Checks all the data sources for the value and returns true if the data item is registered.
Public method	NamedSourceDataExists	Returns true if given source data is known (can be null, but the property has to be registered).
Protected method	PostProcessResult	If the object is InfoObject, returns its DisplayName column (if exists).
Public method	PrioritizeProperty	Prioritizes a property (equivalent to using SetNamedSourceData with last parameter true).
Public method	RegisterNamespace	Registers a namespace within this macro resolver
Public method Static member	RegisterObjectValueByIndexHandler	Registers GetObjectValueByName handler(s) to extend possibilities of MacroEngine to dig values from particular object types. These handlers are internally used when a property is requested out of a given object. First the default object types are checked, then all the handlers (the order of the handler evaluation is not guaranteed).
Public method Static member	RegisterObjectValueByNameHandler	Registers GetObjectValueByName handler(s) to extend possibilities of MacroEngine to dig values from particular object types. These handlers are internally used when a property is requested out of a given object. First the default object types are checked, then all the handlers (the order of the handler evaluation is not guaranteed).
Public method Static member	Resolve	Resolves the context macros.
Public method Static member	ResolveCurrentPath	Resolves the given alias path, applies the path segment to the given format string {0} for level 0.
Public method	ResolveCustomMacro	Resolves the custom macro.
Public method	ResolveMacroExpression(ResolveExpressionSettings)	Resolves the data macro expression (expects expression without {% %} brackets).
Public method	ResolveMacroExpression(String, Boolean, Boolean, String)	Resolves the data macro expression (expects expression without {% %} brackets). Use RemoveDataMacroBrackets(String) method to remove brackets if needed.
Public method	ResolveMacros(String, EvaluationContext)	Resolves the macros.
Public method	ResolveMacros(String, MacroSettings)	Resolves all supported macro types in the given text within specified resolving context.
Public method	ResolvePath	Resolves the path macro.
Public method	SetAnonymousSourceData	Sets (replaces all existing anonymous sources) specified data source (without name) of general type to the resolver.
Public method	SetHiddenNamedSourceData(String, Func<EvaluationContext, Object>)	Registers the named source data with late binding. Callback is called whenever the value is needed by MacroResolver.
Public method	SetHiddenNamedSourceData(String, Object)	Registers the named source data with late binding. Callback is called whenever the value is needed by MacroResolver.
Public method	SetNamedSourceData(Hashtable[])	Sets hashtable data source to the resolver. Keys of the table are considered names of the data.
Public method	SetNamedSourceData(IDictionary<String, Object>, Boolean)	Sets given name-value pairs to the resolver.
Public method	SetNamedSourceData(MacroField, Boolean)	Registers given field as the named source data.
Public method	SetNamedSourceData(String, Object, Boolean)	Registers the named source data. The data can be accessed with macro {%Selector.ColumnName%}. Selector has to be in identifier format.
Public method	SetNamedSourceDataCallback	Registers the named source data with late binding. Callback is called whenever the value is needed by MacroResolver.
Public method	SkippedResolver	Returns true if the macro processing skipped particular resolver name

Events

	Name	Description
Public event	OnGetValue	Gets value event.
Public event Static member	OnResolveCustomMacro	Custom macro event.

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.