PortalFormHelper.GetWidgetFormInfo Method

Returns cached and merged FormInfo for widgets.

Namespace: CMS.PortalEngine
Assembly: CMS.PortalEngine (in CMS.PortalEngine.dll) Version: 12.0.0

Syntax

public static FormInfo GetWidgetFormInfo(
	string widgetName,
	WidgetZoneTypeEnum zoneType,
	string widgetPropertiesFormDefinition,
	bool clone,
	string defaultValuesFormDefinition = ""
)

Parameters

widgetName

Type: System.String
Name of the widget

zoneType

Type: CMS.PortalEngine.WidgetZoneTypeEnum
Type of the zone where widget is placed

widgetPropertiesFormDefinition

Type: System.String
Widget properties form definition

clone

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

defaultValuesFormDefinition (Optional)

Type: System.String
Form definition with overridden system default values

Return Value

Type: FormInfo
Returns FormInfo object