FormHelper.GetFormInfo Method

Returns FormInfo object for specified class name or alternative name. Method loops through supplied class list and returns first object existing. If alternative name is specified then it is merged with default class and then returned If coupled class exists for given alternative form then it is merged as well. If alternative form info not found then its default class is returned. You can also merge two forms in the result by using the + operator between names, such as "customtable.sampletable.filter+customtable.sampletable.extra"

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

Syntax

public static FormInfo GetFormInfo(
	string classes,
	bool clone,
	bool fallbackToDefault = true,
	bool onlyVisible = false
)

Parameters

classes

Type: System.String
Class names or alternative names separated by semicolon

clone

Type: System.Boolean
When returned FormInfo is used only for reading then cloning can be set to FALSE

fallbackToDefault (Optional)

Type: System.Boolean
If true and alternative form is not found, the process attempts to fall back to the class default form

onlyVisible (Optional)

Type: System.Boolean
If true, only visible fields are provided in the result. This also removes any empty categories in the form (considering them invisible).

Return Value

Type: FormInfo
Null if no FormInfo found for any of the specified classes. Otherwise returns first FormInfo which was found.