Table of Contents

Class MacroRuleInfo

Namespace
CMS.MacroEngine
Assembly
CMS.MacroEngine.dll

MacroRuleInfo data container class.

[InfoCache(InfoCacheBy.ID|InfoCacheBy.Name, Priority = InfoCachePriority.NotRemovable)]
public class MacroRuleInfo : AbstractInfo<MacroRuleInfo, IMacroRuleInfoProvider>, IExtensible, IInfo, IAdvancedDataContainer, ICMSObject, IHierarchicalDataContainer, IDataContainer, ISimpleDataContainer, IVirtualHierarchicalObject, IHierarchicalObject, INameIndexable, IMacroObject, IInfoWithId, IInfoWithName
Inheritance
object
MacroRuleInfo
Implements
Inherited Members
Extension Methods

Constructors

MacroRuleInfo()

Constructor - Creates an empty MacroRuleInfo object.

public MacroRuleInfo()

MacroRuleInfo(DataRow)

Constructor - Creates a new MacroRuleInfo object from the given DataRow.

public MacroRuleInfo(DataRow dr)

Parameters

dr DataRow

DataRow with the object data.

Fields

OBJECT_TYPE

Object type

public const string OBJECT_TYPE = "cms.macrorule"

Field Value

string

TYPEINFO

Type information.

public static ObjectTypeInfo TYPEINFO

Field Value

ObjectTypeInfo

Properties

MacroRuleCondition

Condition of the rule in K# language (with macros for parameters).

public virtual string MacroRuleCondition { get; set; }

Property Value

string

MacroRuleDescription

Description of the macro rule.

public virtual string MacroRuleDescription { get; set; }

Property Value

string

MacroRuleDisplayName

Human readable text of the Macro rule (without parameters) - displayed in the list of available rules.

public virtual string MacroRuleDisplayName { get; set; }

Property Value

string

MacroRuleEnabled

Indicates whether the Macro rule is enabled or not (determines visibility in macro rule designer).

public virtual bool MacroRuleEnabled { get; set; }

Property Value

bool

MacroRuleGUID

Macor rule GUID.

public virtual Guid MacroRuleGUID { get; set; }

Property Value

Guid

MacroRuleID

ID of the Macro rule.

public virtual int MacroRuleID { get; set; }

Property Value

int

MacroRuleIsCustom

Indicates whether the Macro rule is custom or defined by CMS (for upgrade purposes).

public virtual bool MacroRuleIsCustom { get; set; }

Property Value

bool

MacroRuleLastModified

Macor rule last modified.

public virtual DateTime MacroRuleLastModified { get; set; }

Property Value

DateTime

MacroRuleName

Code name of the Macro rule.

public virtual string MacroRuleName { get; set; }

Property Value

string

MacroRuleParameters

XML defining parameters of the Macro rule.

public virtual string MacroRuleParameters { get; set; }

Property Value

string

MacroRuleText

Human readable text of the Macro rule (including special macros for parameters).

public virtual string MacroRuleText { get; set; }

Property Value

string

MacroRuleUsageLocation

Specifies the locations within the UI where a macro rule can be utilized.

public virtual MacroRuleUsageLocation MacroRuleUsageLocation { get; set; }

Property Value

MacroRuleUsageLocation

Methods

DeleteObject()

Deletes the object using appropriate provider.

protected override void DeleteObject()

InsertAsCloneInternal(CloneSettings, CloneResult, BaseInfo)

Inserts cloned object to DB.

protected override void InsertAsCloneInternal(CloneSettings settings, CloneResult result, BaseInfo originalObject)

Parameters

settings CloneSettings

Cloning settings

result CloneResult

Cloning result

originalObject BaseInfo

Original source BaseInfo (object being cloned)

SetObject()

Updates the object using appropriate provider.

protected override void SetObject()