Table of Contents

Class FormCategoryInfo

Namespace
CMS.FormEngine
Assembly
CMS.FormEngine.dll

Class for storing info about categories.

public class FormCategoryInfo : AbstractDataContainer<FormCategoryInfo>, IDataContainer, ISimpleDataContainer, IDataDefinitionItem
Inheritance
object
FormCategoryInfo
Implements
Inherited Members
Extension Methods

Constructors

FormCategoryInfo()

Constructor for default FormCategoryInfo.

public FormCategoryInfo()

Properties

CategoryName

Category name.

public string CategoryName { get; set; }

Property Value

string

IsDummy

Indicates if category is not in original form definition.

public bool IsDummy { get; set; }

Property Value

bool

IsInherited

If true, the category is inherited from parent class.

[Obsolete("Property is deprecated and will be removed in the next version.")]
[ObsoleteSince(28, 0)]
public bool IsInherited { get; set; }

Property Value

bool

Properties

Properties (hashtable).

public Hashtable Properties { get; set; }

Property Value

Hashtable

PropertiesMacroTable

Properties macro table (hashtable).

public Hashtable PropertiesMacroTable { get; set; }

Property Value

Hashtable

Methods

Clone()

Returns cloned object of current FormCategoryInfo object.

public IDataDefinitionItem Clone()

Returns

IDataDefinitionItem

Returns clone of FormCategoryInfo

GetPropertyValue(FormCategoryPropertyEnum)

Gets unresolved property value.

public string GetPropertyValue(FormCategoryPropertyEnum property)

Parameters

property FormCategoryPropertyEnum

Property

Returns

string

GetPropertyValue(FormCategoryPropertyEnum, MacroResolver, MacroSettings)

Gets resolved property value.

public string GetPropertyValue(FormCategoryPropertyEnum property, MacroResolver resolver, MacroSettings macroSettings = null)

Parameters

property FormCategoryPropertyEnum

Property

resolver MacroResolver

Macro resolver

macroSettings MacroSettings

Macro context

Returns

string

GetPropertyValue(FormCategoryPropertyEnum, out bool)

Gets unresolved property value.

public string GetPropertyValue(FormCategoryPropertyEnum property, out bool isMacro)

Parameters

property FormCategoryPropertyEnum

Property

isMacro bool

Returns true if property contains macro

Returns

string

GetXmlNode(XmlDocument)

Gets XmlNode for current FormCategoryInfo object.

public XmlNode GetXmlNode(XmlDocument doc)

Parameters

doc XmlDocument

Returns

XmlNode

LoadFromTableData(DataRow, bool, bool)

Loads the field info from plain database structure data

public void LoadFromTableData(DataRow row, bool isPrimary, bool isSystem)

Parameters

row DataRow

Data row with structure information

isPrimary bool

Indicates if field represents primary key

isSystem bool

Indicates if field is system field

LoadFromXmlNode(XmlNode)

Initializes the category instance from given XML data.

public virtual void LoadFromXmlNode(XmlNode categoryNode)

Parameters

categoryNode XmlNode

XML node with the category data

RegisterColumns()

Registers the Columns of this object for resolving data macros.

protected override void RegisterColumns()

SetPropertyValue(FormCategoryPropertyEnum, string, bool)

Sets property value.

public void SetPropertyValue(FormCategoryPropertyEnum property, string value, bool isMacro = false)

Parameters

property FormCategoryPropertyEnum

Property which value is set

value string

Property value

isMacro bool

Indicates if value is macro. Default value is false.