BackgroundImageName プロパティ (HtmlBoxTextWindow)

編集ウィンドウ内で表示される画像名を指定する値を取得または設定します。

シンタックス

Visual Basic

'宣言
 
Public Property BackgroundImageName As String

C#

public string BackgroundImageName {get; set;}

プロパティ値

WebHtmlEditor.ImageDirectory 内に含まれる画像ファイルを示す"/"、"\"、または"~"のインスタンスを含まない文字列または画像ファイルへのフルバーチャル、相対、または絶対パスを示す"/"、"\"、または"~"のひとつまたは複数のインスタンスを含む文字列。デフォルト値は空の文字列です。

解説

このプロパティが設定されると、画像が編集サーフェイスの背景に表示されます。この画像は編集を妨げません。入力は画像の「上」で起こります。エディターに透かしを設定したい場合にこれは便利なプロパティです。

WebHtmlEditor では、すべての画像は WebHtmlEditor.ImageDirectory に指定されたディレクトリにあることを前提します。たとえば、WebHtmlEditor.ImageDirectoryの値が"/ig_common/images/htmleditor/"（デフォルト）で、このプロパティが"myimage.jpg"に設定されると、コントロールは"/ig_common/images/htmleditor/myimage.jpg"でファイルを見つけることができると想定します。「スラッシュ」などのディレクトリ指定の形式を持つ文字列にこのプロパティを設定する場合 (たとえば、"C:\temp\myimage.jpg")、コントロールは画像が WebHtmlEditor.ImageDirectory の中にあるが、このプロパティで供給されたフルパスを使用することを想定しません。