Version www.capesoft.com

	FeHtmlEditor

Contents
		The FeHtmlEditor Object
		Methods
		The Templates
		Overview
		Useful References
		Summary of callback events Using the HTML editor in Windows Vista

File Explorer Classes - FeHtmlEditor

Formerly known as the Html2 file type / object, the FeHtmlEditor Object is used to edit html pages.

FeHtmlEditor - Methods

Quick Reference

Edit

GetHtmlGraphicsInfo

GetInfo

HideControl

Init

InsertHtml

InsertTable

InsertText

KeyPressed

Kill

Load

NewDocument

PrintMe

Reload

Save

SetFocus

Settings

UnhideControl

Update




Edit     ( long EditType ) ThisViewer1.Edit (fe:HtmlEditor_Copy) Calls various "Editing" commands. The EditType parameter can be one of the following: fe:HtmlEditor_Bold fe:HtmlEditor_Italic fe:HtmlEditor_Underline fe:HtmlEditor_Copy fe:HtmlEditor_Cut fe:HtmlEditor_Paste fe:HtmlEditor_Delete fe:HtmlEditor_FindText fe:HtmlEditor_EditFont fe:HtmlEditor_InsertHyperlink fe:HtmlEditor_InsertImage fe:HtmlEditor_Indent fe:HtmlEditor_Outdent fe:HtmlEditor_JustifyCenter fe:HtmlEditor_JustifyLeft fe:HtmlEditor_JustifyRight fe:HtmlEditor_PrintWithDialog fe:HtmlEditor_EditImage fe:HtmlEditor_EditHyperlink fe:HtmlEditor_SelectAll fe:HtmlEditor_Undo fe:HtmlEditor_Redo fe:HtmlEditor_InsertRow fe:HtmlEditor_InsertColumn fe:HtmlEditor_DeleteRows fe:HtmlEditor_DeleteColumns fe:HtmlEditor_DeleteCells fe:HtmlEditor_SplitCell

GetHtmlGraphicsInfo     ( *string HtmlSource ) TempString = ThisViewer1.Source  ! needed only for the next line ThisViewer1.GetHtmlGraphicsInfo (TempString)  ! updates the Source and Graphics list properties ThisEmailSend.MessageHtml = ThisViewer1.Source ThisEmailSend.EmbedList = ThisViewer1.GraphicsList This method was written primarily to make it easier to use File Explorer with NetTalk, to create and send emails. The idea is that you use File Explorer to create / view an email (html). To send this email (using NetTalk), you need to set several NetTalk properties.  Two of these properties are a comma separated list of graphics in the html (ThisEmailSend.EmbedList), and a modified version of the html code (ThisEmailSend.MessageHtml), where image paths are changed from qualified paths to paths prefixed with "cid". This File Explorer method simply updates two File Explorer properties, self.Source and self.GraphicsList. Also look at the notes below on the "RootFolder" property. The code above gives a rough idea how this works, for a detailed example see the fenetalk.app example that ships with File Explorer.

GetInfo     (  ) ThisViewer1.GetInfo () This method queries the object and updates properties with information.  Think of this as updating the properties (variables) at a moment in time. Each time you call this method, the following properties are updated: self.Url self.PagePath self.PageTitle self.Source self.InnerHtml self.InnerText self.OuterHtml self.OuterText self.DocInnerText self.TagName self.ObjString self.ObjType self.PicSource self.PicText self.PicHSpacing self.PicVSpacing self.PicAlign self.PicBorder self.Browser

HideControl     ( ) ThisViewer.HideControl () Hides the File Explorer viewer control.  Note: ?feControl{prop:hide} = true will not work.

Init     ( long CurrentControl ) ThisViewer1.Init (?feControl) Handles initialization for the object Must be called before you call any other methods

InsertHtml     ( byte Location, string TextToInsert ) MyVar = '<strong>I am here</strong>' ThisViewer1.InsertHtml (1, MyVar) This method enables you to insert html into the loaded document.  The TextToInsert parameter that you pass can be either actual "html", or a variable containing the html to insert (as illustrated in the examples below). Location can be one of the following: 1 - Inserts the html at the current position of the cursor. 2 - Immediately before the current element 3 - After the start of the current element, but before the content of the element 4 - Immediately before the end of the element, but after all the content inside the element 5 - Immediately after the end of the element To demonstrate the differences, see the notes on the InsertTextmethod.

InsertTable     ( <string pCaption> ) APPROACH 1: ThisViewer.TableLayout.Columns = 3 ThisViewer.TableLayout.Rows = 5 ThisViewer.TableLayout.Alignment = 'Center' ThisViewer.TableLayout.BorderSize = 1 ThisViewer.TableLayout.CellPadding = 1 ThisViewer.TableLayout.CellSpacing = 1 ThisViewer.TableLayout.TableWidth = 80 ThisViewer.TableLayout.TableWidthIsPercent = true ThisViewer.InsertTable () APPROACH 2: if ThisViewer.TableLayoutWindow()   ThisViewer1.InsertTable () end Inserts a table into the currently loaded html document, at the current location Before calling the InsertTable method, set the TableLayout property as shown above to "prime" the actual insert properties

