HtmlImageName Property

Gets or sets the name of the "HTML" image.

[Visual Basic]
<NotifyParentPropertyAttribute(True)>
<DefaultValueAttribute()>
<DescriptionAttribute("The image to display next to the HTML option.")>
Public Property HtmlImageName As String

[C#]
[NotifyParentPropertyAttribute(true)]
[DefaultValueAttribute()]
[DescriptionAttribute("The image to display next to the HTML option.")]
public string HtmlImageName {get; set;}

[C++]
[NotifyParentPropertyAttribute(true)]
[DefaultValueAttribute()]
[DescriptionAttribute("The image to display next to the HTML option.")]
public: __property string* get_HtmlImageName();
public: __property void set_HtmlImageName( 
   string* value
);

[C++/CLI]
[NotifyParentPropertyAttribute(true)]
[DefaultValueAttribute()]
[DescriptionAttribute("The image to display next to the HTML option.")]
public:
property String^ HtmlImageName {
   String^ get();
   void set (String^ value);
}

Return Type

A string containing no instances of "/", "\", or "~" indicating a image file contained within HtmlBox.ImagesDirectory 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

The image specified by this property is displayed next to the value of the HtmlBoxTabStrip.HtmlText property on the tab strip.

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

PowerWEB TextBox for .NET automatically assumes that all images are in the directory specified by HtmlBox.ImagesDirectory. For example, if the value of HtmlBox.ImagesDirectory is "/PowerWEB_TextBox_Common/images" (the default) and this property was set to "myimage.jpg", the control would assume the file can be found at "/PowerWEB_TextBox_Common/images/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 HtmlBox.ImagesDirectory but would use the full path you supplied for this property.

Requirements

Platforms: Windows 98, Windows NT 4.0, Windows ME, Windows 2000, Windows XP, Windows Server 2003, Windows Vista

See Also

HtmlBoxTabStrip Class  | HtmlBoxTabStrip Members