ServiceResolver Class

Class to resolve the macros in the context of WCF service (REST for example). Handles querystring and cookies macros in a WCS service specific way.

Inheritance Hierarchy

System.Object
  CMS.MacroEngine.MacroResolver
    CMS.WebServices.ServiceResolver

Namespace: CMS.WebServices
Assembly: CMS.WebServices (in CMS.WebServices.dll) Version: 8.2.23

Syntax

public class ServiceResolver : MacroResolver

The ServiceResolver type exposes the following members.

Constructors

	Name	Description
Public method	ServiceResolver	Creates new instance of ServiceResolver.

Methods

	Name	Description
Public method	AddAnonymousSourceData	Adds new anonymous data source of general type to the resolver. (Inherited from MacroResolver.)
Public method	AddSourceAlias	Adds alternative source expression. (Inherited from MacroResolver.)
Public method	Clone	Clones the resolver object. (Inherited from MacroResolver.)
Public method	CreateChild	Creates the child resolver that loads the data from the parent resolver by default. (Inherited from MacroResolver.)
Protected method	FinalizeResult	Finalizes the result (makes the result string). (Inherited from MacroResolver.)
Public method	GetAnonymousSources	Returns list of all aggregated anonymous sources (from the whole resolver hierarchy). (Inherited from MacroResolver.)
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) (Inherited from MacroResolver.)
Public method	GetNamedSourceData	Gets the named source data by the given selector. (Inherited from MacroResolver.)
Public method	GetObjectValue(Object, Int32, EvaluationContext)	Gets the object value at given index (this is called when indexer [(int)] is used in the expression). (Inherited from MacroResolver.)
Public method	GetObjectValue(Object, String, EvaluationContext)	Gets the object value of specified name. (Inherited from MacroResolver.)
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). (Inherited from MacroResolver.)
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). (Inherited from MacroResolver.)
Public method	GetSourceAlias	Gets the named source data by the given selector. (Inherited from MacroResolver.)
Public method	CheckDataSources	Checks all the data sources for the value (at first, it checks if it's not special value). (Overrides MacroResolver.CheckDataSources(String, EvaluationContext).)
Public method	CheckObjectPermissions	Checks whether given user has Read permissions for given object type. (Inherited from MacroResolver.)
Public method	IsDataItemAvailable	Checks all the data sources for the value and returns true if the data item is registered. (Inherited from MacroResolver.)
Public method	NamedSourceDataExists	Returns true if given source data is known (can be null, but the property has to be registered). (Inherited from MacroResolver.)
Protected method	PostProcessResult	If the object is InfoObject, returns its DisplayName column (if exists). (Inherited from MacroResolver.)
Public method	PrioritizeProperty	Prioritizes a property (equivalent to using SetNamedSourceData with last parameter true). (Inherited from MacroResolver.)
Public method	RegisterNamespace	Registers a namespace within this macro resolver (Inherited from MacroResolver.)
Public method	ResolveCustomMacro	Resolves the custom macro. (Inherited from MacroResolver.)
Public method	ResolveMacroExpression(ResolveExpressionSettings)	Resolves the data macro expression (expects expression without {% %} brackets). (Inherited from MacroResolver.)
Public method	ResolveMacroExpression(String, Boolean, Boolean, String)	Resolves the data macro expression (expects expression without {% %} brackets). (Inherited from MacroResolver.)
Public method	ResolveMacros(String, EvaluationContext)	Resolves the macros. (Inherited from MacroResolver.)
Public method	ResolveMacros(String, MacroSettings)	Resolves all supported macro types in the given text within specified resolving context. (Inherited from MacroResolver.)
Public method	ResolvePath	Resolves the path macro. (Inherited from MacroResolver.)
Public method	SetAnonymousSourceData	Sets specified data source (without name) of general type to the resolver. Replaces all the existing anonymous sources. (Inherited from MacroResolver.)
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. (Inherited from MacroResolver.)
Public method	SetHiddenNamedSourceData(String, Object)	Registers the named source data with late binding. Callback is called whenever the value is needed by MacroResolver. (Inherited from MacroResolver.)
Public method	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). (Inherited from MacroResolver.)
Public method	SetNamedSourceData(Hashtable[])	Sets hashtable data source to the resolver. Keys of the table are considered names of the data. (Inherited from MacroResolver.)
Public method	SetNamedSourceData(Object[,], Boolean)	Sets given name-value pairs to the resolver. (Inherited from MacroResolver.)
Public method	SetNamedSourceData(MacroField, Boolean)	Registers given field as the named source data. (Inherited from MacroResolver.)
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. (Inherited from MacroResolver.)
Public method	SetNamedSourceDataCallback	Registers the named source data with late binding. Callback is called whenever the value is needed by MacroResolver. (Inherited from MacroResolver.)
Public method	SetNamedSourceDataInternal	Registers the named source data. The data can be accessed with macro {%Selector.ColumnName%}. Selector has to be in identifier format. (Inherited from MacroResolver.)
Public method	SkippedResolver	Returns true if the macro processing skipped particular resolver name (Inherited from MacroResolver.)

Extension Methods

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

Fields

	Name	Description
Protected field	mActiveMacros	Current stack of active macros (macros that are just being resolved). (Inherited from MacroResolver.)
Protected field	mCurrentRecursion	Recursion handling. (Inherited from MacroResolver.)
Protected field	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) (Inherited from MacroResolver.)
Protected field	mResolverName	Macro resolver name. (Inherited from MacroResolver.)
Protected field	mSettings	Macro context. (Inherited from MacroResolver.)
Protected field	mSkippedResolvers	Returns the list of resolvers that were skipped during the processing of the macros with this resolver. (Inherited from MacroResolver.)

Properties

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

Events

	Name	Description
Public event	OnGetValue	Gets value event. (Inherited from MacroResolver.)