MacroResolver Members

Kentico 8.1 API Reference

The MacroResolver type exposes the following members.

Constructors

	Name	Description
	MacroResolver	Obsolete. Constructor
	MacroResolver(Boolean)	Constructor for inheritance

Methods

	Name	Description
	AddAnonymousSourceData	Adds new anonymous data source of general type to the resolver.
	AddSourceAlias	Adds alternative source expression.
	Clone	Clones the resolver object.
	CreateChild	Creates the child resolver that loads the data from the parent resolver by default.
	EncapsulateObject	Encapsulates object if needed (DataSet, DataRow, DataTable to their Container equivalent).
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	FinalizeResult	Finalizes the result (makes the result string).
	GetAnonymousSources	Returns list of all aggregated anonymous sources (from the whole resolver hierarchy).
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	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)
	GetInstance	Returns new instance of MacroResolver (first calls the OnGetInstance handler, if no handler is attached, new instance is created via protected constructor).
	GetNamedSourceData	Gets the named source data by the given selector.
	GetObjectValue(Object, Int32, EvaluationContext)	Gets the object value at given index (this is called when indexer [(int)] is used in the expression).
	GetObjectValue(Object, String, EvaluationContext)	Gets the object value of specified name.
	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).
	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).
	GetSourceAlias	Gets the named source data by the given selector.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	CheckDataSources	Checks all the data sources for the value. Returns true if given data member was found within supported data sources.
	CheckObjectPermissions	Checks whether given user has Read permissions for given object type.
	IsDataItemAvailable	Checks all the data sources for the value and returns true if the data item is registered.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	NamedSourceDataExists	Returns true if given source data is known (can be null, but the property has to be registered).
	PostProcessResult	If the object is InfoObject, returns its DisplayName column (if exists).
	PrioritizeProperty	Prioritizes a property (equivalent to using SetNamedSourceData with last parameter true).
	RegisterNamespace	Registers a namespace within this macro resolver
	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).
	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).
	Resolve	Resolves the context macros.
	ResolveCurrentPath	Resolves the given alias path, applies the path segment to the given format string {0} for level 0.
	ResolveCustomMacro	Resolves the custom macro.
	ResolveMacroExpression(ResolveExpressionSettings)	Resolves the data macro expression (expects expression without {% %} brackets).
	ResolveMacroExpression(String, Boolean, Boolean, String)	Resolves the data macro expression (expects expression without {% %} brackets).
	ResolveMacros(String)	Resolves the macros.
	ResolveMacros(String, EvaluationContext)	Resolves the macros.
	ResolveMacros(String, MacroSettings)	Resolves all supported macro types in the given text within specified resolving context.
	ResolvePath	Resolves the path macro.
	SetAnonymousSourceData	Sets specified data source (without name) of general type to the resolver. Replaces all the existing anonymous sources.
	SetHiddenNamedSourceData(String, Func EvaluationContext, Object )	Registers the named source data with late binding. Callback is called whenever the value is needed by MacroResolver.
	SetHiddenNamedSourceData(String, Object)	Registers the named source data with late binding. Callback is called whenever the value is needed by MacroResolver.
	SetNamedObjectSourceData	Obsolete. Registers the named object source data. Nice name of the object is used as a selector. It's an abbreviation of calling SetNamedSourceData(infoObj.Generalized.GetNiceName(), infoObj).
	SetNamedSourceData( Hashtable )	Sets hashtable data source to the resolver. Keys of the table are considered names of the data.
	SetNamedSourceData( Object , Boolean)	Sets given name-value pairs to the resolver.
	SetNamedSourceData(MacroField, Boolean)	Registers given field as the named source data.
	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.
	SetNamedSourceDataCallback	Registers the named source data with late binding. Callback is called whenever the value is needed by MacroResolver.
	SetNamedSourceDataInternal	Registers the named source data. The data can be accessed with macro {%Selector.ColumnName%}. Selector has to be in identifier format.
	SkippedResolver	Returns true if the macro processing skipped particular resolver name
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Extension Methods

	Name	Description
	AsValue	Converts object to a query value which can be used as a query parameter (Defined by QueryExtensions.)
	GetAPIString	Gets the string by the specified resource key (Defined by CoreExtensions.)
	GetString	Gets the string by the specified resource key (Defined by CoreExtensions.)
	ToBoolean	Returns the boolean representation of an object or default value if not. (Defined by CoreExtensions.)
	ToDateTime	Returns the DateTime representation of an object or default value if not. (Defined by CoreExtensions.)
	ToDouble	Returns the double representation of an object or default value if not. (Defined by CoreExtensions.)
	ToGuid	Returns the Guid representation of an object or default value if not. (Defined by CoreExtensions.)
	ToInteger	Returns the integer representation of an object or default value if not. (Defined by CoreExtensions.)
	ToString	Returns the string representation of an object or default value if not. (Defined by CoreExtensions.)

Fields

	Name	Description
	mActiveMacros	Current stack of active macros (macros that are just being resolved).
	mCurrentRecursion	Recursion handling.
	mParentResolver	Parent resolver is used to look for the data if it's not explicitly defined in current resolver All the data available in the parent are available also in children (could be overriden, though)
	mResolverName	Macro resolver name.
	mSettings	Macro context.
	mSkippedResolvers	Returns the list of resolvers that were skipped during the processing of the macros with this resolver.
	UNRESOLVED_RETURN_VALUE	Represents unresolved keyword.

Properties

	Name	Description
	Culture	Culture for the resolving
	ResolverName	Name of the resolver.
	Settings	Macro context (settings)
	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.
	SourceObject	Object with source data - To pass parameters to Custom macro function.

Events

	Name	Description
	OnGetInstance	Event raised when new instance of MacroResolver is requested.
	OnGetValue	Gets value event.
	OnResolveCustomMacro	Custom macro event.