SpecialFieldMacro Class

Class for storing values of macro special fields.

Inheritance Hierarchy

System.Object
  CMS.Base.AbstractSimpleDataContainer<SpecialFieldMacro>
    CMS.Base.AbstractDataContainer<SpecialFieldMacro>
      CMS.FormEngine.SpecialFieldMacro

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

Syntax

public class SpecialFieldMacro : AbstractDataContainer<SpecialFieldMacro>

The SpecialFieldMacro type exposes the following members.

Constructors

	Name	Description
Public method	SpecialFieldMacro

Methods

	Name	Description
Public method	ContainsColumn	Returns true if specified column is available in current structure. (Inherited from AbstractDataContainer<ParentObjectType>.)
Public method	GetValue	Gets the object value. (Inherited from AbstractSimpleDataContainer<TObject>.)
Protected method	RegisterColumn(String, Func<TObject, Object>)	Registers the given Column to the object (Inherited from AbstractSimpleDataContainer<TObject>.)
Protected method	RegisterColumn(String, Func<TObject, Object>, Func<TObject, Object, Object>)	Registers the given Column to the object (Inherited from AbstractSimpleDataContainer<TObject>.)
Protected method	RegisterColumns	Registers the Columns of this object (Inherited from AbstractSimpleDataContainer<TObject>.)
Public method	SetValue	Sets the object value. (Inherited from AbstractSimpleDataContainer<TObject>.)
Public method	TryGetValue	Returns value of column. (Inherited from AbstractSimpleDataContainer<TObject>.)

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
Public field Static member	ALL	Represents 'all' macro record.
Public field Static member	DEFAULT	Represents 'none' or 'global' macro record.
Public field Static member	GLOBAL	Represents 'global' macro record.
Public field Static member	GLOBAL_AND_SITE	Represents 'global and site' macro record.
Public field Static member	NONE	Represents 'none' or 'global' macro record.

Properties

	Name	Description
Public property	ColumnNames	Available column names. (Inherited from AbstractDataContainer<ParentObjectType>.)
Public property	Item	Gets or sets the value of the column. (Inherited from AbstractSimpleDataContainer<TObject>.)
Protected property	RegisteredColumns	Registered Columns (Inherited from AbstractSimpleDataContainer<TObject>.)
Protected property	RegisteredColumnsObject	Registered Columns object (Inherited from AbstractSimpleDataContainer<TObject>.)
Protected property	UseLocalColumns	If true, the object uses local columns (Inherited from AbstractSimpleDataContainer<TObject>.)