InsertText     ( byte Location, string TextToInsert ) MyVar = 'I am here' ThisViewer1.InsertText (1, MyVar) This method enables you to insert text into the loaded document.  The TextToInsert parameter that you pass can be either actual text, or a variable containing the text to insert (as illustrated in the examples below). Location can be one of the following: 1 - Inserts the text at the current position of the cursor. 2 - Immediately before the current element 3 - After the start of the current element, but before the content of the element 4 - Immediately before the end of the element, but after all the content inside the element 5 - Immediately after the end of the element Note:  If you're wanting to insert spaces ("        ") you will have problems if using Location = 1, as several spaces will appear as one single space.  If you're struggling with this, rather use the InsertHtml method (refer the FAQ section).

KeyPressed     ( signed FeControl ) ,long if OLEEvent = 13 ! Keypress Event   feLastKeypress = ThisViewer1.Html2KeyPressed(OLEControlFEQ) The ocx we use for this object fires an event (event 13) each time the user presses a key on the keyboard, but does not indicate which key was pressed to fire the event.  The KeyPressed method returns the key that was pressed.  The method needs to be called from within the callback function embed to work. We have implemented this method for you through the template, by adding a check box called "Last Key Pressed" to the "Advanced Options Tab". Not yet working in the latest beta releases

Kill     (  ) ThisViewer1.Kill() Handles the "closing down" of an object Must be called (typically) as the window which contains the object is closed

Load     ( string CurrentPath, <long CurrentControl>, <byte LoadFromVar> ) ThisViewer1.Load (MyVariable, ?feControl, true) Loads a document into the object. If the CurrentControl parameter is omitted, the control which you passed in the Init method is used (default)

NewDocument     ( ) ThisViewer1.NewDocument() Creates a new, blank document You can call this method before calling the Load method, but must call the Init method first

PrintMe     ( byte ShowDialog ) ThisViewer1.PrintMe (true) Prints the loaded document

Reload     ( <long CurrentControl> ) ThisViewer1.Reload () Reloads the last document which you loaded If you omit the CurrentControl parameter, the same control which you used in the Init method is used (default)

Save     ( *string SaveLocation, byte SaveType, byte PromptUser=true ),byte,proc FileNameString = longpath() & '\MyFile.htm' ThisViewer1.Save (FileNameString, 1) This method saves the loaded html document to either a variable (field), or to a file (disk) The SaveType parameter sets whether you are saving to a file on disk or to a variable, and can be one of these values: 1 - Save to a file on disk 2 - Save to a variable The SaveLocation parameter is either the name of the file that the html should be saved to (if SaveType=1), or is the actual variable which should store the html (if SaveType=2).

SetFocus     ( ) ThisViewer.SetFocus() Sets the focus to the window that contains the FileExplorer control.

Settings     ( string BkgColor ) ,byte ThisViewer1.Settings ('Blue') Similar to the Update method, this method is used to change various (page) settings in the loaded document.  At this stage it supports only one such setting, being the ability to change the loaded html page's background color.  Call this method "yourself" (as shown below), or by using the HtmlBackgroundColorButton template.

UnhideControl     ( ) ThisViewer.UnhideControl () Unhides the File Explorer viewer control.  Note: ?feControl{prop:hide} = false will not work.

Update     ( string Property, string PropValue ) ThisViewer1.Update('Source', 'I wrote this') Use this method to update various properties / values The reason you use this method and don't just change the properties "directly" is because using this method results in the changes being implemented "immediately", and not for instance only coming into effect the next time you load a document into the object which is often the "default" behaviour The Property parameter can be one of the following: PrinterHeader PrinterFooter PrinterOrientation Source InnerHtml InnerText OuterHtml OuterText ShowDetails ShowBorders Browser PicSource -  not yet working PicText - not yet working PicHSpacing - not yet working PicVSpacing - not yet working PicAlign - not yet working PicBorder - not yet working

 

FeHtmlEditor - Properties (alphabetical)

