nBit Information Technologies - CMS tools for developers, ActiveX HTML Controls, Web Design

Your Account
Login


Register

ActiveX Controls

Easy FTP DLL

HTML Editor OCX

Misc.

Shopping Cart

Empty

Programming API

| Home

The nBit HTML Editor Programmers API

See Also...

Editor User Interface Part 1

Editor User Interface Part 2

Programmers API

Using the Editor in VB6

Using the Editor in Microsoft Access

Using the Editor in Delphi

Properties

Property Type Description

DocumentHTML string The innerHTML value of the outer tag of the currently editted document. This is the data bound property of the control.

AllHTML string The entire HTML code for the document. Ie Everything between the <HTML> and </HTML> tags.

DocumentTitle string The contents of the <TITLE> tag for the document.

EditorEnabled Boolean When True the editors functions are enabled. When False the editor becomes a ‘locked’ HTML viewer

hWnd Long hwnd of the control

FTPHost string FTP Server name or IP address for uploading / download files

FTPUser string Ftp Server Username

FTPPassword string Ftp Server Password

FTPInitDir string Initial FTP Directory on connection to the host

FTPSaveToURL string http URL of folder on the FTP server to save / retreive files

FTPPassive Boolean Use passive FTP transfer mode

FTPTransferType ed_FTPTransferType
nb_ASCII = use ASCII transfers

nb_Binary = use Binary Transfers

nB_Unknown = FTP class attempts to work out the required transfer type ( defaults to nb_Binary )

FTPProxyServer string If a proxy server is used this is the name or IP of the proxy server.

FTPProxyBypassList string Space delimited string servers that are to bypass the proxy server. Wildcards are acceptable in this list eg *inte* will bypass servers painter and internal.

HiddenButtons String A semi-colon seperated list of button names. When included in the list the named toolbar buttons are invisible.

localImageStore string Folder to store local images. If uploadImages is set to false then all images inserted into the editor will be copied to this folder.

LocalizationFile string Returns or sets the local path to a language localization file that allows developers to customize the text displayed in all context menus and tooltips in the editor.

BaseURL string URL used to resolve relative paths in an HTML document

showFormToolbar Boolean Show Hide theForm elements Toolbar

showFormattingToolbar1 Boolean Show Hide the first Formatting Toolbar

showFormattingToolbar2 Boolean Show Hide the 2nd Formatting Toolbar

CSSText String URL of a Cascading Style Sheets file or valid CSS string

showCSSDropDown Boolean Redundant

isAccessContained Boolean If the control is used in Microsoft Access then this value must be set to True

IsDirty Boolean Boolean value indicating whether the contents of the editor have been changed

showDocumentBackgroundImage Boolean Shows / Hides the background-image setting for a document

EditorEnabled Boolean Enabled and disables the editing features of the control

CSShttp Boolean Is the CSSText property refering to CSS string or CSS file from a URL

BorderStyle Boolean 1 = solid , 0 = no border

UploadImages Boolean Returns / Sets a boolean value indicating whether the editor will upload images inserted into the document from the image command button via FTP or leave them on the local disk

UseEnterAsBR Boolean 1 = a single enter key press will insert a <BR> tag. control-Enter will start a new paragraph

SelectionBorderColor String
Sets / Returns the border color for HTML elements currently selected in the editor. The format for the color string is any valid HTML color.

SelectionBorderStyle EdHighLightStyle Sets / Returns the border style for HTML elements currently selected in the editor.

SelectionBorderWidth String Sets / Returns the border style for HTML elements currently selected in the editor.

Methods

Method Action Definition

PutFileFTP Sends a file to a FTP Server
Function PutFileFTP(ByVal LocalFile As String, ByVal RemoteFile As String) As Boolean

GetFileFTP Retreives a file from a FTP Server
Function GetFileFTP(ByVal LocalFile As String, ByVal RemoteFile As String)

DeleteFileFTP Deletes a file from a FTP Server
Function GetFileFTP(ByVal RemoteFile As String,)

InsertAtCursor Inserts HTML code at the cursor/selection position InsertAtCursor (HTMLText as string, insertWhere as ed_InsertType)

Insert_Image Insert_Image (optional LocalFilename as string) Uploads and Inserts an image into the current document. The image is saved to the URL set by FTPSaveToURL postfixed by the name of the file. If LocalFilename is omitted then a standard windows open dialog prompts the user for the filename.

Insert_Image_NoFTP Insert_Image_NoFTP (optional LocalFilename as string) Inserts an image into the current document without uploading it. The image URL is set to file:///localPath. If LocalFilename is omitted then the standard windows open dialog prompts the user for the filename

insertImageFromURL Inserts an image into the current document without uploading it. The image URL is set to is fully qualified image URL or URL relative to the BaseURL property. If ImageURL is omitted then FTP library images form is opened insertImageFromURL (optional ImageURL as string)

RevertToOriginal Undoes all changes in the current document RevertToOriginal()

ListFilesFTP Returns an object of the type clsDirectoryList listing the files in the directory set by remoteDirectory. Filtering is applied using wildcards eg *.jpg will return a list of all the files with a .jpg extension ListFilesFTP (optional remoteDirectory as string, Filter as string) As clsDirectoryList

Open_document Opens a local HTML file Sub Open_document

Save_document Saves the current document to a local file Sub Save_document

Print_document Opens the print dialog for the current document Sub Print_document

cut_document Cuts the current selection to the clipboard Sub cut_document

copy_document Copies the current selection to the clipboard Sub copy_document

paste_document Pastes the current clipboard data to the document Sub paste_Document

Insert_Image Inserts an image to the current document via FTP. If localImagePath is omitted then the open dialog box is displayed Sub Insert_Image(Optional ByVal localImagePath As Variant)

show_Code Forces the editor to toggle between code and WYSIWYG views sub Show_Code

sendCR Sends a Carriage return to the editor ( now depreciated ). If bBR is true the a HTML BR is inserted else a paragraph tag is inserted
Function sendCR(ByVal bBR As Boolean) As Variant

CheckSpelling Spell checks the selected text in the editor. If there is no text selection the entire document is spell checked Function CheckSpelling()

CountLocalImages Returns a long value indicating the number of images in a document that are referenced as local URLs CountLocalImages () as long

UploadAllImages Uploads all the locally referenced images (src=file:///…) in the document to a FTP server. The directory saved to is set by the SaveToURL property. The src attribute fpr each image is then updated to point to the remote URL. UploadAllImages () As Long

Events

Event Description Definition

Error FTPSuccess(ByVal ID As Long, ByVal Message As String) Error(ByVal errNo As Variant, ByVal errDesc As Variant)

FTPSuccess Raised on the successful completion of an FTP method FTPSuccess(ByVal ID As Long, ByVal Message As String)

FTPError Raised on the un-successful completion of an FTP method FTPError(ByVal errNo As Long, ByVal errDesc As String)

Navigation - Previous : Next