ListControl.DataTextFormatString プロパティ

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

ListControl.DataTextFormatString プロパティ

リスト コントロールに連結されたデータの表示方法を制御するために使用する、書式指定文字列を取得または設定します。

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

Visual Basic (宣言)

<ThemeableAttribute(False)> _
Public Overridable Property
 DataTextFormatString As String

Visual Basic (使用法)

Dim instance As ListControl
Dim value As String

value = instance.DataTextFormatString

instance.DataTextFormatString = value

C#

[ThemeableAttribute(false)] 
public virtual string DataTextFormatString
 { get; set; }

C++

[ThemeableAttribute(false)] 
public:
virtual property String^ DataTextFormatString {
    String^ get ();
    void set (String^ value);
}

J#

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

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

JScript

public function get DataTextFormatString
 () : String

public function set DataTextFormatString
 (value : String)

プロパティ値
コントロールに連結されたデータの書式指定文字列。既定値は String.Empty です。

解説

DataTextFormatString プロパティを使用して、リスト コントロールの項目のカスタム表示形式を指定します。

データ書式指定文字列は、{ A : Bxx } の書式で、コロンで区切られた 2 つの部分から構成されます。たとえば、書式指定文字列 {0:F2} を使用すると、2 桁の固定小数点数でセルが表示されます。

メモ
文字列の全体はリテラル文字列ではなく、書式指定文字列であることを示すために、中かっこ ({}) で囲む必要があります。かっこの外側のテキストはリテラル テキストとして表示されます。

コロンの前の値 (一般的な例での A) は 0 から始まるパラメータのリストのパラメータ インデックスを指定します。

メモ
各セルには 1 つの値しかないため、この値は必ず 0 に設定します。

コロンの後の文字 (一般的な例での B) は値を表示する書式を指定します。共通の書式を次の表に示します。

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

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

書式指定文字の後の値 (一般的な例での xx) は、表示する有効桁数または小数点を指定します。

次の表には、書式指定文字列とその結果の例を示します。標準の英語設定になっていることを想定しています。

数値	書式指定文字列	結果
12345.6789	"{0:C}"	$12,345.68
-12345.6789	"{0:C}"	($12,345.68)
12345	"{0:D}"	12345
12345	"{0:D8}"	00012345
12345.6789	"{0:E}"	1234568E+004
12345.6789	"{0:E10}"	1.2345678900E+004
12345.6789	"{0:F}"	12345.68
12345.6789	"{0:F0}"	12346
12345.6789	"{0:G}"	12345.6789
123456789	"{0:G7}"	1.234568E8
12345.6789	"{0:N}"	12,345.68
123456789	"{0:N4}"	123,456,789.0000
12345.6789	"Total: {0:C}"	Total: $12345.68

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

このプロパティの値はビューステートに格納されます。

このプロパティは、テーマ別またはスタイル シート テーマ別に設定することはできません。詳細については、ThemeableAttribute、ASP.NET のテーマとスキンの概要 の各トピックを参照してください。

プラットフォーム

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、1.1、1.0

参照

関連項目
ListControl クラス
ListControl メンバ
System.Web.UI.WebControls 名前空間
その他の技術情報
書式設定の概要