MacroSettings Members

Kentico 8.0 API Reference

The MacroSettings type exposes the following members.

Constructors

	Name	Description
	MacroSettings	Constructor

Methods

	Name	Description
	AddCacheDependencies	Adds the cache dependencies to the macro context
	AddFileCacheDependencies	Adds the cache dependencies to the macro context
	Clone	Returns the clone of the current context
	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.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Extension Methods

	Name	Description
	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.)

Properties

	Name	Description
	AllowContextMacros	If true, the properties from contexts are not resolved unless explicitly registered.
	AllowRecursion	If true, the recursion is allowed within the macro resolving. Default value is true.
	AvoidInjection	If true, the resolving of the macros should avoid SQL injection (escapes the apostrophes in output). Default value is false
	CacheDependencies	Outputs the cache dependencies collected during the processing
	Culture	Culture used for the resolving
	DisableContextMacros	If true, all the context macros are disabled (only base MacroResolver sources are checked).
	DisableContextObjectMacros	If true, context objects (such as ForumContext, CommunityContext, CMSContext, ...) will not be resolved.
	DisablePageContextMacros	If true, page context macros are not available (CurrentDocument, CurrentPageInfo).
	EncapsulateMacroObjects	If true, the object will be encapsulated to its macro representations
	EncodeResolvedValues	If true, the resolved macro values are encoded to avoid XSS. Default value is false
	EvaluationTimeout	Expression evaluation timeout in milliseconds. If the evaluation time exceeds this time, evaluation will be aborted and the result will be null.
	FileCacheDependencies	Outputs the file cache dependencies collected during the processing
	CheckIntegrity	If true, the integrity of security parameters is checked within macro evaluation.
	CheckSecurity	If true, the security is checked within macro evaluation
	KeepUnresolvedMacros	If true, unresolved macros are kept in their original form.
	MaxRecursionlevel	Gets or sets the maximal recursion level.
	RelatedObject	Related object allows set object used for resolving in macro method. Used in web part properties.
	TrackCacheDependencies	If true, the resolving tracks cache dependencies. Default value is false
	UserName	Gets or sets the name of the user which will be used to verify security when CheckIntegrity is false.
	VirtualMode	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.