BackgroundImageName Property

Gets or sets a value specifying the image name to display within the editing window.

[Visual Basic]
<DescriptionAttribute("Gets/sets an imagename which is displayed as the background image for the text window.")>
<NotifyParentPropertyAttribute(True)>
<DefaultValueAttribute()>
Public Property BackgroundImageName As String

[C#]
[DescriptionAttribute("Gets/sets an imagename which is displayed as the background image for the text window.")]
[NotifyParentPropertyAttribute(true)]
[DefaultValueAttribute()]
public string BackgroundImageName {get; set;}

[C++]
[DescriptionAttribute("Gets/sets an imagename which is displayed as the background image for the text window.")]
[NotifyParentPropertyAttribute(true)]
[DefaultValueAttribute()]
public: __property string* get_BackgroundImageName();
public: __property void set_BackgroundImageName( 
   string* value
);

[C++/CLI]
[DescriptionAttribute("Gets/sets an imagename which is displayed as the background image for the text window.")]
[NotifyParentPropertyAttribute(true)]
[DefaultValueAttribute()]
public:
property String^ BackgroundImageName {
   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

When this property is set, an image is displayed on the background of the editing surface. This image does not interfere with editing. Typing occurs "over" the image. This is a useful property to use if you would like to set a watermark for the editor.

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

HtmlBoxTextWindow Class  | HtmlBoxTextWindow Members