Active (Byte)	( obsolete )
Browser (Byte)	Setting this property to true (1) changes the FeHtmlEditor object to a "read only", html-browsing control.  In this mode you cannot edit anything, and the hyperlinks become active, launching separate (new) windows.  By default this is set to false (0).  Can be "set" either "directly", or using the GetInfo and Update methods.  Can be a very useful property for setting access permissions etc.  Example 1 : ThisViewer1.Update ('Browser', 1) Example 2 : ThisViewer1.Browser = true ThisViewer1.Load ('c:\mydoc.html')
CurrentPath (String)	The full path (including filename) of the file currently loaded in the object.  Refreshed using the GetInfo method.  e.g. 'c:\documents\page1.html'.
DocInnerText (CString)	Same as the InnerText property, but this property holds the InnerText component for the whole document, not just the currently selected portion.  Use this property if you're wanting the "text" from an entire html page.  Refreshed using the GetInfo method.
InnerHtml (CString)	Holds the HTML for the selected object, between the start and end tags.  See the GetInfo and Update methods.
InnerText (CString)	Holds the text for the selected object, between the start and end tags.  See the GetInfo and Update methods.
ObjType (String)	This property holds the selected object type within the current document.  It can be one of three things: "Text" - Selection is text based "None" - Nothing selected "Control" - An image or a form control is selected
OuterHtml (CString)	Holds the selected (html) object's html content  See the GetInfo and Update methods.
OuterText (CString)	Holds the selected (html) object's text content  See the GetInfo and Update methods.
PageTitle (String)	Holds the title of the page being displayed.  See the GetInfo method.
PicAlign (String)	Holds the "Alignment" setting for the currently selected image in an html document.  Use the GetInfo and Update methods.
PicBorder (Byte)	Holds the "Border" width for the currently selected image in an html file.  Use the GetInfo and Update methods.  (Setting the border to 0 will result in the image having no border).
PicHSpacing (Byte)	Holds the "Horizontal Spacing" setting for the currently selected image in an html file.  Use the GetInfo and Update methods.
PicVSpacing (Byte)	Holds the "Vertical Spacing" setting for the currently selected image in an html file.  Use the GetInfo and Update methods.
PicSource (String)	Holds the source (web url or filename) for the currently selected image in an html file.  Use the GetInfo and Update methods.
PicText (String)	Holds the "Alternate Text" (the text that displays when you point at the image, and/or if the image fails to load) for the currently selected image in an html file.  Use the GetInfo and Update methods.
RootFolder (String)	This property is used in the GetHtmlGraphicsInfo method, for the following purpose.  When you are trying to establish the list of graphics in an html document ( primarily useful for when you are using NetTalk to send an email written using File Explorer - see the GraphicsList property ) there may be graphics with paths such as " /MySubfolder/MyImage.gif ".  The problem arises that when you pass NetTalk a graphic path like that ( to embed the graphic into the email at send-time ), it fails as the path is not "valid". File Explorer handles this problem as follows:  If you have first set the HtmlRootFolder property, before calling the GetHtmlGraphicsInfo method, then File Explorer automatically constructs valid paths for these graphics, using the HtmlRootFolder property to establish valid paths for these files.  Example... Example: ThisViewer1.RootFolder = "c:\My Documents\Website1" ! Here we set this property with the folder that contains the actual html page we're working with.  Any graphics in this html file that have no path ( Image1.gif ) or an "incomplete" path ( /Subfoler/Image.gif ) will be assumed to be in this folder or have this folder as their root. ThisViewer1.GetHtmlGraphicsInfo() If you do not set the RootFolder property before calling the GetHtmlGraphicsInfo method, File Explorer will assume that such graphics stem from the exe directory.
Source (CString)	Holds the html component (source / text) of the loaded page.  See the GetInfo and Update methods.
TagName (String)	Holds the Tag Name of the selected object (e.g. "STRONG", "FONT", "A").  See the GetInfo method.
Url (String)	Holds the path / url to the file currently loaded.  Refreshed using the GetInfo method.  e.g. 'c:\documents\'.

 

FeHtmlEditor - Templates

At this time there is quite an overlap in terms of multiple File Explorer classes being implemented by the same templates.  In the future we may revisit this, but for now all templates are covered in the main (FileExplorer.htm) help document, please click here.

 

Summary of callback events

See the FeHtmlEditor_Callbacks procedure in the feabc.app example application for more info.

Event Name	Equate	Description
ContextMenuAction	fe:EdEvt_ContextMenuAction	The user right clicked to display the popup context menu
DisplayChanged	fe:EdEvt_DisplayChanged	The display of the page changed
DocumentComplete	fe:EdEvt_DocumentComplete	The document completed downloading. For frames pages this will be called once for each frame
OnBlur	fe:EdEvt_OnBlur	The control lost focus
OnClick	fe:EdEvt_OnClick	The control was clicked on by the user
OnDblClick	fe:EdEvt_OnDblClick	The control was double clicked on by the user
OnKeyDown	fe:EdEvt_OnKeyDown	The user pressed a key
OnKeyPress	fe:EdEvt_OnKeyPress	The user pressed a key
OnKeyUp	fe:EdEvt_OnKeyUp	The user released the pressed key
OnMouseDown	fe:EdEvt_OnMouseDown	The mouse button was pressed
OnMouseMove	fe:EdEvt_OnMouseMove	The mouse was moved
OnMouseOut	fe:EdEvt_OnMouseOut	The mouse was moved outside the control
OnMouseOver	fe:EdEvt_OnMouseOver	The mouse was moved over the control
OnMouseUp	fe:EdEvt_OnMouseUp	The mouse button was released
OnReadyStateChange	fe:EdEvt_OnReadyStateChange
ShowContextMenu	fe:EdEvt_ShowContextMenu	The right click context menu will be displayed