HTML Editor Interface |
Open Client Administration |
 |
|
HTML Editor Interface |
Open Client Administration |
|
The following methods are available in PROIV logic:
101 - void AppendText(Text) - This method will append the supplied text to the editor. This can be executed before the editor is displayed. The editor will display with the data that has been set by these methods.
102 - string GetText(Start, Length) - This method will return text from the editor. The Start is the index of the first character in the editor text (starting at 1), and the Length is the number of characters. This can be executed before the editor is displayed in which case the text returned will be the data that has been set by these methods.
103 - void ClearText() - This method will clear all the text in the editor. This can be executed before the editor is displayed in which case the data that has been set by these methods is cleared.
104 - void ShowText() - This method will display the editor including any data that has been set by these methods.
105 - number TextLength() - This method will return the current length of the text in the editor. Use this return value in the GetText method to get all the text in the editor. This can be executed before the editor is displayed in which case the return value will be the current length of the data that has been set by these methods.
106 - void SetProperty(Name, Value) - This method will set a property in the editor. See below (Current Editor Properties) for the current property values that can be set.
107 - string GetProperty(Name) - This method will return the lower case value of an editor property. See below (Current Editor Properties) for the current property values that can be got.
Note that the methods dealing with data (AppendText, GetText, ClearText & TextLength) can be executed before the editor is shown. In this case they are dealing with a data buffer not the editor. This data buffer is used to populate the editor when it is shown and after that the data methods are dealing with the data in the editor.
The following properties are the only ones that currently have any meaning to the editor. You can set/get other properties but they will not do anything. Both the names and the values are case insensitive.
FeatureMode - This property can have one of two values: 'Default' or 'NoMenus' (if undefined then 'Default' is used). The 'Default' value gives a fully featured editor with drop down menus and a toolbar. The 'NoMenus' value gives a cut down editor with an extended toolbar and no menus. This property must be set before the ShowText method is run as it has no affect after the editor is shown.
ReadOnly - This property can be either 'True' or 'False' (if undefined then 'False' is used). If this is set to 'True' then the editor will be in read only mode and will not allow the user to edit the text. This property must be set before the ShowText method is run as it has no affect after the editor is shown.
The HTML Editor does not generate any events.
The HTML Editor does not have any special properties defined for it other than the ones that are set/get using the methods shown above. With PROIV logic you can set the standard ActiveX properties (Height, Left, MaxHeight, MaxWidth, Top, Visible & Width) but they have no affect on the editor.
The editor size is approximately the same position and size as the PROIV box defined by the component Row, Column, Height and Width but does not fit exactly within it. This is because the TinyMCE library creates a new node to hold the editor and places it near the node created for the component.
Topic ID: 800120