FormInfo Members

Kentico 8.0 API Reference

The FormInfo type exposes the following members.

Constructors

	Name	Description
	FormInfo	Constructor, creates the form info structure and loads speficied form definition.

Methods

	Name	Description
	AddFormCategory(FormCategoryInfo)	Add a form category at the end of the nodes.
	AddFormCategory(FormCategoryInfo, Int32)	Add a form category at the end of the nodes.
	AddFormItem(IField)	Adds form item at the end of the form.
	AddFormItem(IField, Int32)	Adds form item after a specified field.
	Clone	Clones the object.
	CombineWithForm(FormInfo, CombineWithFormSettings)	Combines the form with another form info.
	CombineWithForm(FormInfo, Boolean, String, Boolean, Boolean)	Combines the form with another form info.
	EnsureDefaultValues	Ensures the default values into the data container.
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	FieldExists	Returns true if the given field exists in the form definition
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetCategoryNames	Returns an List of category names.
	GetColumnNames	Returns an List of field names.
	GetDataRow(Boolean)	Returns empty data row with column names and types.
	GetDataRow(Boolean, String)	Returns empty data row with column names and types.
	GetEmptyFormDocument	Gets empty root FormInfo XML node.
	GetFields(String)	Returns the List of the FormFieldInfo objects.
	GetFields(FormFieldControlTypeEnum)	Returns the List of the FormFieldInfo objects.
	GetFields(Boolean, Boolean, Boolean, Boolean, Boolean)	Returns an List of FormFieldInfo objects.
	GetFields ItemType	Gets the field of the given type (Inherited from DataDefinition.)
	GetFormCategory	Returns CategoryInfo object specified by category name.
	GetFormElements	Returns the List of the form elements.
	GetFormField	Returns field object with data from specified field.
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetHierarchicalFormElements	Returns hierarchical dictionary of items. Each category contains list of its fields. First fields without category are added to empty category.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetVisibilityXML	Returns FromInfo definition in XML used only for FormVisibilityInfo with limited FormFieldInfo attributes.
	GetXmlDefinition	Returns FormInfo definition in xml.
	LoadDefaultValues(DataRow, FormResolveTypeEnum)	Loads the default values into the DataRow.
	LoadDefaultValues(DataRow, Boolean)	Loads the default values into the DataRow.
	LoadDefaultValues(IDataContainer, FormResolveTypeEnum)	Loads the default values into the data container.
	LoadDefaultValues(DataRow, String, Boolean)	Loads the default values into the DataRow.
	LoadField	Loads the field from the XML node (Overrides DataDefinition LoadField(XmlNode).)
	LoadFromXml(String)	Loads the data definition from XML file (Inherited from DataDefinition.)
	LoadFromXml(XmlDocument)	Loads the definition from the XML document (Overrides DataDefinition LoadFromXml(XmlDocument).)
	LoadItem	Loads the item from the XML node (Overrides DataDefinition LoadItem(XmlNode).)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	MoveFormCategoryDown	Moves specified form category down.
	MoveFormCategoryUp	Moves specified form category up.
	MoveFormFieldDown	Moves specified form field down.
	MoveFormFieldToPositionInCategory	Moves specified form field to specified position in category. If category isn't specified, than field is moved to default category.
	MoveFormFieldUp	Moves specified form field up.
	NewCategoryDefinition	Creates a new category definition object
	NewFieldDefinition	Creates a new field definition object (Overrides DataDefinition NewFieldDefinition .)
	RemoveEmptyCategories	Removes all categories from the form that do not contain any fields
	RemoveFields	Remove fields matching the given condition
	RemoveFormCategory	Remove specified form category.
	RemoveFormField	Remove specified form field.
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	UpdateExistingFields	Updates the existing fields from the FormInfo definition.
	UpdateFormCategory	Update specified category node.
	UpdateFormField	Update specified field node.
	UsesHtmlArea	Returns true, if the form uses one or more visible HTML area fields.

Extension Methods

	Name	Description
	GetAPIString	Gets the string by the specified resource key (Defined by CoreExtensions.)
	GetString	Gets the string by the specified resource key (Defined by CoreExtensions.)
	ToBoolean	Returns the boolean representation of an object or default value if not. (Defined by CoreExtensions.)
	ToDateTime	Returns the DateTime representation of an object or default value if not. (Defined by CoreExtensions.)
	ToDouble	Returns the double representation of an object or default value if not. (Defined by CoreExtensions.)
	ToGuid	Returns the Guid representation of an object or default value if not. (Defined by CoreExtensions.)
	ToInteger	Returns the integer representation of an object or default value if not. (Defined by CoreExtensions.)
	ToString	Returns the string representation of an object or default value if not. (Defined by CoreExtensions.)

Fields

	Name	Description
	ATTRIBUTE_VERSION	Name of attribute version used in xml documents.
	DISPLAY_CONTEXT_DASHBOARD	Dashboard display context.

Properties

	Name	Description
	ContextResolver	Context macro resolver.
	FormName	Gets or sets FormInfo name.
	ItemsList	Returns list of all FormItems. (Inherited from DataDefinition.)