ImageName Property (BaseToolbarButton)

The name of the image displayed on the button.

Syntax

Visual Basic

'Declaration
 
Public Property ImageName As String

C#

public string ImageName {get; set;}

Property Value

A string containing no instances of "/", "\", or "~" indicating a image file contained within WebHtmlEditor.ImageDirectory or a string containing one or many instances of "/", "\", or "~" indicating a full virtual, relative, or absolute path to an image file. The default value is an empty string.

Remarks

This property will come preset to a valid imagename found in the images directory (specified by WebHtmlEditor.ImageDirectory) created during the product installation. Set this property only if you wish to change from the presets.

This property is not used when WebHtmlEditor.ButtonMode = ButtonMode.HTML.

WebHtmlEditor for .NET automatically assumes that all images are in the directory specified by WebHtmlEditor.ImageDirectory. For example, if the value of WebHtmlEditor.ImageDirectory is "/ig_common/images/htmleditor/" (the default) and this property was set to "myimage.jpg", the control would assume the file can be found at "/ig_common/images/htmleditor/myimage.jpg". If you set this property to a string that has some form of directory designation, such as "slashes" within it (for example "C:\temp\myimage.jpg") the control would no longer assume that the image is within WebHtmlEditor.ImageDirectory but would use the full path you supplied for this property.

Requirements

Target Platforms: Windows 10, Windows 8.1, Windows 8, Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2