You are here: Ektron Namespace > Server Controls API > Ektron.Cms Namespace > Ektron.Cms.Controls Namespace > Classes > HtmlEditor Class > HtmlEditor Properties
Ektron CMS400.NET API Documentation
ContentsIndexHome
PreviousUpNext
HtmlEditor Properties

The properties of the HtmlEditor class are listed here.

 
Name 
Description 
 
This signifies that the selected content is archived.  
 
DESIGN TIME ONLY: Used to indicate to a user that they are logged in, and permits them to login through a login dialog in VisualStudio.NET.  
 
DESIGN TIME ONLY: Used to find the Web service required to access the CMS in Design Time.  
 
The action to perform on the posted content. The CMS buttons will set this value when selected. This is mostly useful on the receipt of the post as this will inform the code behind as to what action to take.  
 
Specifies the content ID to load. This value must match a value that exists in the CMS database. The selection of content is similar to that in the ContentBlock control. The content can only be accessed if the user is logged in. This value can be set only on editor load, before the editor and contents are rendered. After editor load, this value is ignored.
If this value is 0, then the code behind must handle making the calls that check out content and setting the content at edit time by placing it into the .Text property for the... more 
 
The title for the selected Content. This is set when new content is read. It can not be changed by the code behind. A text field is created, with the name EktContentTitle, that contains the description. The user can change it there.  
 
This value describes the type of content to which the selected ID refers. If this value is blank, then the content is a custom type, to be defined type, or unsupported type. These are the possible types:  
 
This specifies which JavaScript function to run when the HTML editor is ready to start processing commands. This happens after the initialization of the editor and the loading of the initial content.
This is the name, not the full function definition, of a JavaScript function. The function must follow the format defined in the eWebEditPro documentation for this type of method. Below is an example:
 
 
If 'true', the user can upload locally selected images and linked files that they have put into their content. If enabled, the automatic upload mechanism will allow uploading of the local files automatically with minimal user intervention. If 'false', the site developer must provide an upload page, such as the CMS library, where the upload can occur.  
 
If true, includes the information about the content in fields posted with a form post. (These fields are defined in the summary of this control.)
Set the value to 'false' if the page maintains these values or the page is just using the editor to edit general formatted text.
If the information must be posted, but not shown to the end user, then define the class [ControlName]_TitleLabel as having no display, or set the ShowTitle property to false.  
 
DESIGN TIME ONLY: Read only property that lets a developer know if the user is currently log into the site as a user.  
 
Specifies the ID of the language to use for the content to load. This value must match a value that exists in the CMS database.  
 
DESIGN TIME ONLY: Read only property that lets a developer know the user ID of the user who is currently logged in.  
 
DESIGN TIME ONLY: Read only property that lets a developer know the user name of the user who is currently logged in.  
 
Path 
The path to the site that contains this control. This is not available in the properties window. It is meant for code behind which wants to override the path used by the CMS.
The path is automatically determined by the control at run time, if it is not set by the code behind.
This is only available from Code Behind.  
 
The display to use for viewing the content. This can be used to simplify the display or to debug the operation of editing content on the site.
The options selectable are:
  • "activex" = Use the ActiveX control
  • "textarea" = Show HTML in text area

The default is "activex". This is only available from Code Behind.  
 
If true, then the posted HTML is encoded using URL encoding. This makes the transfer secure. If the content is encoded then it must be decoded on the receiving side.
If the decode process is not wanted, then set this value to false. This will require the validateRequest attribute in the page definition be set to false.  
 
Controls whether the CMS toolbar is displayed in the editor's toolbar. If this value is true, then commands containing CMS functionality are displayed in the editor's toolbar. The commands are for check-in, publish, and edit cancellation.  
 
If 'true', the title of the selected content is displayed. The user can then edit the title. The submission of content posts up the title, even if it is not displayed to the user, unless the IncludeContentInfo property is set to a false value.  
 
Assigns a single stylesheet to use with the edited content.  
 
Text 
The HTML text being edited.  
 
This specifies the level of the toolbar feature set offered to the user. It may be that they need a minimal set of functionality to keep the editing simple. It may be they need full functionality for a major edit. This defines the amount of functionality offered to the user.
These are the value values:
  • "None"
  • "Reduced"
  • "Default"
  • "DataDesigner"
  • "DataEntry"
  • "Calendar"
  • "FormDesign"
  • "XSLTDesign"
  • "Full"
  • "Custom"
 
 
This specifies which JavaScript function to run when the toolbar resets. The toolbar reset offers the opportunity for the script to affect the operation of the toolbar with actions such as adding or removing commands, disabling commands, or creating entirely new toolbars.
This is the name, not the full function definition, of a JavaScript function. The function must follow the format defined in the eWebEditPro documentation for this type of method. Below is an example:
 
 
The translation file (or stream) that contains the XML elements for the translation of strings used in the editor. If this is blank, the client system's windows setting is used to select form the series of default translation files.  
Created with a commercial version of Doc-O-Matic. In order to make this message disappear you need to register this software. If you have problems registering this software please contact us at [email protected].
Copyright (c) 2008. All rights reserved.
What do you think about this topic? Send feedback!