ObjectTypeInfo.MacroCollectionName Property

Note: This API is now obsolete.

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.

Namespace: CMS.DataEngine
Assembly: CMS.DataEngine (in CMS.DataEngine.dll) Version: 13.0.131

Syntax

[ObsoleteAttribute("This property is obsolete and will be removed in the next version. Use MacroSettings.MacroCollectionName instead.")]
public string MacroCollectionName { get; set; }

Property Value

Type: 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.