HomeDev GuideAPI Reference
Dev GuideAPI ReferenceUser GuideGitHubNuGetDev CommunitySubmit a ticketLog In
GitHubNuGetDev CommunitySubmit a ticket


Note

This documentation is for version 1 of the TinyMCE add-on only. \*\*The documentation for version 2, see [TinyMCE editor](🔗) .

Note

In Optimizely Content Management System (CMS) version 11, the TinyMCE editor and related plugin configuration features were moved into a separate [NuGet package](🔗) as an add-on with its own versioning number and breaking changes.

Property settings define settings that affect a specific property or property type, for example, how an editor is configured. A common example is to define settings for the TinyMCE rich-text editor to control which tools are available when editing an XhtmlString property type.

You can define settings both in code and in the admin view. Rules similar to ones that control content types apply, so settings have the following priorities:

  1. A specific setting for a property defined in the admin view, which is either a custom setting for this property or a pointer to a specific global setting.

  2. A specific setting for a property defined for the model in code.

  3. A global setting defined in the admin view marked as the **Default** settings for the property type.

  4. A global setting defined in code.

Typical use cases are: a developer responsible for defining and maintaining settings, and an administrator who can override the settings. For example, if you need to add a tool before updating the website implementation, the workflow may look as follows:

  1. The developer creates a settings class and sets this as default.

  2. If the developer needs specific settings for some properties, the developer creates a settings class and adds it as an attribute on the property.

  3. If an administrator needs to change settings for a specific property, he adds a custom setting for the property in the admin view, which takes immediate effect.

  4. The administrator can remove the settings in the admin view after the developer add the settings class to the code.

  5. If an administrator needs to change the default settings, he creates a shared setting and marks this as the default to take precedence over the code's default settings.

  6. After the developer updates the settings from code, the administrator can remove the default settings in the admin view.

## Create a global settings object

The following code sample shows how to create a default settings object and also how to apply personalization for the administrators role:



### Use a custom setting for a property

The following example shows how to apply a custom setting for a specific property by creating a class (in this case, the `IsDefault` property is not set):



To apply this to a specific property on a model, add the `PropertySettings` attribute to it as follows:



### Read a custom setting for a property

If you are developing a custom property, you can read the property setting using an `extension` method on content, as shown in the following example:



You can use the underlying the `PropertySettingsResolver` class to read property settings without having access to a typed model.

## Update mergedConfigurationProperties

`mergedConfigurationProperties` are properties that are mergable for plugins in TinyMCE. If several TinyMCE plugins set different values for any of the configuration options listed in this attribute, these values will be merged.

Default value of `mergedConfigurationProperties` is: `{ "valid\_elements", "extended\_valid\_elements", "invalid\_elements", "valid\_child\_elements" }`

`mergedConfigurationProperties`  is an `IList`, and can be modified in initialization module, as shown in the following example: