Ext.NET  5.3.0
.NET Component Framework for Enterprise Level Apps
Ext.Net.HtmlEditor.Builder< THtmlEditor, TBuilder > Class Template Reference

More...

Inheritance diagram for Ext.Net.HtmlEditor.Builder< THtmlEditor, TBuilder >:
Ext.Net.Field.Builder< THtmlEditor, TBuilder >

Public Member Functions

 Builder (THtmlEditor component)
 
virtual TBuilder ButtonDefaults (Action< object > action)
 A config object to apply to the toolbar's Ext.button.Button to affect how they operate. More...
 
virtual TBuilder Text (string text)
 The Text value to initialize this field with. More...
 
virtual TBuilder Listeners (Action< HtmlEditorListeners > action)
 Client-side JavaScript Event Handlers More...
 
virtual TBuilder DirectEvents (Action< HtmlEditorDirectEvents > action)
 Server-side Ajax Event Handlers More...
 
virtual TBuilder AfterIFrameTpl (XTemplate afterIFrameTpl)
 An optional string or XTemplate configuration to insert in the field markup after the iframe element. If an XTemplate is used, the component's subTpl data serves as the context. More...
 
virtual TBuilder AfterTextAreaTpl (XTemplate afterTextAreaTpl)
 An optional string or XTemplate configuration to insert in the field markup after the textarea element. If an XTemplate is used, the component's subTpl data serves as the context. More...
 
virtual TBuilder BeforeIFrameTpl (XTemplate beforeIFrameTpl)
 An optional string or XTemplate configuration to insert in the field markup before the iframe element. If an XTemplate is used, the component's subTpl data serves as the context. More...
 
virtual TBuilder BeforeTextAreaTpl (XTemplate beforeTextAreaTpl)
 An optional string or XTemplate configuration to insert in the field markup before the textarea element. If an XTemplate is used, the component's subTpl data serves as the context. More...
 
virtual TBuilder CreateLinkText (string createLinkText)
 The default text for the create link prompt. More...
 
virtual TBuilder DefaultFont (string defaultFont)
 The default font family (defaults to 'tahoma'). More...
 
