ImageField.DataImageUrlFormatString プロパティ

.NET Framework クラス ライブラリ リファレンス

ImageField.DataImageUrlFormatString プロパティ

メモ : このプロパティは、.NET Framework version 2.0 で新しく追加されたものです。

ImageField オブジェクトの各イメージの URL の表示書式を指定する文字列を取得または設定します。

名前空間: System.Web.UI.WebControls
アセンブリ: System.Web (system.web.dll 内)
構文

Visual Basic (宣言)

Public Overridable Property
 DataImageUrlFormatString As String

Visual Basic (使用法)

Dim instance As ImageField
Dim value As String

value = instance.DataImageUrlFormatString

instance.DataImageUrlFormatString = value

C#

public virtual string DataImageUrlFormatString
 { get; set; }

C++

public:
virtual property String^ DataImageUrlFormatString {
    String^ get ();
    void set (String^ value);
}

J#

/** @property */
public String get_DataImageUrlFormatString ()

/** @property */
public void set_DataImageUrlFormatString (String
 value)

JScript

public function get DataImageUrlFormatString
 () : String

public function set DataImageUrlFormatString
 (value : String)

プロパティ値
ImageField オブジェクトの各イメージの URL の表示書式を指定する文字列。既定値は空の文字列です ("")。この値は、URL に適用される特定の書式が設定されていないことを示します。

解説

ImageField オブジェクトに表示されるイメージの URL にカスタム書式を指定するには、DataImageUrlFormatString プロパティを使用します。これにより、ImageField オブジェクトにファイル名しか含まれていない場合でも、URL を生成できます。DataImageUrlFormatString プロパティが設定されていない場合、URL には特別な書式は一切適用されません。

書式指定文字列には、任意のリテラル文字列を使用でき、通常は、フィールド値のプレースホルダが含まれます。たとえば、"Item Value: {0}" という書式指定文字列があった場合、"{0}" のプレースホルダは、DataImageUrlField プロパティによって指定されたフィールドの値と置き換えられます。書式指定文字列の残りの部分は、リテラル テキストとして表示されます。

メモ
書式指定文字列にプレースホルダが含まれない場合、最終的な表示テキストには、データ ソースから取得したフィールドの値は含まれません。

プレースホルダは、{A:Bxx} の形式で、中かっこ ("{}") で囲まれた、コロン (":") 区切りの 2 つの部分から構成されます。コロンの前の値 (一般的な例での A) は 0 から始まるパラメータのリストのフィールド値インデックスを指定します。

メモ
このパラメータは、書式指定構文の一部です。各セルはフィールド値を 1 つしか格納できないので、この値は必ず 0 に設定します。

コロンおよびコロンの後の値は省略可能です。コロンの後の文字 (一般的な例での B) には、値を表示する際に使用する書式を指定します。共通の書式を次の表に示します。

書式指定文字	説明
C	通貨書式で数値を表示します。
D	10 進数書式で数値を表示します。
E	科学 (指数) 書式で数値を表示します。
F	固定書式で数値を表示します。
G	一般書式で数値を表示します。
N	数値書式で数値を表示します。
X	16 進数書式で数値を表示します。

メモ
書式指定文字では、X を除き大文字と小文字が区別されません。X は大文字または小文字を指定した 16 進数文字を表示します。

書式指定文字の後の値 (一般的な例での xx) は、表示する有効桁数または小数点を指定します。たとえば、書式指定文字列 "{0:F2}" を使用すると、2 桁の固定小数点数で表示されます。

書式指定の詳細については、「書式設定の概要」を参照してください。

使用例

DataImageUrlFormatString プロパティを使用して、ImageField オブジェクトのイメージに対する URL に、カスタム書式を適用する方法を次のコード例に示します。

ImageFieldImageUrlFormatString#1

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
ImageField クラス
ImageField メンバ
System.Web.UI.WebControls 名前空間
ImageField.DataImageUrlField プロパティ
ImageField.DataAlternateTextFormatString プロパティ
その他の技術情報
書式設定の概要