SpecialFieldsDefinition Class

Class for storing special fields.

Inheritance Hierarchy

System.Object
  System.Collections.Generic.List<SpecialField>
    CMS.FormEngine.SpecialFieldsDefinition

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

Syntax

public class SpecialFieldsDefinition : List<SpecialField>

The SpecialFieldsDefinition type exposes the following members.

Constructors

	Name	Description
Public method	SpecialFieldsDefinition	Constructor.

Methods

	Name	Description
Public method	FillItems	Fills list items.
Public method Static member	IsSpecialFieldMacro	Check if input is one of special field macros.
Public method	LoadFromMacro	Loads special fields from macro data source.
Public method	LoadFromQuery	Loads special fields from query.
Public method	LoadFromText	Loads special fields from source text.
Public method	ToString	Gets string representation (Overrides Object.ToString().)

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	DATA_HASH_ATTRIBUTE	Constant string to identify data-hash attribute.
Public field Static member	REPLACED_SEMICOLON	Used to separate values from text on each line in 'Options' mode.
Public field Static member	SEMICOLON_TO_REPLACE	Enables users to insert semicolon into 'options' mode values.

Properties

	Name	Description
Public property	AllowDuplicates	Gets or sets a value indicating whether duplicate items should be filtered out when filling a target collection.
Public property	FieldInfo	Form field info
Public property	ResourcePrefix	Resource string prefix to localize names of items.
Public property	SetUniqueIDs	Indicates if special fields should contain unique IDs
Public property	SortItems	If true, the items are sorted before filling a target collection.
Public property	Texts	Returns all text values.
Public property	Values	Returns all values.