You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: 13/umbraco-forms/developer/configuration/README.md
+6-1Lines changed: 6 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -73,7 +73,8 @@ For illustration purposes, the following structure represents the full set of op
73
73
"PrevalueSourceTypes": {},
74
74
"WorkflowTypes": {},
75
75
},
76
-
"MandatoryFieldsetLegends": false
76
+
"MandatoryFieldsetLegends": false,
77
+
"UseViewEngineFormThemeResolver": false
77
78
},
78
79
"Options": {
79
80
"IgnoreWorkFlowsOnEdit": "True",
@@ -241,6 +242,10 @@ When creating a form with Umbraco Forms, adding captions to the groups for field
241
242
242
243
If you want to ensure form creators always have to provide a caption, you can set the value of this setting to `true`.
243
244
245
+
### UseViewEngineFormThemeResolver
246
+
247
+
Forms introduced an alternative `IFormThemeResolver` in 13.6 that uses the View Engine (`ICompositeViewEngine`) to resolve theme views, instead of relying on physical files to exist (and doing I/O lookups via the Partial Views file system abstraction). To take advantage of this new resolver, you can set the value of this setting to `true`.
248
+
244
249
### Form default settings configuration
245
250
246
251
The following configured values are applied to all forms as they are created. They can then be amended on a per-form basis via the Umbraco backoffice.
#### Add support for subscription licensing using product key
22
+
23
+
In addition to the existing one-off license using the `umbracoForms.lic` file, support for configuring a subscription license using a product key is added. As [announced](https://github.com/umbraco/Announcements/issues/25), Forms 17 will only be available through a subscription-based license. To make the transition to this upcoming major easier, you can already purchase a new subscription (avoiding the one-off purchase) or convert your recently purchased one-off license into a subscription.
24
+
25
+
The 14-day trail license isn't generated anymore on install, but you can still fully test Forms on localhost. Configuring the license from the backoffice is also removed due to the direct integration with the legacy license infrastructure and to align the license management to the Licenses dashboard in the Settings section.
26
+
27
+
Read more about [the licensing model](./installation/the-licensing-model.md).
28
+
29
+
#### Only show reCAPTCHA v2 or v3 fields when settings are configured
30
+
31
+
Forms provides reCAPTCHA v2 and v3 fields out-of-the-box, but both were always shown to editors in the backoffice. These fields are now only shown when their respective settings are configured. This avoids editors adding a reCAPTCHA field that doesn't work due to missing configuration and/or mixing up the v2 and v3 versions.
32
+
33
+
If the settings aren't configured in `appsettings.json` or environment variables (and thus available through `IConfiguration`), the required field needs to be manually added. This can be the case when manually configuring the `Recaptcha2Settings` or `Recaptcha3Settings` object in code:
#### Allow using ViewEngine to resolve theme views
47
+
48
+
The default theme views are resolved using the [Partial Views file system](../umbraco-cms/extending/filesystemproviders/README.md#other-ifilesystems) (an abstraction over the `/Views/Partials` directory). This requires I/O lookups to determine whether specific theme views exist and manually specifying all files when using a [Razor Class Library](./developer/themes.md#shipping-themes-in-a-razor-class-library).
49
+
50
+
By enabling the [`UseViewEngineFormThemeResolver` setting](./developer/configuration/README.md#useviewengineformthemeresolver), theme vies are resolved using the `ICompositeViewEngine`, which will include compiled views (including those shipped in RCLs).
Copy file name to clipboardExpand all lines: 16/umbraco-forms/developer/configuration/README.md
+10-6Lines changed: 10 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,7 @@ With Umbraco Forms it's possible to customize the functionality with various con
10
10
11
11
## Editing configuration values
12
12
13
-
All configuration for Umbraco Forms is held in the `appSettings.json` file found at the root of your Umbraco website. If the configuration has been customized to use another source, then the same keys and values discussed in this article can be applied there.
13
+
All configuration for Umbraco Forms is held in the `appsettings.json` file found at the root of your Umbraco website. If the configuration has been customized to use another source, then the same keys and values discussed in this article can be applied there.
14
14
15
15
The convention for Umbraco configuration is to have package based options stored as a child structure below the `Umbraco` element, and as a sibling of `CMS`. Forms configuration follows this pattern, i.e.:
16
16
@@ -72,7 +72,8 @@ For illustration purposes, the following structure represents the full set of op
72
72
"PrevalueSourceTypes": {},
73
73
"WorkflowTypes": {},
74
74
},
75
-
"MandatoryFieldsetLegends": false
75
+
"MandatoryFieldsetLegends": false,
76
+
"UseViewEngineFormThemeResolver": false
76
77
},
77
78
"Options": {
78
79
"IgnoreWorkFlowsOnEdit": "True",
@@ -236,6 +237,10 @@ When creating a form with Umbraco Forms, adding captions to the groups for field
236
237
237
238
If you want to ensure form creators always have to provide a caption, you can set the value of this setting to `true`.
238
239
240
+
### UseViewEngineFormThemeResolver
241
+
242
+
Forms introduced an alternative `IFormThemeResolver` in 16.1 that uses the View Engine (`ICompositeViewEngine`) to resolve theme views, instead of relying on physical files to exist (and doing I/O lookups via the Partial Views file system abstraction). To take advantage of this new resolver, you can set the value of this setting to `true`.
243
+
239
244
### Form default settings configuration
240
245
241
246
The following configured values are applied to all forms as they are created. They can then be amended on a per-form basis via the Umbraco backoffice.
@@ -428,29 +433,28 @@ Forms will by default track relations between forms and the content pages they a
428
433
429
434
If you would like to disable this feature, you can set the value of this setting to `true`.
430
435
431
-
## TrackRenderedFormsStorageMethod
436
+
###TrackRenderedFormsStorageMethod
432
437
433
438
Forms tracks the forms rendered on a page in order that the associated scripts can be placed in a different location within the HTML. Usually this is used to [render the scripts](../rendering-scripts.md) at the bottom of the page.
434
439
435
440
By default, `HttpContext.Items` is used as the storage mechanism for this tracking.
436
441
437
442
You can optionally revert to the legacy behavior of using `TempData` by changing this setting from the default of `HttpContextItems` to `TempData`.
438
443
439
-
## EnableMultiPageFormSettings
444
+
###EnableMultiPageFormSettings
440
445
441
446
This setting determines whether [multi-page form settings](../../editor/creating-a-form/form-settings.md#multi-page-forms) are available to editors.
442
447
443
448
By default the value is `true`. To disable the feature, set the value to `false`.
444
449
445
-
## EnableAdvancedValidationRules
450
+
###EnableAdvancedValidationRules
446
451
447
452
This setting determines whether [advanced form validation rules](../../editor/creating-a-form/form-advanced.md) are available to editors.
448
453
449
454
By default, the value is `false`. This is partly because the feature is only considered for "power users", comfortable with crafting rules using the required JSON syntax. And partly as validating the rules on the client requires an additional front-end dependency.
450
455
451
456
To make the feature available to editors and include the dependency when using `@Html.RenderUmbracoFormDependencies(Url)`, set the value to `true`.
#### Add support for subscription licensing using product key
22
+
23
+
In addition to the existing one-off license using the `umbracoForms.lic` file, support for configuring a subscription license using a product key is added. As [announced](https://github.com/umbraco/Announcements/issues/25), Forms 17 will only be available through a subscription-based license. To make the transition to this upcoming major easier, you can already purchase a new subscription (avoiding the one-off purchase) or convert your recently purchased one-off license into a subscription.
24
+
25
+
The 14-day trail license isn't generated anymore on install, but you can still fully test Forms on localhost. Configuring the license from the backoffice is also removed due to the direct integration with the legacy license infrastructure and to align the license management to the Licenses dashboard in the Settings section.
26
+
27
+
Read more about [the licensing model](./installation/the-licensing-model.md).
28
+
29
+
#### Only show reCAPTCHA v2 or v3 fields when settings are configured
30
+
31
+
Forms provides reCAPTCHA v2 and v3 fields out-of-the-box, but both were always shown to editors in the backoffice. These fields are now only shown when their respective settings are configured. This avoids editors adding a reCAPTCHA field that doesn't work due to missing configuration and/or mixing up the v2 and v3 versions.
32
+
33
+
If the settings aren't configured in `appsettings.json` or environment variables (and thus available through `IConfiguration`), the required field needs to be manually added. This can be the case when manually configuring the `Recaptcha2Settings` or `Recaptcha3Settings` object in code:
#### Allow using ViewEngine to resolve theme views
47
+
48
+
The default theme views are resolved using the [Partial Views file system](../umbraco-cms/extending/filesystemproviders/README.md#other-ifilesystems) (an abstraction over the `/Views/Partials` directory). This requires I/O lookups to determine whether specific theme views exist and manually specifying all files when using a [Razor Class Library](./developer/themes.md#shipping-themes-in-a-razor-class-library).
49
+
50
+
By enabling the [`UseViewEngineFormThemeResolver` setting](./developer/configuration/README.md#useviewengineformthemeresolver), theme vies are resolved using the `ICompositeViewEngine`, which will include compiled views (including those shipped in RCLs).
0 commit comments