Documentation > CMS Template API Library > WysiwygParams

CrownPeak.CMSAPI.WysiwygParams

The set of Params for enabling and disabling features in the Wysiwyg editor.

NameDescriptionType
AddButton(FeatureType)

This function is used to add a button to the wysiwyg.

Method
AddButtons(List[FeatureType])

This function is used to add a set of buttons to the wysiwyg. The order that they are added is the order that they will displayed on the screen.

Method
AddColorGroup(FeatureType)

Adds fore color and back color buttons

Method
AddCutPasteGroup(FeatureType)

Adds cut, cuthtml and paste buttons

Method
AddExtendedStyleGroup(FeatureType)

Adds strikethrough, superscript and subscript buttons

Method
AddExtendedSyleGroup(FeatureType)

Method
AddFontGroup(FeatureType)

Adds fontstyle, fontface and fontsize buttons

Method
AddIndentGroup(FeatureType)

Adds indent and outdent buttons

Method
AddJustifyGroup(FeatureType)

Adds justify left, justify center, justify right buttons

Method
AddLinkGroup(FeatureType)

Adds link, remove link and make anchor buttons

Method
AddListGroup(FeatureType)

Adds unordered list and ordered list buttons

Method
AddSimpleStyleGroup(FeatureType)

Adds bold, italic and underline buttons

Method
AddStyleGroup(FeatureType)

Adds bold, italic, underline, strikethrough, superscript and subscript buttons buttons

Method
AddUndoGroup(FeatureType)

Adds undo, redo buttons

Method
BodyBackground

Sets the body background of the wysiwyg, use web color format (#ffffff).

Property
BodyStyle

Gets or sets the style of the body tag inside the WYSIWYG editor.

Property
brOnEnter

If this field is set to true, the wysiwyg will add a
when the enter button is pressed.

Property
DesignEditTabs

Used to turn on and off the Design/Edit tabs, whic hthe user can use to switch back and forth between code view and design view. Setting this value to false will disable this feature.

Property
DisableAutoPTags

If set to true, content will be not automatically be wrapped with paragraph (

) tags if it has not been properly enclosed with block tags. See also . Ephox does not recommend setting this attribute to true as it may cause invalid HTML to be generated. According to TinyMCE, not using P elements as root block can severly cripple the functionality of the editor.

Property
DisableImageEditing

Used to turn on and off the image editing tools. Setting this value to true will disable the image editing tools.

Property
DisableWrapCustomTagsInP

If set to true, any custom tag specified outside of a block element will be automatically wrapped in a P tag (Ephox).

Property
DisableXHTMLOutput

Used to control the wysiwyg XHTMLOutput feature. Setting this value to true will prevent the wysiwyg from converting the html to xhtml.

Property
DocumentNavigator

Used to turn on and off the Document Navigator. Setting the value to false will turn off the document navigator.

Property
HtmlImportStyleOption

Turns on or off the HtmlImportStyleOption.

Property
HtmlPasteOptions

Turns on or off the HtmlPasteOptions.

Property
ImageBrowse

Sets the behavior when browsing to an image in the cms. Defaults to RelationShipType.Link which creates a link the image.

Property
ImageEditingOptions

A list that determines what should be on the image editing toolbar. Possible values are: separator, rotateCCW, rotateCW, flipVertical, flipHorizontal, reflect, dropShadow, roundedCorners, and crop.

Property
ImageFolder

Sets the default folder location that displays in the aset browse window when the image upload button is clicked.

Property
ImageUpload

Sets the behavior when uploading an image into the wysiwyg from the user's computer. Defaults to RelationShipType.Attach which attaches the image to the asset.

Property
IndentContent

Formats the content based on html tags. Setting IndentContent to true will base the formatting on the html tags.

Property
InsertHTML

Gets or sets whether the user will be allowed to insert HTML into the wysiwyg at the cursor without switching to the code tab with the "Insert HTML Fragment" button.

Property
LinkBrowse

Sets the behavior when browsing to an asset in the cms. Defaults to RelationShipType.Link which creates a link the asset.

Property
LinkFolder

Sets the default folder location that displays in the asset browse window when the asset select button is clicked.

Property
LinkUpload

Sets the behavior when uploading a file into the wysiwyg from the user's computer. Defaults to RelationShipType.Attach which uploads the file into the asset.

Property
MailtoList

Represents a list of email addresses available to the MailTo Control. The Key is the email address, and the Value is the email label.

Property
PreferredHeight

Use this when uploading images larger than 800 x 600, if you do not want them to be resized. Always set PreferredWidth when setting this parameter or it will be ignored.

Property
PreferredWidth

Use this when uploading images larger than 800 x 600, if you do not want them to be resized. Always set PreferredHeight when setting this parameter or it will be ignored.

Property
PreviewStylesheet

Optional: Stylesheet to use during preview.

Property
StrictXHTML

Property
Stylesheet

Sets the wysiwyg stylesheet.

Property
TemplateBrowserOn

Gets or sets whether to display the "Insert Template" button. Clicking the button shows a list of WYSIWYG templates containing HTML fragments that may be inserted. All developer templates in the folder will show up as WYSIWYG templates. The asset label is the WYSIWYG template's name, and the asset body is the WYSIWYG template's HTML fragment.

Property
TemplateFolder

Gets or sets the template folder used by . Defaults to /System/CMS Snippets/Default

Property
WordImportStyleOption

Turns on and off the Word Import Style Option.

Property
WordPasteOptions

Turns on and off the Word Paste Options. When true, ephox will present the user with some paste options to sanitize the data coming in from a paste. This is useful when pasting from a word document.

Property

Connect with CrownPeak