virtual TBuilder DefaultLinkValue (string defaultLinkValue)
 The default value for the create link prompt (defaults to http://). More...
 
virtual TBuilder DefaultValue (string defaultValue)
 A default value to be put into the editor to resolve focus issues (defaults to (Non-breaking space) in Opera and IE6, ​ (Zero-width space) in all other browsers). More...
 
virtual TBuilder EnableAlignments (bool enableAlignments)
 Enable the left, center, right alignment buttons (defaults to true). More...
 
virtual TBuilder EnableColors (bool enableColors)
 Enable the fore/highlight color buttons (defaults to true). More...
 
virtual TBuilder EnableFont (bool enableFont)
 Enable font selection. Not available in Safari. (defaults to true). More...
 
virtual TBuilder EnableFontSize (bool enableFontSize)
 Enable the increase/decrease font size buttons (defaults to true). More...
 
virtual TBuilder EnableFormat (bool enableFormat)
 Enable the bold, italic and underline buttons (defaults to true). More...
 
virtual TBuilder EnableLinks (bool enableLinks)
 Enable the create link button. Not available in Safari. (defaults to true). More...
 
virtual TBuilder EnableLists (bool enableLists)
 Enable the bullet and numbered list buttons. Not available in Safari. (defaults to true). More...
 
virtual TBuilder EnableSourceEdit (bool enableSourceEdit)
 Enable the switch to source edit button. Not available in Safari. (defaults to true). More...
 
virtual TBuilder EscapeValue (bool escapeValue)
 
virtual TBuilder FontFamilies (string[] fontFamilies)
 An array of available font families. More...
 
virtual TBuilder ButtonTips (Action< HtmlEditorButtonTips > action)
 
virtual TBuilder IframeAttrTpl (XTemplate iframeAttrTpl)
 An optional string or XTemplate configuration to insert in the field markup inside the iframe element (as attributes). If an XTemplate is used, the component's subTpl data serves as the context. More...
 
virtual TBuilder ExecCmd (string cmd, string value)
 
virtual TBuilder ExecCmd (string cmd, bool value)
 
virtual TBuilder InsertAtCursor (string text)
 
virtual TBuilder PushValue ()
 Protected method that will not generally be called directly. Pushes the value of the textarea into the iframe editor. More...
 
virtual TBuilder RelayCmd (string cmd, string value)
 
virtual TBuilder RelayCmd (string cmd, bool value)
 
virtual TBuilder SyncValue ()
 Protected method that will not generally be called directly. Syncs the contents of the editor iframe with the textarea. More...
 
virtual TBuilder ToggleSourceEdit ()
 Toggles the editor between standard and source edit mode. More...
 
virtual TBuilder ToggleSourceEdit (bool sourceEdit)
 
virtual TBuilder UpdateToolbar ()
 Protected method that will not generally be called directly. It triggers a toolbar update by reading the markup state of the current selection in the editor. More...
 
 Builder ()
 
 Builder (HtmlEditor component)
 
 Builder (HtmlEditor.Config config)
 

Static Public Member Functions

static implicit operator Builder (HtmlEditor component)
 

Detailed Description

Type Constraints
THtmlEditor :HtmlEditor 
TBuilder :Builder 
TBuilder :THtmlEditor 
TBuilder :TBuilder 

Constructor & Destructor Documentation

◆ Builder() [1/4]

Ext.Net.HtmlEditor.Builder< THtmlEditor, TBuilder >.Builder ( THtmlEditor  component)
inline

◆ Builder() [2/4]

Ext.Net.HtmlEditor.Builder< THtmlEditor, TBuilder >.Builder ( )
inline

◆ Builder() [3/4]

Ext.Net.HtmlEditor.Builder< THtmlEditor, TBuilder >.Builder ( HtmlEditor  component)
inline

◆ Builder() [4/4]

Ext.Net.HtmlEditor.Builder< THtmlEditor, TBuilder >.Builder ( HtmlEditor.Config  config)
inline

Member Function Documentation

◆ AfterIFrameTpl()

virtual TBuilder Ext.Net.HtmlEditor.Builder< THtmlEditor, TBuilder >.AfterIFrameTpl ( XTemplate  afterIFrameTpl)
inlinevirtual

An optional string or XTemplate configuration to insert in the field markup after the iframe element. If an XTemplate is used, the component's subTpl data serves as the context.

◆ AfterTextAreaTpl()

virtual TBuilder Ext.Net.HtmlEditor.Builder< THtmlEditor, TBuilder >.AfterTextAreaTpl ( XTemplate  afterTextAreaTpl)
inlinevirtual

An optional string or XTemplate configuration to insert in the field markup after the textarea element. If an XTemplate is used, the component's subTpl data serves as the context.

◆ BeforeIFrameTpl()

virtual TBuilder Ext.Net.HtmlEditor.Builder< THtmlEditor, TBuilder >.BeforeIFrameTpl ( XTemplate  beforeIFrameTpl)
inlinevirtual

An optional string or XTemplate configuration to insert in the field markup before the iframe element. If an XTemplate is used, the component's subTpl data serves as the context.

◆ BeforeTextAreaTpl()

virtual TBuilder Ext.Net.HtmlEditor.Builder< THtmlEditor, TBuilder >.BeforeTextAreaTpl ( XTemplate  beforeTextAreaTpl)
inlinevirtual

An optional string or XTemplate configuration to insert in the field markup before the textarea element. If an XTemplate is used, the component's subTpl data serves as the context.

◆ ButtonDefaults()

virtual TBuilder Ext.Net.HtmlEditor.Builder< THtmlEditor, TBuilder >.ButtonDefaults ( Action< object >  action)
inlinevirtual

A config object to apply to the toolbar's Ext.button.Button to affect how they operate.

Parameters
actionThe action delegate
Returns
An instance of TBuilder

◆ ButtonTips()

virtual TBuilder Ext.Net.HtmlEditor.Builder< THtmlEditor, TBuilder >.ButtonTips ( Action< HtmlEditorButtonTips action)
inlinevirtual

Parameters
actionThe action delegate
Returns
An instance of TBuilder

◆ CreateLinkText()

virtual TBuilder Ext.Net.HtmlEditor.Builder< THtmlEditor, TBuilder >.CreateLinkText ( string  createLinkText)
inlinevirtual

The default text for the create link prompt.

◆ DefaultFont()

virtual TBuilder Ext.Net.HtmlEditor.Builder< THtmlEditor, TBuilder >.DefaultFont ( string  defaultFont)
inlinevirtual

The default font family (defaults to 'tahoma').

◆ DefaultLinkValue()

virtual TBuilder Ext.Net.HtmlEditor.Builder< THtmlEditor, TBuilder >.DefaultLinkValue ( string  defaultLinkValue)
inlinevirtual

The default value for the create link prompt (defaults to http://).

◆ DefaultValue()

virtual TBuilder Ext.Net.HtmlEditor.Builder< THtmlEditor, TBuilder >.DefaultValue ( string  defaultValue)
inlinevirtual

A default value to be put into the editor to resolve focus issues (defaults to (Non-breaking space) in Opera and IE6, ​ (Zero-width space) in all other browsers).

◆ DirectEvents()

virtual TBuilder Ext.Net.HtmlEditor.Builder< THtmlEditor, TBuilder >.DirectEvents ( Action< HtmlEditorDirectEvents action)
inlinevirtual

Server-side Ajax Event Handlers

Parameters
actionThe action delegate
Returns
An instance of TBuilder

◆ EnableAlignments()

virtual TBuilder Ext.Net.HtmlEditor.Builder< THtmlEditor, TBuilder >.EnableAlignments ( bool  enableAlignments)
inlinevirtual

Enable the left, center, right alignment buttons (defaults to true).

◆ EnableColors()

virtual TBuilder Ext.Net.HtmlEditor.Builder< THtmlEditor, TBuilder >.EnableColors ( bool  enableColors)
inlinevirtual

Enable the fore/highlight color buttons (defaults to true).

◆ EnableFont()

virtual TBuilder Ext.Net.HtmlEditor.Builder< THtmlEditor, TBuilder >.EnableFont ( bool  enableFont)
inlinevirtual

Enable font selection. Not available in Safari. (defaults to true).

◆ EnableFontSize()

virtual TBuilder Ext.Net.HtmlEditor.Builder< THtmlEditor, TBuilder >.EnableFontSize ( bool  enableFontSize)
inlinevirtual

Enable the increase/decrease font size buttons (defaults to true).

◆ EnableFormat()

virtual TBuilder Ext.Net.HtmlEditor.Builder< THtmlEditor, TBuilder >.EnableFormat ( bool  enableFormat)
inlinevirtual

Enable the bold, italic and underline buttons (defaults to true).

◆ EnableLinks()

virtual TBuilder Ext.Net.HtmlEditor.Builder< THtmlEditor, TBuilder >.EnableLinks ( bool  enableLinks)
inlinevirtual

Enable the create link button. Not available in Safari. (defaults to true).

◆ EnableLists()

virtual TBuilder Ext.Net.HtmlEditor.Builder< THtmlEditor, TBuilder >.EnableLists ( bool  enableLists)
inlinevirtual

Enable the bullet and numbered list buttons. Not available in Safari. (defaults to true).

◆ EnableSourceEdit()

virtual TBuilder Ext.Net.HtmlEditor.Builder< THtmlEditor, TBuilder >.EnableSourceEdit ( bool  enableSourceEdit)
inlinevirtual

Enable the switch to source edit button. Not available in Safari. (defaults to true).

◆ EscapeValue()

virtual TBuilder Ext.Net.HtmlEditor.Builder< THtmlEditor, TBuilder >.EscapeValue ( bool  escapeValue)
inlinevirtual

◆ ExecCmd() [1/2]

virtual TBuilder Ext.Net.HtmlEditor.Builder< THtmlEditor, TBuilder >.ExecCmd ( string  cmd,
bool  value 
)
inlinevirtual

◆ ExecCmd() [2/2]

virtual TBuilder Ext.Net.HtmlEditor.Builder< THtmlEditor, TBuilder >.ExecCmd ( string  cmd,
string  value 
)
inlinevirtual

◆ FontFamilies()

virtual TBuilder Ext.Net.HtmlEditor.Builder< THtmlEditor, TBuilder >.FontFamilies ( string[]  fontFamilies)
inlinevirtual

An array of available font families.

◆ IframeAttrTpl()

virtual TBuilder Ext.Net.HtmlEditor.Builder< THtmlEditor, TBuilder >.IframeAttrTpl ( XTemplate  iframeAttrTpl)
inlinevirtual

An optional string or XTemplate configuration to insert in the field markup inside the iframe element (as attributes). If an XTemplate is used, the component's subTpl data serves as the context.

◆ InsertAtCursor()

virtual TBuilder Ext.Net.HtmlEditor.Builder< THtmlEditor, TBuilder >.InsertAtCursor ( string  text)
inlinevirtual

◆ Listeners()

virtual TBuilder Ext.Net.HtmlEditor.Builder< THtmlEditor, TBuilder >.Listeners ( Action< HtmlEditorListeners action)
inlinevirtual

Client-side JavaScript Event Handlers

Parameters
actionThe action delegate
Returns
An instance of TBuilder

◆ operator Builder()

static implicit Ext.Net.HtmlEditor.Builder< THtmlEditor, TBuilder >.operator Builder ( HtmlEditor  component)
inlinestatic

◆ PushValue()

virtual TBuilder Ext.Net.HtmlEditor.Builder< THtmlEditor, TBuilder >.PushValue ( )
inlinevirtual

Protected method that will not generally be called directly. Pushes the value of the textarea into the iframe editor.

◆ RelayCmd() [1/2]

virtual TBuilder Ext.Net.HtmlEditor.Builder< THtmlEditor, TBuilder >.RelayCmd ( string  cmd,
bool  value 
)
inlinevirtual

◆ RelayCmd() [2/2]

virtual TBuilder Ext.Net.HtmlEditor.Builder< THtmlEditor, TBuilder >.RelayCmd ( string  cmd,
string  value 
)
inlinevirtual

◆ SyncValue()

virtual TBuilder Ext.Net.HtmlEditor.Builder< THtmlEditor, TBuilder >.SyncValue ( )
inlinevirtual

Protected method that will not generally be called directly. Syncs the contents of the editor iframe with the textarea.

◆ Text()

virtual TBuilder Ext.Net.HtmlEditor.Builder< THtmlEditor, TBuilder >.Text ( string  text)
inlinevirtual

The Text value to initialize this field with.

◆ ToggleSourceEdit() [1/2]

virtual TBuilder Ext.Net.HtmlEditor.Builder< THtmlEditor, TBuilder >.ToggleSourceEdit ( )
inlinevirtual

Toggles the editor between standard and source edit mode.

◆ ToggleSourceEdit() [2/2]

virtual TBuilder Ext.Net.HtmlEditor.Builder< THtmlEditor, TBuilder >.ToggleSourceEdit ( bool  sourceEdit)
inlinevirtual

◆ UpdateToolbar()

virtual TBuilder Ext.Net.HtmlEditor.Builder< THtmlEditor, TBuilder >.UpdateToolbar ( )
inlinevirtual

Protected method that will not generally be called directly. It triggers a toolbar update by reading the markup state of the current selection in the editor.


The documentation for this class was generated from the following file: